Skip to content

Commit 83f8301

Browse files
wxiaoguangGiteaBot
wxiaoguang
and
GiteaBot
authored
Clean up log messages (#30313)
`log.Xxx("%v")` is not ideal, this PR adds necessary context messages. Remove some unnecessary logs. Co-authored-by: Giteabot <[email protected]>
1 parent 94aad35 commit 83f8301

File tree

17 files changed

+31
-47
lines changed

17 files changed

+31
-47
lines changed

‎cmd/web.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ func showWebStartupMessage(msg string) {
114114
log.Info("* WorkPath: %s", setting.AppWorkPath)
115115
log.Info("* CustomPath: %s", setting.CustomPath)
116116
log.Info("* ConfigFile: %s", setting.CustomConf)
117-
log.Info("%s", msg)
117+
log.Info("%s", msg) // show startup message
118118
}
119119

120120
func serveInstall(ctx *cli.Context) error {

‎models/asymkey/ssh_key_fingerprint.go

+4-13
Original file line numberDiff line numberDiff line change
@@ -76,23 +76,14 @@ func calcFingerprintNative(publicKeyContent string) (string, error) {
7676
// CalcFingerprint calculate public key's fingerprint
7777
func CalcFingerprint(publicKeyContent string) (string, error) {
7878
// Call the method based on configuration
79-
var (
80-
fnName, fp string
81-
err error
82-
)
83-
if len(setting.SSH.KeygenPath) == 0 {
84-
fnName = "calcFingerprintNative"
85-
fp, err = calcFingerprintNative(publicKeyContent)
86-
} else {
87-
fnName = "calcFingerprintSSHKeygen"
88-
fp, err = calcFingerprintSSHKeygen(publicKeyContent)
89-
}
79+
useNative := setting.SSH.KeygenPath == ""
80+
calcFn := util.Iif(useNative, calcFingerprintNative, calcFingerprintSSHKeygen)
81+
fp, err := calcFn(publicKeyContent)
9082
if err != nil {
9183
if IsErrKeyUnableVerify(err) {
92-
log.Info("%s", publicKeyContent)
9384
return "", err
9485
}
95-
return "", fmt.Errorf("%s: %w", fnName, err)
86+
return "", fmt.Errorf("CalcFingerprint(%s): %w", util.Iif(useNative, "native", "ssh-keygen"), err)
9687
}
9788
return fp, nil
9889
}

‎models/repo/issue.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func (repo *Repository) IsDependenciesEnabled(ctx context.Context) bool {
5353
var u *RepoUnit
5454
var err error
5555
if u, err = repo.GetUnit(ctx, unit.TypeIssues); err != nil {
56-
log.Trace("%s", err)
56+
log.Trace("IsDependenciesEnabled: %v", err)
5757
return setting.Service.DefaultEnableDependencies
5858
}
5959
return u.IssuesConfig().EnableDependencies

‎modules/util/util.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ func ToPointer[T any](val T) *T {
214214
}
215215

216216
// Iif is an "inline-if", it returns "trueVal" if "condition" is true, otherwise "falseVal"
217-
func Iif[T comparable](condition bool, trueVal, falseVal T) T {
217+
func Iif[T any](condition bool, trueVal, falseVal T) T {
218218
if condition {
219219
return trueVal
220220
}

‎routers/api/v1/notify/repo.go

-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import (
1010

1111
activities_model "code.gitea.io/gitea/models/activities"
1212
"code.gitea.io/gitea/models/db"
13-
"code.gitea.io/gitea/modules/log"
1413
"code.gitea.io/gitea/modules/structs"
1514
"code.gitea.io/gitea/services/context"
1615
"code.gitea.io/gitea/services/convert"
@@ -201,7 +200,6 @@ func ReadRepoNotifications(ctx *context.APIContext) {
201200
if !ctx.FormBool("all") {
202201
statuses := ctx.FormStrings("status-types")
203202
opts.Status = statusStringsToNotificationStatuses(statuses, []string{"unread"})
204-
log.Error("%v", opts.Status)
205203
}
206204
nl, err := db.Find[activities_model.Notification](ctx, opts)
207205
if err != nil {

‎routers/private/actions.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func GenerateActionsRunnerToken(ctx *context.PrivateContext) {
2626
defer rd.Close()
2727

2828
if err := json.NewDecoder(rd).Decode(&genRequest); err != nil {
29-
log.Error("%v", err)
29+
log.Error("JSON Decode failed: %v", err)
3030
ctx.JSON(http.StatusInternalServerError, private.Response{
3131
Err: err.Error(),
3232
})
@@ -35,7 +35,7 @@ func GenerateActionsRunnerToken(ctx *context.PrivateContext) {
3535

3636
owner, repo, err := parseScope(ctx, genRequest.Scope)
3737
if err != nil {
38-
log.Error("%v", err)
38+
log.Error("parseScope failed: %v", err)
3939
ctx.JSON(http.StatusInternalServerError, private.Response{
4040
Err: err.Error(),
4141
})
@@ -45,18 +45,18 @@ func GenerateActionsRunnerToken(ctx *context.PrivateContext) {
4545
if errors.Is(err, util.ErrNotExist) || (token != nil && !token.IsActive) {
4646
token, err = actions_model.NewRunnerToken(ctx, owner, repo)
4747
if err != nil {
48-
err := fmt.Sprintf("error while creating runner token: %v", err)
49-
log.Error("%v", err)
48+
errMsg := fmt.Sprintf("error while creating runner token: %v", err)
49+
log.Error("NewRunnerToken failed: %v", errMsg)
5050
ctx.JSON(http.StatusInternalServerError, private.Response{
51-
Err: err,
51+
Err: errMsg,
5252
})
5353
return
5454
}
5555
} else if err != nil {
56-
err := fmt.Sprintf("could not get unactivated runner token: %v", err)
57-
log.Error("%v", err)
56+
errMsg := fmt.Sprintf("could not get unactivated runner token: %v", err)
57+
log.Error("GetLatestRunnerToken failed: %v", errMsg)
5858
ctx.JSON(http.StatusInternalServerError, private.Response{
59-
Err: err,
59+
Err: errMsg,
6060
})
6161
return
6262
}

‎routers/private/hook_verification.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func verifyCommits(oldCommitID, newCommitID string, repo *git.Repository, env []
4747
_ = stdoutWriter.Close()
4848
err := readAndVerifyCommitsFromShaReader(stdoutReader, repo, env)
4949
if err != nil {
50-
log.Error("%v", err)
50+
log.Error("readAndVerifyCommitsFromShaReader failed: %v", err)
5151
cancel()
5252
}
5353
_ = stdoutReader.Close()
@@ -66,7 +66,6 @@ func readAndVerifyCommitsFromShaReader(input io.ReadCloser, repo *git.Repository
6666
line := scanner.Text()
6767
err := readAndVerifyCommit(line, repo, env)
6868
if err != nil {
69-
log.Error("%v", err)
7069
return err
7170
}
7271
}

‎routers/private/mail.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func SendEmail(ctx *context.PrivateContext) {
3535
defer rd.Close()
3636

3737
if err := json.NewDecoder(rd).Decode(&mail); err != nil {
38-
log.Error("%v", err)
38+
log.Error("JSON Decode failed: %v", err)
3939
ctx.JSON(http.StatusInternalServerError, private.Response{
4040
Err: err.Error(),
4141
})

‎routers/web/admin/users.go

-1
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,6 @@ func EditUserPost(ctx *context.Context) {
403403
ctx.Data["Err_Password"] = true
404404
ctx.RenderWithErr(ctx.Tr("auth.password_pwned"), tplUserEdit, &form)
405405
case password.IsErrIsPwnedRequest(err):
406-
log.Error("%s", err.Error())
407406
ctx.Data["Err_Password"] = true
408407
ctx.RenderWithErr(ctx.Tr("auth.password_pwned_err"), tplUserEdit, &form)
409408
default:

‎routers/web/auth/password.go

-2
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ func ResetPasswdPost(ctx *context.Context) {
214214
case errors.Is(err, password.ErrIsPwned):
215215
ctx.RenderWithErr(ctx.Tr("auth.password_pwned"), tplResetPassword, nil)
216216
case password.IsErrIsPwnedRequest(err):
217-
log.Error("%s", err.Error())
218217
ctx.RenderWithErr(ctx.Tr("auth.password_pwned_err"), tplResetPassword, nil)
219218
default:
220219
ctx.ServerError("UpdateAuth", err)
@@ -298,7 +297,6 @@ func MustChangePasswordPost(ctx *context.Context) {
298297
ctx.Data["Err_Password"] = true
299298
ctx.RenderWithErr(ctx.Tr("auth.password_pwned"), tplMustChangePassword, &form)
300299
case password.IsErrIsPwnedRequest(err):
301-
log.Error("%s", err.Error())
302300
ctx.Data["Err_Password"] = true
303301
ctx.RenderWithErr(ctx.Tr("auth.password_pwned_err"), tplMustChangePassword, &form)
304302
default:

‎routers/web/user/setting/account.go

-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ func AccountPost(ctx *context.Context) {
7474
case errors.Is(err, password.ErrIsPwned):
7575
ctx.Flash.Error(ctx.Tr("auth.password_pwned"))
7676
case password.IsErrIsPwnedRequest(err):
77-
log.Error("%s", err.Error())
7877
ctx.Flash.Error(ctx.Tr("auth.password_pwned_err"))
7978
default:
8079
ctx.ServerError("UpdateAuth", err)

‎services/context/captcha.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ func VerifyCaptcha(ctx *Context, tpl base.TplName, form any) {
7979
case setting.CfTurnstile:
8080
valid, err = turnstile.Verify(ctx, ctx.Req.Form.Get(cfTurnstileResponseField))
8181
default:
82-
ctx.ServerError("Unknown Captcha Type", fmt.Errorf("Unknown Captcha Type: %s", setting.Service.CaptchaType))
82+
ctx.ServerError("Unknown Captcha Type", fmt.Errorf("unknown Captcha Type: %s", setting.Service.CaptchaType))
8383
return
8484
}
8585
if err != nil {
86-
log.Debug("%v", err)
86+
log.Debug("Captcha Verify failed: %v", err)
8787
}
8888

8989
if !valid {

‎services/notify/notify.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ func AutoMergePullRequest(ctx context.Context, doer *user_model.User, pr *issues
9191
// NewPullRequest notifies new pull request to notifiers
9292
func NewPullRequest(ctx context.Context, pr *issues_model.PullRequest, mentions []*user_model.User) {
9393
if err := pr.LoadIssue(ctx); err != nil {
94-
log.Error("%v", err)
94+
log.Error("LoadIssue failed: %v", err)
9595
return
9696
}
9797
if err := pr.Issue.LoadPoster(ctx); err != nil {
@@ -112,7 +112,7 @@ func PullRequestSynchronized(ctx context.Context, doer *user_model.User, pr *iss
112112
// PullRequestReview notifies new pull request review
113113
func PullRequestReview(ctx context.Context, pr *issues_model.PullRequest, review *issues_model.Review, comment *issues_model.Comment, mentions []*user_model.User) {
114114
if err := review.LoadReviewer(ctx); err != nil {
115-
log.Error("%v", err)
115+
log.Error("LoadReviewer failed: %v", err)
116116
return
117117
}
118118
for _, notifier := range notifiers {

‎services/repository/files/cherry_pick.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func CherryPick(ctx context.Context, repo *repo_model.Repository, doer *user_mod
2828

2929
t, err := NewTemporaryUploadRepository(ctx, repo)
3030
if err != nil {
31-
log.Error("%v", err)
31+
log.Error("NewTemporaryUploadRepository failed: %v", err)
3232
}
3333
defer t.Close()
3434
if err := t.Clone(opts.OldBranch, false); err != nil {

‎services/repository/files/patch.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func ApplyDiffPatch(ctx context.Context, repo *repo_model.Repository, doer *user
111111

112112
t, err := NewTemporaryUploadRepository(ctx, repo)
113113
if err != nil {
114-
log.Error("%v", err)
114+
log.Error("NewTemporaryUploadRepository failed: %v", err)
115115
}
116116
defer t.Close()
117117
if err := t.Clone(opts.OldBranch, true); err != nil {

‎services/repository/files/update.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ func ChangeRepoFiles(ctx context.Context, repo *repo_model.Repository, doer *use
143143

144144
t, err := NewTemporaryUploadRepository(ctx, repo)
145145
if err != nil {
146-
log.Error("%v", err)
146+
log.Error("NewTemporaryUploadRepository failed: %v", err)
147147
}
148148
defer t.Close()
149149
hasOldBranch := true

‎services/wiki/wiki.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
161161
if isOldWikiExist {
162162
err := gitRepo.RemoveFilesFromIndex(oldWikiPath)
163163
if err != nil {
164-
log.Error("%v", err)
164+
log.Error("RemoveFilesFromIndex failed: %v", err)
165165
return err
166166
}
167167
}
@@ -171,18 +171,18 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
171171

172172
objectHash, err := gitRepo.HashObject(strings.NewReader(content))
173173
if err != nil {
174-
log.Error("%v", err)
174+
log.Error("HashObject failed: %v", err)
175175
return err
176176
}
177177

178178
if err := gitRepo.AddObjectToIndex("100644", objectHash, newWikiPath); err != nil {
179-
log.Error("%v", err)
179+
log.Error("AddObjectToIndex failed: %v", err)
180180
return err
181181
}
182182

183183
tree, err := gitRepo.WriteTree()
184184
if err != nil {
185-
log.Error("%v", err)
185+
log.Error("WriteTree failed: %v", err)
186186
return err
187187
}
188188

@@ -207,7 +207,7 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
207207

208208
commitHash, err := gitRepo.CommitTree(doer.NewGitSig(), committer, tree, commitTreeOpts)
209209
if err != nil {
210-
log.Error("%v", err)
210+
log.Error("CommitTree failed: %v", err)
211211
return err
212212
}
213213

@@ -222,11 +222,11 @@ func updateWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model
222222
0,
223223
),
224224
}); err != nil {
225-
log.Error("%v", err)
225+
log.Error("Push failed: %v", err)
226226
if git.IsErrPushOutOfDate(err) || git.IsErrPushRejected(err) {
227227
return err
228228
}
229-
return fmt.Errorf("Push: %w", err)
229+
return fmt.Errorf("failed to push: %w", err)
230230
}
231231

232232
return nil

0 commit comments

Comments
 (0)