2023-02-13 18:59:59 +01:00
< table id = "repo-files-table" class = "ui single line table gt-mt-0" data-last-commit-loader-url = " {{ .LastCommitLoaderURL }} " >
2015-12-07 23:30:52 +01:00
< thead >
2017-11-30 06:08:40 +01:00
< tr class = "commit-list" >
2021-10-08 15:08:22 +02:00
< th colspan = "2" {{ if not .LatestCommit }} class = "notready" {{ end }} >
{{ if not .LatestCommit }}
< div class = "ui active tiny slow centered inline" > …< / div >
2015-12-07 23:30:52 +01:00
{{ else }}
2021-10-08 15:08:22 +02:00
{{ if .LatestCommitUser }}
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 14:37:34 +01:00
{{ avatar $.Context .LatestCommitUser 24 }}
2021-10-08 15:08:22 +02:00
{{ if .LatestCommitUser.FullName }}
2023-02-23 21:28:18 +01:00
< a class = "muted author-wrapper" title = " {{ .LatestCommitUser.FullName }} " href = " {{ .LatestCommitUser.HomeLink }} " >< strong > {{ .LatestCommitUser.FullName }} </ strong ></ a >
2021-10-08 15:08:22 +02:00
{{ else }}
2023-02-23 21:28:18 +01:00
< a class = "muted author-wrapper" title = " {{ if .LatestCommit.Author }}{{ .LatestCommit.Author.Name }}{{ else }}{{ .LatestCommitUser.Name }}{{ end }} " href = " {{ .LatestCommitUser.HomeLink }} " >< strong > {{ if .LatestCommit.Author }}{{ .LatestCommit.Author.Name }}{{ else }}{{ .LatestCommitUser.Name }}{{ end }} </ strong ></ a >
2021-10-08 15:08:22 +02:00
{{ end }}
{{ else }}
{{ if .LatestCommit.Author }}
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 14:37:34 +01:00
{{ avatarByEmail $.Context .LatestCommit.Author.Email .LatestCommit.Author.Name 24 }}
2023-02-23 21:28:18 +01:00
< span class = "author-wrapper" title = " {{ .LatestCommit.Author.Name }} " >< strong > {{ .LatestCommit.Author.Name }} </ strong ></ span >
2021-10-08 15:08:22 +02:00
{{ end }}
2020-02-29 14:27:19 +01:00
{{ end }}
2022-08-25 23:55:52 +02:00
< a rel = "nofollow" class = "ui sha label {{ if .LatestCommit.Signature }} isSigned {{ if .LatestCommitVerification.Verified }} isVerified {{ if eq .LatestCommitVerification.TrustStatus "trusted" }}{{ else if eq .LatestCommitVerification.TrustStatus "untrusted" }} Untrusted {{ else }} Unmatched {{ end }}{{ else if .LatestCommitVerification.Warning }} isWarning {{ end }}{{ end }} " href = " {{ .RepoLink }} /commit/ {{ PathEscape .LatestCommit.ID.String }} " >
2021-10-08 15:08:22 +02:00
< span class = "shortsha" > {{ ShortSha .LatestCommit.ID.String }} </ span >
{{ if .LatestCommit.Signature }}
{{ template "repo/shabox_badge" dict "root" $ "verification" .LatestCommitVerification }}
{{ end }}
< / a >
{{ template "repo/commit_statuses" dict "Status" .LatestCommitStatus "Statuses" .LatestCommitStatuses "root" $ }}
2022-08-25 23:55:52 +02:00
{{ $commitLink := printf "%s/commit/%s" .RepoLink ( PathEscape .LatestCommit.ID.String ) }}
2022-01-20 00:26:57 +01:00
< span class = "grey commit-summary" title = " {{ .LatestCommit.Summary }} " >< span class = "message-wrapper" > {{ RenderCommitMessageLinkSubject $.Context .LatestCommit.Message $.RepoLink $commitLink $.Repository.ComposeMetas }} </ span >
2021-10-08 15:08:22 +02:00
{{ if IsMultilineCommitMessage .LatestCommit.Message }}
2023-07-27 12:47:41 +02:00
< button class = "ui button js-toggle-commit-body ellipsis-button" aria-expanded = "false" > ...< / button >
2023-02-19 05:06:14 +01:00
< pre class = "commit-body gt-hidden" > {{ RenderCommitBody $.Context .LatestCommit.Message $.RepoLink $.Repository.ComposeMetas }} </ pre >
2021-10-08 15:08:22 +02:00
{{ end }}
< / span >
2017-11-30 06:08:40 +01:00
{{ end }}
2015-12-07 23:30:52 +01:00
< / th >
2022-06-27 22:58:46 +02:00
< th class = "text grey right age" > {{ if .LatestCommit }}{{ if .LatestCommit.Committer }}{{ TimeSince .LatestCommit.Committer.When $.locale }}{{ end }}{{ end }} </ th >
2015-12-07 23:30:52 +01:00
< / tr >
< / thead >
< tbody >
{{ if .HasParentPath }}
< tr class = "has-parent" >
2023-06-22 03:59:49 +02:00
< td colspan = "3" > {{ svg "octicon-reply" }} < a class = "muted" href = " {{ .BranchLink }}{{ if .ParentPath }}{{ PathEscapeSegments .ParentPath }}{{ end }} " > ..</ a ></ td >
2015-12-07 23:30:52 +01:00
< / tr >
{{ end }}
{{ range $item := .Files }}
2020-12-17 15:00:47 +01:00
{{ $entry := $item .Entry }}
{{ $commit := $item .Commit }}
{{ $subModuleFile := $item .SubModuleFile }}
2021-10-08 15:08:22 +02:00
< tr data-entryname = " {{ $entry .Name }} " data-ready = " {{ if $commit }} true {{ else }} false {{ end }} " class = " {{ if not $commit }} not {{ end }} ready entry" >
2020-08-26 17:52:44 +02:00
< td class = "name four wide" >
< span class = "truncate" >
{{ if $entry .IsSubModule }}
2020-09-11 22:19:00 +02:00
{{ svg "octicon-file-submodule" }}
Introduce customized HTML elements, fix incorrect AppUrl usages in templates (#22861)
This PR follows:
* #21986
* #22831
This PR also introduce customized HTML elements, which would also help
problems like:
* #17760
* #21429
* #21440
With customized HTML elements, there won't be any load-search-replace
operations, and it can avoid page flicking (which @silverwind cares a
lot).
Browser support:
https://developer.mozilla.org/en-US/docs/Web/API/Window/customElements
# FAQ
## Why the component has the prefix?
As usual, I would strongly suggest to add prefixes for our own/private
names. The dedicated prefix will avoid conflicts in the future, and it
makes it easier to introduce various 3rd components, like GitHub's
`relative-time` component. If there is no prefix, it's impossible to
introduce another public component with the same name in the future.
## Why the `custcomp.js` is loaded before HTML body? The `index.js` is
after HTML body.
Customized components must be registered before the content loading.
Otherwise there would be still some flicking.
`custcomp.js` should have its own dependencies and should be very light,
so it won't affect the page loading time too much.
## Why use `data-url` attribute but not use the `textContent`?
According to the standard, the `connectedCallback` occurs on the
tag-opening moment. The element's children are not ready yet.
## Why not use `{{.GuessCurrentOrigin $.ctx ...}}` to let backend decide
the absolute URL?
It's difficult for backend to guess the correct protocol(scheme)
correctly with zero configuration. Generating the absolute URL from
frontend can guarantee that the URL is 100% correct -- since the user is
visiting it.
# Screenshot
<details>
![image](https://user-images.githubusercontent.com/2114189/218256757-a267c8ba-3108-4755-9ae5-329f1b08f615.png)
</details>
2023-02-17 15:02:20 +01:00
{{ $refURL := $subModuleFile .RefURL AppUrl $.Repository.FullName $.SSHDomain }} {{/* FIXME: the usage of AppUrl seems incorrect, it would be fixed in the future, use AppSubUrl instead */}}
2020-08-26 17:52:44 +02:00
{{ if $refURL }}
2022-07-22 12:49:24 +02:00
< a class = "muted" href = " {{ $refURL }} " > {{ $entry .Name }} </ a >< span class = "at" > @</ span >< a href = " {{ $refURL }} /commit/ {{ PathEscape $subModuleFile .RefID }} " > {{ ShortSha $subModuleFile .RefID }} </ a >
2020-08-26 17:52:44 +02:00
{{ else }}
2020-12-17 15:00:47 +01:00
{{ $entry .Name }} < span class = "at" > @</ span > {{ ShortSha $subModuleFile .RefID }}
2020-08-26 17:52:44 +02:00
{{ end }}
2020-08-23 21:05:17 +02:00
{{ else }}
2020-08-26 17:52:44 +02:00
{{ if $entry .IsDir }}
{{ $subJumpablePathName := $entry .GetSubJumpablePathName }}
2022-04-01 02:15:46 +02:00
{{ svg "octicon-file-directory-fill" }}
2022-07-22 12:49:24 +02:00
< a class = "muted" href = " {{ $.TreeLink }} / {{ PathEscapeSegments $subJumpablePathName }} " title = " {{ $subJumpablePathName }} " >
2023-04-29 14:02:29 +02:00
{{ $subJumpablePathFields := StringUtils .Split $subJumpablePathName "/" }}
{{ $subJumpablePathFieldLast := ( Eval ( len $subJumpablePathFields ) "-" 1 ) }}
{{ if eq $subJumpablePathFieldLast 0 }}
{{ $subJumpablePathName }}
2020-08-26 17:52:44 +02:00
{{ else }}
2023-04-29 14:02:29 +02:00
{{ $subJumpablePathPrefixes := slice $subJumpablePathFields 0 $subJumpablePathFieldLast }}
2023-05-25 04:31:26 +02:00
< span class = "text light-2" > {{ StringUtils .Join $subJumpablePathPrefixes "/" }} </ span > /{{ index $subJumpablePathFields $subJumpablePathFieldLast }}
2020-08-26 17:52:44 +02:00
{{ end }}
< / a >
{{ else }}
2020-09-11 22:19:00 +02:00
{{ svg ( printf "octicon-%s" ( EntryIcon $entry )) }}
2022-07-22 12:49:24 +02:00
< a class = "muted" href = " {{ $.TreeLink }} / {{ PathEscapeSegments $entry .Name }} " title = " {{ $entry .Name }} " > {{ $entry .Name }} </ a >
2020-08-26 17:52:44 +02:00
{{ end }}
2020-08-23 21:05:17 +02:00
{{ end }}
2020-08-26 17:52:44 +02:00
< / span >
< / td >
2019-11-02 01:26:21 +01:00
< td class = "message nine wide" >
2020-08-26 17:52:44 +02:00
< span class = "truncate" >
2021-10-08 15:08:22 +02:00
{{ if $commit }}
2021-12-03 17:15:53 +01:00
{{ $commitLink := printf "%s/commit/%s" $.RepoLink ( PathEscape $commit .ID.String ) }}
2022-01-20 00:26:57 +01:00
{{ RenderCommitMessageLinkSubject $.Context $commit .Message $.RepoLink $commitLink $.Repository.ComposeMetas }}
2021-10-08 15:08:22 +02:00
{{ else }}
< div class = "ui active tiny slow centered inline" > …< / div >
{{ end }}
2020-08-26 17:52:44 +02:00
< / span >
2015-12-07 23:30:52 +01:00
< / td >
2022-06-27 22:58:46 +02:00
< td class = "text right age three wide" > {{ if $commit }}{{ TimeSince $commit .Committer.When $.locale }}{{ end }} </ td >
2015-12-07 23:30:52 +01:00
< / tr >
{{ end }}
< / tbody >
2014-07-26 06:24:27 +02:00
< / table >
{{ if .ReadmeExist }}
2015-12-07 23:30:52 +01:00
{{ template "repo/view_file" . }}
2015-07-28 10:42:06 +02:00
{{ end }}