fix: update unexpected error and API Server log error types (#94)

Signed-off-by: Britania Rodriguez Reyes <britaniar@microsoft.com>

Author: britaniar

pkg/utils/controller/controller.go

@@ -87,6 +87,8 @@ func NewExpectedBehaviorError(err error) error {
 // NewAPIServerError returns error types when accessing data from cache or API server.
 func NewAPIServerError(fromCache bool, err error) error {
 	if err != nil {
+		// The func may return other unexpected runtime errors other than API server errors.
+		// https://github.com/kubernetes-sigs/controller-runtime/blob/main/pkg/client/client.go#L334-L339
 		if fromCache && isUnexpectedCacheError(err) {
 			return NewUnexpectedBehaviorError(err)
 		}
@@ -98,8 +100,9 @@ func NewAPIServerError(fromCache bool, err error) error {
 
 func isUnexpectedCacheError(err error) bool {
 	// may need to add more error code based on the production
-	// Cache will return notFound for GET.
-	return !apierrors.IsNotFound(err)
+	// When the cache is missed, it will query API server and return API server errors.
+	var statusErr *apierrors.StatusError
+	return !errors.Is(err, context.Canceled) && !errors.As(err, &statusErr) && !errors.Is(err, context.DeadlineExceeded)
 }
 
 // NewUserError returns ErrUserError type error when err is not nil.

pkg/utils/controller/controller_test.go

@@ -111,10 +111,10 @@ func TestNewAPIServerError(t *testing.T) {
 			wantErr:   ErrAPIServerError,
 		},
 		{
-			name:      "reading from cache: unexpectedBehaviorError",
+			name:      "reading from cache: apiServerError",
 			fromCache: true,
 			err:       apierrors.NewConflict(schema.GroupResource{}, "conflict", nil),
-			wantErr:   ErrUnexpectedBehavior,
+			wantErr:   ErrAPIServerError,
 		},
 		{
 			name:      "reading from API server: apiServerError",
@@ -128,6 +128,36 @@ func TestNewAPIServerError(t *testing.T) {
 			err:       apierrors.NewConflict(schema.GroupResource{}, "conflict", nil),
 			wantErr:   ErrAPIServerError,
 		},
+		{
+			name:      "reading from API server: context canceled",
+			fromCache: false,
+			err:       fmt.Errorf("client rate limiter Wait returned an error: %w", context.Canceled),
+			wantErr:   ErrAPIServerError,
+		},
+		{
+			name:      "reading from API server: deadline exceeded",
+			fromCache: false,
+			err:       fmt.Errorf("client rate limiter Wait returned an error: %w", context.DeadlineExceeded),
+			wantErr:   ErrAPIServerError,
+		},
+		{
+			name:      "reading from cache: context canceled",
+			fromCache: true,
+			err:       fmt.Errorf("client rate limiter Wait returned an error: %w", context.Canceled),
+			wantErr:   ErrAPIServerError,
+		},
+		{
+			name:      "reading from cache: deadline exceeded",
+			fromCache: true,
+			err:       fmt.Errorf("client rate limiter Wait returned an error: %w", context.DeadlineExceeded),
+			wantErr:   ErrAPIServerError,
+		},
+		{
+			name:      "reading from cache: missing kind error",
+			fromCache: true,
+			err:       runtime.NewMissingKindErr("unstructured object has no kind"),
+			wantErr:   ErrUnexpectedBehavior,
+		},
 	}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {