Merge pull request forcedotcom#3940 from bbirman/settings-menu

bbirman · web-flow · commit 362007bd2522 · 2025-10-30T11:07:52.000-05:00
Add settings menu to login screen
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Common/WebViewStateManager.swift b/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Common/WebViewStateManager.swift
@@ -38,6 +38,7 @@ public class SFSDKWebViewStateManager: NSObject {
 
     @objc
     @MainActor
+    @available(*, deprecated, renamed: "resetSessionCookie", message: "Deprecated in Salesforce Mobile SDK 13.2 and will be removed in Salesforce Mobile SDK 14.0. Use resetSessionCookie instead.")
     public static func removeSession() {
         if sessionCookieManagementDisabled {
             SFSDKCoreLogger.d(SFSDKWebViewStateManager.self, message: "[\(Self.self) removeSession]: Cookie Management disabled. Will do nothing.")
@@ -62,6 +63,22 @@ public class SFSDKWebViewStateManager: NSObject {
         }
     }
     
+    @objc
+    @MainActor
+    public static func clearCache() async {
+        let dataStore = WKWebsiteDataStore.default()
+        let nonCookieDataTypes: Set<String> = [WKWebsiteDataTypeDiskCache,
+                                               WKWebsiteDataTypeMemoryCache,
+                                               WKWebsiteDataTypeFetchCache,
+                                               WKWebsiteDataTypeLocalStorage,
+                                               WKWebsiteDataTypeSessionStorage,
+                                               WKWebsiteDataTypeIndexedDBDatabases,
+                                               WKWebsiteDataTypeWebSQLDatabases,
+                                               WKWebsiteDataTypeOfflineWebApplicationCache,
+                                               WKWebsiteDataTypeServiceWorkerRegistrations]
+        await dataStore.removeData(ofTypes: nonCookieDataTypes, modifiedSince: Date.distantPast)
+    }
+    
     @objc
     @MainActor
     public static func removeSessionForcefully() async {
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFLoginViewController.h b/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFLoginViewController.h
@@ -48,6 +48,12 @@ NS_SWIFT_NAME(SalesforceLoginViewControllerDelegate)
  */
 - (void)loginViewController:(nonnull SFLoginViewController *)loginViewController didChangeLoginHost:(nonnull SFSDKLoginHost *)newLoginHost;
 
+- (void)loginViewControllerDidClearCache:(nonnull SFLoginViewController *)loginViewController;
+
+- (void)loginViewControllerDidClearCookies:(nonnull SFLoginViewController *)loginViewController;
+
+- (void)loginViewControllerDidReload:(nonnull SFLoginViewController *)loginViewController;
+
 @end
 
 /** The Salesforce login screen view.
@@ -85,9 +91,12 @@ NS_SWIFT_NAME(SalesforceLoginViewController)
 /** Specify visibility of nav bar. This property will be used to hide/show the nav bar*/
 @property (nonatomic) BOOL showNavbar NS_SWIFT_NAME(showsNavigationBar);
 
-/** Specifiy the visibility of the settings icon. This property will be used to hide/show the settings icon*/
+/** Specify the visibility of the settings icon. This property will be used to hide/show the settings icon*/
 @property (nonatomic) BOOL showSettingsIcon NS_SWIFT_NAME(showsSettingsIcon);
 
+/// Specify the visibility of the server picker option in the settings menu.
+@property (nonatomic) BOOL showServerPicker NS_SWIFT_NAME(showsServerPicker);
+
 /** Specify all display properties in a config. All the above properties are backed by
  a config object */
 @property (nonatomic, strong, nonnull) SFSDKLoginViewControllerConfig *config;
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFLoginViewController.m b/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFLoginViewController.m
@@ -184,6 +184,14 @@ - (void)setShowSettingsIcon:(BOOL)showSettingsIcon {
     self.config.showSettingsIcon = showSettingsIcon;
 }
 
+- (BOOL)showServerPicker {
+    return self.config.showServerPicker;
+}
+
+- (void)setShowServerPicker:(BOOL)showServerPicker {
+    self.config.showServerPicker = showServerPicker;
+}
+
 - (SFSDKLoginViewControllerConfig *)config {
     return _config;
 }
@@ -200,20 +208,10 @@ - (void)setupNavigationBar {
     if (self.showNavbar) {
         self.navBar = self.navigationController.navigationBar;
         self.navBar.topItem.titleView = [self createTitleItem];
-        // Hides the gear icon if there are no hosts to switch to.
-        SFManagedPreferences *managedPreferences = [SFManagedPreferences sharedPreferences];
-        if (managedPreferences.onlyShowAuthorizedHosts && managedPreferences.loginHosts.count == 0) {
-            self.config.showSettingsIcon = NO;
-        }
+        
         if(self.showSettingsIcon) {
             // Setup right bar button.
             UIBarButtonItem *button = [self createSettingsButton];
-            if (!button.target){
-                [button setTarget:self];
-            }
-            if (!button.action){
-                [button setAction:@selector(showLoginHost:)];
-            }
             self.navBar.topItem.rightBarButtonItem = button;
         }
         [self styleNavigationBar:self.navBar];
@@ -265,9 +263,57 @@ - (UIBarButtonItem *)createBackButton {
 
 - (UIBarButtonItem *)createSettingsButton {
     UIImage *image = [[SFSDKResourceUtils imageNamed:@"login-window-gear"] imageWithRenderingMode:UIImageRenderingModeAlwaysTemplate];
-    UIBarButtonItem *settingsButton = [[UIBarButtonItem alloc] initWithImage:image style:UIBarButtonItemStylePlain target:self action:@selector(showLoginHost:)];
-    settingsButton.accessibilityLabel = [SFSDKResourceUtils localizedString:@"LOGIN_CHOOSE_SERVER"];
-    settingsButton.accessibilityIdentifier = @"choose connection button";
+    
+    NSMutableArray  *menuActions = [[NSMutableArray alloc] initWithCapacity:3];
+
+    // Don't show the change server option if there are no hosts to switch to.
+    SFManagedPreferences *managedPreferences = [SFManagedPreferences sharedPreferences];
+    if (managedPreferences.onlyShowAuthorizedHosts && managedPreferences.loginHosts.count == 0) {
+        self.showServerPicker = NO;
+    }
+    
+    if (self.showServerPicker) {
+        [menuActions addObject:[UIAction actionWithTitle:[SFSDKResourceUtils localizedString:@"LOGIN_CHOOSE_SERVER"]
+                                                   image:nil
+                                              identifier:nil
+                                                 handler:^(__kindof UIAction* _Nonnull action) {
+            [self showLoginHost:self];
+        }]];
+    }
+
+
+    [menuActions addObject:[UIAction actionWithTitle:[SFSDKResourceUtils localizedString:@"LOGIN_CLEAR_COOKIES"]
+                                               image:nil
+                                          identifier:nil
+                                             handler:^(__kindof UIAction* _Nonnull action) {
+        if ([self.delegate respondsToSelector:@selector(loginViewControllerDidClearCookies:)]) {
+            [self.delegate loginViewControllerDidClearCookies:self];
+        }
+    }]];
+
+    [menuActions addObject:[UIAction actionWithTitle:[SFSDKResourceUtils localizedString:@"LOGIN_CLEAR_CACHE"]
+                                                 image:nil
+                                            identifier:nil
+                                               handler:^(__kindof UIAction* _Nonnull action) {
+        if ([self.delegate respondsToSelector:@selector(loginViewControllerDidClearCache:)]) {
+            [self.delegate loginViewControllerDidClearCache:self];
+        }
+    }]];
+
+    [menuActions addObject:[UIAction actionWithTitle:[SFSDKResourceUtils localizedString:@"LOGIN_RELOAD"]
+                                               image:nil
+                                          identifier:nil
+                                             handler:^(__kindof UIAction* _Nonnull action) {
+        if ([self.delegate respondsToSelector:@selector(loginViewControllerDidReload:)]) {
+            [self.delegate loginViewControllerDidReload:self];
+        }
+    }]];
+    
+    UIMenu *menu = [UIMenu menuWithTitle:@"" // No title
+                                children:menuActions];
+    UIBarButtonItem *settingsButton = [[UIBarButtonItem alloc] initWithImage:image menu:menu];
+    settingsButton.accessibilityLabel = [SFSDKResourceUtils localizedString:@"LOGIN_SETTINGS_BUTTON"];
+    settingsButton.accessibilityIdentifier = @"settings";
     return settingsButton;
 }
 
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFSDKLoginViewControllerConfig.h b/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFSDKLoginViewControllerConfig.h
@@ -43,14 +43,17 @@ NS_SWIFT_NAME(SalesforceLoginViewControllerConfig)
 /** Specify visibility of nav bar. This property will be used to hide/show the nav bar*/
 @property (nonatomic) BOOL showNavbar NS_SWIFT_NAME(showsNavigationBar);
 
-/** Specifiy the visibility of the settings icon. This property will be used to hide/show the settings icon*/
+/** Specify the visibility of the settings icon. This property will be used to hide/show the settings icon*/
 @property (nonatomic) BOOL showSettingsIcon NS_SWIFT_NAME(showsSettingsIcon);
 
-/** Specifiy the visibility of the back icon. This property value can be changed by changing the value of shouldAuthenticate in bootconfig or by subclasssing SFLoginViewController.
+/// Specify the visibility of the server picker option in the settings menu.
+@property (nonatomic) BOOL showServerPicker NS_SWIFT_NAME(showsServerPicker);
+
+/** Specify the visibility of the back icon. This property value can be changed by changing the value of shouldAuthenticate in bootconfig or by subclasssing SFLoginViewController.
  */
 @property (nonatomic,readonly) BOOL shouldDisplayBackButton NS_SWIFT_NAME(showsBackButton);
 
-/** Specifiy a delegate for LoginViewController. */
+/** Specify a delegate for LoginViewController. */
 @property (nonatomic, weak, nullable) id<SFLoginViewControllerDelegate> delegate;
 
 @property (nonatomic, copy, nullable) SFLoginViewControllerCreationBlock loginViewControllerCreationBlock;
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFSDKLoginViewControllerConfig.m b/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/Login/SFSDKLoginViewControllerConfig.m
@@ -45,6 +45,7 @@ - (instancetype)init {
         self.navBarFont = nil;
         _showNavbar = YES;
         _showSettingsIcon = YES;
+        _showServerPicker = YES;
     }
     return self;
 }
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/UserAccount/SFUserAccountManager.m b/libs/SalesforceSDKCore/SalesforceSDKCore/Classes/UserAccount/SFUserAccountManager.m
@@ -730,7 +730,7 @@ - (void)postPushUnregistration:(SFUserAccount *)user logoutReason:(SFLogoutReaso
         [self setCurrentUserInternal:nil];
     }
 
-    [SFSDKWebViewStateManager removeSession];
+    [SFSDKWebViewStateManager resetSessionCookie];
     
     //restore these id's inorder to enable post logout cleanup of components
     // TODO: Revisit the userInfo data structure of kSFNotificationUserDidLogout in 7.0.
@@ -1044,6 +1044,25 @@ - (void)loginViewController:(SFLoginViewController *)loginViewController didChan
     [[NSNotificationCenter defaultCenter] postNotification:loginHostChangedNotification];
     NSString *sceneId = loginViewController.view.window.windowScene.session.persistentIdentifier;
     self.authSessions[sceneId].oauthRequest.loginHost = newLoginHost.host;
+    [self restartAuthenticationForViewController:loginViewController];
+}
+
+- (void)loginViewControllerDidClearCache:(SFLoginViewController *)loginViewController {
+    [SFSDKWebViewStateManager clearCacheWithCompletionHandler:^{}];
+    [self restartAuthenticationForViewController:loginViewController];
+}
+
+- (void)loginViewControllerDidClearCookies:(SFLoginViewController *)loginViewController {
+    [SFSDKWebViewStateManager removeSessionForcefullyWithCompletionHandler:^{}];
+    [self restartAuthenticationForViewController:loginViewController];
+}
+
+- (void)loginViewControllerDidReload:(SFLoginViewController *)loginViewController {
+    [self restartAuthenticationForViewController:loginViewController];
+}
+
+- (void)restartAuthenticationForViewController:(SFLoginViewController *)loginViewController {
+    NSString *sceneId = loginViewController.view.window.windowScene.session.persistentIdentifier;
     [self restartAuthentication:self.authSessions[sceneId]];
 }
 
diff --git a/libs/SalesforceSDKCore/SalesforceSDKCoreTests/WebViewStateManagerTests.swift b/libs/SalesforceSDKCore/SalesforceSDKCoreTests/WebViewStateManagerTests.swift
@@ -35,4 +35,38 @@ final class WebViewStateManagerTests: XCTestCase {
         SFSDKWebViewStateManager.sessionCookieManagementDisabled = false
         XCTAssertFalse(SFSDKWebViewStateManager.sessionCookieManagementDisabled)
     }
+    
+    @MainActor
+    func testClearCache() async throws {
+        // Add some test data
+        let html = "<html><body><script>localStorage.setItem('test', 'value');</script></body></html>"
+        let webView = WKWebView(frame: CGRect(x: 0, y: 0, width: 100, height: 100), configuration: WKWebViewConfiguration())
+        
+        // Load HTML and wait for JavaScript to execute
+        webView.loadHTMLString(html, baseURL: URL(string: "https://test.salesforce.com"))
+        try await Task.sleep(for: .seconds(1))
+        
+        // Define data types to check
+        let dataTypes: Set<String> = [WKWebsiteDataTypeDiskCache,
+                                      WKWebsiteDataTypeMemoryCache,
+                                      WKWebsiteDataTypeFetchCache,
+                                      WKWebsiteDataTypeLocalStorage,
+                                      WKWebsiteDataTypeSessionStorage,
+                                      WKWebsiteDataTypeIndexedDBDatabases,
+                                      WKWebsiteDataTypeWebSQLDatabases,
+                                      WKWebsiteDataTypeOfflineWebApplicationCache,
+                                      WKWebsiteDataTypeServiceWorkerRegistrations]
+        
+        let dataStore = WKWebsiteDataStore.default()
+        // Verify data exists before clearing
+        let initialRecords = await dataStore.dataRecords(ofTypes: dataTypes)
+        XCTAssertFalse(initialRecords.isEmpty, "Expected data to exist before clearing")
+        
+        // Clear the cache
+        await SFSDKWebViewStateManager.clearCache()
+        
+        // Verify data was cleared
+        let records = await dataStore.dataRecords(ofTypes: dataTypes)
+        XCTAssertTrue(records.isEmpty, "Expected data to be cleared")
+    }
 }
diff --git a/shared/resources/SalesforceSDKResources.bundle/en.lproj/Localizable.strings b/shared/resources/SalesforceSDKResources.bundle/en.lproj/Localizable.strings
@@ -59,13 +59,18 @@
 "LOGIN_SERVER_PRODUCTION" = "Production";
 "LOGIN_SERVER_SANDBOX" = "Sandbox";
 "LOGIN_SERVER_WELCOME" = "Welcome";
-"LOGIN_CHOOSE_SERVER" = "Choose Connection";
+"LOGIN_CHOOSE_SERVER" = "Change Server";
 "LOGIN_ADD_SERVER" = "Add Connection";
 "LOGIN_SERVER_URL" = "Host";
 "LOGIN_SERVER_NAME" = "Label";
 "LOGIN_SERVER_URL_PLACEHOLDER" = "Example: login.salesforce.com";
 "LOGIN_SERVER_NAME_PLACEHOLDER" = "Optional";
 "DONE_BUTTON" = "Done";
+"LOGIN_SETTINGS_BUTTON" = "Settings";
+
+"LOGIN_CLEAR_COOKIES" = "Clear Cookies";
+"LOGIN_CLEAR_CACHE" = "Clear Cache";
+"LOGIN_RELOAD" = "Reload";
 
 // Account Switcher
 "ACCOUNT_SWITCHER_TITLE" = "Manage Accounts";

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ - (instancetype)init {`
`45`	`45`	`self.navBarFont = nil;`
`46`	`46`	`_showNavbar = YES;`
`47`	`47`	`_showSettingsIcon = YES;`
	`48`	`+ _showServerPicker = YES;`
`48`	`49`	`}`
`49`	`50`	`return self;`
`50`	`51`	`}`