@W-19368408: [MSDK] Local dev instant login (iOS) #3944

JohnsonEricAtSalesforce · 2025-10-16T01:00:22Z

🎸 Ready For Review 🥁

This is the iOS counterpart to forcedotcom/SalesforceMobileSDK-Android#2785.

This adds a new process argument which may be used for debug app builds only to authenticate a user via test credentials in automated tests. The new code is wrapped in a #ifdef DEBUG preprocessor condition so that it will not be present for release builds.

This new means of automating authentication for debug testing does not expose production builds to risk and also minimizes access since usernames and passwords are not used. The test credentials JSON provided by Salesforce Mobile SDK's REST Explorer sample app uses refresh tokens which can be remotely expired and cannot be used for privilege elevation beyond the public APIs.

Here's an example of testing the new parameter interactively in Xcode by adding it to the app's scheme:

Here's an example for XCUITest:

super.launchArguments = ["creds: \(STRING_PACKAGE)"]
super.launch()

This is an Appium example:

capabilities = {
     "platformName": "iOS",
     "deviceName": "iPhone 17 Pro Max",
     "platformVersion": "26.0",
     "app": "/path/to/your/app.app",
     "automationName": "XCUITest",
     "processArguments": {
       "args": ["creds", "<STRING PACKAGE>"]
     }
   }

And, finally, an example at the shell:

xcrun simctl launch booted <YOUR APP> -creds "<STRING PACKAGE>"

JohnsonEricAtSalesforce · 2025-10-16T01:01:58Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Common/SalesforceSDKManager.m

+        if ([arguments containsObject:@"-creds"]) {
+            NSString *creds = arguments[[arguments indexOfObject:@"-creds"] + 1];
+
+            [TestSetupUtils populateAuthCredentialsFromString:creds];


The crux is retrieving the new parameter and passing it to mostly existing test harness logic. @bbirman, is this a logical place to accomplish this? I tried few other ideas, but ran into issues and circular dependencies on the manager singleton.

Is SFUserAccountManager a possibility? If not, this class sounds good to me, though wondering about using load, does it have something to do with the runtime?

I looked through SFUserAccountManager just now. It doesn't seem to have any logical place to add this. I tried a couple, but they also trigger some circular initialization overflows a lot like some of the entry points in the manager I tried. TestSetupUtils is dependent on the SDK and user account manager objects.

load is nice in this instance since it's the class level initializer for SalesforceSDKManager and is outside the other initialization methods. You're correct that it's part of the Objective-C spec. I recall there is a way to do something like that in Swift, but it has been a few years since I exercised that.

JohnsonEricAtSalesforce · 2025-10-16T01:02:29Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Test/TestSetupUtils.h

+ @return The configuration data used to configure SFUserAccountManager (useful e.g. for hybrid
+ apps which need the data to bootstrap SFHybridViewController).
+ */
+ (SFSDKTestCredentialsData *)populateAuthCredentialsFromString:(NSString *)testCredentialsJsonString;


This new method lets us reuse the non-file logic around ingesting the JSON.

JohnsonEricAtSalesforce · 2025-10-16T01:03:25Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Test/TestSetupUtils.m

    return credsData;
 }

-+ (void)synchronousAuthRefresh


This method didn't change, though Github marked it as a diff due to other logic moving.

JohnsonEricAtSalesforce · 2025-10-16T01:03:53Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Test/TestSetupUtils.m

+             authListener.returnStatus);
+}
+
+ (SFOAuthCredentials *)newClientCredentials {


This method did not change. This method didn't change, though Github marked it as a diff due to other logic moving.

JohnsonEricAtSalesforce · 2025-10-16T01:04:07Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Test/TestSetupUtils.m

+    return [TestSetupUtils authCredentialsFromJson:[SFJsonUtils objectFromJSONString:testCredentialsJsonString]];
+}
+
+ (void)synchronousAuthRefresh


This method didn't change, though Github marked it as a diff due to other logic moving.

JohnsonEricAtSalesforce · 2025-10-16T01:04:20Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Test/TestSetupUtils.m

