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/services
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 Add context cache as a request level cache (#22294) 1 year ago
agit Rename almost all Ctx functions (#22071) 2 years ago
asymkey Add context cache as a request level cache (#22294) 1 year ago
attachment Add API management for issue/pull and comment attachments (#21783) 2 years ago
auth Add context cache as a request level cache (#22294) 1 year ago
automerge Improve trace logging for pulls and processes (#22633) 1 year ago
context Support org/user level projects (#22235) 1 year ago
convert Add context cache as a request level cache (#22294) 1 year ago
cron Add Cargo package registry (#21888) 1 year ago
externalaccount Implement FSFE REUSE for golang files (#21840) 2 years ago
forms Pull Requests: setting to allow edits by maintainers by default, tweak UI (#22862) 1 year ago
gitdiff Refactor git command package to improve security and maintainability (#22678) 1 year ago
issue Webhooks: for issue close/reopen action, add commit ID that caused it (#22583) 1 year ago
lfs Use context parameter in models/git (#22367) 1 year ago
mailer fix permission check for creating comment while mail (#22524) 1 year ago
markup Implement FSFE REUSE for golang files (#21840) 2 years ago
migrations Prevent duplicate labels when importing more than 99 (#22591) 1 year ago
mirror Use proxy for pull mirror (#22771) 1 year ago
org Implement FSFE REUSE for golang files (#21840) 2 years ago
packages Use import of OCI structs (#22765) 1 year ago
pull Add context cache as a request level cache (#22294) 1 year ago
release Add context cache as a request level cache (#22294) 1 year ago
repository Add context cache as a request level cache (#22294) 1 year ago
task Implement FSFE REUSE for golang files (#21840) 2 years ago
user Add context cache as a request level cache (#22294) 1 year ago
webhook Add context cache as a request level cache (#22294) 1 year ago
wiki Improve utils of slices (#22379) 1 year ago