Ensure we always use logging methods with Context (#225)

* Ensure we always use logging methods with Context
* Pass background contexts where we don't accept one from the user
May consider changing the API in a future version.

Author: ehdr

modal-go/.golangci.toml

@@ -5,6 +5,7 @@ enable = [
   "errcheck",
   "govet",
   "ineffassign",
+  "sloglint",
   "staticcheck",
   "unused",
   "usetesting",
@@ -13,5 +14,8 @@ enable = [
 [linters.settings.staticcheck]
 checks = ["all"]
 
+[linters.settings.sloglint]
+context = "all"
+
 [formatters]
 enable = ["gofmt", "goimports"]

modal-go/app.go

@@ -82,6 +82,6 @@ func (s *appServiceImpl) FromName(ctx context.Context, name string, params *AppF
 		return nil, err
 	}
 
-	s.client.logger.Debug("Retrieved App", "app_id", resp.GetAppId(), "app_name", name)
+	s.client.logger.DebugContext(ctx, "Retrieved App", "app_id", resp.GetAppId(), "app_name", name)
 	return &App{AppID: resp.GetAppId(), Name: name}, nil
 }

modal-go/auth_token_manager.go

@@ -108,7 +108,7 @@ func (m *AuthTokenManager) backgroundRefresh(ctx context.Context) {
 
 		// Refresh the token
 		if _, err := m.FetchToken(ctx); err != nil {
-			m.logger.Error("Failed to refresh auth token", "error", err)
+			m.logger.ErrorContext(ctx, "Failed to refresh auth token", "error", err)
 			// Sleep for 5 seconds before trying again on failure
 			select {
 			case <-ctx.Done():
@@ -135,7 +135,7 @@ func (m *AuthTokenManager) FetchToken(ctx context.Context) (string, error) {
 	if exp := m.decodeJWT(token); exp > 0 {
 		expiry = exp
 	} else {
-		m.logger.Warn("x-modal-auth-token does not contain exp field")
+		m.logger.WarnContext(ctx, "x-modal-auth-token does not contain exp field")
 		// We'll use the token, and set the expiry to 20 min from now.
 		expiry = time.Now().Unix() + DefaultExpiryOffset
 	}

modal-go/client.go

@@ -112,6 +112,7 @@ type ClientParams struct {
 
 // NewClientWithOptions generates a new client and allows overriding options in the default profile configuration.
 func NewClientWithOptions(params *ClientParams) (*Client, error) {
+	ctx := context.Background()
 	if params == nil {
 		params = &ClientParams{}
 	}
@@ -161,15 +162,15 @@ func NewClientWithOptions(params *ClientParams) (*Client, error) {
 		additionalStreamInterceptors: params.GRPCStreamInterceptors,
 	}
 
-	logger.Debug("Initializing Modal client", "version", sdkVersion(), "server_url", profile.ServerURL)
+	logger.DebugContext(ctx, "Initializing Modal client", "version", sdkVersion(), "server_url", profile.ServerURL)
 
 	if params.ControlPlaneClient != nil {
 		c.cpClient = &clientWithConn{
 			ModalClientClient: params.ControlPlaneClient,
 			conn:              params.ControlPlaneConn,
 		}
 	} else {
-		conn, client, err := newClient(profile, c, c.additionalUnaryInterceptors, c.additionalStreamInterceptors)
+		conn, client, err := newClient(ctx, profile, c, c.additionalUnaryInterceptors, c.additionalStreamInterceptors)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create control plane client: %w", err)
 		}
@@ -181,7 +182,7 @@ func NewClientWithOptions(params *ClientParams) (*Client, error) {
 		return nil, fmt.Errorf("failed to start auth token manager: %w", err)
 	}
 
-	logger.Debug("Modal client initialized successfully")
+	logger.DebugContext(ctx, "Modal client initialized successfully")
 
 	c.Apps = &appServiceImpl{client: c}
 	c.CloudBucketMounts = &cloudBucketMountServiceImpl{client: c}
@@ -200,7 +201,7 @@ func NewClientWithOptions(params *ClientParams) (*Client, error) {
 
 // ipClient returns the input plane client for the given server URL.
 // It creates a new client if one doesn't exist for that specific server URL, otherwise it returns the existing client.
-func (c *Client) ipClient(serverURL string) (pb.ModalClientClient, error) {
+func (c *Client) ipClient(ctx context.Context, serverURL string) (pb.ModalClientClient, error) {
 	c.mu.RLock()
 	if client, ok := c.ipClients[serverURL]; ok {
 		c.mu.RUnlock()
@@ -215,10 +216,10 @@ func (c *Client) ipClient(serverURL string) (pb.ModalClientClient, error) {
 		return client, nil
 	}
 
-	c.logger.Debug("Creating input plane client", "server_url", serverURL)
+	c.logger.DebugContext(ctx, "Creating input plane client", "server_url", serverURL)
 	prof := c.profile
 	prof.ServerURL = serverURL
-	conn, client, err := newClient(prof, c, c.additionalUnaryInterceptors, c.additionalStreamInterceptors)
+	conn, client, err := newClient(ctx, prof, c, c.additionalUnaryInterceptors, c.additionalStreamInterceptors)
 	if err != nil {
 		return nil, err
 	}
@@ -228,25 +229,26 @@ func (c *Client) ipClient(serverURL string) (pb.ModalClientClient, error) {
 
 // Close stops the background auth token refresh and closes all gRPC connections.
 func (c *Client) Close() {
-	c.logger.Debug("Closing Modal client")
+	ctx := context.Background()
+	c.logger.DebugContext(ctx, "Closing Modal client")
 	c.authTokenManager.Stop()
 
 	if c.cpClient != nil {
 		if err := c.cpClient.Close(); err != nil {
-			c.logger.Warn("Failed to close control plane connection", "error", err)
+			c.logger.WarnContext(ctx, "Failed to close control plane connection", "error", err)
 		}
 	}
 
 	c.mu.Lock()
 	for serverURL, client := range c.ipClients {
 		if err := client.Close(); err != nil {
-			c.logger.Warn("Failed to close input plane connection", "server_url", serverURL, "error", err)
+			c.logger.WarnContext(ctx, "Failed to close input plane connection", "server_url", serverURL, "error", err)
 		}
 	}
 	c.ipClients = map[string]*clientWithConn{}
 	c.mu.Unlock()
 
-	c.logger.Debug("Modal client closed")
+	c.logger.DebugContext(ctx, "Modal client closed")
 }
 
 // Version returns the SDK version.
@@ -298,7 +300,7 @@ func isRetryableGrpc(err error) bool {
 
 // newClient dials the given server URL with auth/timeout/retry interceptors installed.
 // It returns (conn, stub). Close the conn when done.
-func newClient(profile Profile, c *Client, customUnaryInterceptors []grpc.UnaryClientInterceptor, customStreamInterceptors []grpc.StreamClientInterceptor) (*grpc.ClientConn, pb.ModalClientClient, error) {
+func newClient(ctx context.Context, profile Profile, c *Client, customUnaryInterceptors []grpc.UnaryClientInterceptor, customStreamInterceptors []grpc.StreamClientInterceptor) (*grpc.ClientConn, pb.ModalClientClient, error) {
 	var target string
 	var creds credentials.TransportCredentials
 	var scheme string
@@ -314,7 +316,7 @@ func newClient(profile Profile, c *Client, customUnaryInterceptors []grpc.UnaryC
 		return nil, nil, status.Errorf(codes.InvalidArgument, "invalid server URL: %s", profile.ServerURL)
 	}
 
-	c.logger.Debug("Connecting to Modal server", "target", target, "scheme", scheme)
+	c.logger.DebugContext(ctx, "Connecting to Modal server", "target", target, "scheme", scheme)
 
 	unaryInterceptors := []grpc.UnaryClientInterceptor{
 		headerInjectorUnaryInterceptor(profile, c.sdkVersion),

modal-go/cloud_bucket_mount.go

@@ -1,6 +1,7 @@
 package modal
 
 import (
+	"context"
 	"fmt"
 	"net/url"
 	"strings"
@@ -39,6 +40,7 @@ type CloudBucketMountParams struct {
 
 // New creates a new CloudBucketMount.
 func (s *cloudBucketMountServiceImpl) New(bucketName string, params *CloudBucketMountParams) (*CloudBucketMount, error) {
+	ctx := context.Background()
 	if params == nil {
 		params = &CloudBucketMountParams{}
 	}
@@ -67,7 +69,8 @@ func (s *cloudBucketMountServiceImpl) New(bucketName string, params *CloudBucket
 		} else {
 			mount.bucketType = pb.CloudBucketMount_S3
 			if s.client != nil && s.client.logger != nil {
-				s.client.logger.Debug(
+				s.client.logger.DebugContext(
+					ctx,
 					"CloudBucketMount received unrecognized bucket endpoint URL. Assuming AWS S3 configuration as fallback.",
 					"BucketEndpointURL", *mount.BucketEndpointURL,
 				)

modal-go/function.go

@@ -305,7 +305,7 @@ func (f *Function) createRemoteInvocation(ctx context.Context, input *pb.Functio
 	}
 	inputPlaneURL := metadata.GetInputPlaneUrl()
 	if inputPlaneURL != "" {
-		ipClient, err := f.client.ipClient(inputPlaneURL)
+		ipClient, err := f.client.ipClient(ctx, inputPlaneURL)
 		if err != nil {
 			return nil, err
 		}