-             authListener.returnStatus);
-}
-
-+ (SFOAuthCredentials *)newClientCredentials {


This method didn't change, though Github marked it as a diff due to other logic moving.

github-actions · 2025-10-16T01:04:51Z

	1 Warning
⚠️	Static Analysis found an issue with one or more files you modified. Please fix the issue(s).

Clang Static Analysis Issues

File	Type	Category	Description	Line	Col
SalesforceSDKManager	Nil value used as mutex for @synchronized() (no synchronization will occur)	Logic error	Nil value used as mutex for @synchronized() (no synchronization will occur)	144	5
SalesforceSDKManager	Nil value used as mutex for @synchronized() (no synchronization will occur)	Logic error	Nil value used as mutex for @synchronized() (no synchronization will occur)	156	5

Generated by 🚫 Danger

codecov · 2025-10-16T01:09:29Z

Codecov Report

❌ Patch coverage is 57.14286% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 63.00%. Comparing base (f71eda5) to head (b780b88).

Files with missing lines	Patch %	Lines
...forceSDKCore/Classes/Common/SalesforceSDKManager.m	57.14%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3944      +/-   ##
==========================================
- Coverage   63.04%   63.00%   -0.04%     
==========================================
  Files         249      249              
  Lines       22455    22462       +7     
==========================================
- Hits        14156    14152       -4     
- Misses       8299     8310      +11

Components	Coverage Δ
Analytics	`70.78% <ø> (ø)`
Common	`71.09% <ø> (ø)`
Core	`53.11% <57.14%> (-0.06%)`	⬇️
SmartStore	`73.66% <ø> (ø)`
MobileSync	`87.66% <ø> (ø)`

Files with missing lines	Coverage Δ
...forceSDKCore/Classes/Common/SalesforceSDKManager.m	`57.70% <57.14%> (-0.01%)`	⬇️

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…ogin To SalesforceSDKManager `init`)

JohnsonEricAtSalesforce · 2025-10-21T20:07:08Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Common/SalesforceSDKManager.m

+    if ([arguments containsObject:@"-creds"]) {
+        NSString *creds = arguments[[arguments indexOfObject:@"-creds"] + 1];
+
+        [TestSetupUtils populateAuthCredentialsFromString:creds initializeSdk:NO];


@bbirman - Now we have Local Dev Instant Login hosted in SalesforceSDKManager.init so we can avoid using load. Notice the two new boolean parameters on these two statements which allow TestSetupUtils to execute correctly here in initializeSDK while still running exactly the same in existing tests.

JohnsonEricAtSalesforce · 2025-10-21T20:08:20Z

libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Test/TestSetupUtils.m

+        if (postUserDidLogIn) {
+            NSDictionary *userInfo = @{kSFNotificationUserInfoAccountKey: userAccount,
+                                       kSFNotificationUserInfoAuthTypeKey: authInfo};
+            [[NSNotificationCenter defaultCenter] postNotificationName:kSFNotificationUserDidLogIn


These two lines allow TestSetupUtils to stop the default login from being shown and deliver the test app directly to its authenticated view.

That matches the behavior for Local Dev Instant Login for Android.

There is similar notification login in the user account manager, but its only a few lines and not visible to this scope, so I thought to leave that alone and replicate the notification here so we minimize authentication regression risk. All the changes in this pull request are non-production code so far.

JohnsonEricAtSalesforce · 2025-10-21T20:12:26Z

@bbirman - After really researching exactly how TestSetupUtils compares with the user's interactive authentication experience in SFUserAccountManager, I was able to make a few tweaks to the non-production logic in TestSetupUtils to make it work perfectly. It's nice that this test harness update doesn't touch any of the production authentication logic 👍🏻

JohnsonEricAtSalesforce · 2025-10-21T20:13:50Z

I ran this using the RestAPIExplorer sample and giving it the new parameter shown in the screenshot above. After a fresh install, it brought my test user directly to the app's authenticated view in all my test runs ⭐️

JohnsonEricAtSalesforce · 2025-10-21T20:19:57Z

Local tests are passing as well ✅

…Utils` From Code Coverage)

@W-19368408: [MSDK] Local dev instant login (iOS)

785262b

JohnsonEricAtSalesforce self-assigned this Oct 16, 2025

JohnsonEricAtSalesforce commented Oct 16, 2025

View reviewed changes

@W-19368408: [MSDK] Local dev instant login (iOS) (Move Dev Instant L…

f322cf4

…ogin To SalesforceSDKManager `init`)

JohnsonEricAtSalesforce commented Oct 21, 2025

View reviewed changes

JohnsonEricAtSalesforce requested a review from bbirman October 21, 2025 20:10

bbirman approved these changes Oct 21, 2025

View reviewed changes

wmathurin approved these changes Oct 21, 2025

View reviewed changes

@W-19368408: [MSDK] Local dev instant login (iOS) (Exclude `TestSetup…

b780b88

…Utils` From Code Coverage)

@W-19368408: [MSDK] Local dev instant login (iOS) #3944

Are you sure you want to change the base?

@W-19368408: [MSDK] Local dev instant login (iOS) #3944

Conversation

JohnsonEricAtSalesforce commented Oct 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 16, 2025

Clang Static Analysis Issues

Uh oh!

codecov bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JohnsonEricAtSalesforce commented Oct 21, 2025

Uh oh!

JohnsonEricAtSalesforce commented Oct 21, 2025

Uh oh!

JohnsonEricAtSalesforce commented Oct 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Oct 16, 2025 •

edited

Loading