wrap errors with grpc

Author: mateoHernandez123

go.sum

@@ -7,6 +7,7 @@ import (
 
 	"github.com/conductorone/baton-sdk/pkg/uhttp"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
+	"google.golang.org/grpc/codes"
 )
 
 var (
@@ -33,21 +34,21 @@ type WorkatoClient struct {
 func NewWorkatoClient(ctx context.Context, apiKey, baseUrl string) (*WorkatoClient, error) {
 	parseBaseUrl, err := url.Parse(baseUrl)
 	if err != nil {
-		return nil, err
+		return nil, uhttp.WrapErrors(codes.InvalidArgument, "baton-workato: failed to parse base URL", err)
 	}
 
 	if apiKey == "" {
-		return nil, ErrApiKeyIsEmpty
+		return nil, uhttp.WrapErrors(codes.InvalidArgument, "baton-workato: api key is empty", ErrApiKeyIsEmpty)
 	}
 
 	httpClient, err := uhttp.NewClient(ctx, uhttp.WithLogger(true, ctxzap.Extract(ctx)))
 	if err != nil {
-		return nil, err
+		return nil, uhttp.WrapErrors(codes.Internal, "baton-workato: failed to create HTTP client", err)
 	}
 
 	uhttpClient, err := uhttp.NewBaseHttpClientWithContext(ctx, httpClient)
 	if err != nil {
-		return nil, err
+		return nil, uhttp.WrapErrors(codes.Internal, "baton-workato: failed to create base HTTP client", err)
 	}
 
 	return &WorkatoClient{

pkg/connector/client/client.go

@@ -30,7 +30,7 @@ func (c *WorkatoClient) GetCollaboratorPrivileges(ctx context.Context, id int) (
 	}
 
 	if len(response.Data) == 0 {
-		return nil, status.Errorf(codes.NotFound, "baton-workato: no collaborator privileges found")
+		return nil, status.Errorf(codes.NotFound, "baton-workato: no collaborator privileges found for id %d", id)
 	}
 
 	return response.Data, nil

pkg/connector/client/colaborator.go

@@ -5,6 +5,9 @@ import (
 	"fmt"
 	"net/http"
 	"strconv"
+
+	"github.com/conductorone/baton-sdk/pkg/uhttp"
+	"google.golang.org/grpc/codes"
 )
 
 func (c *WorkatoClient) GetFolders(ctx context.Context, parentId *int, pToken string) ([]Folder, string, error) {
@@ -15,7 +18,7 @@ func (c *WorkatoClient) GetFolders(ctx context.Context, parentId *int, pToken st
 	if pToken != "" {
 		page, err = strconv.Atoi(pToken)
 		if err != nil {
-			return nil, "", ErrInvalidPaginationToken
+			return nil, "", uhttp.WrapErrors(codes.InvalidArgument, "baton-workato: invalid pagination token for folders", ErrInvalidPaginationToken)
 		}
 	}
 

pkg/connector/client/folder.go

@@ -12,6 +12,7 @@ import (
 	"github.com/conductorone/baton-sdk/pkg/uhttp"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
 	"go.uber.org/zap"
+	"google.golang.org/grpc/codes"
 )
 
 var (
@@ -32,22 +33,42 @@ func (c *WorkatoClient) getPath(path string) *url.URL {
 	return c.baseUrl.JoinPath(path)
 }
 
+// httpToGRPCCode maps HTTP status codes to gRPC codes.
+func httpToGRPCCode(statusCode int) codes.Code {
+	switch statusCode {
+	case http.StatusBadRequest:
+		return codes.InvalidArgument
+	case http.StatusUnauthorized:
+		return codes.Unauthenticated
+	case http.StatusForbidden:
+		return codes.PermissionDenied
+	case http.StatusNotFound:
+		return codes.NotFound
+	case http.StatusInternalServerError:
+		return codes.Internal
+	default:
+		return codes.Unknown
+	}
+}
+
 func getError(ctx context.Context, originalErr error, resp *http.Response) error {
+	grpcCode := httpToGRPCCode(resp.StatusCode)
+
 	bytes, err := io.ReadAll(resp.Body)
 	if err != nil {
 		// We expect the response body to be JSON, according to the Workato API docs, but this is not guaranteed.
 		l := ctxzap.Extract(ctx)
 		l.Debug("failed to read response body", zap.String("body", string(bytes)))
-		return errors.Join(originalErr, err)
+		return uhttp.WrapErrors(grpcCode, "baton-workato: failed to read error response", errors.Join(originalErr, err))
 	}
 
 	var cErr ApiError
 	err = json.Unmarshal(bytes, &cErr)
 	if err != nil {
-		return errors.Join(originalErr, err)
+		return uhttp.WrapErrors(grpcCode, "baton-workato: failed to parse error response", errors.Join(originalErr, err))
 	}
 
-	return errors.Join(originalErr, errors.New(cErr.Message))
+	return uhttp.WrapErrors(grpcCode, fmt.Sprintf("baton-workato: API error (status %d)", resp.StatusCode), errors.Join(originalErr, errors.New(cErr.Message)))
 }
 
 func (c *WorkatoClient) doRequest(ctx context.Context, method string, urlAddress *url.URL, res interface{}, body interface{}) error {
@@ -64,7 +85,7 @@ func (c *WorkatoClient) doRequest(ctx context.Context, method string, urlAddress
 		uhttp.WithJSONBody(body),
 	)
 	if err != nil {
-		return err
+		return uhttp.WrapErrors(codes.Internal, "baton-workato: failed to create HTTP request", err)
 	}
 
 	var options []uhttp.DoOption
@@ -77,10 +98,10 @@ func (c *WorkatoClient) doRequest(ctx context.Context, method string, urlAddress
 
 	if resp == nil {
 		if err != nil {
-			return err
+			return uhttp.WrapErrors(codes.Internal, "baton-workato: response is nil and error is nil, this should never happen", err)
 		}
 
-		return errors.New("baton-workato: response is nil and error is nil, this should never happen, might be a bug in the http client")
+		return uhttp.WrapErrors(codes.Internal, "baton-workato: response is nil and error is nil, this should never happen", err)
 	}
 
 	defer resp.Body.Close()

pkg/connector/client/helpers.go

@@ -5,6 +5,9 @@ import (
 	"fmt"
 	"net/http"
 	"strconv"
+
+	"github.com/conductorone/baton-sdk/pkg/uhttp"
+	"google.golang.org/grpc/codes"
 )
 
 func (c *WorkatoClient) GetProjects(ctx context.Context, pToken string) ([]Project, string, error) {
@@ -15,7 +18,7 @@ func (c *WorkatoClient) GetProjects(ctx context.Context, pToken string) ([]Proje
 	if pToken != "" {
 		page, err = strconv.Atoi(pToken)
 		if err != nil {
-			return nil, "", ErrInvalidPaginationToken
+			return nil, "", uhttp.WrapErrors(codes.InvalidArgument, "baton-workato: invalid pagination token for projects", ErrInvalidPaginationToken)
 		}
 	}
 

pkg/connector/client/project.go

@@ -5,6 +5,9 @@ import (
 	"fmt"
 	"net/http"
 	"strconv"
+
+	"github.com/conductorone/baton-sdk/pkg/uhttp"
+	"google.golang.org/grpc/codes"
 )
 
 func (c *WorkatoClient) GetRoles(ctx context.Context, pToken string) ([]Role, string, error) {
@@ -15,7 +18,7 @@ func (c *WorkatoClient) GetRoles(ctx context.Context, pToken string) ([]Role, st
 	if pToken != "" {
 		page, err = strconv.Atoi(pToken)
 		if err != nil {
-			return nil, "", ErrInvalidPaginationToken
+			return nil, "", uhttp.WrapErrors(codes.InvalidArgument, "baton-workato: invalid pagination token for roles", ErrInvalidPaginationToken)
 		}
 	}
 

pkg/connector/client/roles.go

@@ -4,13 +4,15 @@ import (
 	"context"
 
 	"github.com/conductorone/baton-sdk/pkg/types/resource"
+	"github.com/conductorone/baton-sdk/pkg/uhttp"
 	"github.com/conductorone/baton-workato/pkg/connector/client"
 
 	v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
 	"github.com/conductorone/baton-sdk/pkg/annotations"
 	"github.com/conductorone/baton-sdk/pkg/pagination"
 
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
+	"google.golang.org/grpc/codes"
 )
 
 type collaboratorBuilder struct {
@@ -37,7 +39,7 @@ func (o *collaboratorBuilder) List(ctx context.Context, parentResourceID *v2.Res
 	for i, collaborator := range collaborators {
 		us, err := collaboratorResource(&collaborator)
 		if err != nil {
-			return nil, "", nil, err
+			return nil, "", nil, uhttp.WrapErrors(codes.Internal, "baton-workato: failed to create collaborator resource", err)
 		}
 		rv[i] = us
 	}
@@ -91,7 +93,7 @@ func collaboratorResource(collaborator *client.Collaborator) (*v2.Resource, erro
 		traits,
 	)
 	if err != nil {
-		return nil, err
+		return nil, uhttp.WrapErrors(codes.Internal, "baton-workato: failed to create collaborator resource", err)
 	}
 
 	return ret, nil

pkg/connector/collaborator.go

@@ -2,6 +2,7 @@ package connector
 
 import (
 	"context"
+	"fmt"
 	"strconv"
 	"sync"
 
@@ -53,7 +54,7 @@ func (p *collaboratorCache) init(ctx context.Context) error {
 	}
 
 	if err := p.buildCache(ctx); err != nil {
-		return err
+		return fmt.Errorf("baton-workato: failed to build collaborator cache: %w", err)
 	}
 
 	p.initialized = true
@@ -70,7 +71,7 @@ func (p *collaboratorCache) buildCache(ctx context.Context) error {
 
 	collaborators, err := p.client.GetCollaborators(ctx)
 	if err != nil {
-		return err
+		return fmt.Errorf("baton-workato: failed to get collaborators for cache: %w", err)
 	}
 
 	l.Debug("Building cache for collaborators", zap.Int("count", len(collaborators)))
@@ -82,7 +83,7 @@ func (p *collaboratorCache) buildCache(ctx context.Context) error {
 				l.Warn("Collaborator not found, skipping", zap.Int("collaborator_id", collaborator.Id))
 				continue
 			}
-			return err
+			return fmt.Errorf("baton-workato: failed to get collaborator privileges for cache building (id %d): %w", collaborator.Id, err)
 		}
 
 		compoundUser := &CompoundUser{

pkg/connector/collaborator_cache.go

@@ -2,9 +2,10 @@ package cpagination
 
 import (
 	"encoding/json"
-	"fmt"
 
 	"github.com/conductorone/baton-sdk/pkg/pagination"
+	"github.com/conductorone/baton-sdk/pkg/uhttp"
+	"google.golang.org/grpc/codes"
 )
 
 type genericSerializedPaginationBag[T any] struct {
@@ -24,7 +25,7 @@ func GenBagFromToken[T any](pToken pagination.Token) (*GenBag[T], error) {
 	bag := &GenBag[T]{}
 	err := bag.Unmarshal(pToken.Token)
 	if err != nil {
-		return nil, err
+		return nil, uhttp.WrapErrors(codes.Internal, "baton-workato: failed to unmarshal pagination token for generic bag", err)
 	}
 	return bag, nil
 }
@@ -83,7 +84,7 @@ func (pb *GenBag[T]) Unmarshal(input string) error {
 	if input != "" {
 		err := json.Unmarshal([]byte(input), &target)
 		if err != nil {
-			return fmt.Errorf("page token corrupt: %w", err)
+			return uhttp.WrapErrors(codes.Internal, "baton-workato: failed to unmarshal pagination token for generic bag", err)
 		}
 
 		pb.states = target.States