fix/http: add logging middleware to default exported external http clients

Author: ggilmore

cmd/frontend/graphqlbackend/BUILD.bazel

@@ -510,6 +510,7 @@ go_test(
         "//internal/gitserver/gitdomain",
         "//internal/gitserver/protocol",
         "//internal/gqlutil",
+        "//internal/httpcli",
         "//internal/observation",
         "//internal/oobmigration",
         "//internal/ratelimit",

cmd/frontend/graphqlbackend/cody_gateway_rate_limit.go

@@ -24,7 +24,8 @@ func (r *siteResolver) CodyGatewayRateLimitStatus(ctx context.Context) (*[]RateL
 		return nil, err
 	}
 
-	cgc, ok := codygateway.NewClientFromSiteConfig(httpcli.ExternalDoer)
+	logger := r.logger.Scoped("CodyGatewayRateLimitStatus")
+	cgc, ok := codygateway.NewClientFromSiteConfig(httpcli.ExternalDoer(logger))
 	if !ok {
 		// Not configured for chat/autocomplete.
 		return nil, nil

cmd/frontend/graphqlbackend/external_accounts.go

@@ -173,7 +173,7 @@ func (r *schemaResolver) AddExternalAccount(ctx context.Context, args *struct {
 
 	switch args.ServiceType {
 	case extsvc.TypeGerrit:
-		err := gext.AddGerritExternalAccount(ctx, r.db, a.UID, args.ServiceID, args.AccountDetails)
+		err := gext.AddGerritExternalAccount(ctx, r.db, r.logger, a.UID, args.ServiceID, args.AccountDetails)
 		if err != nil {
 			return nil, err
 		}

cmd/frontend/graphqlbackend/external_accounts_test.go

@@ -180,7 +180,7 @@ func TestExternalAccounts_AddExternalAccount(t *testing.T) {
 				}
 			}
 
-			gerrit.MockVerifyAccount = func(_ context.Context, _ *url.URL, _ *gerrit.AccountCredentials) (*gerrit.Account, error) {
+			gerrit.MockVerifyAccount = func(_ context.Context, _ log.Logger, _ *url.URL, _ *gerrit.AccountCredentials) (*gerrit.Account, error) {
 				return &gerrit.Account{
 					ID:       1234,
 					Username: "alice",

cmd/frontend/graphqlbackend/external_service.go

@@ -311,12 +311,14 @@ func (r *externalServiceResolver) CheckConnection(ctx context.Context) (*externa
 	ctx, cancel := context.WithTimeout(ctx, 15*time.Second)
 	defer cancel()
 
+	logger := r.logger.Scoped("externalServiceResolver.CheckConnection")
+
 	source, err := repos.NewSource(
 		ctx,
-		log.Scoped("externalServiceResolver.CheckConnection"),
+		logger,
 		r.db,
 		r.externalService,
-		httpcli.ExternalClientFactory,
+		httpcli.ExternalClientFactory(logger.Scoped("httpclient")),
 		gitserver.NewClient("graphql.check-connection"),
 	)
 	if err != nil {

cmd/frontend/graphqlbackend/guardrails_test.go

@@ -9,6 +9,7 @@ import (
 	"testing"
 
 	"github.com/graph-gophers/graphql-go"
+	"github.com/sourcegraph/log"
 	"github.com/stretchr/testify/require"
 
 	"github.com/sourcegraph/sourcegraph/cmd/frontend/enterprise"
@@ -20,6 +21,7 @@ import (
 	"github.com/sourcegraph/sourcegraph/internal/database"
 	"github.com/sourcegraph/sourcegraph/internal/database/dbmocks"
 	"github.com/sourcegraph/sourcegraph/internal/gitserver"
+	"github.com/sourcegraph/sourcegraph/internal/httpcli"
 	"github.com/sourcegraph/sourcegraph/internal/observation"
 	"github.com/sourcegraph/sourcegraph/lib/errors"
 	"github.com/sourcegraph/sourcegraph/lib/pointers"
@@ -194,7 +196,9 @@ func makeGatewayEndpoint(t *testing.T) string {
 
 func TestSnippetAttributionReactsToSiteConfigChanges(t *testing.T) {
 	// Use a regular HTTP client as default external doer cannot hit localhost.
-	guardrails.MockHttpClient = http.DefaultClient
+	guardrails.MockHttpClient = func(_ log.Logger) httpcli.Doer {
+		return http.DefaultClient
+	}
 	t.Cleanup(func() { guardrails.MockHttpClient = nil })
 	// Starting attribution configuration has no endpoints to use.
 	noAttributionConfigured := schema.SiteConfiguration{

cmd/frontend/graphqlbackend/survey_response.go

@@ -117,7 +117,7 @@ func (r *schemaResolver) SubmitSurvey(ctx context.Context, args *struct {
 	}
 
 	// Submit form to HubSpot
-	if err := hubspotutil.Client().SubmitForm(hubspotutil.SurveyFormID, &surveySubmissionForHubSpot{
+	if err := hubspotutil.Client(r.logger).SubmitForm(hubspotutil.SurveyFormID, &surveySubmissionForHubSpot{
 		Email:           email,
 		Score:           args.Input.Score,
 		OtherUseCase:    args.Input.OtherUseCase,
@@ -181,7 +181,7 @@ func (r *schemaResolver) SubmitHappinessFeedback(ctx context.Context, args *stru
 	}
 
 	// Submit form to HubSpot
-	if err := hubspotutil.Client().SubmitForm(hubspotutil.HappinessFeedbackFormID, &data); err != nil {
+	if err := hubspotutil.Client(r.logger).SubmitForm(hubspotutil.HappinessFeedbackFormID, &data); err != nil {
 		// Log an error, but don't return one if the only failure was in submitting feedback results to HubSpot.
 		log15.Error("Unable to submit happiness feedback results to Sourcegraph remote", "error", err)
 	}

cmd/frontend/graphqlbackend/user_usage_stats.go

@@ -169,11 +169,11 @@ func (r *schemaResolver) LogEvents(ctx context.Context, args *EventBatch) (*Empt
 				}
 			}
 
-			hubspotutil.SyncUser(userPrimaryEmail, hubspotutil.CodyClientInstalledEventID, &hubspot.ContactProperties{
+			hubspotutil.SyncUser(r.logger, userPrimaryEmail, hubspotutil.CodyClientInstalledEventID, &hubspot.ContactProperties{
 				DatabaseID: userID,
 			})
 
-			hubspotutil.SyncUserWithV3Event(userPrimaryEmail, hubspotutil.CodyClientInstalledV3EventID,
+			hubspotutil.SyncUserWithV3Event(r.logger, userPrimaryEmail, hubspotutil.CodyClientInstalledV3EventID,
 				&hubspot.ContactProperties{
 					DatabaseID: userID,
 				},

cmd/frontend/hubspot/BUILD.bazel

@@ -14,6 +14,7 @@ go_library(
         "//internal/httpcli",
         "//lib/errors",
         "@com_github_google_go_querystring//query",
+        "@com_github_sourcegraph_log//:log",
         "@org_uber_go_atomic//:atomic",
     ],
 )

cmd/frontend/hubspot/hubspot.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/google/go-querystring/query"
+	"github.com/sourcegraph/log"
 	"go.uber.org/atomic"
 
 	"github.com/sourcegraph/sourcegraph/internal/httpcli"
@@ -25,13 +26,15 @@ type Client struct {
 
 	lastPing       atomic.Time
 	lastPingResult atomic.Error
+	logger         log.Logger
 }
 
 // New returns a new HubSpot client using the given Portal ID.
-func New(portalID, accessToken string) *Client {
+func New(portalID, accessToken string, logger log.Logger) *Client {
 	return &Client{
 		portalID:    portalID,
 		accessToken: accessToken,
+		logger:      logger.Scoped("HubSpotClient"),
 	}
 }
 
@@ -61,7 +64,7 @@ func (c *Client) postForm(methodName string, baseURL *url.URL, suffix string, bo
 	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
 	setAccessTokenAuthorizationHeader(req, c.accessToken)
 
-	resp, err := httpcli.ExternalDoer.Do(req)
+	resp, err := httpcli.ExternalDoer(c.logger).Do(req)
 	if err != nil {
 		return wrapError(methodName, err)
 	}
@@ -95,7 +98,7 @@ func (c *Client) postJSON(methodName string, baseURL *url.URL, reqPayload, respP
 	req.Header.Set("Content-Type", "application/json")
 	setAccessTokenAuthorizationHeader(req, c.accessToken)
 
-	resp, err := httpcli.ExternalDoer.Do(req.WithContext(ctx))
+	resp, err := httpcli.ExternalDoer(c.logger).Do(req.WithContext(ctx))
 	if err != nil {
 		return wrapError(methodName, err)
 	}
@@ -129,7 +132,7 @@ func (c *Client) get(ctx context.Context, methodName string, baseURL *url.URL, s
 	ctx, cancel := context.WithTimeout(req.Context(), time.Minute)
 	defer cancel()
 
-	resp, err := httpcli.ExternalDoer.Do(req.WithContext(ctx))
+	resp, err := httpcli.ExternalDoer(c.logger).Do(req.WithContext(ctx))
 	if err != nil {
 		return wrapError(methodName, err)
 	}