Merge pull request #2693 from AzureAD/release/2.4.0

swasti29 · web-flow · commit c38402fabcd6 · 2025-09-08T16:58:55.000-07:00
release 2.4.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## [2.4.0]
+* Prevent double conversion of MSALInternal error #2688
+
 ## [2.3.0]
 * Fix automation tests (#2673)
 
diff --git a/MSAL.podspec b/MSAL.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "MSAL"
-  s.version      = "2.3.0"
+  s.version      = "2.4.0"
   s.summary      = "Microsoft Authentication Library (MSAL) for iOS"
   s.description  = <<-DESC
                    The MSAL library for iOS gives your app the ability to begin using the Microsoft Cloud by supporting Microsoft Azure Active Directory and Microsoft Accounts in a converged experience using industry standard OAuth2 and OpenID Connect. The library also supports Microsoft Azure B2C for those using our hosted identity management service.
diff --git a/MSAL/IdentityCore b/MSAL/IdentityCore
@@ -1 +1 @@
-Subproject commit cf9450cfece2868ac63e8c6089494561d9afc778
+Subproject commit 5f27cd7c598ebcc40fcf30b15f5ef15dc7abfa5e
diff --git a/MSAL/resources/ios/Info.plist b/MSAL/resources/ios/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.3.0</string>
+	<string>2.4.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSPrincipalClass</key>
diff --git a/MSAL/resources/mac/Info.plist b/MSAL/resources/mac/Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.3.0</string>
+	<string>2.4.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>
diff --git a/MSAL/src/MSALErrorConverter.m b/MSAL/src/MSALErrorConverter.m
@@ -238,13 +238,18 @@ + (NSError *)errorWithDomain:(NSString *)domain
     else if ([domain isEqualToString:MSALErrorDomain])
     {
         mappedCode = @(code);
+        internalCode = userInfo[MSALInternalErrorCodeKey];
     }
     
     if (shouldClassifyErrors && mappedCode != nil && ![s_recoverableErrorCode containsObject:mappedCode])
     {
-        // If mapped code is MSALErrorInternal, set internalCode to MSALInternalErrorUnexpected
-        // to avoid the case when both mapped and internal code are MSALErrorInternal.
-        internalCode = [mappedCode isEqual:@(MSALErrorInternal)] ? @(MSALInternalErrorUnexpected) : mappedCode;
+        if (!internalCode)
+        {
+            // If mapped code is MSALErrorInternal, set internalCode to MSALInternalErrorUnexpected
+            // to avoid the case when both mapped and internal code are MSALErrorInternal.
+            internalCode = [mappedCode isEqual:@(MSALErrorInternal)] ? @(MSALInternalErrorUnexpected) : mappedCode;
+        }
+        
         mappedCode = @(MSALErrorInternal);
     }
     
diff --git a/MSAL/src/MSAL_Internal.h b/MSAL/src/MSAL_Internal.h
@@ -26,7 +26,7 @@
 //------------------------------------------------------------------------------
 
 #define MSAL_VER_HIGH       2
-#define MSAL_VER_LOW        3
+#define MSAL_VER_LOW        4
 #define MSAL_VER_PATCH      0
 
 #define STR_HELPER(x) #x
diff --git a/MSAL/test/automation/tests/MSALBaseUITest.m b/MSAL/test/automation/tests/MSALBaseUITest.m
@@ -239,7 +239,7 @@ - (void)closeAuthUIUsingWebViewType:(MSIDWebviewType)webViewType
             // We take the first one and force tap it, for some reason tap doesn't work
             XCUIElement *firstButton = [elementQuery elementBoundByIndex:0];
             
-            __auto_type coordinate = [firstButton coordinateWithNormalizedOffset:CGVectorMake(0, 0)];
+            __auto_type coordinate = [firstButton coordinateWithNormalizedOffset:CGVectorMake(1, 1)];
             [coordinate tap];
         }
         else
diff --git a/MSAL/test/automation/tests/interactive/MSALADFSv4FederatedTests.m b/MSAL/test/automation/tests/interactive/MSALADFSv4FederatedTests.m
@@ -58,6 +58,7 @@ - (void)setUp
 
 #pragma mark - Tests
 
+#ifdef FEDERATION_TESTS_ENABLED
 - (void)testInteractiveADFSv4Login_withPromptAlways_noLoginHint_andSystemWebView
 {
     MSIDAutomationTestRequest *request = [self.class.confProvider defaultAppRequest:self.testEnvironment targetTenantId:self.primaryAccount.targetTenantId];
@@ -107,5 +108,6 @@ - (void)testInteractiveADFSv4Login_withPromptAlways_withLoginHint_andEmbeddedWeb
     NSString *homeAccountId = [self runSharedADFSInteractiveLoginWithRequest:request];
     XCTAssertNotNil(homeAccountId);
 }
+#endif // FEDERATION_TESTS_ENABLED
 
 @end
