Add more logs in getDeviceInfo flow due to an IcM (#1439)

* Add more logs in getDeviceInfo flow due to an IcM * Address Cr
AzureAD · Feb 4, 2022 · 3749484 · 3749484
1 parent e6e6afc
commit 3749484
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/MSAL/src/MSALPublicClientApplication.m b/MSAL/src/MSALPublicClientApplication.m
@@ -1459,7 +1459,7 @@ - (void)signoutWithAccount:(nonnull MSALAccount *)account
 - (void)getDeviceInformationWithParameters:(MSALParameters *)parameters
                            completionBlock:(MSALDeviceInformationCompletionBlock)completionBlock
 {
-    MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, nil, @"Querying device info");
+    MSID_LOG_WITH_CTX(MSIDLogLevelInfo, nil, @"Querying device info");
 
     __auto_type block = ^(MSALDeviceInformation * _Nullable deviceInformation, NSError * _Nullable msidError)
     {
@@ -1471,7 +1471,7 @@ - (void)getDeviceInformationWithParameters:(MSALParameters *)parameters
         }
         else
         {
-            MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, nil, @"Retrieved device info %@", deviceInformation);
+            MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, nil, @"Retrieved device info %@", MSID_PII_LOG_MASKABLE(deviceInformation));
         }
 
         [MSALPublicClientApplication logOperation:@"getDeviceInformation" result:nil error:msalError context:nil];
@@ -1495,6 +1495,7 @@ - (void)getDeviceInformationWithParameters:(MSALParameters *)parameters
 
     if (!requestParams)
     {
+        MSID_LOG_WITH_CTX_PII(MSIDLogLevelError, nil, @"GetDeviceInfo: Error when creating requestParams: %@", requestParamsError);
         block(nil, requestParamsError);
         return;
     }

diff --git a/MSAL/src/instance/MSALDeviceInfoProvider.m b/MSAL/src/instance/MSALDeviceInfoProvider.m
@@ -53,12 +53,14 @@ - (void)deviceInfoWithRequestParameters:(MSIDRequestParameters *)requestParamete
         {
             [msalDeviceInfo addRegisteredDeviceMetadataInformation:deviceRegMetaDataInfo];
         }
-
+
+        MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, nil, @"GetDeviceInfo: Completing filling device info: %@, error: %@", MSID_PII_LOG_MASKABLE(msalDeviceInfo), MSID_PII_LOG_MASKABLE(error));
         completionBlock(msalDeviceInfo, error);
     };
 
     if (![requestParameters shouldUseBroker])
     {
+        MSID_LOG_WITH_CTX(MSIDLogLevelInfo, requestParameters, @"GetDeviceInfo: Should use broker decision: %i", NO);
         NSError *error = MSIDCreateError(MSIDErrorDomain, MSIDErrorBrokerNotAvailable, @"Broker is not enabled for this operation. Please make sure you have enabled broker support for your application", nil, nil, nil, nil, nil, YES);
         completionBlock(nil, error);
         return;
@@ -69,7 +71,8 @@ - (void)deviceInfoWithRequestParameters:(MSIDRequestParameters *)requestParamete
     {
         canCallSSOExtension = [MSIDSSOExtensionGetDeviceInfoRequest canPerformRequest];
     }
-
+
+    MSID_LOG_WITH_CTX(MSIDLogLevelInfo, requestParameters, @"GetDeviceInfo: Should call Sso Extension decision: %i", canCallSSOExtension);
     if (!canCallSSOExtension)
     {
         MSID_LOG_WITH_CTX(MSIDLogLevelInfo, requestParameters, @"Broker is not present on this device. Defaulting to personal mode");
@@ -81,31 +84,36 @@ - (void)deviceInfoWithRequestParameters:(MSIDRequestParameters *)requestParamete
     if (@available(iOS 13.0, macOS 10.15, *))
     {
         // We are here means canCallSSOExtension is TRUE
+        MSID_LOG_WITH_CTX(MSIDLogLevelVerbose, requestParameters, @"GetDeviceInfo: Creating Sso Extension request");
         NSError *requestError;
         MSIDSSOExtensionGetDeviceInfoRequest *ssoExtensionRequest = [[MSIDSSOExtensionGetDeviceInfoRequest alloc] initWithRequestParameters:requestParameters
                                                                                                                                       error:&requestError];
-
         if (!ssoExtensionRequest)
         {
+            MSID_LOG_WITH_CTX_PII(MSIDLogLevelError, requestParameters, @"GetDeviceInfo: Get error when creating ssoExtensionRequest: %@", MSID_PII_LOG_MASKABLE(requestError));
             completionBlock(nil, requestError);
             return;
         }
 
         if (![self setCurrentSSOExtensionRequest:ssoExtensionRequest])
         {
+            MSID_LOG_WITH_CTX(MSIDLogLevelError, requestParameters, @"GetDeviceInfo: Cannot start Sso Extension as another is in progress");
             NSError *error = MSIDCreateError(MSIDErrorDomain, MSIDErrorInternal, @"Trying to start a get accounts request while one is already executing", nil, nil, nil, nil, nil, YES);
             completionBlock(nil, error);
             return;
         }
 
+        MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, requestParameters, @"GetDeviceInfo: Invoking Sso Extension with ssoExtensionRequest: %@", MSID_PII_LOG_MASKABLE(ssoExtensionRequest));
         [ssoExtensionRequest executeRequestWithCompletion:^(MSIDDeviceInfo * _Nullable deviceInfo, NSError * _Nullable error)
         {
+            MSID_LOG_WITH_CTX_PII(MSIDLogLevelInfo, requestParameters, @"GetDeviceInfo: Receiving results from Sso Extension with device info: %@, error: %@", MSID_PII_LOG_MASKABLE(deviceInfo), MSID_PII_LOG_MASKABLE(error));
             [self copyAndClearCurrentSSOExtensionRequest];
 
             if (!deviceInfo)
             {
                 // We are returing registration details irrespective of failures due to SSO extension request as registration details must have for few clients
                 // Once we identify and fix the intermittent SSO extension issue then we should return either deviceInfo or error
+                MSID_LOG_WITH_CTX_PII(MSIDLogLevelError, nil, @"GetDeviceInfo: Error getting device info: %@", MSID_PII_LOG_MASKABLE(error));
                 fillDeviceInfoCompletionBlock(nil, error);
                 return;
             }