You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
forgejo/modules
Lunny Xiao bd820aa9c5
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.

But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.

The core context cache is here. It defines a new context
```go
type cacheContext struct {
	ctx  context.Context
	data map[any]map[any]any
        lock sync.RWMutex
}

var cacheContextKey = struct{}{}

func WithCacheContext(ctx context.Context) context.Context {
	return context.WithValue(ctx, cacheContextKey, &cacheContext{
		ctx:  ctx,
		data: make(map[any]map[any]any),
	})
}
```

Then you can use the below 4 methods to read/write/del the data within
the same context.

```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```

Then let's take a look at how `system.GetString` implement it.

```go
func GetSetting(ctx context.Context, key string) (string, error) {
	return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
		return cache.GetString(genSettingCacheKey(key), func() (string, error) {
			res, err := GetSettingNoCache(ctx, key)
			if err != nil {
				return "", err
			}
			return res.SettingValue, nil
		})
	})
}
```

First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.

An object stored in the context cache will only be destroyed after the
context disappeared.
1 year ago
..
actions Fix actions workflow branches match bug (#22724) 1 year ago
activitypub Add Chef package registry (#22554) 1 year ago
analyze Implement FSFE REUSE for golang files (#21840) 2 years ago
auth Add context cache as a request level cache (#22294) 1 year ago
avatar Unify hashing for avatar (#22289) 2 years ago
base Implement FSFE REUSE for golang files (#21840) 2 years ago
cache Add context cache as a request level cache (#22294) 1 year ago
charset Fix isAllowed of escapeStreamer (#22814) 1 year ago
container Implement FSFE REUSE for golang files (#21840) 2 years ago
context Fix improper HTMLURL usages in Go code (#22839) 1 year ago
csv Implement FSFE REUSE for golang files (#21840) 2 years ago
doctor Add cron method to gc LFS MetaObjects (#22385) 1 year ago
emoji Fix unstable emoji sort (#22346) 1 year ago
eventsource Move `convert` package to services (#22264) 2 years ago
generate Implement FSFE REUSE for golang files (#21840) 2 years ago
git Remember to attach the parent tree when converting TreeEntry() -> Tree() (#22902) 1 year ago
gitgraph Add context cache as a request level cache (#22294) 1 year ago
graceful Implement FSFE REUSE for golang files (#21840) 2 years ago
hcaptcha Consume hcaptcha and pwn deps (#22610) 1 year ago
highlight Implement FSFE REUSE for golang files (#21840) 2 years ago
hostmatcher Implement FSFE REUSE for golang files (#21840) 2 years ago
html Implement FSFE REUSE for golang files (#21840) 2 years ago
httpcache Add some comments for recent code (#22725) 1 year ago
httplib Implement FSFE REUSE for golang files (#21840) 2 years ago
indexer Make issue and code search support camel case (#22829) 1 year ago
issue/template Allow issue templates to not render title (#22589) 1 year ago
json Update gitea-vet to check FSFE REUSE (#22004) 2 years ago
lfs escape filename when assemble URL (#22850) 1 year ago
log Improve trace logging for pulls and processes (#22633) 1 year ago
markup Move `IsReadmeFile*` from `modules/markup/` to `modules/util` (#22877) 1 year ago
mcaptcha Implement FSFE REUSE for golang files (#21840) 2 years ago
metrics include build info in Prometheus metrics (#22819) 1 year ago
migration Fix restore repo bug, clarify the problem of ForeignIndex (#22776) 1 year ago
mirror Implement FSFE REUSE for golang files (#21840) 2 years ago
nosql Implement FSFE REUSE for golang files (#21840) 2 years ago
notification Implement actions (#21937) 1 year ago
options Implement FSFE REUSE for golang files (#21840) 2 years ago
packages Use import of OCI structs (#22765) 1 year ago
paginator Update gitea-vet to check FSFE REUSE (#22004) 2 years ago
password Consume hcaptcha and pwn deps (#22610) 1 year ago
pprof Implement FSFE REUSE for golang files (#21840) 2 years ago
private Implement actions (#21937) 1 year ago
process Improve trace logging for pulls and processes (#22633) 1 year ago
proxy Use proxy for pull mirror (#22771) 1 year ago
proxyprotocol Implement FSFE REUSE for golang files (#21840) 2 years ago
public Implement FSFE REUSE for golang files (#21840) 2 years ago
queue Correctly handle select on multiple channels in Queues (#22146) 2 years ago
recaptcha Implement FSFE REUSE for golang files (#21840) 2 years ago
references Use correct captured group range when parsing cross-reference (#22672) 1 year ago
regexplru Implement FSFE REUSE for golang files (#21840) 2 years ago
repository Add context cache as a request level cache (#22294) 1 year ago
secret Implement FSFE REUSE for golang files (#21840) 2 years ago
session Update gitea-vet to check FSFE REUSE (#22004) 2 years ago
setting Add Chef package registry (#22554) 1 year ago
sitemap Fix sitemap (#22272) 2 years ago
ssh Implement FSFE REUSE for golang files (#21840) 2 years ago
storage Implement actions (#21937) 1 year ago
structs Pull Requests: setting to allow edits by maintainers by default, tweak UI (#22862) 1 year ago
svg Implement FSFE REUSE for golang files (#21840) 2 years ago
sync Implement FSFE REUSE for golang files (#21840) 2 years ago
system Implement FSFE REUSE for golang files (#21840) 2 years ago
templates Add context cache as a request level cache (#22294) 1 year ago
test refactor some functions to support ctx as first parameter (#21878) 2 years ago
timeutil Check for zero time instant in `TimeStamp.IsZero()` (#22171) 2 years ago
translation Implement FSFE REUSE for golang files (#21840) 2 years ago
turnstile Add new captcha: cloudflare turnstile (#22369) 1 year ago
typesniffer Implement FSFE REUSE for golang files (#21840) 2 years ago
updatechecker Implement FSFE REUSE for golang files (#21840) 2 years ago
upload Implement FSFE REUSE for golang files (#21840) 2 years ago
uri Implement FSFE REUSE for golang files (#21840) 2 years ago
user Implement FSFE REUSE for golang files (#21840) 2 years ago
util Move `IsReadmeFile*` from `modules/markup/` to `modules/util` (#22877) 1 year ago
validation Map OIDC groups to Orgs/Teams (#21441) 1 year ago
watcher Implement FSFE REUSE for golang files (#21840) 2 years ago
web Map OIDC groups to Orgs/Teams (#21441) 1 year ago
webhook Restructure `webhook` module (#22256) 2 years ago