diff --git a/MSAL/test/automation/tests/interactive/MSALGuestUserTests.m b/MSAL/test/automation/tests/interactive/MSALGuestUserTests.m
@@ -57,6 +57,7 @@ - (void)setUp
     [self loadTestAccount:accountConfigurationRequest];
 }
 
+#ifdef FEDERATION_TESTS_ENABLED
 // #347620
 - (void)testInteractiveAndSilentAADLogin_withNonConvergedApp_withPromptAlways_noLoginHint_SystemWebView_signinIntoGuestTenantFirst
 {
@@ -160,6 +161,7 @@ - (void)testInteractiveAndSilentAADLogin_withConvergedApp_withPromptAlways_noLog
     homeRequest.homeAccountIdentifier = homeAccountId;
     [self runSharedSilentAADLoginWithTestRequest:homeRequest];
 }
+#endif // FEDERATION_TESTS_ENABLED
 
 - (NSString *)runSharedGuestInteractiveLoginWithRequest:(MSIDAutomationTestRequest *)request
                                         closeResultView:(BOOL)closeResultView
diff --git a/MSAL/test/unit/MSALErrorConverterTests.m b/MSAL/test/unit/MSALErrorConverterTests.m
@@ -588,4 +588,35 @@ - (MSALAuthenticationSchemePop *) generateAuthSchemePopInstance
     return authScheme;
 }
 
+- (void)testErrorConversion_whenInternalMSALErrorPassed_shouldNotDoDoubleConversion
+{
+    NSInteger errorCode = MSALErrorInternal;
+    NSString *errorDescription = @"a fake error description.";
+    NSString *oauthError = @"a fake oauth error message.";
+    NSString *subError = @"a fake suberror";
+    
+    NSError *msalError = [MSALErrorConverter errorWithDomain:MSALErrorDomain
+                                                        code:errorCode
+                                            errorDescription:errorDescription
+                                                  oauthError:oauthError
+                                                    subError:subError
+                                             underlyingError:nil
+                                               correlationId:nil
+                                                    userInfo:@{MSALInternalErrorCodeKey: @(MSALInternalErrorInvalidClient)}
+                                              classifyErrors:YES
+                                          msalOauth2Provider:nil
+                                                  authScheme:[MSALAuthenticationSchemeBearer new]
+                                                  popManager:nil];
+    
+    NSString *expectedErrorDomain = MSALErrorDomain;
+    XCTAssertNotNil(msalError);
+    XCTAssertEqualObjects(msalError.domain, expectedErrorDomain);
+    XCTAssertEqual(msalError.code, MSALErrorInternal);
+    XCTAssertEqualObjects(msalError.userInfo[MSALErrorDescriptionKey], errorDescription);
+    XCTAssertEqualObjects(msalError.userInfo[MSALOAuthErrorKey], oauthError);
+    XCTAssertEqualObjects(msalError.userInfo[MSALOAuthSubErrorKey], subError);
+    XCTAssertEqualObjects(msalError.userInfo[MSALInternalErrorCodeKey], @(MSALInternalErrorInvalidClient));
+    XCTAssertFalse([msalError.userInfo.allKeys containsObject: MSALSTSErrorCodesKey]);
+}
+
 @end
diff --git a/build.py b/build.py
@@ -36,7 +36,7 @@
 script_start_time = timer()
 
 ios_sim_device_type = "iPhone 15"
-ios_sim_device_exact_name = ios_sim_device_type + " Simulator \(17.5\)"
+ios_sim_device_exact_name = ios_sim_device_type + " Simulator \\(17.5\\)"
 ios_sim_dest = "-destination 'platform=iOS Simulator,name=" + ios_sim_device_type + ",OS=17.5'"
 ios_sim_flags = "-sdk iphonesimulator CODE_SIGN_IDENTITY=\"\" CODE_SIGNING_REQUIRED=NO"
 
@@ -144,6 +144,8 @@ def __init__(self, target):
 		self.skipped = False
 		self.start_time = None
 		self.end_time = None
