Skip to content

Commit bb0ff77

Browse files
zeripathzeripath
authored
Share HTML template renderers and create a watcher framework (#20218)
The recovery, API, Web and package frameworks all create their own HTML Renderers. This increases the memory requirements of Gitea unnecessarily with duplicate templates being kept in memory. Further the reloading framework in dev mode for these involves locking and recompiling all of the templates on each load. This will potentially hide concurrency issues and it is inefficient. This PR stores the templates renderer in the context and stores this context in the NormalRoutes, it then creates a fsnotify.Watcher framework to watch files. The watching framework is then extended to the mailer templates which were previously not being reloaded in dev. Then the locales are simplified to a similar structure. Fix #20210 Fix #20211 Fix #20217 Signed-off-by: Andrew Thornton <art27@cantab.net>
1 parent c21d651 commit bb0ff77

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+899
-615
lines changed

‎cmd/embedded.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ func initEmbeddedExtractor(c *cli.Context) error {
123123

124124
sections["public"] = &section{Path: "public", Names: public.AssetNames, IsDir: public.AssetIsDir, Asset: public.Asset}
125125
sections["options"] = &section{Path: "options", Names: options.AssetNames, IsDir: options.AssetIsDir, Asset: options.Asset}
126-
sections["templates"] = &section{Path: "templates", Names: templates.AssetNames, IsDir: templates.AssetIsDir, Asset: templates.Asset}
126+
sections["templates"] = &section{Path: "templates", Names: templates.BuiltinAssetNames, IsDir: templates.BuiltinAssetIsDir, Asset: templates.BuiltinAsset}
127127

128128
for _, sec := range sections {
129129
assets = append(assets, buildAssetList(sec, pats, c)...)

‎cmd/web.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,10 @@ func runWeb(ctx *cli.Context) error {
126126
return err
127127
}
128128
}
129-
c := install.Routes()
129+
installCtx, cancel := context.WithCancel(graceful.GetManager().HammerContext())
130+
c := install.Routes(installCtx)
130131
err := listen(c, false)
132+
cancel()
131133
if err != nil {
132134
log.Critical("Unable to open listener for installer. Is Gitea already running?")
133135
graceful.GetManager().DoGracefulShutdown()
@@ -175,7 +177,7 @@ func runWeb(ctx *cli.Context) error {
175177
}
176178

177179
// Set up Chi routes
178-
c := routers.NormalRoutes()
180+
c := routers.NormalRoutes(graceful.GetManager().HammerContext())
179181
err := listen(c, true)
180182
<-graceful.GetManager().Done()
181183
log.Info("PID: %d Gitea Web Finished", os.Getpid())

‎contrib/pr/checkout.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"code.gitea.io/gitea/models/db"
2828
"code.gitea.io/gitea/models/unittest"
2929
gitea_git "code.gitea.io/gitea/modules/git"
30+
"code.gitea.io/gitea/modules/graceful"
3031
"code.gitea.io/gitea/modules/markup"
3132
"code.gitea.io/gitea/modules/markup/external"
3233
repo_module "code.gitea.io/gitea/modules/repository"
@@ -117,7 +118,7 @@ func runPR() {
117118
// routers.GlobalInit()
118119
external.RegisterRenderers()
119120
markup.Init()
120-
c := routers.NormalRoutes()
121+
c := routers.NormalRoutes(graceful.GetManager().HammerContext())
121122

122123
log.Printf("[PR] Ready for testing !\n")
123124
log.Printf("[PR] Login with user1, user2, user3, ... with pass: password\n")

‎go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ require (
2828
github.com/emirpasic/gods v1.18.1
2929
github.com/ethantkoenig/rupture v1.0.1
3030
github.com/felixge/fgprof v0.9.2
31+
github.com/fsnotify/fsnotify v1.5.4
3132
github.com/gliderlabs/ssh v0.3.4
3233
github.com/go-ap/activitypub v0.0.0-20220615144428-48208c70483b
3334
github.com/go-ap/jsonld v0.0.0-20220615144122-1d862b15410d
@@ -161,7 +162,6 @@ require (
161162
github.com/envoyproxy/protoc-gen-validate v0.6.2 // indirect
162163
github.com/felixge/httpsnoop v1.0.2 // indirect
163164
github.com/form3tech-oss/jwt-go v3.2.3+incompatible // indirect
164-
github.com/fsnotify/fsnotify v1.5.4 // indirect
165165
github.com/fullstorydev/grpcurl v1.8.1 // indirect
166166
github.com/fxamacker/cbor/v2 v2.4.0 // indirect
167167
github.com/go-ap/errors v0.0.0-20220615144307-e8bc4a40ae9f // indirect

‎integrations/api_activitypub_person_test.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ import (
2323

2424
func TestActivityPubPerson(t *testing.T) {
2525
setting.Federation.Enabled = true
26-
c = routers.NormalRoutes()
26+
c = routers.NormalRoutes(context.TODO())
2727
defer func() {
2828
setting.Federation.Enabled = false
29-
c = routers.NormalRoutes()
29+
c = routers.NormalRoutes(context.TODO())
3030
}()
3131

3232
onGiteaRun(t, func(*testing.T, *url.URL) {
@@ -60,10 +60,10 @@ func TestActivityPubPerson(t *testing.T) {
6060

6161
func TestActivityPubMissingPerson(t *testing.T) {
6262
setting.Federation.Enabled = true
63-
c = routers.NormalRoutes()
63+
c = routers.NormalRoutes(context.TODO())
6464
defer func() {
6565
setting.Federation.Enabled = false
66-
c = routers.NormalRoutes()
66+
c = routers.NormalRoutes(context.TODO())
6767
}()
6868

6969
onGiteaRun(t, func(*testing.T, *url.URL) {
@@ -75,10 +75,10 @@ func TestActivityPubMissingPerson(t *testing.T) {
7575

7676
func TestActivityPubPersonInbox(t *testing.T) {
7777
setting.Federation.Enabled = true
78-
c = routers.NormalRoutes()
78+
c = routers.NormalRoutes(context.TODO())
7979
defer func() {
8080
setting.Federation.Enabled = false
81-
c = routers.NormalRoutes()
81+
c = routers.NormalRoutes(context.TODO())
8282
}()
8383

8484
srv := httptest.NewServer(c)

‎integrations/api_nodeinfo_test.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
package integrations
66

77
import (
8+
"context"
89
"net/http"
910
"net/url"
1011
"testing"
@@ -18,10 +19,10 @@ import (
1819

1920
func TestNodeinfo(t *testing.T) {
2021
setting.Federation.Enabled = true
21-
c = routers.NormalRoutes()
22+
c = routers.NormalRoutes(context.TODO())
2223
defer func() {
2324
setting.Federation.Enabled = false
24-
c = routers.NormalRoutes()
25+
c = routers.NormalRoutes(context.TODO())
2526
}()
2627

2728
onGiteaRun(t, func(*testing.T, *url.URL) {

‎integrations/create_no_session_test.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
package integrations
66

77
import (
8+
"context"
89
"net/http"
910
"net/http/httptest"
1011
"os"
@@ -57,7 +58,7 @@ func TestSessionFileCreation(t *testing.T) {
5758
oldSessionConfig := setting.SessionConfig.ProviderConfig
5859
defer func() {
5960
setting.SessionConfig.ProviderConfig = oldSessionConfig
60-
c = routers.NormalRoutes()
61+
c = routers.NormalRoutes(context.TODO())
6162
}()
6263

6364
var config session.Options
@@ -82,7 +83,7 @@ func TestSessionFileCreation(t *testing.T) {
8283

8384
setting.SessionConfig.ProviderConfig = string(newConfigBytes)
8485

85-
c = routers.NormalRoutes()
86+
c = routers.NormalRoutes(context.TODO())
8687

8788
t.Run("NoSessionOnViewIssue", func(t *testing.T) {
8889
defer PrintCurrentTest(t)()

‎integrations/integration_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func TestMain(m *testing.M) {
8989
defer cancel()
9090

9191
initIntegrationTest()
92-
c = routers.NormalRoutes()
92+
c = routers.NormalRoutes(context.TODO())
9393

9494
// integration test settings...
9595
if setting.Cfg != nil {

‎modules/charset/escape_test.go

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,11 +133,18 @@ then resh (ר), and finally heh (ה) (which should appear leftmost).`,
133133
},
134134
}
135135

136+
type nullLocale struct{}
137+
138+
func (nullLocale) Language() string { return "" }
139+
func (nullLocale) Tr(key string, _ ...interface{}) string { return key }
140+
func (nullLocale) TrN(cnt interface{}, key1, keyN string, args ...interface{}) string { return "" }
141+
142+
var _ (translation.Locale) = nullLocale{}
143+
136144
func TestEscapeControlString(t *testing.T) {
137145
for _, tt := range escapeControlTests {
138146
t.Run(tt.name, func(t *testing.T) {
139-
locale := translation.NewLocale("en_US")
140-
status, result := EscapeControlString(tt.text, locale)
147+
status, result := EscapeControlString(tt.text, nullLocale{})
141148
if !reflect.DeepEqual(*status, tt.status) {
142149
t.Errorf("EscapeControlString() status = %v, wanted= %v", status, tt.status)
143150
}
@@ -173,7 +180,7 @@ func TestEscapeControlReader(t *testing.T) {
173180
t.Run(tt.name, func(t *testing.T) {
174181
input := strings.NewReader(tt.text)
175182
output := &strings.Builder{}
176-
status, err := EscapeControlReader(input, output, translation.NewLocale("en_US"))
183+
status, err := EscapeControlReader(input, output, nullLocale{})
177184
result := output.String()
178185
if err != nil {
179186
t.Errorf("EscapeControlReader(): err = %v", err)
@@ -195,5 +202,5 @@ func TestEscapeControlReader_panic(t *testing.T) {
195202
for i := 0; i < 6826; i++ {
196203
bs = append(bs, []byte("—")...)
197204
}
198-
_, _ = EscapeControlString(string(bs), translation.NewLocale("en_US"))
205+
_, _ = EscapeControlString(string(bs), nullLocale{})
199206
}

‎modules/context/context.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -658,8 +658,8 @@ func Auth(authMethod auth.Method) func(*Context) {
658658
}
659659

660660
// Contexter initializes a classic context for a request.
661-
func Contexter() func(next http.Handler) http.Handler {
662-
rnd := templates.HTMLRenderer()
661+
func Contexter(ctx context.Context) func(next http.Handler) http.Handler {
662+
_, rnd := templates.HTMLRenderer(ctx)
663663
csrfOpts := getCsrfOpts()
664664
if !setting.IsProd {
665665
CsrfTokenRegenerationInterval = 5 * time.Second // in dev, re-generate the tokens more aggressively for debug purpose

0 commit comments

Comments
 (0)