Add new error type MSIDErrorBrokerXpcUnexpectedError for Broker XPC service on Mac

Author: kai

IdentityCore/src/MSIDError.h

@@ -364,6 +364,9 @@ typedef NS_ENUM(NSInteger, MSIDErrorCode)
     // App state while failed to open broker error
     MSIDErrorBrokerAppIsInactive = -51902,
     MSIDErrorBrokerAppIsInBackground = -51903,
+    
+    // Broker Xpc internal error
+    MSIDErrorBrokerXpcUnexpectedError = -52001,
 
 };
 

IdentityCore/src/MSIDError.m

@@ -447,6 +447,9 @@ void MSIDFillAndLogError(NSError **error, MSIDErrorCode errorCode, NSString *err
             return @"MSIDErrorBrokerAppIsInactive";
         case MSIDErrorBrokerAppIsInBackground:
             return @"MSIDErrorBrokerAppIsInBackground";
+            // Broker Xpc internal error
+        case MSIDErrorBrokerXpcUnexpectedError:
+            return @"MSIDErrorBrokerXpcUnexpectedError";
     }
 
     return [NSString stringWithFormat:@"Unknown: %@", @(errorCode)];

IdentityCore/src/controllers/MSIDSilentController.m

@@ -143,8 +143,8 @@ - (void)acquireTokenWithRequest:(MSIDSilentTokenRequest *)request
         self.currentRequest = nil;
         MSIDRequestCompletionBlock completionBlockWrapper = ^(MSIDTokenResult *fallResult, NSError *fallError)
         {
-            // We don't have any meaningful information from fallback controller (edge case of SSO error) so we use the local controller result earlier
-            if (!fallResult && (fallError.code == MSIDErrorSSOExtensionUnexpectedError))
+            // We don't have any meaningful information from fallback controller (edge case of SSO/Xpc error) so we use the local controller result earlier
+            if (!fallResult && (fallError.code == MSIDErrorSSOExtensionUnexpectedError || fallError.code == MSIDErrorBrokerXpcUnexpectedError))
             {
                 completionBlock(result, error);
             }

IdentityCore/src/controllers/broker/mac/MSIDXpcInteractiveTokenRequestController.m

@@ -113,7 +113,7 @@ - (BOOL)shouldFallback:(NSError *)error
         case ASAuthorizationErrorNotHandled:
         case ASAuthorizationErrorUnknown:
         case ASAuthorizationErrorFailed:
-        case MSIDErrorSSOExtensionUnexpectedError:
+        case MSIDErrorBrokerXpcUnexpectedError:
             shouldFallback = YES;
     }
 

IdentityCore/src/util/mac/MSIDXpcSingleSignOnProvider.m

@@ -372,7 +372,7 @@ - (void)getXpcService:(id<MSIDXpcProviderCaching>)xpcProviderCache withContinueB
     if (!xpcProviderCache.xpcConfiguration)
     {
         MSID_LOG_WITH_CTX(MSIDLogLevelWarning, nil, @"[Entra broker] CLIENT - Code should not be triggerred at here", nil, nil);
-        continueBlock(nil, nil, MSIDCreateError(MSIDErrorDomain, MSIDErrorSSOExtensionUnexpectedError, @"[Entra broker] CLIENT - Xpc configuration is not available", nil, nil, nil, nil, nil, YES));
+        continueBlock(nil, nil, MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerXpcUnexpectedError, @"[Entra broker] CLIENT - Xpc configuration is not available", nil, nil, nil, nil, nil, YES));
         return;
     }
 
@@ -399,7 +399,7 @@ - (void)getXpcService:(id<MSIDXpcProviderCaching>)xpcProviderCache withContinueB
     __block BOOL isConnectionErroredOut = NO;
     [connection resume];
     [connection setInterruptionHandler:^{
-        NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorSSOExtensionUnexpectedError, @"[Entra broker] CLIENT -- dispatcher connection is interrupted", nil, nil, nil, nil, nil, YES);
+        NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerXpcUnexpectedError, @"[Entra broker] CLIENT -- dispatcher connection is interrupted", nil, nil, nil, nil, nil, YES);
         if (!isConnectionErroredOut && continueBlock)
         {
             isConnectionErroredOut = YES;
@@ -408,7 +408,7 @@ - (void)getXpcService:(id<MSIDXpcProviderCaching>)xpcProviderCache withContinueB
     }];
 
     [connection setInvalidationHandler:^{
-        NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorSSOExtensionUnexpectedError, @"[Entra broker] CLIENT -- dispatcher connection is invalidated", nil, nil, nil, nil, nil, YES);
+        NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerXpcUnexpectedError, @"[Entra broker] CLIENT -- dispatcher connection is invalidated", nil, nil, nil, nil, nil, YES);
         if (!isConnectionErroredOut && continueBlock)
         {
             isConnectionErroredOut = YES;
@@ -428,7 +428,7 @@ - (void)getXpcService:(id<MSIDXpcProviderCaching>)xpcProviderCache withContinueB
         [connection invalidate];
         if (error)
         {
-            NSError *xpcUnexpectedError = MSIDCreateError(MSIDErrorDomain, MSIDErrorSSOExtensionUnexpectedError, [NSString stringWithFormat:@"[Entra broker] CLIENT - get broker instance endpoint failed: %@", error], nil, nil, nil, nil, nil, YES);
+            NSError *xpcUnexpectedError = MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerXpcUnexpectedError, [NSString stringWithFormat:@"[Entra broker] CLIENT - get broker instance endpoint failed: %@", error], nil, nil, nil, nil, nil, YES);
             if (continueBlock) continueBlock(nil, nil, xpcUnexpectedError);
             return;
         }
@@ -453,12 +453,12 @@ - (void)getXpcService:(id<MSIDXpcProviderCaching>)xpcProviderCache withContinueB
 
         [directConnection resume];
         [directConnection setInterruptionHandler:^{
-            NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorSSOExtensionUnexpectedError, @"[Entra broker] CLIENT -- instance connection is interrupted", nil, nil, nil, nil, nil, YES);
+            NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerXpcUnexpectedError, @"[Entra broker] CLIENT -- instance connection is interrupted", nil, nil, nil, nil, nil, YES);
             if (continueBlock) continueBlock(nil, nil, xpcError);
         }];
 
         [directConnection setInvalidationHandler:^{
-            NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorSSOExtensionUnexpectedError, @"[Entra broker] CLIENT -- instance connection is invalidated", nil, nil, nil, nil, nil, YES);
+            NSError *xpcError = MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerXpcUnexpectedError, @"[Entra broker] CLIENT -- instance connection is invalidated", nil, nil, nil, nil, nil, YES);
             if (continueBlock) continueBlock(nil, nil, xpcError);
         }];