+		self.linter = target.get("linter", "swiftlint")
+		self.directory = target.get("directory", ".")
 	
 	def xcodebuild_command(self, operation, xcpretty) :
 		"""
@@ -184,7 +186,7 @@ def xcodebuild_command(self, operation, xcpretty) :
 		if (xcpretty) :
 			command += " | xcpretty"
 		if (xcpretty and operation == "test") :
-			command += " --report junit --output ./build/reports/'" + target.name + ".xml'"
+			command += " --report junit --output ./build/reports/'" + self.name + ".xml'"
 		
 		return command
 	
@@ -275,7 +277,7 @@ def get_device_guid(self) :
 		if (self.platform == "Mac") :
 			return device_guids.get_mac().decode(sys.stdout.encoding)
 		
-		raise Exception("Unsupported platform: \"" + "\", valid platforms are \"iOS\", \"visionOS\", and \"Mac\"")
+		raise Exception("Unsupported platform: \"" + self.platform + "\", valid platforms are \"iOS\", \"visionOS\", and \"Mac\"")
 
 	def do_lint(self) :
 		if (self.linter != "swiftlint") :
@@ -360,7 +362,7 @@ def do_operation(self, operation) :
 
 		print_operation_end(self.name, operation, exit_code, start_time)
 		
-		print 
+		print()
 		return exit_code
 	
 	def requires_simulator(self) :
@@ -389,7 +391,7 @@ def launch_simulator(targets) :
             print(command)
             break
     print(command)
-	# This spawns a new process without us having to wait for it
+    # This spawns a new process without us having to wait for it
     subprocess.Popen(command, shell = True)
 
 clean = True

Original file line number	Diff line number	Diff line change
`@@ -238,13 +238,18 @@ + (NSError )errorWithDomain:(NSString )domain`
`238`	`238`	`else if ([domain isEqualToString:MSALErrorDomain])`
`239`	`239`	`{`
`240`	`240`	`mappedCode = @(code);`
	`241`	`+ internalCode = userInfo[MSALInternalErrorCodeKey];`
`241`	`242`	`}`
`242`	`243`
`243`	`244`	`if (shouldClassifyErrors && mappedCode != nil && ![s_recoverableErrorCode containsObject:mappedCode])`
`244`	`245`	`{`
`245`		`- // If mapped code is MSALErrorInternal, set internalCode to MSALInternalErrorUnexpected`
`246`		`- // to avoid the case when both mapped and internal code are MSALErrorInternal.`
`247`		`- internalCode = [mappedCode isEqual:@(MSALErrorInternal)] ? @(MSALInternalErrorUnexpected) : mappedCode;`
	`246`	`+ if (!internalCode)`
	`247`	`+ {`
	`248`	`+ // If mapped code is MSALErrorInternal, set internalCode to MSALInternalErrorUnexpected`
	`249`	`+ // to avoid the case when both mapped and internal code are MSALErrorInternal.`
	`250`	`+ internalCode = [mappedCode isEqual:@(MSALErrorInternal)] ? @(MSALInternalErrorUnexpected) : mappedCode;`
	`251`	`+ }`
	`252`	`+`
`248`	`253`	`mappedCode = @(MSALErrorInternal);`
`249`	`254`	`}`
`250`	`255`
Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,7 @@ - (void)closeAuthUIUsingWebViewType:(MSIDWebviewType)webViewType`
`239`	`239`	`// We take the first one and force tap it, for some reason tap doesn't work`
`240`	`240`	`XCUIElement *firstButton = [elementQuery elementBoundByIndex:0];`
`241`	`241`
`242`		`- __auto_type coordinate = [firstButton coordinateWithNormalizedOffset:CGVectorMake(0, 0)];`
	`242`	`+ __auto_type coordinate = [firstButton coordinateWithNormalizedOffset:CGVectorMake(1, 1)];`
`243`	`243`	`[coordinate tap];`
`244`	`244`	`}`
`245`	`245`	`else`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ - (void)setUp`
`58`	`58`
`59`	`59`	`#pragma mark - Tests`
`60`	`60`
	`61`	`+#ifdef FEDERATION_TESTS_ENABLED`
`61`	`62`	`- (void)testInteractiveADFSv4Login_withPromptAlways_noLoginHint_andSystemWebView`
`62`	`63`	`{`
`63`	`64`	`MSIDAutomationTestRequest *request = [self.class.confProvider defaultAppRequest:self.testEnvironment targetTenantId:self.primaryAccount.targetTenantId];`
`@@ -107,5 +108,6 @@ - (void)testInteractiveADFSv4Login_withPromptAlways_withLoginHint_andEmbeddedWeb`
`107`	`108`	`NSString *homeAccountId = [self runSharedADFSInteractiveLoginWithRequest:request];`
`108`	`109`	`XCTAssertNotNil(homeAccountId);`
`109`	`110`	`}`
	`111`	`+#endif // FEDERATION_TESTS_ENABLED`
`110`	`112`
`111`	`113`	`@end`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ - (void)setUp`
`57`	`57`	`[self loadTestAccount:accountConfigurationRequest];`
`58`	`58`	`}`
`59`	`59`
	`60`	`+#ifdef FEDERATION_TESTS_ENABLED`
`60`	`61`	`// #347620`
`61`	`62`	`- (void)testInteractiveAndSilentAADLogin_withNonConvergedApp_withPromptAlways_noLoginHint_SystemWebView_signinIntoGuestTenantFirst`
`62`	`63`	`{`
`@@ -160,6 +161,7 @@ - (void)testInteractiveAndSilentAADLogin_withConvergedApp_withPromptAlways_noLog`
`160`	`161`	`homeRequest.homeAccountIdentifier = homeAccountId;`
`161`	`162`	`[self runSharedSilentAADLoginWithTestRequest:homeRequest];`
`162`	`163`	`}`
	`164`	`+#endif // FEDERATION_TESTS_ENABLED`
`163`	`165`
`164`	`166`	`- (NSString )runSharedGuestInteractiveLoginWithRequest:(MSIDAutomationTestRequest )request`
`165`	`167`	`closeResultView:(BOOL)closeResultView`