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/repository
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
..
archiver refactor some functions to support ctx as first parameter (#21878) 2 years ago
files Add context cache as a request level cache (#22294) 1 year ago
adopt.go Repositories: by default disable all units except code and pulls on forks (#22541) 1 year ago
adopt_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
avatar.go Unify hashing for avatar (#22289) 2 years ago
avatar_test.go Unify hashing for avatar (#22289) 2 years ago
branch.go Supports wildcard protected branch (#20825) 1 year ago
cache.go Implement FSFE REUSE for golang files (#21840) 2 years ago
check.go Refactor git command package to improve security and maintainability (#22678) 1 year ago
fork.go Repositories: by default disable all units except code and pulls on forks (#22541) 1 year ago
fork_test.go Add option to prohibit fork if user reached maximum limit of repositories (#21848) 2 years ago
hooks.go Implement FSFE REUSE for golang files (#21840) 2 years ago
lfs.go Add cron method to gc LFS MetaObjects (#22385) 1 year ago
main_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
push.go Add context cache as a request level cache (#22294) 1 year ago
repository.go Rename almost all Ctx functions (#22071) 2 years ago
repository_test.go refactor some functions to support ctx as first parameter (#21878) 2 years ago
review.go Implement FSFE REUSE for golang files (#21840) 2 years ago
review_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
template.go Implement FSFE REUSE for golang files (#21840) 2 years ago
transfer.go Rename almost all Ctx functions (#22071) 2 years ago
transfer_test.go Rename almost all Ctx functions (#22071) 2 years ago