Skip to content

Commit 33044e0

Browse files
committed
Merge remote-tracking branch 'giteaofficial/main'
* giteaofficial/main: [skip ci] Updated translations via Crowdin Fix incorrect ref commit ID usage (go-gitea#33331) Improve sync fork behavior (go-gitea#33319) Refactor response writer & access logger (go-gitea#33323)
2 parents 5f079b0 + 2e42e96 commit 33044e0

File tree

17 files changed

+283
-102
lines changed

17 files changed

+283
-102
lines changed

models/git/branch.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,9 @@ func GetBranch(ctx context.Context, repoID int64, branchName string) (*Branch, e
167167
BranchName: branchName,
168168
}
169169
}
170+
// FIXME: this design is not right: it doesn't check `branch.IsDeleted`, it doesn't make sense to make callers to check IsDeleted again and again.
171+
// It causes inconsistency with `GetBranches` and `git.GetBranch`, and will lead to strange bugs
172+
// In the future, there should be 2 functions: `GetBranchExisting` and `GetBranchWithDeleted`
170173
return &branch, nil
171174
}
172175

options/locale/locale_en-US.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1953,7 +1953,7 @@ pulls.upstream_diverging_prompt_behind_1 = This branch is %[1]d commit behind %[
19531953
pulls.upstream_diverging_prompt_behind_n = This branch is %[1]d commits behind %[2]s
19541954
pulls.upstream_diverging_prompt_base_newer = The base branch %s has new changes
19551955
pulls.upstream_diverging_merge = Sync fork
1956-
pulls.upstream_diverging_merge_confirm = Would you like to merge base repository's default branch onto this repository's branch %s?
1956+
pulls.upstream_diverging_merge_confirm = Would you like to merge "%[1]s" onto "%[2]s"?
19571957

19581958
pull.deleted_branch = (deleted):%s
19591959
pull.agit_documentation = Review documentation about AGit

options/locale/locale_pt-PT.ini

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1952,7 +1952,6 @@ pulls.upstream_diverging_prompt_behind_1=Este ramo está %[1]d cometimento atrá
19521952
pulls.upstream_diverging_prompt_behind_n=Este ramo está %[1]d cometimentos atrás de %[2]s
19531953
pulls.upstream_diverging_prompt_base_newer=O ramo base %s tem novas modificações
19541954
pulls.upstream_diverging_merge=Sincronizar derivação
1955-
pulls.upstream_diverging_merge_confirm=Gostaria de integrar o ramo principal do repositório base no ramo %s deste repositório?
19561955

19571956
pull.deleted_branch=(eliminado):%s
19581957
pull.agit_documentation=Rever a documentação sobre o AGit

routers/common/middleware.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,18 @@ func ProtocolMiddlewares() (handlers []any) {
4343

4444
func RequestContextHandler() func(h http.Handler) http.Handler {
4545
return func(next http.Handler) http.Handler {
46-
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
47-
profDesc := fmt.Sprintf("%s: %s", req.Method, req.RequestURI)
46+
return http.HandlerFunc(func(respOrig http.ResponseWriter, req *http.Request) {
47+
// this response writer might not be the same as the one in context.Base.Resp
48+
// because there might be a "gzip writer" in the middle, so the "written size" here is the compressed size
49+
respWriter := context.WrapResponseWriter(respOrig)
50+
51+
profDesc := fmt.Sprintf("HTTP: %s %s", req.Method, req.RequestURI)
4852
ctx, finished := reqctx.NewRequestContext(req.Context(), profDesc)
4953
defer finished()
5054

5155
defer func() {
5256
if err := recover(); err != nil {
53-
RenderPanicErrorPage(resp, req, err) // it should never panic
57+
RenderPanicErrorPage(respWriter, req, err) // it should never panic
5458
}
5559
}()
5660

@@ -62,7 +66,7 @@ func RequestContextHandler() func(h http.Handler) http.Handler {
6266
_ = req.MultipartForm.RemoveAll() // remove the temp files buffered to tmp directory
6367
}
6468
})
65-
next.ServeHTTP(context.WrapResponseWriter(resp), req)
69+
next.ServeHTTP(respWriter, req)
6670
})
6771
}
6872
}

