Find a file
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
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github update discord invite (#19907) 2022-06-07 11:40:27 -04:00
assets Use import of OCI structs (#22765) 2023-02-06 10:07:09 +00:00
build Consume hcaptcha and pwn deps (#22610) 2023-01-29 09:49:51 -06:00
cmd Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
contrib Add Contributed backport command (#22643) 2023-01-31 22:10:54 +00:00
custom/conf Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
docker Rootless Docker - Mistake with the repo-avatars parent folder name (#22637) 2023-01-31 22:42:48 +00:00
docs Add command to bulk set must-change-password (#22823) 2023-02-14 16:12:19 -06:00
models Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
modules Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
options Pull Requests: setting to allow edits by maintainers by default, tweak UI (#22862) 2023-02-13 14:09:52 +08:00
public Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
routers Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
services Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
snap Remove unnecessary whitespace in snapcraft.yaml (#22090) 2022-12-10 08:31:16 -06:00
templates Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
tests Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
tools Move fuzz tests into tests/fuzz (#22376) 2023-01-09 15:30:14 +08:00
web_src Fix dark-colored description text in arc-green theme (#22908) 2023-02-14 13:05:19 -06:00
.air.toml Add more test directory to exclude dir of air, remove watching templates from air include dir because gitea has internal mechanism (#22246) 2022-12-27 14:00:34 +08:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Add .dockerignore (#21753) 2022-11-10 04:04:09 +01:00
.drone.yml use drone secrets for s3 config (#22770) 2023-02-05 16:42:48 -05:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies (#22538) 2023-01-21 10:42:13 +08:00
.gitattributes Hook go-licenses into tidy again (#21353) 2022-10-10 20:45:02 +02:00
.gitignore Add go licenses to licenses.txt (#21034) 2022-09-04 00:20:46 +02:00
.gitpod.yml Split default gitpod view to include all tasks (#22555) 2023-01-20 13:46:33 -06:00
.golangci.yml Fix .golangci.yml (#22868) 2023-02-11 21:44:53 +00:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm refactor: ignore LGTM from author of pull request. (#3283) 2018-01-02 06:13:49 -06:00
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Move all remaining colors into CSS variables (#21903) 2022-11-23 08:22:27 +08:00
BSDmakefile Add BSDmakefile to prevent errors when make is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
build.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
CHANGELOG.md Frontport 1.18.2 and 1.18.3 Changelogs (#22580) 2023-01-23 09:36:00 -06:00
CONTRIBUTING.md Add Contributed backport command (#22643) 2023-01-31 22:10:54 +00:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile update to build with go1.20 (#22732) 2023-02-03 11:23:52 -05:00
Dockerfile.rootless update to build with go1.20 (#22732) 2023-02-03 11:23:52 -05:00
go.mod Use import of OCI structs (#22765) 2023-02-06 10:07:09 +00:00
go.sum Use import of OCI structs (#22765) 2023-02-06 10:07:09 +00:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Support asciicast files as new markup (#22448) 2023-01-18 08:46:58 +08:00
MAINTAINERS Update username (#22147) 2022-12-16 15:11:03 +02:00
Makefile update to build with go1.20 (#22732) 2023-02-03 11:23:52 -05:00
package-lock.json Implement actions (#21937) 2023-01-31 09:45:19 +08:00
package.json Implement actions (#21937) 2023-01-31 09:45:19 +08:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
README.md link update in README files (#22582) 2023-01-23 15:57:57 -05:00
README_ZH.md link update in README files (#22582) 2023-01-23 15:57:57 -05:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
vitest.config.js Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00
webpack.config.js Update JS dependencies and eslint (#22190) 2022-12-20 17:15:47 -05:00

Gitea

Gitea - Git with a cup of tea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater and Internet connectivity to download npm dependencies.

When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js and Internet connectivity.

Parallelism (make -j <num>) is not supported.

More info: https://docs.gitea.io/en-us/install-from-source/

Using

./gitea web

NOTE: If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

NOTES:

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Translating

Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

https://docs.gitea.io/en-us/translation-guidelines/

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The Hugo-based documentation theme is hosted at gitea/theme.

The official Gitea CLI is developed at gitea/tea.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark