Merge pull request #15 from ConductorOne/ggreer/skip-disabled-users

Add command line flag to skip syncing disabled users.

cmd/baton-retool/config.go

@@ -11,9 +11,10 @@ import (
 type config struct {
 	cli.BaseConfig `mapstructure:",squash"` // Puts the base config options in the same place as the connector options
 
-	ConnectionString string `mapstructure:"connection-string"`
-	SkipPages        bool   `mapstructure:"skip-pages"`
-	SkipResources    bool   `mapstructure:"skip-resources"`
+	ConnectionString  string `mapstructure:"connection-string"`
+	SkipPages         bool   `mapstructure:"skip-pages"`
+	SkipResources     bool   `mapstructure:"skip-resources"`
+	SkipDisabledUsers bool   `mapstructure:"skip-disabled-users"`
 }
 
 // validateConfig is run after the configuration is loaded, and should return an error if it isn't valid.

cmd/baton-retool/main.go

@@ -36,6 +36,7 @@ func main() {
 
 	cmd.PersistentFlags().Bool("skip-pages", false, "Skip syncing pages")
 	cmd.PersistentFlags().Bool("skip-resources", false, "Skip syncing resources")
+	cmd.PersistentFlags().Bool("skip-disabled-users", false, "Skip syncing disabled users")
 
 	err = cmd.Execute()
 	if err != nil {
@@ -47,7 +48,7 @@ func main() {
 func getConnector(ctx context.Context, cfg *config) (types.ConnectorServer, error) {
 	l := ctxzap.Extract(ctx)
 
-	cb, err := connector.New(ctx, cfg.ConnectionString, cfg.SkipPages, cfg.SkipResources)
+	cb, err := connector.New(ctx, cfg.ConnectionString, cfg.SkipPages, cfg.SkipResources, cfg.SkipDisabledUsers)
 	if err != nil {
 		l.Error("error creating connector builder", zap.Error(err))
 		return nil, err

go.mod

@@ -3,7 +3,7 @@ module github.com/conductorone/baton-retool
 go 1.20
 
 require (
-	github.com/conductorone/baton-sdk v0.1.21
+	github.com/conductorone/baton-sdk v0.1.22
 	github.com/georgysavva/scany v1.2.1
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
 	github.com/jackc/pgx/v4 v4.18.1

go.sum

@@ -55,8 +55,8 @@ github.com/cockroachdb/apd v1.1.0 h1:3LFP3629v+1aKXU5Q37mxmRxX/pIu1nijXydLShEq5I
 github.com/cockroachdb/apd v1.1.0/go.mod h1:8Sl8LxpKi29FqWXR16WEFZRNSz3SoPzUzeMeY4+DwBQ=
 github.com/cockroachdb/cockroach-go/v2 v2.2.0 h1:/5znzg5n373N/3ESjHF5SMLxiW4RKB05Ql//KWfeTFs=
 github.com/cockroachdb/cockroach-go/v2 v2.2.0/go.mod h1:u3MiKYGupPPjkn3ozknpMUpxPaNLTFWAya419/zv6eI=
-github.com/conductorone/baton-sdk v0.1.21 h1:lFNAtBi/XUzhEfNMA/4LnvaVYbWHpy4PZz4kFMZMKDw=
-github.com/conductorone/baton-sdk v0.1.21/go.mod h1:1VMycIep+HU8JXef2wenT3ECzx1w3Jr3KDQG+L6Mv30=
+github.com/conductorone/baton-sdk v0.1.22 h1:9IX0q8oPVfuHyvXdLbxCRGgqhjp/SqGv8T1RbiM1Tps=
+github.com/conductorone/baton-sdk v0.1.22/go.mod h1:1VMycIep+HU8JXef2wenT3ECzx1w3Jr3KDQG+L6Mv30=
 github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
 github.com/coreos/go-systemd v0.0.0-20190719114852-fd7a80b32e1f/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=

pkg/client/group.go

@@ -66,6 +66,7 @@ type GroupMember struct {
 	UserID  *int64 `db:"userId"`
 	GroupID *int64 `db:"groupId"`
 	IsAdmin bool   `db:"isAdmin"`
+	Enabled bool   `db:"enabled"`
 }
 
 func (g *GroupMember) GetUserID() int64 {
@@ -152,7 +153,7 @@ func (c *Client) GetGroupResourceFolderDefault(ctx context.Context, groupID int6
 	return &ret, nil
 }
 
-func (c *Client) ListGroupMembers(ctx context.Context, groupID int64, pager *Pager) ([]*GroupMember, string, error) {
+func (c *Client) ListGroupMembers(ctx context.Context, groupID int64, pager *Pager, skipDisabledUsers bool) ([]*GroupMember, string, error) {
 	l := ctxzap.Extract(ctx)
 	l.Debug("listing group members for group", zap.Int64("group_id", groupID))
 
@@ -165,7 +166,12 @@ func (c *Client) ListGroupMembers(ctx context.Context, groupID int64, pager *Pag
 	args = append(args, groupID)
 
 	sb := &strings.Builder{}
-	_, _ = sb.WriteString(`select "id", "userId", "groupId", "isAdmin" from user_groups WHERE "groupId"=$1 ORDER BY "id" `)
+	if skipDisabledUsers {
+		_, _ = sb.WriteString(`select user_groups.id as id, "userId", "groupId", "isAdmin", users.enabled from user_groups
+		 INNER JOIN users ON users.id = "user_groups"."userId" WHERE "groupId"=$1 and users.enabled = true ORDER BY "id" `)
+	} else {
+		_, _ = sb.WriteString(`select "id", "userId", "groupId", "isAdmin" from user_groups WHERE "groupId"=$1 ORDER BY "id" `)
+	}
 
 	args = append(args, limit+1)
 	_, _ = sb.WriteString(fmt.Sprintf("LIMIT $%d ", len(args)))

pkg/client/pagination.go

@@ -5,7 +5,7 @@ import (
 )
 
 const (
-	MaxPageSize = 100
+	MaxPageSize = 250
 	MinPageSize = 10
 )
 

pkg/client/user.go

@@ -65,7 +65,7 @@ func (u *UserModel) GetLastLoggedIn() time.Time {
 	return time.Time{}
 }
 
-func (c *Client) ListUsersForOrg(ctx context.Context, orgID int64, pager *Pager) ([]*UserModel, string, error) {
+func (c *Client) ListUsersForOrg(ctx context.Context, orgID int64, pager *Pager, skipDisabledUsers bool) ([]*UserModel, string, error) {
 	l := ctxzap.Extract(ctx)
 	l.Debug("listing users for org", zap.Int64("org_id", orgID))
 
@@ -78,6 +78,9 @@ func (c *Client) ListUsersForOrg(ctx context.Context, orgID int64, pager *Pager)
 	sb := &strings.Builder{}
 	_, _ = sb.WriteString(`SELECT "id", "email", "firstName", "lastName", "profilePhotoUrl", "enabled", "userName", "organizationId", "lastLoggedIn" from users WHERE "organizationId"=$1 `)
 	args = append(args, orgID)
+	if skipDisabledUsers {
+		_, _ = sb.WriteString("AND enabled = true ")
+	}
 	_, _ = sb.WriteString(`ORDER BY "id" `)
 	_, _ = sb.WriteString("LIMIT $2 ")
 	args = append(args, limit+1)

pkg/connector/connector.go

@@ -20,9 +20,10 @@ func titleCase(s string) string {
 }
 
 type ConnectorImpl struct {
-	client        *client.Client
-	skipPages     bool
-	skipResources bool
+	client            *client.Client
+	skipPages         bool
+	skipResources     bool
+	skipDisabledUsers bool
 }
 
 func (c *ConnectorImpl) Metadata(ctx context.Context) (*v2.ConnectorMetadata, error) {
@@ -46,31 +47,32 @@ func (c *ConnectorImpl) Asset(ctx context.Context, asset *v2.AssetRef) (string,
 
 func (c *ConnectorImpl) ResourceSyncers(ctx context.Context) []connectorbuilder.ResourceSyncer {
 	syncers := []connectorbuilder.ResourceSyncer{
-		newOrgSyncer(ctx, c.client, c.skipPages, c.skipResources),
-		newUserSyncer(ctx, c.client),
-		newGroupSyncer(ctx, c.client),
+		newOrgSyncer(ctx, c.client, c.skipPages, c.skipResources, c.skipDisabledUsers),
+		newUserSyncer(ctx, c.client, c.skipDisabledUsers),
+		newGroupSyncer(ctx, c.client, c.skipDisabledUsers),
 	}
 
 	if !c.skipPages {
-		syncers = append(syncers, newPageSyncer(ctx, c.client))
+		syncers = append(syncers, newPageSyncer(ctx, c.client, c.skipDisabledUsers))
 	}
 
 	if !c.skipResources {
-		syncers = append(syncers, newResourceSyncer(ctx, c.client))
+		syncers = append(syncers, newResourceSyncer(ctx, c.client, c.skipDisabledUsers))
 	}
 
 	return syncers
 }
 
-func New(ctx context.Context, dsn string, skipPages bool, skipResources bool) (*ConnectorImpl, error) {
+func New(ctx context.Context, dsn string, skipPages bool, skipResources bool, skipDisabledUsers bool) (*ConnectorImpl, error) {
 	c, err := client.New(ctx, dsn)
 	if err != nil {
 		return nil, err
 	}
 
 	return &ConnectorImpl{
-		client:        c,
-		skipPages:     skipPages,
-		skipResources: skipResources,
+		client:            c,
+		skipPages:         skipPages,
+		skipResources:     skipResources,
+		skipDisabledUsers: skipDisabledUsers,
 	}, nil
 }

pkg/connector/groups.go

@@ -33,8 +33,9 @@ func memberEntitlementId(groupID *v2.ResourceId) string {
 }
 
 type groupSyncer struct {
-	resourceType *v2.ResourceType
-	client       *client.Client
+	resourceType      *v2.ResourceType
+	client            *client.Client
+	skipDisabledUsers bool
 }
 
 func (s *groupSyncer) ResourceType(ctx context.Context) *v2.ResourceType {
@@ -131,7 +132,7 @@ func (s *groupSyncer) Grants(ctx context.Context, resource *v2.Resource, pToken
 		return nil, "", nil, err
 	}
 
-	members, nextPageToken, err := s.client.ListGroupMembers(ctx, groupID, &client.Pager{Token: pToken.Token, Size: pToken.Size})
+	members, nextPageToken, err := s.client.ListGroupMembers(ctx, groupID, &client.Pager{Token: pToken.Token, Size: pToken.Size}, s.skipDisabledUsers)
 	if err != nil {
 		return nil, "", nil, err
 	}
@@ -246,9 +247,10 @@ func (o *groupSyncer) Revoke(ctx context.Context, grant *v2.Grant) (annotations.
 	return nil, nil
 }
 
-func newGroupSyncer(ctx context.Context, c *client.Client) *groupSyncer {
+func newGroupSyncer(ctx context.Context, c *client.Client, skipDisabledUsers bool) *groupSyncer {
 	return &groupSyncer{
-		resourceType: resourceTypeGroup,
-		client:       c,
+		resourceType:      resourceTypeGroup,
+		client:            c,
+		skipDisabledUsers: skipDisabledUsers,
 	}
 }

pkg/connector/organizations.go

@@ -20,10 +20,11 @@ var resourceTypeOrg = &v2.ResourceType{
 }
 
 type orgSyncer struct {
-	resourceType  *v2.ResourceType
-	client        *client.Client
-	skipPages     bool
-	skipResources bool
+	resourceType      *v2.ResourceType
+	client            *client.Client
+	skipPages         bool
+	skipResources     bool
+	skipDisabledUsers bool
 }
 
 func (s *orgSyncer) ResourceType(ctx context.Context) *v2.ResourceType {
@@ -245,7 +246,7 @@ func (s *orgSyncer) Grants(ctx context.Context, resource *v2.Resource, pToken *p
 			return nil, "", nil, err
 		}
 
-		members, nextPageToken, err := s.client.ListGroupMembers(ctx, g.ID, &client.Pager{Token: bag.PageToken(), Size: pToken.Size})
+		members, nextPageToken, err := s.client.ListGroupMembers(ctx, g.ID, &client.Pager{Token: bag.PageToken(), Size: pToken.Size}, s.skipDisabledUsers)
 		if err != nil {
 			return nil, "", nil, err
 		}
@@ -281,11 +282,12 @@ func (s *orgSyncer) Grants(ctx context.Context, resource *v2.Resource, pToken *p
 	return ret, nextPageToken, nil, nil
 }
 
-func newOrgSyncer(ctx context.Context, c *client.Client, skipPages bool, skipResources bool) *orgSyncer {
+func newOrgSyncer(ctx context.Context, c *client.Client, skipPages bool, skipResources bool, skipDisabledUsers bool) *orgSyncer {
 	return &orgSyncer{
-		resourceType:  resourceTypeOrg,
-		client:        c,
-		skipPages:     skipPages,
-		skipResources: skipResources,
+		resourceType:      resourceTypeOrg,
+		client:            c,
+		skipPages:         skipPages,
+		skipResources:     skipResources,
+		skipDisabledUsers: skipDisabledUsers,
 	}
 }

pkg/connector/pages.go

@@ -18,8 +18,9 @@ var resourceTypePage = &v2.ResourceType{
 }
 
 type pageSyncer struct {
-	resourceType *v2.ResourceType
-	client       *client.Client
+	resourceType      *v2.ResourceType
+	client            *client.Client
+	skipDisabledUsers bool
 }
 
 func (s *pageSyncer) ResourceType(ctx context.Context) *v2.ResourceType {
@@ -163,7 +164,7 @@ func (s *pageSyncer) Grants(ctx context.Context, resource *v2.Resource, pToken *
 			return nil, "", nil, err
 		}
 
-		members, nextPageToken, err := s.client.ListGroupMembers(ctx, group.ID, &client.Pager{Token: bag.PageToken(), Size: pToken.Size})
+		members, nextPageToken, err := s.client.ListGroupMembers(ctx, group.ID, &client.Pager{Token: bag.PageToken(), Size: pToken.Size}, s.skipDisabledUsers)
 		if err != nil {
 			return nil, "", nil, err
 		}
@@ -216,9 +217,10 @@ func (s *pageSyncer) Grants(ctx context.Context, resource *v2.Resource, pToken *
 	return ret, nextPageToken, nil, nil
 }
 
-func newPageSyncer(ctx context.Context, c *client.Client) *pageSyncer {
+func newPageSyncer(ctx context.Context, c *client.Client, skipDisabledUsers bool) *pageSyncer {
 	return &pageSyncer{
-		resourceType: resourceTypePage,
-		client:       c,
+		resourceType:      resourceTypePage,
+		client:            c,
+		skipDisabledUsers: skipDisabledUsers,
 	}
 }

pkg/connector/resources.go

@@ -19,8 +19,9 @@ var resourceTypeResource = &v2.ResourceType{
 }
 
 type resourceSyncer struct {
-	resourceType *v2.ResourceType
-	client       *client.Client
+	resourceType      *v2.ResourceType
+	client            *client.Client
+	skipDisabledUsers bool
 }
 
 func (s *resourceSyncer) ResourceType(ctx context.Context) *v2.ResourceType {
@@ -166,7 +167,7 @@ func (s *resourceSyncer) Grants(ctx context.Context, resource *v2.Resource, pTok
 			return nil, "", nil, err
 		}
 
-		members, nextPageToken, err := s.client.ListGroupMembers(ctx, group.ID, &client.Pager{Token: bag.PageToken(), Size: pToken.Size})
+		members, nextPageToken, err := s.client.ListGroupMembers(ctx, group.ID, &client.Pager{Token: bag.PageToken(), Size: pToken.Size}, s.skipDisabledUsers)
 		if err != nil {
 			return nil, "", nil, err
 		}
@@ -219,9 +220,10 @@ func (s *resourceSyncer) Grants(ctx context.Context, resource *v2.Resource, pTok
 	return ret, nextPageToken, nil, nil
 }
 
-func newResourceSyncer(ctx context.Context, c *client.Client) *resourceSyncer {
+func newResourceSyncer(ctx context.Context, c *client.Client, skipDisabledUsers bool) *resourceSyncer {
 	return &resourceSyncer{
-		resourceType: resourceTypeResource,
-		client:       c,
+		resourceType:      resourceTypeResource,
+		client:            c,
+		skipDisabledUsers: skipDisabledUsers,
 	}
 }

pkg/connector/users.go

@@ -20,8 +20,9 @@ var resourceTypeUser = &v2.ResourceType{
 }
 
 type userSyncer struct {
-	resourceType *v2.ResourceType
-	client       *client.Client
+	resourceType      *v2.ResourceType
+	client            *client.Client
+	skipDisabledUsers bool
 }
 
 func (s *userSyncer) ResourceType(ctx context.Context) *v2.ResourceType {
@@ -42,7 +43,7 @@ func (s *userSyncer) List(
 		return nil, "", nil, err
 	}
 
-	users, nextPageToken, err := s.client.ListUsersForOrg(ctx, orgID, &client.Pager{Token: pToken.Token, Size: pToken.Size})
+	users, nextPageToken, err := s.client.ListUsersForOrg(ctx, orgID, &client.Pager{Token: pToken.Token, Size: pToken.Size}, s.skipDisabledUsers)
 	if err != nil {
 		return nil, "", nil, err
 	}
@@ -96,9 +97,10 @@ func (s *userSyncer) Grants(ctx context.Context, resource *v2.Resource, pToken *
 	return nil, "", nil, nil
 }
 
-func newUserSyncer(ctx context.Context, c *client.Client) *userSyncer {
+func newUserSyncer(ctx context.Context, c *client.Client, skipDisabledUsers bool) *userSyncer {
 	return &userSyncer{
-		resourceType: resourceTypeUser,
-		client:       c,
+		resourceType:      resourceTypeUser,
+		client:            c,
+		skipDisabledUsers: skipDisabledUsers,
 	}
 }