Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Commit 30af07f

Browse files
camdencheekcamdencheek
authored
Chore: remove some uses of log15 (#57519)
1 parent 683aeaa commit 30af07f

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

+220
-189
lines changed

‎cmd/frontend/globals/BUILD.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ go_library(
88
deps = [
99
"//internal/conf",
1010
"//schema",
11-
"@com_github_inconshreveable_log15//:log15",
11+
"@com_github_sourcegraph_log//:log",
1212
],
1313
)

‎cmd/frontend/globals/globals.go‎

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22
package globals
33

44
import (
5+
"fmt"
56
"net/url"
67
"reflect"
78
"sync"
89
"sync/atomic"
910

10-
"github.com/inconshreveable/log15"
11+
"github.com/sourcegraph/log"
1112

1213
"github.com/sourcegraph/sourcegraph/internal/conf"
1314
"github.com/sourcegraph/sourcegraph/schema"
@@ -29,25 +30,27 @@ var watchExternalURLOnce sync.Once
2930
// WatchExternalURL watches for changes in the `externalURL` site configuration
3031
// so that changes are reflected in what is returned by the ExternalURL function.
3132
func WatchExternalURL() {
33+
logger := log.Scoped("externalURLWatcher", "")
34+
3235
watchExternalURLOnce.Do(func() {
3336
conf.Watch(func() {
3437
after := defaultExternalURL
3538
if val := conf.Get().ExternalURL; val != "" {
3639
var err error
3740
if after, err = url.Parse(val); err != nil {
38-
log15.Error("globals.ExternalURL", "value", val, "error", err)
41+
logger.Error("globals.ExternalURL", log.String("value", val), log.Error(err))
3942
return
4043
}
4144
}
4245

4346
if before := ExternalURL(); !reflect.DeepEqual(before, after) {
4447
SetExternalURL(after)
4548
if before.Host != "example.com" {
46-
log15.Info(
49+
logger.Info(
4750
"globals.ExternalURL",
48-
"updated", true,
49-
"before", before,
50-
"after", after,
51+
log.Bool("updated", true),
52+
log.String("before", before.String()),
53+
log.String("after", after.String()),
5154
)
5255
}
5356
}
@@ -84,23 +87,25 @@ var watchPermissionsUserMappingOnce sync.Once
8487
// WatchPermissionsUserMapping watches for changes in the `permissions.userMapping` site configuration
8588
// so that changes are reflected in what is returned by the PermissionsUserMapping function.
8689
func WatchPermissionsUserMapping() {
90+
logger := log.Scoped("permissionsUserMapWatcher", "")
91+
8792
watchPermissionsUserMappingOnce.Do(func() {
8893
conf.Watch(func() {
8994
after := conf.Get().PermissionsUserMapping
9095
if after == nil {
9196
after = defaultPermissionsUserMapping
9297
} else if after.BindID != "email" && after.BindID != "username" {
93-
log15.Error("globals.PermissionsUserMapping", "BindID", after.BindID, "error", "not a valid value")
98+
logger.Error("globals.PermissionsUserMapping", log.String("BindID", after.BindID), log.String("error", "not a valid value"))
9499
return
95100
}
96101

97102
if before := PermissionsUserMapping(); !reflect.DeepEqual(before, after) {
98103
SetPermissionsUserMapping(after)
99-
log15.Info(
104+
logger.Info(
100105
"globals.PermissionsUserMapping",
101-
"updated", true,
102-
"before", before,
103-
"after", after,
106+
log.Bool("updated", true),
107+
log.String("before", fmt.Sprint(before)),
108+
log.String("after", fmt.Sprint(after)),
104109
)
105110
}
106111
})
@@ -140,6 +145,8 @@ func WatchBranding() {
140145
panic("WatchBranding called more than once")
141146
}
142147

148+
logger := log.Scoped("brandingWatcher", "")
149+
143150
conf.Watch(func() {
144151
after := conf.Get().Branding
145152
if after == nil {
@@ -152,11 +159,11 @@ func WatchBranding() {
152159

153160
if before := Branding(); !reflect.DeepEqual(before, after) {
154161
SetBranding(after)
155-
log15.Debug(
162+
logger.Debug(
156163
"globals.Branding",
157-
"updated", true,
158-
"before", before,
159-
"after", after,
164+
log.Bool("updated", true),
165+
log.String("before", fmt.Sprint(before)),
166+
log.String("after", fmt.Sprint(after)),
160167
)
161168
}
162169
})

‎cmd/frontend/internal/app/debug.go‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,6 @@ func addGrafana(r *mux.Router, db database.DB) {
132132
req.URL.Path = req.URL.Path[i+len(prefix):]
133133
}
134134
},
135-
ErrorLog: log.New(env.DebugOut, fmt.Sprintf("%s debug proxy: ", "grafana"), log.LstdFlags),
136135
}))
137136
}
138137
} else {
@@ -261,7 +260,6 @@ func addJaeger(r *mux.Router, db database.DB) {
261260
req.URL.Scheme = "http"
262261
req.URL.Host = jaegerURL.Host
263262
},
264-
ErrorLog: log.New(env.DebugOut, fmt.Sprintf("%s debug proxy: ", "jaeger"), log.LstdFlags),
265263
}))
266264
}
267265

‎cmd/frontend/internal/app/debugproxies/BUILD.bazel‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ go_library(
1414
"//internal/actor",
1515
"//internal/auth",
1616
"//internal/database",
17-
"//internal/env",
1817
"//internal/errcode",
1918
"//lib/errors",
2019
"@com_github_gorilla_mux//:mux",

‎cmd/frontend/internal/app/debugproxies/handler.go‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package debugproxies
33
import (
44
"database/sql"
55
"fmt"
6-
"log"
76
"net/http"
87
"net/http/httputil"
98
"sort"
@@ -16,7 +15,6 @@ import (
1615
"github.com/sourcegraph/sourcegraph/internal/actor"
1716
"github.com/sourcegraph/sourcegraph/internal/auth"
1817
"github.com/sourcegraph/sourcegraph/internal/database"
19-
"github.com/sourcegraph/sourcegraph/internal/env"
2018
"github.com/sourcegraph/sourcegraph/internal/errcode"
2119
"github.com/sourcegraph/sourcegraph/lib/errors"
2220
)
@@ -141,7 +139,6 @@ func reverseProxyFromHost(db database.DB, host string, pathPrefix string) http.H
141139
req.URL.Path = req.URL.Path[i+len(pathPrefix):]
142140
}
143141
},
144-
ErrorLog: log.New(env.DebugOut, fmt.Sprintf("k8s %s debug proxy: ", host), log.LstdFlags),
145142
})
146143
}
147144

‎cmd/frontend/internal/app/ui/BUILD.bazel‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ go_test(
104104
"//schema",
105105
"//ui/assets",
106106
"@com_github_gorilla_mux//:mux",
107+
"@com_github_sourcegraph_log//logtest",
107108
"@com_github_stretchr_testify//assert",
108109
],
109110
)

‎cmd/frontend/internal/app/ui/handlers.go‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package ui
33
import (
44
"context"
55
"html/template"
6-
"log"
76
"net/http"
87
"net/http/httputil"
98
"net/url"
@@ -14,9 +13,8 @@ import (
1413

1514
"github.com/gorilla/mux"
1615
"github.com/grafana/regexp"
17-
"github.com/inconshreveable/log15"
1816

19-
sglog "github.com/sourcegraph/log"
17+
"github.com/sourcegraph/log"
2018

2119
"github.com/sourcegraph/sourcegraph/cmd/frontend/auth"
2220
"github.com/sourcegraph/sourcegraph/cmd/frontend/backend"
@@ -141,7 +139,7 @@ var mockNewCommon func(w http.ResponseWriter, r *http.Request, title string, ser
141139
// In the case of a repository that is cloning, a Common data structure is
142140
// returned but it has a nil Repo.
143141
func newCommon(w http.ResponseWriter, r *http.Request, db database.DB, title string, indexed bool, serveError serveErrorHandler) (*Common, error) {
144-
logger := sglog.Scoped("commonHandler", "")
142+
logger := log.Scoped("commonHandler", "")
145143
if mockNewCommon != nil {
146144
return mockNewCommon(w, r, title, serveError)
147145
}
@@ -263,7 +261,7 @@ func newCommon(w http.ResponseWriter, r *http.Request, db database.DB, title str
263261
ctx := context.Background()
264262
_, err = repoupdater.DefaultClient.EnqueueRepoUpdate(ctx, common.Repo.Name)
265263
if err != nil {
266-
log15.Error("EnqueueRepoUpdate", "error", err)
264+
logger.Error("EnqueueRepoUpdate", log.Error(err))
267265
}
268266
}()
269267
}
@@ -540,7 +538,6 @@ func searchBadgeHandler() *httputil.ReverseProxy {
540538
r.URL.Host = "search-badger"
541539
r.URL.Path = "/"
542540
},
543-
ErrorLog: log.New(env.DebugOut, "search-badger proxy: ", log.LstdFlags),
544541
}
545542
}
546543

‎cmd/frontend/internal/app/ui/raw.go‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ import (
1515

1616
"github.com/golang/gddo/httputil"
1717
"github.com/gorilla/mux"
18-
"github.com/inconshreveable/log15"
1918
"github.com/prometheus/client_golang/prometheus"
2019
"github.com/prometheus/client_golang/prometheus/promauto"
2120

21+
"github.com/sourcegraph/log"
2222
"github.com/sourcegraph/sourcegraph/cmd/frontend/globals"
2323
"github.com/sourcegraph/sourcegraph/internal/database"
2424
"github.com/sourcegraph/sourcegraph/internal/errcode"
@@ -60,7 +60,7 @@ import (
6060
// - This route would ideally be using strict slashes, in order for us to support symlinks via HTTP redirects.
6161
//
6262

63-
func serveRaw(db database.DB, gitserverClient gitserver.Client) handlerFunc {
63+
func serveRaw(logger log.Logger, db database.DB, gitserverClient gitserver.Client) handlerFunc {
6464
return func(w http.ResponseWriter, r *http.Request) error {
6565
const (
6666
textPlain = "text/plain"
@@ -132,7 +132,17 @@ func serveRaw(db database.DB, gitserverClient gitserver.Client) handlerFunc {
132132
)
133133
defer func() {
134134
duration := time.Since(start)
135-
log15.Debug("raw endpoint", "repo", common.Repo.Name, "commit", common.CommitID, "contentType", contentType, "type", requestType, "path", requestedPath, "size", size, "duration", duration, "error", err)
135+
logger.Debug(
136+
"raw endpoint",
137+
log.String("repo", string(common.Repo.Name)),
138+
log.String("commit", string(common.CommitID)),
139+
log.String("contentType", contentType),
140+
log.String("type", requestType),
141+
log.String("path", requestedPath),
142+
log.Int64("size", size),
143+
log.Duration("duration", duration),
144+
log.Error(err),
145+
)
136146
var errorS string
137147
switch {
138148
case err == nil:

‎cmd/frontend/internal/app/ui/raw_test.go‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515

1616
"github.com/stretchr/testify/assert"
1717

18+
"github.com/sourcegraph/log/logtest"
1819
"github.com/sourcegraph/sourcegraph/internal/api"
1920
"github.com/sourcegraph/sourcegraph/internal/database"
2021
"github.com/sourcegraph/sourcegraph/internal/database/dbmocks"
@@ -77,6 +78,8 @@ func Test_serveRawWithHTTPRequestMethodHEAD(t *testing.T) {
7778
mockNewCommon = nil
7879
}()
7980

81+
logger := logtest.Scoped(t)
82+
8083
t.Run("success response for HEAD request", func(t *testing.T) {
8184
// httptest server will return a 200 OK, so gitserver.Client.RepoInfo will not return
8285
// an error.
@@ -90,7 +93,7 @@ func Test_serveRawWithHTTPRequestMethodHEAD(t *testing.T) {
9093
db.ReposFunc.SetDefaultReturn(rstore)
9194
rstore.GetByNameFunc.SetDefaultReturn(&types.Repo{ID: 123}, nil)
9295

93-
err := serveRaw(db, gitserver.NewClient())(w, req)
96+
err := serveRaw(logger, db, gitserver.NewClient())(w, req)
9497
if err != nil {
9598
t.Fatalf("Failed to invoke serveRaw: %v", err)
9699
}
@@ -113,7 +116,7 @@ func Test_serveRawWithHTTPRequestMethodHEAD(t *testing.T) {
113116
db.ReposFunc.SetDefaultReturn(rstore)
114117
rstore.GetByNameFunc.SetDefaultReturn(nil, &database.RepoNotFoundErr{ID: 123})
115118

116-
err := serveRaw(db, gitserver.NewClient())(w, req)
119+
err := serveRaw(logger, db, gitserver.NewClient())(w, req)
117120
if err == nil {
118121
t.Fatal("Want error but got nil")
119122
}
@@ -137,6 +140,8 @@ func Test_serveRawWithContentArchive(t *testing.T) {
137140
mockNewCommon = nil
138141
}()
139142

143+
logger := logtest.Scoped(t)
144+
140145
mockGitServerResponse := "this is a gitserver archive response"
141146

142147
t.Run("success response for format=zip", func(t *testing.T) {
@@ -148,7 +153,7 @@ func Test_serveRawWithContentArchive(t *testing.T) {
148153
w := httptest.NewRecorder()
149154

150155
db := dbmocks.NewMockDB()
151-
err := serveRaw(db, gitserver.NewClient())(w, req)
156+
err := serveRaw(logger, db, gitserver.NewClient())(w, req)
152157
if err != nil {
153158
t.Fatalf("Failed to invoke serveRaw: %v", err)
154159
}
@@ -188,7 +193,7 @@ func Test_serveRawWithContentArchive(t *testing.T) {
188193
w := httptest.NewRecorder()
189194

190195
db := dbmocks.NewMockDB()
191-
err := serveRaw(db, gitserver.NewClient())(w, req)
196+
err := serveRaw(logger, db, gitserver.NewClient())(w, req)
192197
if err != nil {
193198
t.Fatalf("Failed to invoke serveRaw: %v", err)
194199
}
@@ -234,6 +239,8 @@ func Test_serveRawWithContentTypePlain(t *testing.T) {
234239
mockNewCommon = nil
235240
}()
236241

242+
logger := logtest.Scoped(t)
243+
237244
assertHeaders := func(w http.ResponseWriter) {
238245
t.Helper()
239246

@@ -264,7 +271,7 @@ func Test_serveRawWithContentTypePlain(t *testing.T) {
264271
w := httptest.NewRecorder()
265272

266273
db := dbmocks.NewMockDB()
267-
err := serveRaw(db, gsClient)(w, req)
274+
err := serveRaw(logger, db, gsClient)(w, req)
268275
if err != nil {
269276
t.Fatalf("Failed to invoke serveRaw: %v", err)
270277
}
@@ -294,7 +301,7 @@ func Test_serveRawWithContentTypePlain(t *testing.T) {
294301
w := httptest.NewRecorder()
295302

296303
db := dbmocks.NewMockDB()
297-
err := serveRaw(db, gsClient)(w, req)
304+
err := serveRaw(logger, db, gsClient)(w, req)
298305
if err != nil {
299306
t.Fatalf("Failed to invoke serveRaw: %v", err)
300307
}
@@ -327,7 +334,7 @@ c.go`
327334
req := httptest.NewRequest("GET", "/github.com/sourcegraph/sourcegraph/-/raw", nil)
328335
w := httptest.NewRecorder()
329336

330-
err := serveRaw(dbmocks.NewMockDB(), gitserverClient)(w, req)
337+
err := serveRaw(logger, dbmocks.NewMockDB(), gitserverClient)(w, req)
331338
if err != nil {
332339
t.Fatalf("Failed to invoke serveRaw: %v", err)
333340
}
@@ -360,7 +367,7 @@ c.go`
360367
req := httptest.NewRequest("GET", "/github.com/sourcegraph/sourcegraph/-/raw?format=exe", nil)
361368
w := httptest.NewRecorder()
362369

363-
err := serveRaw(dbmocks.NewMockDB(), gitserverClient)(w, req)
370+
err := serveRaw(logger, dbmocks.NewMockDB(), gitserverClient)(w, req)
364371
if err != nil {
365372
t.Fatalf("Failed to invoke serveRaw: %v", err)
366373
}
@@ -389,6 +396,7 @@ func Test_serveRawRepoCloning(t *testing.T) {
389396
t.Cleanup(func() {
390397
mockNewCommon = nil
391398
})
399+
logger := logtest.Scoped(t)
392400
// Fail git server calls, as they should not be invoked for a cloning repo.
393401
initHTTPTestGitServer(t, http.StatusInternalServerError, "{should not be invoked}")
394402
gsClient := gitserver.NewMockClient()
@@ -399,7 +407,7 @@ func Test_serveRawRepoCloning(t *testing.T) {
399407
db := dbmocks.NewMockDB()
400408
// Former implementation would sleep awaiting repository to be available.
401409
// Await request to be served with a timeout by racing done channel with time.After.
402-
err := serveRaw(db, gsClient)(w, req)
410+
err := serveRaw(logger, db, gsClient)(w, req)
403411
if err != nil {
404412
t.Fatalf("Failed to invoke serveRaw: %v", err)
405413
}

0 commit comments

Comments
 (0)