Skip to content

Commit ee8f2bf

Browse files
johnallersjohnallers
authored
Cleanup and fixing comments (#35)
* verify interfaces * cleanup parameters and fix comments * fix punctuation and grammar
1 parent b8e59eb commit ee8f2bf

File tree

6 files changed

+29
-21
lines changed

6 files changed

+29
-21
lines changed

‎pkg/connector/collaborator.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55
"fmt"
66
"strconv"
77

8+
"github.com/conductorone/baton-sdk/pkg/connectorbuilder"
89
"github.com/conductorone/baton-sdk/pkg/types/grant"
910
"github.com/conductorone/baton-sdk/pkg/types/resource"
1011
"github.com/conductorone/baton-sdk/pkg/types/sessions"
@@ -19,6 +20,8 @@ import (
1920
"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
2021
)
2122

23+
var _ connectorbuilder.ResourceSyncerV2 = (*collaboratorBuilder)(nil)
24+
2225
type collaboratorBuilder struct {
2326
client *client.WorkatoClient
2427
cache *collaboratorCache

‎pkg/connector/connector.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ type Connector struct {
2828
func (d *Connector) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncerV2 {
2929
return []connectorbuilder.ResourceSyncerV2{
3030
newCollaboratorBuilder(d.client, d.env, d.disableCustomRolesSync),
31-
newPrivilegeBuilder(d.client, d.env),
31+
newPrivilegeBuilder(d.client),
3232
newRoleBuilder(d.client, d.env, d.disableCustomRolesSync),
3333
newFolderBuilder(d.client, d.disableCustomRolesSync),
3434
newProjectBuilder(d.client),

‎pkg/connector/folder.go‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import (
88
"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
99
"go.uber.org/zap"
1010

11+
"github.com/conductorone/baton-sdk/pkg/connectorbuilder"
1112
"github.com/conductorone/baton-sdk/pkg/types/entitlement"
1213
"github.com/conductorone/baton-sdk/pkg/types/grant"
1314
"github.com/conductorone/baton-workato/pkg/connector/client"
@@ -21,6 +22,8 @@ const (
2122
collaboratorAccessEntitlement = "collaborator-access"
2223
)
2324

25+
var _ connectorbuilder.ResourceSyncerV2 = (*folderBuilder)(nil)
26+
2427
type folderBuilder struct {
2528
client *client.WorkatoClient
2629
cache *collaboratorCache
@@ -31,8 +34,7 @@ func (o *folderBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
3134
return folderResourceType
3235
}
3336

34-
// List returns all the users from the database as resource objects.
35-
// Users include a UserTrait because they are the 'shape' of a standard user.
37+
// List returns all the folders and project folders.
3638
func (o *folderBuilder) List(ctx context.Context, parentResourceID *v2.ResourceId, attr rs.SyncOpAttrs) ([]*v2.Resource, *rs.SyncOpResults, error) {
3739
l := ctxzap.Extract(ctx)
3840
l.Debug("Listing folders")
@@ -92,7 +94,7 @@ func (o *folderBuilder) List(ctx context.Context, parentResourceID *v2.ResourceI
9294
return nil, nil, nil
9395
}
9496

95-
// Entitlements always returns an empty slice for users.
97+
// Entitlements returns an entitlement for the folder to be assigned to a collaborator.
9698
func (o *folderBuilder) Entitlements(_ context.Context, resource *v2.Resource, _ rs.SyncOpAttrs) ([]*v2.Entitlement, *rs.SyncOpResults, error) {
9799
var rv []*v2.Entitlement
98100

@@ -106,7 +108,7 @@ func (o *folderBuilder) Entitlements(_ context.Context, resource *v2.Resource, _
106108
return rv, nil, nil
107109
}
108110

109-
// Grants always returns an empty slice for users since they don't have any entitlements.
111+
// Grants returns the roles granted to a folder.
110112
func (o *folderBuilder) Grants(ctx context.Context, resource *v2.Resource, attr rs.SyncOpAttrs) ([]*v2.Grant, *rs.SyncOpResults, error) {
111113
type Bag struct {
112114
ResourceTypeID string

‎pkg/connector/privilege.go‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import (
44
"context"
55
"fmt"
66

7+
"github.com/conductorone/baton-sdk/pkg/connectorbuilder"
78
rs "github.com/conductorone/baton-sdk/pkg/types/resource"
89
"github.com/conductorone/baton-workato/pkg/connector/client"
910
"github.com/conductorone/baton-workato/pkg/connector/workato"
@@ -17,6 +18,8 @@ const (
1718
assignedEntitlement = "assigned"
1819
)
1920

21+
var _ connectorbuilder.ResourceSyncerV2 = (*privilegeBuilder)(nil)
22+
2023
type privilegeBuilder struct {
2124
client *client.WorkatoClient
2225
cache *collaboratorCache
@@ -26,8 +29,7 @@ func (o *privilegeBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
2629
return privilegeResourceType
2730
}
2831

29-
// List returns all the users from the database as resource objects.
30-
// Users include a UserTrait because they are the 'shape' of a standard user.
32+
// List returns all the privileges.
3133
func (o *privilegeBuilder) List(ctx context.Context, _ *v2.ResourceId, _ rs.SyncOpAttrs) ([]*v2.Resource, *rs.SyncOpResults, error) {
3234
l := ctxzap.Extract(ctx)
3335
l.Debug("Listing privileges")
@@ -47,7 +49,7 @@ func (o *privilegeBuilder) List(ctx context.Context, _ *v2.ResourceId, _ rs.Sync
4749
return rv, nil, nil
4850
}
4951

50-
// Entitlements always returns an empty slice for users.
52+
// Entitlements returns an entitlement for the privilege to be assigned to a collaborator.
5153
func (o *privilegeBuilder) Entitlements(_ context.Context, resource *v2.Resource, _ rs.SyncOpAttrs) ([]*v2.Entitlement, *rs.SyncOpResults, error) {
5254
var rv []*v2.Entitlement
5355
assigmentOptions := []entitlement.EntitlementOption{
@@ -60,12 +62,12 @@ func (o *privilegeBuilder) Entitlements(_ context.Context, resource *v2.Resource
6062
return rv, nil, nil
6163
}
6264

63-
// Grants always returns an empty slice for users since they don't have any entitlements.
64-
func (o *privilegeBuilder) Grants(ctx context.Context, resource *v2.Resource, attr rs.SyncOpAttrs) ([]*v2.Grant, *rs.SyncOpResults, error) {
65+
// Grants returns an empty slice. Grants for privileges are emitted when listing collaborator grants.
66+
func (o *privilegeBuilder) Grants(_ context.Context, _ *v2.Resource, _ rs.SyncOpAttrs) ([]*v2.Grant, *rs.SyncOpResults, error) {
6567
return nil, nil, nil
6668
}
6769

68-
func newPrivilegeBuilder(client *client.WorkatoClient, env workato.Environment) *privilegeBuilder {
70+
func newPrivilegeBuilder(client *client.WorkatoClient) *privilegeBuilder {
6971
return &privilegeBuilder{
7072
client: client,
7173
cache: newCollaboratorCache(client),

‎pkg/connector/project.go‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@ package connector
33
import (
44
"context"
55

6+
"github.com/conductorone/baton-sdk/pkg/connectorbuilder"
67
rs "github.com/conductorone/baton-sdk/pkg/types/resource"
78
"github.com/conductorone/baton-workato/pkg/connector/client"
89
"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
910

1011
v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
1112
)
1213

14+
var _ connectorbuilder.ResourceSyncerV2 = (*projectBuilder)(nil)
15+
1316
type projectBuilder struct {
1417
client *client.WorkatoClient
1518
}
@@ -18,8 +21,7 @@ func (o *projectBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
1821
return projectResourceType
1922
}
2023

21-
// List returns all the users from the database as resource objects.
22-
// Users include a UserTrait because they are the 'shape' of a standard user.
24+
// List returns all the projects.
2325
func (o *projectBuilder) List(ctx context.Context, _ *v2.ResourceId, attr rs.SyncOpAttrs) ([]*v2.Resource, *rs.SyncOpResults, error) {
2426
l := ctxzap.Extract(ctx)
2527
l.Debug("Listing projects")
@@ -44,12 +46,12 @@ func (o *projectBuilder) List(ctx context.Context, _ *v2.ResourceId, attr rs.Syn
4446
}, nil
4547
}
4648

47-
// Entitlements always returns an empty slice for users.
49+
// Entitlements returns an empty slice since projects are not assignable.
4850
func (o *projectBuilder) Entitlements(_ context.Context, _ *v2.Resource, _ rs.SyncOpAttrs) ([]*v2.Entitlement, *rs.SyncOpResults, error) {
4951
return nil, nil, nil
5052
}
5153

52-
// Grants always returns an empty slice for users since they don't have any entitlements.
54+
// Grants returns an empty slice since projects are not grantable.
5355
func (o *projectBuilder) Grants(_ context.Context, _ *v2.Resource, _ rs.SyncOpAttrs) ([]*v2.Grant, *rs.SyncOpResults, error) {
5456
return nil, nil, nil
5557
}

‎pkg/connector/role.go‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,8 @@ func (o *roleBuilder) ResourceType(ctx context.Context) *v2.ResourceType {
3838
return roleResourceType
3939
}
4040

41-
// List returns all the users from the database as resource objects.
42-
// Users include a UserTrait because they are the 'shape' of a standard user.
43-
func (o *roleBuilder) List(ctx context.Context, parentResourceID *v2.ResourceId, attr rs.SyncOpAttrs) ([]*v2.Resource, *rs.SyncOpResults, error) {
41+
// List returns all the Workato base roles and custom roles.
42+
func (o *roleBuilder) List(ctx context.Context, _ *v2.ResourceId, attr rs.SyncOpAttrs) ([]*v2.Resource, *rs.SyncOpResults, error) {
4443
l := ctxzap.Extract(ctx)
4544
l.Debug("Listing roles")
4645

@@ -86,8 +85,8 @@ func (o *roleBuilder) List(ctx context.Context, parentResourceID *v2.ResourceId,
8685
}, nil
8786
}
8887

89-
// Entitlements always returns an empty slice for users.
90-
func (o *roleBuilder) Entitlements(_ context.Context, resource *v2.Resource, attr rs.SyncOpAttrs) ([]*v2.Entitlement, *rs.SyncOpResults, error) {
88+
// Entitlements returns an entitlement for the role to be assigned to a collaborator.
89+
func (o *roleBuilder) Entitlements(_ context.Context, resource *v2.Resource, _ rs.SyncOpAttrs) ([]*v2.Entitlement, *rs.SyncOpResults, error) {
9190
var rv []*v2.Entitlement
9291
assigmentOptions := []entitlement.EntitlementOption{
9392
entitlement.WithGrantableTo(collaboratorResourceType),
@@ -99,7 +98,7 @@ func (o *roleBuilder) Entitlements(_ context.Context, resource *v2.Resource, att
9998
return rv, nil, nil
10099
}
101100

102-
// Grants always returns an empty slice for users since they don't have any entitlements.
101+
// Grants returns the privileges granted to a role.
103102
func (o *roleBuilder) Grants(ctx context.Context, resource *v2.Resource, attr rs.SyncOpAttrs) ([]*v2.Grant, *rs.SyncOpResults, error) {
104103
l := ctxzap.Extract(ctx)
105104
rv := make([]*v2.Grant, 0)

0 commit comments

Comments
 (0)