Skip to content

Commit 41c946a

Browse files
wxiaoguangwxiaoguang
authored
Prepare common tmpl functions in a middleware (#33957)
Fix the TODO in `routers/web/web.go`, and avoid the unnecessary `GetActiveStopwatch` SQL query in non-related route handlers.
1 parent 32258e0 commit 41c946a

File tree

6 files changed

+91
-80
lines changed

6 files changed

+91
-80
lines changed

‎routers/common/pagetmpl.go‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// Copyright 2025 The Gitea Authors. All rights reserved.
2+
// SPDX-License-Identifier: MIT
3+
4+
package common
5+
6+
import (
7+
goctx "context"
8+
"errors"
9+
10+
activities_model "code.gitea.io/gitea/models/activities"
11+
"code.gitea.io/gitea/models/db"
12+
issues_model "code.gitea.io/gitea/models/issues"
13+
"code.gitea.io/gitea/modules/log"
14+
"code.gitea.io/gitea/services/context"
15+
)
16+
17+
// StopwatchTmplInfo is a view on a stopwatch specifically for template rendering
18+
type StopwatchTmplInfo struct {
19+
IssueLink string
20+
RepoSlug string
21+
IssueIndex int64
22+
Seconds int64
23+
}
24+
25+
func getActiveStopwatch(goCtx goctx.Context) *StopwatchTmplInfo {
26+
ctx := context.GetWebContext(goCtx)
27+
if ctx.Doer == nil {
28+
return nil
29+
}
30+
31+
_, sw, issue, err := issues_model.HasUserStopwatch(ctx, ctx.Doer.ID)
32+
if err != nil {
33+
if !errors.Is(err, goctx.Canceled) {
34+
log.Error("Unable to HasUserStopwatch for user:%-v: %v", ctx.Doer, err)
35+
}
36+
return nil
37+
}
38+
39+
if sw == nil || sw.ID == 0 {
40+
return nil
41+
}
42+
43+
return &StopwatchTmplInfo{
44+
issue.Link(),
45+
issue.Repo.FullName(),
46+
issue.Index,
47+
sw.Seconds() + 1, // ensure time is never zero in ui
48+
}
49+
}
50+
51+
func notificationUnreadCount(goCtx goctx.Context) int64 {
52+
ctx := context.GetWebContext(goCtx)
53+
if ctx.Doer == nil {
54+
return 0
55+
}
56+
count, err := db.Count[activities_model.Notification](ctx, activities_model.FindNotificationOptions{
57+
UserID: ctx.Doer.ID,
58+
Status: []activities_model.NotificationStatus{activities_model.NotificationStatusUnread},
59+
})
60+
if err != nil {
61+
if !errors.Is(err, goctx.Canceled) {
62+
log.Error("Unable to find notification for user:%-v: %v", ctx.Doer, err)
63+
}
64+
return 0
65+
}
66+
return count
67+
}
68+
69+
func PageTmplFunctions(ctx *context.Context) {
70+
if ctx.IsSigned {
71+
// defer the function call to the last moment when the tmpl renders
72+
ctx.Data["NotificationUnreadCount"] = notificationUnreadCount
73+
ctx.Data["GetActiveStopwatch"] = getActiveStopwatch
74+
}
75+
}

‎routers/web/repo/issue_stopwatch.go‎

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
package repo
55

66
import (
7-
"strings"
8-
97
"code.gitea.io/gitea/models/db"
108
issues_model "code.gitea.io/gitea/models/issues"
119
"code.gitea.io/gitea/modules/eventsource"
@@ -72,39 +70,3 @@ func CancelStopwatch(c *context.Context) {
7270

7371
c.JSONRedirect("")
7472
}
75-
76-
// GetActiveStopwatch is the middleware that sets .ActiveStopwatch on context
77-
func GetActiveStopwatch(ctx *context.Context) {
78-
if strings.HasPrefix(ctx.Req.URL.Path, "/api") {
79-
return
80-
}
81-
82-
if !ctx.IsSigned {
83-
return
84-
}
85-
86-
_, sw, issue, err := issues_model.HasUserStopwatch(ctx, ctx.Doer.ID)
87-
if err != nil {
88-
ctx.ServerError("HasUserStopwatch", err)
89-
return
90-
}
91-
92-
if sw == nil || sw.ID == 0 {
93-
return
94-
}
95-
96-
ctx.Data["ActiveStopwatch"] = StopwatchTmplInfo{
97-
issue.Link(),
98-
issue.Repo.FullName(),
99-
issue.Index,
100-
sw.Seconds() + 1, // ensure time is never zero in ui
101-
}
102-
}
103-
104-
// StopwatchTmplInfo is a view on a stopwatch specifically for template rendering
105-
type StopwatchTmplInfo struct {
106-
IssueLink string
107-
RepoSlug string
108-
IssueIndex int64
109-
Seconds int64
110-
}

‎routers/web/user/notification.go‎

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
package user
55

66
import (
7-
goctx "context"
87
"errors"
98
"fmt"
109
"net/http"
@@ -35,32 +34,6 @@ const (
3534
tplNotificationSubscriptions templates.TplName = "user/notification/notification_subscriptions"
3635
)
3736

38-
// GetNotificationCount is the middleware that sets the notification count in the context
39-
func GetNotificationCount(ctx *context.Context) {
40-
if strings.HasPrefix(ctx.Req.URL.Path, "/api") {
41-
return
42-
}
43-
44-
if !ctx.IsSigned {
45-
return
46-
}
47-
48-
ctx.Data["NotificationUnreadCount"] = func() int64 {
49-
count, err := db.Count[activities_model.Notification](ctx, activities_model.FindNotificationOptions{
50-
UserID: ctx.Doer.ID,
51-
Status: []activities_model.NotificationStatus{activities_model.NotificationStatusUnread},
52-
})
53-
if err != nil {
54-
if err != goctx.Canceled {
55-
log.Error("Unable to GetNotificationCount for user:%-v: %v", ctx.Doer, err)
56-
}
57-
return -1
58-
}
59-
60-
return count
61-
}
62-
}
63-
6437
// Notifications is the notifications page
6538
func Notifications(ctx *context.Context) {
6639
getNotifications(ctx)

‎routers/web/web.go‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,10 +280,8 @@ func Routes() *web.Router {
280280
routes.Get("/api/swagger", append(mid, misc.Swagger)...) // Render V1 by default
281281
}
282282

283-
// TODO: These really seem like things that could be folded into Contexter or as helper functions
284-
mid = append(mid, user.GetNotificationCount)
285-
mid = append(mid, repo.GetActiveStopwatch)
286283
mid = append(mid, goGet)
284+
mid = append(mid, common.PageTmplFunctions)
287285

288286
others := web.NewRouter()
289287
others.Use(mid...)

‎templates/base/head_navbar.tmpl‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{{$notificationUnreadCount := 0}}
22
{{if and .IsSigned .NotificationUnreadCount}}
3-
{{$notificationUnreadCount = call .NotificationUnreadCount}}
3+
{{$notificationUnreadCount = call .NotificationUnreadCount ctx}}
4+
{{end}}
5+
{{$activeStopwatch := NIL}}
6+
{{if and .IsSigned EnableTimetracking .GetActiveStopwatch}}
7+
{{$activeStopwatch = call .GetActiveStopwatch ctx}}
48
{{end}}
5-
69
<nav id="navbar" aria-label="{{ctx.Locale.Tr "aria.navbar"}}">
710
<div class="navbar-left">
811
<!-- the logo -->
@@ -12,8 +15,8 @@
1215

1316
<!-- mobile right menu, it must be here because in mobile view, each item is a flex column, the first item is a full row column -->
1417
<div class="ui secondary menu navbar-mobile-right only-mobile">
15-
{{if and .IsSigned EnableTimetracking .ActiveStopwatch}}
16-
<a id="mobile-stopwatch-icon" class="active-stopwatch item" href="{{.ActiveStopwatch.IssueLink}}" title="{{ctx.Locale.Tr "active_stopwatch"}}" data-seconds="{{.ActiveStopwatch.Seconds}}">
18+
{{if $activeStopwatch}}
19+
<a id="mobile-stopwatch-icon" class="active-stopwatch item" href="{{$activeStopwatch.IssueLink}}" title="{{ctx.Locale.Tr "active_stopwatch"}}" data-seconds="{{$activeStopwatch.Seconds}}">
1720
<div class="tw-relative">
1821
{{svg "octicon-stopwatch"}}
1922
<span class="header-stopwatch-dot"></span>
@@ -82,8 +85,8 @@
8285
</div><!-- end content avatar menu -->
8386
</div><!-- end dropdown avatar menu -->
8487
{{else if .IsSigned}}
85-
{{if and EnableTimetracking .ActiveStopwatch}}
86-
<a class="item not-mobile active-stopwatch" href="{{.ActiveStopwatch.IssueLink}}" title="{{ctx.Locale.Tr "active_stopwatch"}}" data-seconds="{{.ActiveStopwatch.Seconds}}">
88+
{{if $activeStopwatch}}
89+
<a class="item not-mobile active-stopwatch" href="{{$activeStopwatch.IssueLink}}" title="{{ctx.Locale.Tr "active_stopwatch"}}" data-seconds="{{$activeStopwatch.Seconds}}">
8790
<div class="tw-relative">
8891
{{svg "octicon-stopwatch"}}
8992
<span class="header-stopwatch-dot"></span>
@@ -186,23 +189,23 @@
186189
{{end}}
187190
</div><!-- end full right menu -->
188191

189-
{{if and .IsSigned EnableTimetracking .ActiveStopwatch}}
192+
{{if $activeStopwatch}}
190193
<div class="active-stopwatch-popup tippy-target">
191194
<div class="tw-flex tw-items-center tw-gap-2 tw-p-3">
192-
<a class="stopwatch-link tw-flex tw-items-center tw-gap-2 muted" href="{{.ActiveStopwatch.IssueLink}}">
195+
<a class="stopwatch-link tw-flex tw-items-center tw-gap-2 muted" href="{{$activeStopwatch.IssueLink}}">
193196
{{svg "octicon-issue-opened" 16}}
194-
<span class="stopwatch-issue">{{.ActiveStopwatch.RepoSlug}}#{{.ActiveStopwatch.IssueIndex}}</span>
197+
<span class="stopwatch-issue">{{$activeStopwatch.RepoSlug}}#{{$activeStopwatch.IssueIndex}}</span>
195198
</a>
196199
<div class="tw-flex tw-gap-1">
197-
<form class="stopwatch-commit form-fetch-action" method="post" action="{{.ActiveStopwatch.IssueLink}}/times/stopwatch/toggle">
200+
<form class="stopwatch-commit form-fetch-action" method="post" action="{{$activeStopwatch.IssueLink}}/times/stopwatch/toggle">
198201
{{.CsrfTokenHtml}}
199202
<button
200203
type="submit"
201204
class="ui button mini compact basic icon tw-mr-0"
202205
data-tooltip-content="{{ctx.Locale.Tr "repo.issues.stop_tracking"}}"
203206
>{{svg "octicon-square-fill"}}</button>
204207
</form>
205-
<form class="stopwatch-cancel form-fetch-action" method="post" action="{{.ActiveStopwatch.IssueLink}}/times/stopwatch/cancel">
208+
<form class="stopwatch-cancel form-fetch-action" method="post" action="{{$activeStopwatch.IssueLink}}/times/stopwatch/cancel">
206209
{{.CsrfTokenHtml}}
207210
<button
208211
type="submit"

‎templates/user/notification/notification_div.tmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div role="main" aria-label="{{.Title}}" class="page-content user notification" id="notification_div" data-sequence-number="{{.SequenceNumber}}">
22
<div class="ui container">
3-
{{$notificationUnreadCount := call .NotificationUnreadCount}}
3+
{{$notificationUnreadCount := call .NotificationUnreadCount ctx}}
44
<div class="tw-flex tw-items-center tw-justify-between tw-mb-[--page-spacing]">
55
<div class="small-menu-items ui compact tiny menu">
66
<a class="{{if eq .Status 1}}active {{end}}item" href="{{AppSubUrl}}/notifications?q=unread">

0 commit comments

Comments
 (0)