foster/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-25 08:59:31 -05:00
Code Issues Wiki Activity

Increase cacheContextLifetime to reduce false reports (#32011)

Browse source 
Replace #32001.

To prevent the context cache from being misused for long-term work
(which would result in using invalid cache without awareness), the
context cache is designed to exist for a maximum of 10 seconds. This
leads to many false reports, especially in the case of slow SQL.

This PR increases it to 5 minutes to reduce false reports.

5 minutes is not a very safe value, as a lot of changes may have
occurred within that time frame. However, as far as I know, there has
not been a case of misuse of context cache discovered so far, so I think
5 minutes should be OK.

Please note that after this PR, if warning logs are found again, it
should get attention, at that time it can be almost 100% certain that it
is a misuse.

(cherry picked from commit a323a82ec4bde6ae39b97200439829bf67c0d31e)
This commit is contained in:
Jason Song 2024-09-09 12:51:25 +08:00 committed by Gergely Nagy
parent af3fbb397a
commit 5b1990b3b2
No known key found for this signature in database
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
modules/cache/context.go vendored
View file

@ -63,9 +63,9 @@ func (cc *cacheContext) isDiscard() bool {
} }
// cacheContextLifetime is the max lifetime of cacheContext. // cacheContextLifetime is the max lifetime of cacheContext.
// Since cacheContext is used to cache data in a request level context, 10s is enough. // Since cacheContext is used to cache data in a request level context, 5 minutes is enough.
// If a cacheContext is used more than 10s, it's probably misuse. // If a cacheContext is used more than 5 minutes, it's probably misuse.
const cacheContextLifetime = 10 * time.Second const cacheContextLifetime = 5 * time.Minute
var timeNow = time.Now var timeNow = time.Now
@ -133,7 +133,7 @@ func GetContextData(ctx context.Context, tp, key any) any {
if c.Expired() { if c.Expired() {
// The warning means that the cache context is misused for long-life task, // The warning means that the cache context is misused for long-life task,
// it can be resolved with WithNoCacheContext(ctx). // it can be resolved with WithNoCacheContext(ctx).
log.Warn("cache context is expired, may be misused for long-life tasks: %v", c) log.Warn("cache context is expired, is highly likely to be misused for long-life tasks: %v", c)
return nil return nil
} }
return c.Get(tp, key) return c.Get(tp, key)
@ -146,7 +146,7 @@ func SetContextData(ctx context.Context, tp, key, value any) {
if c.Expired() { if c.Expired() {
// The warning means that the cache context is misused for long-life task, // The warning means that the cache context is misused for long-life task,
// it can be resolved with WithNoCacheContext(ctx). // it can be resolved with WithNoCacheContext(ctx).
log.Warn("cache context is expired, may be misused for long-life tasks: %v", c) log.Warn("cache context is expired, is highly likely to be misused for long-life tasks: %v", c)
return return
} }
c.Put(tp, key, value) c.Put(tp, key, value)
@ -159,7 +159,7 @@ func RemoveContextData(ctx context.Context, tp, key any) {
if c.Expired() { if c.Expired() {
// The warning means that the cache context is misused for long-life task, // The warning means that the cache context is misused for long-life task,
// it can be resolved with WithNoCacheContext(ctx). // it can be resolved with WithNoCacheContext(ctx).
log.Warn("cache context is expired, may be misused for long-life tasks: %v", c) log.Warn("cache context is expired, is highly likely to be misused for long-life tasks: %v", c)
return return
} }
c.Delete(tp, key) c.Delete(tp, key)

2
modules/cache/context_test.go vendored
View file

@ -46,7 +46,7 @@ func TestWithCacheContext(t *testing.T) {
timeNow = now timeNow = now
}() }()
timeNow = func() time.Time { timeNow = func() time.Time {
return now().Add(10 * time.Second) return now().Add(5 * time.Minute)
} }
v = GetContextData(ctx, field, "my_config1") v = GetContextData(ctx, field, "my_config1")
assert.Nil(t, v) assert.Nil(t, v)