Use SDK Id funcs for generating connector object IDs (#3)

* Use SDK Id funcs for generating connector object IDs

* Drop unused ID formatting functions

* Fix lint

Author: jirwin

.gitignore

@@ -6,6 +6,7 @@
 *.dylib
 build/
 *.c1z
+*.db
 
 # Test binary, built with `go test -c`
 *.test

.golangci.yml

@@ -57,15 +57,13 @@ linters-settings:
 linters:
   disable-all: true
   enable:
-    - deadcode # Finds unused code
     - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
     - gosimple # Linter for Go source code that specializes in simplifying a code
     - govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
     - ineffassign # Detects when assignments to existing variables are not used
     - staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
     - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
     - unused # Checks Go code for unused constants, variables, functions and types
-    - varcheck # Finds unused global variables and constants
     - asasalint # Check for pass []any as any in variadic func(...any)
     - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
     - bidichk # Checks for dangerous unicode character sequences

go.mod

@@ -3,7 +3,7 @@ module github.com/conductorone/baton-github
 go 1.19
 
 require (
-	github.com/conductorone/baton-sdk v0.0.4
+	github.com/conductorone/baton-sdk v0.0.7
 	github.com/google/go-github/v41 v41.0.0
 	github.com/grpc-ecosystem/go-grpc-middleware v1.3.0
 	github.com/spf13/cobra v1.6.1

go.sum

@@ -89,8 +89,8 @@ github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDk
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
 github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
 github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
-github.com/conductorone/baton-sdk v0.0.4 h1:Je19ih9toyocBbmJUIMaoR866v6vVIrr5DpiCb2n/ns=
-github.com/conductorone/baton-sdk v0.0.4/go.mod h1:jPdcy08LmTIPzgZcSOo7mviSAG0NUbjavg/1LpCTeOI=
+github.com/conductorone/baton-sdk v0.0.7 h1:4+PMrcG/HT9x6UCfHaL8wH6HFaSHhc/rGQWko/92zRc=
+github.com/conductorone/baton-sdk v0.0.7/go.mod h1:jPdcy08LmTIPzgZcSOo7mviSAG0NUbjavg/1LpCTeOI=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=

pkg/connector/helpers.go

@@ -16,40 +16,11 @@ import (
 
 var titleCaser = cases.Title(language.English)
 
-// fmtResourceId returns a new v2.ResourceID given a resource type and resource ID.
-func fmtResourceId(rTypeID string, orgName string, id int64) *v2.ResourceId {
-	return &v2.ResourceId{
-		ResourceType: rTypeID,
-		Resource:     fmt.Sprintf("%s:%d", orgName, id),
-	}
-}
-
 func getOrgName(rID *v2.ResourceId) string {
 	ret, _, _ := strings.Cut(rID.Resource, ":")
 	return ret
 }
 
-// fmtResourceRole returns a formatted string that represents a unique ID for an entitlement.
-func fmtResourceRole(resourceID *v2.ResourceId, role string) string {
-	return fmt.Sprintf(
-		"%s:%s:role:%s",
-		resourceID.ResourceType,
-		resourceID.Resource,
-		role,
-	)
-}
-
-func fmtResourceGrant(resourceID *v2.ResourceId, principalId *v2.ResourceId, permission string) string {
-	return fmt.Sprintf(
-		"%s-grant:%s:%s:%s:%s",
-		resourceID.ResourceType,
-		resourceID.Resource,
-		principalId.ResourceType,
-		principalId.Resource,
-		permission,
-	)
-}
-
 func v1AnnotationsForResourceType(resourceTypeID string) annotations.Annotations {
 	annos := annotations.Annotations{}
 	annos.Append(&v2.V1Identifier{
@@ -59,12 +30,11 @@ func v1AnnotationsForResourceType(resourceTypeID string) annotations.Annotations
 	return annos
 }
 
-// parseResourceToGithub returns the resource type and upstream object ID for a given v2.ResourceID.
+// parseResourceToGithub returns the upstream API ID by looking at the last 'part' of the resource ID.
 func parseResourceToGithub(id *v2.ResourceId) (int64, error) {
-	if _, rID, found := strings.Cut(id.Resource, ":"); found {
-		return strconv.ParseInt(rID, 10, 64)
-	}
-	return 0, fmt.Errorf("github-connector: invalid internal id: '%s'", id.Resource)
+	idParts := strings.Split(id.Resource, ":")
+
+	return strconv.ParseInt(idParts[len(idParts)-1], 10, 64)
 }
 
 func parsePageToken(i string, resourceID *v2.ResourceId) (*pagination.Bag, int, error) {

pkg/connector/org.go

@@ -8,6 +8,7 @@ import (
 	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/conductorone/baton-sdk/pkg/sdk"
 	"github.com/google/go-github/v41/github"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
 	"go.uber.org/zap"
@@ -35,7 +36,7 @@ func (o *orgResourceType) ResourceType(_ context.Context) *v2.ResourceType {
 
 func (o *orgResourceType) List(
 	ctx context.Context,
-	_ *v2.ResourceId,
+	parentResourceID *v2.ResourceId,
 	pToken *pagination.Token,
 ) ([]*v2.Resource, string, annotations.Annotations, error) {
 	bag, page, err := parsePageToken(pToken.Token, &v2.ResourceId{ResourceType: resourceTypeOrg.Id})
@@ -89,11 +90,13 @@ func (o *orgResourceType) List(
 		annos.Append(&v2.ChildResourceType{ResourceTypeId: resourceTypeTeam.Id})
 		annos.Append(&v2.ChildResourceType{ResourceTypeId: resourceTypeRepository.Id})
 
+		resourceID, err := sdk.NewResourceID(resourceTypeOrg, parentResourceID, org.GetLogin())
+		if err != nil {
+			return nil, "", nil, err
+		}
+
 		ret = append(ret, &v2.Resource{
-			Id: &v2.ResourceId{
-				ResourceType: resourceTypeOrg.Id,
-				Resource:     org.GetLogin(),
-			},
+			Id:          resourceID,
 			DisplayName: org.GetLogin(),
 			Annotations: annos,
 		})
@@ -114,7 +117,7 @@ func (o *orgResourceType) Entitlements(
 			Id: fmt.Sprintf("org:%s:role:%s", resource.Id, level),
 		})
 		rv = append(rv, &v2.Entitlement{
-			Id:          fmtResourceRole(resource.Id, level),
+			Id:          sdk.NewEntitlementID(resource, level),
 			Resource:    resource,
 			DisplayName: fmt.Sprintf("%s Org %s", resource.DisplayName, titleCaser.String(level)),
 			Description: fmt.Sprintf("Access to %s org in Github", resource.DisplayName),
@@ -184,12 +187,15 @@ func (o *orgResourceType) Grants(
 			annos.Append(&v2.V1Identifier{
 				Id: fmt.Sprintf("org-grant:%s:%d:%s", resource.Id.Resource, user.GetID(), roleName),
 			})
+
+			en := &v2.Entitlement{
+				Id:       sdk.NewEntitlementID(resource, roleName),
+				Resource: resource,
+			}
+
 			rv = append(rv, &v2.Grant{
-				Id: fmtResourceGrant(resource.Id, ur.Id, roleName),
-				Entitlement: &v2.Entitlement{
-					Id:       fmtResourceRole(resource.Id, roleName),
-					Resource: resource,
-				},
+				Id:          sdk.NewGrantID(en, ur),
+				Entitlement: en,
 				Annotations: annos,
 				Principal:   ur,
 			})

pkg/connector/repository.go

@@ -7,6 +7,7 @@ import (
 	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/conductorone/baton-sdk/pkg/sdk"
 	"github.com/google/go-github/v41/github"
 )
 
@@ -37,8 +38,13 @@ func repositoryResource(ctx context.Context, orgName string, repo *github.Reposi
 		Id: fmt.Sprintf("repo:%d", repo.GetID()),
 	})
 
+	resourceID, err := sdk.NewResourceID(resourceTypeRepository, parentResourceID, repo.GetID())
+	if err != nil {
+		return nil, err
+	}
+
 	return &v2.Resource{
-		Id:               fmtResourceId(resourceTypeRepository.Id, orgName, repo.GetID()),
+		Id:               resourceID,
 		DisplayName:      repo.GetName(),
 		ParentResourceId: parentResourceID,
 		Annotations:      annos,
@@ -108,7 +114,7 @@ func (o *repositoryResourceType) Entitlements(_ context.Context, resource *v2.Re
 			Id: fmt.Sprintf("repo:%s:role:%s", resource.Id, level),
 		})
 		rv = append(rv, &v2.Entitlement{
-			Id:          fmtResourceRole(resource.Id, level),
+			Id:          sdk.NewEntitlementID(resource, level),
 			Resource:    resource,
 			DisplayName: fmt.Sprintf("%s Repo %s", resource.DisplayName, titleCaser.String(level)),
 			Description: fmt.Sprintf("Access to %s repository in Github", resource.DisplayName),
@@ -185,12 +191,14 @@ func (o *repositoryResourceType) Grants(
 					return nil, "", nil, err
 				}
 
+				en := &v2.Entitlement{
+					Id:       sdk.NewEntitlementID(resource, permission),
+					Resource: resource,
+				}
+
 				rv = append(rv, &v2.Grant{
-					Entitlement: &v2.Entitlement{
-						Id:       fmtResourceRole(resource.Id, permission),
-						Resource: resource,
-					},
-					Id:          fmtResourceGrant(resource.Id, ur.Id, permission),
+					Entitlement: en,
+					Id:          sdk.NewGrantID(en, ur),
 					Principal:   ur,
 					Annotations: annos,
 				})
@@ -234,12 +242,14 @@ func (o *repositoryResourceType) Grants(
 					return nil, "", nil, err
 				}
 
+				en := &v2.Entitlement{
+					Id:       sdk.NewEntitlementID(resource, permission),
+					Resource: resource,
+				}
+
 				rv = append(rv, &v2.Grant{
-					Entitlement: &v2.Entitlement{
-						Id:       fmtResourceRole(resource.Id, permission),
-						Resource: resource,
-					},
-					Id:          fmtResourceGrant(resource.Id, tr.Id, permission),
+					Entitlement: en,
+					Id:          sdk.NewGrantID(en, tr),
 					Principal:   tr,
 					Annotations: annos,
 				})

pkg/connector/team.go

@@ -7,6 +7,7 @@ import (
 	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/conductorone/baton-sdk/pkg/sdk"
 	"github.com/google/go-github/v41/github"
 	"google.golang.org/protobuf/types/known/structpb"
 )
@@ -39,8 +40,13 @@ func teamResource(ctx context.Context, orgName string, team *github.Team, parent
 	})
 	annos.Append(&v2.ChildResourceType{ResourceTypeId: resourceTypeTeam.Id})
 
+	resourceID, err := sdk.NewResourceID(resourceTypeTeam, parentResourceID, team.GetID())
+	if err != nil {
+		return nil, err
+	}
+
 	return &v2.Resource{
-		Id:               fmtResourceId(resourceTypeTeam.Id, orgName, team.GetID()),
+		Id:               resourceID,
 		DisplayName:      team.GetName(),
 		Annotations:      annos,
 		ParentResourceId: parentResourceID,
@@ -151,7 +157,7 @@ func (o *teamResourceType) Entitlements(_ context.Context, resource *v2.Resource
 			Id: fmt.Sprintf("team:%s:role:%s", resource.Id, level),
 		})
 		rv = append(rv, &v2.Entitlement{
-			Id:          fmtResourceRole(resource.Id, level),
+			Id:          sdk.NewEntitlementID(resource, level),
 			Resource:    resource,
 			DisplayName: fmt.Sprintf("%s Team %s", resource.DisplayName, titleCaser.String(level)),
 			Description: fmt.Sprintf("Access to %s team in Github", resource.DisplayName),
@@ -218,12 +224,14 @@ func (o *teamResourceType) Grants(ctx context.Context, resource *v2.Resource, pT
 			return nil, "", nil, err
 		}
 
+		en := &v2.Entitlement{
+			Id:       sdk.NewEntitlementID(resource, membership.GetRole()),
+			Resource: resource,
+		}
+
 		rv = append(rv, &v2.Grant{
-			Entitlement: &v2.Entitlement{
-				Id:       fmtResourceRole(resource.Id, membership.GetRole()),
-				Resource: resource,
-			},
-			Id:          fmtResourceGrant(resource.Id, ur.Id, membership.GetRole()),
+			Entitlement: en,
+			Id:          sdk.NewGrantID(en, ur),
 			Principal:   ur,
 			Annotations: annos,
 		})

pkg/connector/user.go

@@ -9,6 +9,7 @@ import (
 	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/conductorone/baton-sdk/pkg/sdk"
 	"github.com/google/go-github/v41/github"
 	"google.golang.org/protobuf/types/known/structpb"
 )
@@ -35,11 +36,13 @@ func userResource(ctx context.Context, user *github.User) (*v2.Resource, error)
 		Id: strconv.FormatInt(user.GetID(), 10),
 	})
 
+	resourceID, err := sdk.NewResourceID(resourceTypeUser, nil, user.GetID())
+	if err != nil {
+		return nil, err
+	}
+
 	return &v2.Resource{
-		Id: &v2.ResourceId{
-			ResourceType: resourceTypeUser.Id,
-			Resource:     fmt.Sprintf("%d", user.GetID()),
-		},
+		Id:          resourceID,
 		DisplayName: displayName,
 		Annotations: annos,
 	}, nil