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/models/repo
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.go Implement FSFE REUSE for golang files (#21840) 2 years ago
attachment.go Preview images for Issue cards in Project Board view (#22112) 1 year ago
attachment_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
avatar.go Add context cache as a request level cache (#22294) 1 year ago
collaboration.go Always reuse transaction (#22362) 1 year ago
collaboration_test.go Rename almost all Ctx functions (#22071) 2 years ago
fork.go Implement FSFE REUSE for golang files (#21840) 2 years ago
fork_test.go refactor some functions to support ctx as first parameter (#21878) 2 years ago
git.go Implement FSFE REUSE for golang files (#21840) 2 years ago
issue.go Rename almost all Ctx functions (#22071) 2 years ago
language_stats.go Round language stats percentage using largest remainder (#22026) 2 years ago
main_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
mirror.go Use ErrInvalidArgument in packages (#22268) 2 years ago
pushmirror.go Use ErrInvalidArgument in packages (#22268) 2 years ago
pushmirror_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
redirect.go Implement FSFE REUSE for golang files (#21840) 2 years ago
redirect_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
release.go Use link in UI which returned a relative url but not html_url which contains an absolute url (#21986) 1 year ago
repo.go Fix improper HTMLURL usages in Go code (#22839) 1 year ago
repo_indexer.go Implement FSFE REUSE for golang files (#21840) 2 years ago
repo_list.go Remove ONLY_SHOW_RELEVANT_REPOS setting (#21962) 1 year ago
repo_list_test.go Add a simple test for external renderer (#20033) 2 years ago
repo_test.go refactor some functions to support ctx as first parameter (#21878) 2 years ago
repo_unit.go Pull Requests: setting to allow edits by maintainers by default, tweak UI (#22862) 1 year ago
star.go Implement FSFE REUSE for golang files (#21840) 2 years ago
star_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
topic.go Implement FSFE REUSE for golang files (#21840) 2 years ago
topic_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
update.go Fix error when calculate the repository size (#22392) 1 year ago
upload.go Implement FSFE REUSE for golang files (#21840) 2 years ago
user_repo.go Implement FSFE REUSE for golang files (#21840) 2 years ago
user_repo_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
watch.go Implement FSFE REUSE for golang files (#21840) 2 years ago
watch_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
wiki.go Implement FSFE REUSE for golang files (#21840) 2 years ago
wiki_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago