Fail sync if we have >10 warnings and >10% of actions have resulted in a warning. (#570)

Author: ggreer

pkg/sync/state.go

@@ -36,6 +36,7 @@ type State interface {
 	SetShouldSkipEntitlementsAndGrants()
 	ShouldSkipGrants() bool
 	SetShouldSkipGrants()
+	GetCompletedActionsCount() uint64
 }
 
 // ActionOp represents a sync operation.
@@ -156,6 +157,7 @@ type state struct {
 	shouldFetchRelatedResources     bool
 	shouldSkipEntitlementsAndGrants bool
 	shouldSkipGrants                bool
+	completedActionsCount           uint64
 }
 
 // serializedToken is used to serialize the token to JSON. This separate object is used to avoid having exported fields
@@ -169,7 +171,7 @@ type serializedToken struct {
 	ShouldFetchRelatedResources     bool                     `json:"should_fetch_related_resources,omitempty"`
 	ShouldSkipEntitlementsAndGrants bool                     `json:"should_skip_entitlements_and_grants,omitempty"`
 	ShouldSkipGrants                bool                     `json:"should_skip_grants,omitempty"`
-	ShouldSkipEntitlements          bool                     `json:"should_skip_entitlements,omitempty"`
+	CompletedActionsCount           uint64                   `json:"completed_actions_count,omitempty"`
 }
 
 // push adds a new action to the stack. If there is no current state, the action is directly set to current, else
@@ -197,6 +199,7 @@ func (st *state) pop() *Action {
 	}
 
 	ret := *st.currentAction
+	st.completedActionsCount++
 
 	if len(st.actions) > 0 {
 		st.currentAction = &st.actions[len(st.actions)-1]
@@ -243,10 +246,12 @@ func (st *state) Unmarshal(input string) error {
 		st.shouldSkipEntitlementsAndGrants = token.ShouldSkipEntitlementsAndGrants
 		st.shouldSkipGrants = token.ShouldSkipGrants
 		st.shouldFetchRelatedResources = token.ShouldFetchRelatedResources
+		st.completedActionsCount = token.CompletedActionsCount
 	} else {
 		st.actions = nil
 		st.entitlementGraph = nil
 		st.currentAction = &Action{Op: InitOp}
+		st.completedActionsCount = 0
 	}
 
 	return nil
@@ -266,6 +271,7 @@ func (st *state) Marshal() (string, error) {
 		ShouldFetchRelatedResources:     st.shouldFetchRelatedResources,
 		ShouldSkipEntitlementsAndGrants: st.shouldSkipEntitlementsAndGrants,
 		ShouldSkipGrants:                st.shouldSkipGrants,
+		CompletedActionsCount:           st.completedActionsCount,
 	})
 	if err != nil {
 		return "", err
@@ -406,3 +412,9 @@ func (st *state) ParentResourceTypeID(ctx context.Context) string {
 
 	return c.ParentResourceTypeID
 }
+
+func (st *state) GetCompletedActionsCount() uint64 {
+	st.mtx.RLock()
+	defer st.mtx.RUnlock()
+	return st.completedActionsCount
+}

pkg/sync/syncer.go

@@ -475,9 +475,12 @@ func (s *syncer) Sync(ctx context.Context) error {
 			return err
 		}
 
-		// TODO: count actions divided by warnings and error if warning percentage is too high
+		// If we have more than 10 warnings and more than 10% of actions ended in a warning, exit the sync.
 		if len(warnings) > 10 {
-			return fmt.Errorf("too many warnings, exiting sync. warnings: %v", warnings)
+			completedActionsCount := s.state.GetCompletedActionsCount()
+			if completedActionsCount > 0 && float64(len(warnings))/float64(completedActionsCount) > 0.1 {
+				return fmt.Errorf("too many warnings, exiting sync. warnings: %v completed actions: %d", warnings, completedActionsCount)
+			}
 		}
 		select {
 		case <-runCtx.Done():