2022-08-26 00:55:52 +03:00
{{ $ in dex : = 0 }}
2020-05-24 01:05:20 +03:00
<div class="timeline-item commits-list">
2021-08-09 21:08:51 +03:00
{{ range .comment .Commits }}
2022-08-26 00:55:52 +03:00
{{ $ tag : = printf "%s-%d" $ .comment .HashTag $ in dex }}
Use a general Eval function for expressions in templates. (#23927)
One of the proposals in #23328
This PR introduces a simple expression calculator
(templates/eval/eval.go), it can do basic expression calculations.
Many untested template helper functions like `Mul` `Add` can be replaced
by this new approach.
Then these `Add` / `Mul` / `percentage` / `Subtract` / `DiffStatsWidth`
could all use this `Eval`.
And it provides enhancements for Golang templates, and improves
readability.
Some examples:
----
* Before: `{{Add (Mul $glyph.Row 12) 12}}`
* After: `{{Eval $glyph.Row "*" 12 "+" 12}}`
----
* Before: `{{if lt (Add $i 1) (len $.Topics)}}`
* After: `{{if Eval $i "+" 1 "<" (len $.Topics)}}`
## FAQ
### Why not use an existing expression package?
We need a highly customized expression engine:
* do the calculation on the fly, without pre-compiling
* deal with int/int64/float64 types, to make the result could be used in
Golang template.
* make the syntax could be used in the Golang template directly
* do not introduce too much complex or strange syntax, we just need a
simple calculator.
* it needs to strictly follow Golang template's behavior, for example,
Golang template treats all non-zero values as truth, but many 3rd
packages don't do so.
### What's the benefit?
* Developers don't need to add more `Add`/`Mul`/`Sub`-like functions,
they were getting more and more.
Now, only one `Eval` is enough for all cases.
* The new code reads better than old `{{Add (Mul $glyph.Row 12) 12}}`,
the old one isn't familiar to most procedural programming developers
(eg, the Golang expression syntax).
* The `Eval` is fully covered by tests, many old `Add`/`Mul`-like
functions were never tested.
### The performance?
It doesn't use `reflect`, it doesn't need to parse or compile when used
in Golang template, the performance is as fast as native Go template.
### Is it too complex? Could it be unstable?
The expression calculator program is a common homework for computer
science students, and it's widely used as a teaching and practicing
purpose for developers. The algorithm is pretty well-known.
The behavior can be clearly defined, it is stable.
2023-04-07 16:25:49 +03:00
{{ $ in dex = Eval $ in dex "+" 1 }}
2020-05-24 01:05:20 +03:00
<div class="singular-commit" id=" {{ $ tag }} ">
2020-09-11 23:19:00 +03:00
<span class="badge badge-commit"> {{ svg "octicon-git-commit" }} </span>
2020-05-20 15:47:24 +03:00
{{ if .User }}
2022-02-14 14:19:07 +03:00
<a href=" {{ .User .HomeLink }} ">
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 16:37:34 +03:00
{{ avatar $ .root .Context .User }}
2020-12-03 21:46:11 +03:00
</a>
2020-05-20 15:47:24 +03:00
{{ else }}
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 16:37:34 +03:00
{{ avatarByEmail $ .root .Context .Author .Email .Author .Name }}
2020-05-20 15:47:24 +03:00
{{ end }}
2023-03-27 17:44:51 +03:00
{{ $ commitLink : = printf "%s/commit/%s" $ .comment .Issue .PullRequest .BaseRepo .Link ( PathEscape .ID .String ) }}
2020-05-20 15:47:24 +03:00
<span class="ui float right shabox">
2021-08-09 21:08:51 +03:00
{{ template "repo/commit_statuses" dict "Status" .Status "Statuses" .Statuses "root" $ .root }}
2020-05-20 15:47:24 +03:00
{{ $ class : = "ui sha label" }}
{{ if .Signature }}
{{ $ class = ( printf "%s%s" $ class " isSigned" ) }}
{{ if .Verification .Verified }}
{{ if eq .Verification .TrustStatus "trusted" }}
{{ $ class = ( printf "%s%s" $ class " isVerified" ) }}
{{ else if eq .Verification .TrustStatus "untrusted" }}
{{ $ class = ( printf "%s%s" $ class " isVerifiedUntrusted" ) }}
{{ else }}
{{ $ class = ( printf "%s%s" $ class " isVerifiedUnmatched" ) }}
{{ end }}
{{ else if .Verification .Warning }}
{{ $ class = ( printf "%s%s" $ class " isWarning" ) }}
{{ end }}
{{ end }}
2023-03-27 17:44:51 +03:00
<a href=" {{ $ commitLink }} " rel="nofollow" class=" {{ $ class }} ">
<span class="shortsha"> {{ ShortSha .ID .String }} </span>
{{ if .Signature }}
{{ template "repo/shabox_badge" dict "root" $ .root "verification" .Verification }}
{{ end }}
</a>
2020-05-20 15:47:24 +03:00
</span>
2023-02-13 20:59:59 +03:00
<span class="gt-mono commit-summary {{ if gt .ParentCount 1 }} grey text {{ end }} " title=" {{ .Summary }} "> {{ RenderCommitMessageLinkSubject $ .root .Context .Message ( $ .comment .Issue .PullRequest .BaseRepo .Link | Escape ) $ commitLink $ .comment .Issue .PullRequest .BaseRepo .ComposeMetas }} </span>
2020-05-20 15:47:24 +03:00
{{ if IsMultilineCommitMessage .Message }}
2021-11-23 05:44:38 +03:00
<button class="ui button ellipsis-button" aria-expanded="false">...</button>
2020-05-20 15:47:24 +03:00
{{ end }}
{{ if IsMultilineCommitMessage .Message }}
2023-02-19 07:06:14 +03:00
<pre class="commit-body gt-hidden"> {{ RenderCommitBody $ .root .Context .Message ( $ .comment .Issue .PullRequest .BaseRepo .Link | Escape ) $ .comment .Issue .PullRequest .BaseRepo .ComposeMetas }} </pre>
2020-05-20 15:47:24 +03:00
{{ end }}
</div>
{{ end }}
2020-05-24 01:05:20 +03:00
</div>
