gitea/templates/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.
2023-02-15 21:37:34 +08:00
..
actions Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
branch Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
cite Copy citation file content, in APA and BibTex format, on repo home page (#19999) 2022-11-11 18:02:50 +01:00
diff Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
editor Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
find Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
graph Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
issue Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
migrate Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
projects Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
pulls Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
release Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
settings Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
wiki Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
activity.tmpl Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00
blame.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
branch_dropdown.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
clone_buttons.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
clone_script.tmpl Make clone URL use current page's host (#22808) 2023-02-09 17:29:13 +08:00
commit_page.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
commit_status.tmpl Change commit status icons to SVG (#20736) 2022-08-09 23:55:29 +02:00
commit_statuses.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
commits_list_small.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
commits_list.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
commits_table.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
commits.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
create_helper.tmpl Add templates to customize text when creating and migrating repositories 2023-01-24 22:36:48 -05:00
create.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
empty.tmpl Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00
file_info.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
forks.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
graph.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
header.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
home.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
icon.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
packages.tmpl Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00
search.tmpl Remove Fomantic-UI's .hidden CSS class for menu elements (#22895) 2023-02-14 19:53:54 +08:00
shabox_badge.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
sub_menu.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
unicode_escape_prompt.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
upload.tmpl Refactor i18n to locale (#20153) 2022-06-27 15:58:46 -05:00
user_cards.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
view_file.tmpl Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
view_list.tmpl Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
watchers.tmpl Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00