routers/web/repo/code_frequency.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func CodeFrequency(ctx *context.Context) {
2929

3030
// CodeFrequencyData returns JSON of code frequency data
3131
func CodeFrequencyData(ctx *context.Context) {
32-
if contributorStats, err := contributors_service.GetContributorStats(ctx, ctx.Cache, ctx.Repo.Repository, ctx.Repo.CommitID); err != nil {
32+
if contributorStats, err := contributors_service.GetContributorStats(ctx, ctx.Cache, ctx.Repo.Repository, ctx.Repo.Repository.DefaultBranch); err != nil {
3333
if errors.Is(err, contributors_service.ErrAwaitGeneration) {
3434
ctx.Status(http.StatusAccepted)
3535
return

routers/web/repo/contributors.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func Contributors(ctx *context.Context) {
2626

2727
// ContributorsData renders JSON of contributors along with their weekly commit statistics
2828
func ContributorsData(ctx *context.Context) {
29-
if contributorStats, err := contributors_service.GetContributorStats(ctx, ctx.Cache, ctx.Repo.Repository, ctx.Repo.CommitID); err != nil {
29+
if contributorStats, err := contributors_service.GetContributorStats(ctx, ctx.Cache, ctx.Repo.Repository, ctx.Repo.Repository.DefaultBranch); err != nil {
3030
if errors.Is(err, contributors_service.ErrAwaitGeneration) {
3131
ctx.Status(http.StatusAccepted)
3232
return

routers/web/repo/recent_commits.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ func RecentCommits(ctx *context.Context) {
2929

3030
// RecentCommitsData returns JSON of recent commits data
3131
func RecentCommitsData(ctx *context.Context) {
32-
if contributorStats, err := contributors_service.GetContributorStats(ctx, ctx.Cache, ctx.Repo.Repository, ctx.Repo.CommitID); err != nil {
32+
if contributorStats, err := contributors_service.GetContributorStats(ctx, ctx.Cache, ctx.Repo.Repository, ctx.Repo.Repository.DefaultBranch); err != nil {
3333
if errors.Is(err, contributors_service.ErrAwaitGeneration) {
3434
ctx.Status(http.StatusAccepted)
3535
return

routers/web/repo/search.go

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,23 @@ func Search(ctx *context.Context) {
6767
ctx.Data["CodeIndexerUnavailable"] = !code_indexer.IsAvailable(ctx)
6868
}
6969
} else {
70+
searchRefName := git.RefNameFromBranch(ctx.Repo.Repository.DefaultBranch) // BranchName should be default branch or the first existing branch
7071
res, err := git.GrepSearch(ctx, ctx.Repo.GitRepo, prepareSearch.Keyword, git.GrepOptions{
7172
ContextLineNumber: 1,
7273
IsFuzzy: prepareSearch.IsFuzzy,
73-
RefName: git.RefNameFromBranch(ctx.Repo.Repository.DefaultBranch).String(), // BranchName should be default branch or the first existing branch
74+
RefName: searchRefName.String(),
7475
PathspecList: indexSettingToGitGrepPathspecList(),
7576
})
7677
if err != nil {
7778
// TODO: if no branch exists, it reports: exit status 128, fatal: this operation must be run in a work tree.
7879
ctx.ServerError("GrepSearch", err)
7980
return
8081
}
82+
commitID, err := ctx.Repo.GitRepo.GetRefCommitID(searchRefName.String())
83+
if err != nil {
84+
ctx.ServerError("GetRefCommitID", err)
85+
return
86+
}
8187
total = len(res)
8288
pageStart := min((page-1)*setting.UI.RepoSearchPagingNum, len(res))
8389
pageEnd := min(page*setting.UI.RepoSearchPagingNum, len(res))
@@ -86,7 +92,7 @@ func Search(ctx *context.Context) {
8692
searchResults = append(searchResults, &code_indexer.Result{
8793
RepoID: ctx.Repo.Repository.ID,
8894
Filename: r.Filename,
89-
CommitID: ctx.Repo.CommitID,
95+
CommitID: commitID,
9096
// UpdatedUnix: not supported yet
9197
// Language: not supported yet
9298
// Color: not supported yet

routers/web/repo/setting/webhook.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,8 @@ func TestWebhook(ctx *context.Context) {
655655
}
656656

657657
// Grab latest commit or fake one if it's empty repository.
658+
// Note: in old code, the "ctx.Repo.Commit" is the last commit of the default branch.
659+
// New code doesn't set that commit, so it always uses the fake commit to test webhook.
658660
commit := ctx.Repo.Commit
659661
if commit == nil {
660662
ghost := user_model.NewGhostUser()

routers/web/web.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1146,7 +1146,7 @@ func registerRoutes(m *web.Router) {
11461146
m.Post("/cancel", repo.MigrateCancelPost)
11471147
})
11481148
},
1149-
reqSignIn, context.RepoAssignment, reqRepoAdmin, context.RepoRef(),
1149+
reqSignIn, context.RepoAssignment, reqRepoAdmin,
11501150
ctxDataSet("PageIsRepoSettings", true, "LFSStartServer", setting.LFS.StartServer),
11511151
)
11521152
// end "/{username}/{reponame}/settings"
@@ -1513,7 +1513,7 @@ func registerRoutes(m *web.Router) {
15131513
m.Group("/activity_author_data", func() {
15141514
m.Get("", repo.ActivityAuthors)
15151515
m.Get("/{period}", repo.ActivityAuthors)
1516-
}, context.RepoRef(), repo.MustBeNotEmpty)
1516+
}, repo.MustBeNotEmpty)
15171517

15181518
m.Group("/archive", func() {
15191519
m.Get("/*", repo.Download)

services/context/access_log.go

Lines changed: 59 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ import (
1818
"code.gitea.io/gitea/modules/web/middleware"
1919
)
2020

21-
type routerLoggerOptions struct {
22-
req *http.Request
21+
type accessLoggerTmplData struct {
2322
Identity *string
2423
Start *time.Time
25-
ResponseWriter http.ResponseWriter
26-
Ctx map[string]any
27-
RequestID *string
24+
ResponseWriter struct {
25+
Status, Size int
26+
}
27+
Ctx map[string]any
28+
RequestID *string
2829
}
2930

3031
const keyOfRequestIDInTemplate = ".RequestID"
@@ -51,51 +52,65 @@ func parseRequestIDFromRequestHeader(req *http.Request) string {
5152
return requestID
5253
}
5354

55+
type accessLogRecorder struct {
56+
logger log.BaseLogger
57+
logTemplate *template.Template
58+
needRequestID bool
59+
}
60+
61+
func (lr *accessLogRecorder) record(start time.Time, respWriter ResponseWriter, req *http.Request) {
62+
var requestID string
63+
if lr.needRequestID {
64+
requestID = parseRequestIDFromRequestHeader(req)
65+
}
66+
67+
reqHost, _, err := net.SplitHostPort(req.RemoteAddr)
68+
if err != nil {
69+
reqHost = req.RemoteAddr
70+
}
71+
72+
identity := "-"
73+
data := middleware.GetContextData(req.Context())
74+
if signedUser, ok := data[middleware.ContextDataKeySignedUser].(*user_model.User); ok {
75+
identity = signedUser.Name
76+
}
77+
buf := bytes.NewBuffer([]byte{})
78+
tmplData := accessLoggerTmplData{
79+
Identity: &identity,
80+
Start: &start,
81+
Ctx: map[string]any{
82+
"RemoteAddr": req.RemoteAddr,
83+
"RemoteHost": reqHost,
84+
"Req": req,
85+
},
86+
RequestID: &requestID,
87+
}
88+
tmplData.ResponseWriter.Status = respWriter.Status()
89+
tmplData.ResponseWriter.Size = respWriter.WrittenSize()
90+
err = lr.logTemplate.Execute(buf, tmplData)
91+
if err != nil {
92+
log.Error("Could not execute access logger template: %v", err.Error())
93+
}
94+
95+
lr.logger.Log(1, log.INFO, "%s", buf.String())
96+
}
97+
98+
func newAccessLogRecorder() *accessLogRecorder {
99+
return &accessLogRecorder{
100+
logger: log.GetLogger("access"),
101+
logTemplate: template.Must(template.New("log").Parse(setting.Log.AccessLogTemplate)),
102+
needRequestID: len(setting.Log.RequestIDHeaders) > 0 && strings.Contains(setting.Log.AccessLogTemplate, keyOfRequestIDInTemplate),
103+
}
104+
}
105+
54106
// AccessLogger returns a middleware to log access logger
55107
func AccessLogger() func(http.Handler) http.Handler {
56-
logger := log.GetLogger("access")
57-
needRequestID := len(setting.Log.RequestIDHeaders) > 0 && strings.Contains(setting.Log.AccessLogTemplate, keyOfRequestIDInTemplate)
58-
logTemplate, _ := template.New("log").Parse(setting.Log.AccessLogTemplate)
108+
recorder := newAccessLogRecorder()
59109
return func(next http.Handler) http.Handler {
60110
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
61111
start := time.Now()
62-
63-
var requestID string
64-
if needRequestID {
65-
requestID = parseRequestIDFromRequestHeader(req)
66-
}
67-
68-
reqHost, _, err := net.SplitHostPort(req.RemoteAddr)
69-
if err != nil {
70-
reqHost = req.RemoteAddr
71-
}
72-
73112
next.ServeHTTP(w, req)
74-
rw := w.(ResponseWriter)
75-
76-
identity := "-"
77-
data := middleware.GetContextData(req.Context())
78-
if signedUser, ok := data[middleware.ContextDataKeySignedUser].(*user_model.User); ok {
79-
identity = signedUser.Name
80-
}
81-
buf := bytes.NewBuffer([]byte{})
82-
err = logTemplate.Execute(buf, routerLoggerOptions{
83-
req: req,
84-
Identity: &identity,
85-
Start: &start,
86-
ResponseWriter: rw,
87-
Ctx: map[string]any{
88-
"RemoteAddr": req.RemoteAddr,
89-
"RemoteHost": reqHost,
90-
"Req": req,
91-
},
92-
RequestID: &requestID,
93-
})
94-
if err != nil {
95-
log.Error("Could not execute access logger template: %v", err.Error())
96-
}
97-
98-
logger.Info("%s", buf.String())
113+
recorder.record(start, w.(ResponseWriter), req)
99114
})
100115
}
101116
}

services/context/access_log_test.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 context
5+
6+
import (
7+
"fmt"
8+
"net/http"
9+
"net/url"
10+
"testing"
11+
"time"
12+
13+
"code.gitea.io/gitea/modules/log"
14+
"code.gitea.io/gitea/modules/setting"
15+
16+
"github.com/stretchr/testify/assert"
17+
)
18+
19+
type testAccessLoggerMock struct {
20+
logs []string
21+
}
22+
23+
func (t *testAccessLoggerMock) Log(skip int, level log.Level, format string, v ...any) {
24+
t.logs = append(t.logs, fmt.Sprintf(format, v...))
25+
}
26+
27+
func (t *testAccessLoggerMock) GetLevel() log.Level {
28+
return log.INFO
29+
}
30+
31+
type testAccessLoggerResponseWriterMock struct{}
32+
33+
func (t testAccessLoggerResponseWriterMock) Header() http.Header {
34+
return nil
35+
}
36+
37+
func (t testAccessLoggerResponseWriterMock) Before(f func(ResponseWriter)) {}
38+
39+
func (t testAccessLoggerResponseWriterMock) WriteHeader(statusCode int) {}
40+
41+
func (t testAccessLoggerResponseWriterMock) Write(bytes []byte) (int, error) {
42+
return 0, nil
43+
}
44+
45+
func (t testAccessLoggerResponseWriterMock) Flush() {}
46+
47+
func (t testAccessLoggerResponseWriterMock) WrittenStatus() int {
48+
return http.StatusOK
49+
}
50+
51+
func (t testAccessLoggerResponseWriterMock) Status() int {
52+
return t.WrittenStatus()
53+
}
54+
55+
func (t testAccessLoggerResponseWriterMock) WrittenSize() int {
56+
return 123123
57+
}
58+
59+
func TestAccessLogger(t *testing.T) {
60+
setting.Log.AccessLogTemplate = `{{.Ctx.RemoteHost}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.URL.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}" "{{.Ctx.Req.UserAgent}}"`
61+
recorder := newAccessLogRecorder()
62+
mockLogger := &testAccessLoggerMock{}
63+
recorder.logger = mockLogger
64+
req := &http.Request{
65+
RemoteAddr: "remote-addr",
66+
Method: "GET",
67+
Proto: "https",
68+
URL: &url.URL{Path: "/path"},
69+
}
70+
req.Header = http.Header{}
71+
req.Header.Add("Referer", "referer")
72+
req.Header.Add("User-Agent", "user-agent")
73+
recorder.record(time.Date(2000, 1, 2, 3, 4, 5, 0, time.UTC), &testAccessLoggerResponseWriterMock{}, req)
74+
assert.Equal(t, []string{`remote-addr - - [02/Jan/2000:03:04:05 +0000] "GET /path https" 200 123123 "referer" "user-agent"`}, mockLogger.logs)
75+
}

0 commit comments

Comments
 (0)