Extract SFHFKeychainUtils in a dedicated Swift package

mokagio · mokagio · commit 95580ff34cee · 2025-03-12T14:32:58.000+11:00
We need it in a dedicated package because the Objective-C implementation
does not use ARC. Therefore, we need to use the `-fno-objc-arc` compiler
setting. But such a setting should be applied sparingly so instead of
blanket using it in an existing Objective-C package like
WordPressSharedObjC, we use it surgically just for this file.
diff --git a/Modules/Package.swift b/Modules/Package.swift
@@ -11,6 +11,7 @@ let package = Package(
         .library(name: "AsyncImageKit", targets: ["AsyncImageKit"]),
         .library(name: "DesignSystem", targets: ["DesignSystem"]),
         .library(name: "JetpackStatsWidgetsCore", targets: ["JetpackStatsWidgetsCore"]),
+        .library(name: "SFHFKeychainUtils", targets: ["SFHFKeychainUtils"]),
         .library(name: "WordPressData", targets: ["WordPressData"]),
         .library(name: "WordPressFlux", targets: ["WordPressFlux"]),
         .library(name: "WordPressShared", targets: ["WordPressShared"]),
@@ -60,6 +61,12 @@ let package = Package(
         ]),
         .target(name: "DesignSystem", swiftSettings: [.swiftLanguageMode(.v5)]),
         .target(name: "JetpackStatsWidgetsCore", swiftSettings: [.swiftLanguageMode(.v5)]),
+        // SFHFKeychainUtils is an old Objective-C keychain wrapper.
+        // The implementatoin predates ARC, hence the dedicated target with ARC disabled, for the time being.
+        .target(
+            name: "SFHFKeychainUtils",
+            cSettings: [.unsafeFlags(["-fno-objc-arc"])]
+        ),
         .target(name: "UITestsFoundation", dependencies: [
             .product(name: "ScreenObject", package: "ScreenObject"),
             .product(name: "XCUITestHelpers", package: "ScreenObject"),
@@ -146,6 +153,7 @@ enum XcodeSupport {
         ]
 
         let shareAndDraftExtensionsDependencies: [Target.Dependency] = [
+            "SFHFKeychainUtils",
             "WordPressShared",
             "WordPressUI",
             .product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack"),
@@ -168,6 +176,7 @@ enum XcodeSupport {
             .xcodeTarget("XcodeTarget_App", dependencies: [
                 "DesignSystem",
                 "JetpackStatsWidgetsCore",
+                "SFHFKeychainUtils",
                 "WordPressData",
                 "WordPressFlux",
                 "WordPressShared",
@@ -206,6 +215,7 @@ enum XcodeSupport {
                 .product(name: "WordPressEditor", package: "AztecEditor-iOS"),
             ]),
             .xcodeTarget("XcodeTarget_WordPressTests", dependencies: testDependencies + [
+                "SFHFKeychainUtils",
                 "WordPressShared",
                 .product(name: "Gravatar", package: "Gravatar-SDK-iOS"),
                 .product(name: "Nimble", package: "Nimble"),
@@ -216,6 +226,7 @@ enum XcodeSupport {
             .xcodeTarget("XcodeTarget_ShareExtension", dependencies: shareAndDraftExtensionsDependencies),
             .xcodeTarget("XcodeTarget_DraftActionExtension", dependencies: shareAndDraftExtensionsDependencies),
             .xcodeTarget("XcodeTarget_NotificationServiceExtension", dependencies: [
+                "SFHFKeychainUtils",
                 "WordPressShared",
             ]),
             .xcodeTarget("XcodeTarget_StatsWidget", dependencies: [
diff --git a/Modules/Sources/SFHFKeychainUtils/SFHFKeychainUtils.m b/Modules/Sources/SFHFKeychainUtils/SFHFKeychainUtils.m
diff --git a/Modules/Sources/SFHFKeychainUtils/include/SFHFKeychainUtils.h b/Modules/Sources/SFHFKeychainUtils/include/SFHFKeychainUtils.h
@@ -27,7 +27,7 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //
 
-#import <UIKit/UIKit.h>
+#import <Foundation/Foundation.h>
 
 
 @interface SFHFKeychainUtils : NSObject {
@@ -68,4 +68,4 @@
 + (NSArray<NSDictionary<NSString *, NSString *> *> *)getAllPasswordsForAccessGroup:(NSString *)accessGroup
                                                                              error:(NSError **)error;
 
-@end
+@end
diff --git a/WordPress/Classes/Models/Blog/Blog.m b/WordPress/Classes/Models/Blog/Blog.m
@@ -5,6 +5,7 @@
 #import "Constants.h"
 #import "WPUserAgent.h"
 #import "WordPress-Swift.h"
+@import SFHFKeychainUtils;
 
 @import NSObject_SafeExpectations;
 @import NSURL_IDN;
diff --git a/WordPress/Classes/Models/WPAccount.m b/WordPress/Classes/Models/WPAccount.m
@@ -1,3 +1,4 @@
+@import SFHFKeychainUtils;
 #import "WPAccount.h"
 #import "WordPress-Swift.h"
 
diff --git a/WordPress/Classes/Services/CredentialsService.swift b/WordPress/Classes/Services/CredentialsService.swift
@@ -1,3 +1,5 @@
+import SFHFKeychainUtils
+
 protocol CredentialsProvider {
     func getPassword(username: String, service: String) -> String?
 }
diff --git a/WordPress/Classes/Services/NotificationSupportService.swift b/WordPress/Classes/Services/NotificationSupportService.swift
@@ -1,4 +1,5 @@
 import Foundation
+import SFHFKeychainUtils
 
 @objc
 open class NotificationSupportService: NSObject {
diff --git a/WordPress/Classes/Services/ShareExtensionService.swift b/WordPress/Classes/Services/ShareExtensionService.swift
@@ -1,4 +1,5 @@
 import Foundation
+import SFHFKeychainUtils
 
 @objc
 open class ShareExtensionService: NSObject {
diff --git a/WordPress/Classes/Stores/StatsWidgetsStore.swift b/WordPress/Classes/Stores/StatsWidgetsStore.swift
@@ -1,4 +1,5 @@
 import JetpackStatsWidgetsCore
+import SFHFKeychainUtils
 import WidgetKit
 
 class StatsWidgetsStore {
diff --git a/WordPress/Classes/System/WordPress-Bridging-Header.h b/WordPress/Classes/System/WordPress-Bridging-Header.h
@@ -1,5 +1,3 @@
-#import "SFHFKeychainUtils.h"
-
 // WordPress Module
 
 #import "ActivityLogViewController.h"
@@ -55,7 +53,6 @@
 #import "SettingTableViewCell.h"
 #import "SettingsTextViewController.h"
 #import "SharingViewController.h"
-#import "SFHFKeychainUtils.h"
 #import "SiteSettingsViewController.h"
 #import "SourcePostAttribution.h"
 #import "StatsViewController.h"
diff --git a/WordPress/Classes/System/WordPressAppDelegate.swift b/WordPress/Classes/System/WordPressAppDelegate.swift
@@ -1,3 +1,4 @@
+import SFHFKeychainUtils
 import UIKit
 import CocoaLumberjackSwift
 import Reachability
diff --git a/WordPress/Classes/Utility/KeychainUtils.swift b/WordPress/Classes/Utility/KeychainUtils.swift
@@ -1,3 +1,5 @@
+import SFHFKeychainUtils
+
 @objcMembers
 class KeychainUtils: NSObject {
 
diff --git a/WordPress/Classes/Utility/Migrations/10-11/BlogToAccount.m b/WordPress/Classes/Utility/Migrations/10-11/BlogToAccount.m
@@ -5,6 +5,7 @@
 
 @import NSObject_SafeExpectations;
 @import NSURL_IDN;
+@import SFHFKeychainUtils;
 
 @implementation BlogToAccount {
     NSString *_defaultWpcomUsername;
diff --git a/WordPress/Classes/Utility/Migrations/10-11/BlogToJetpackAccount.m b/WordPress/Classes/Utility/Migrations/10-11/BlogToJetpackAccount.m
@@ -3,6 +3,7 @@
 #import "WordPress-Swift.h"
 
 @import NSObject_SafeExpectations;
+@import SFHFKeychainUtils;
 
 static NSString * const BlogJetpackKeychainPrefix = @"jetpackblog-";
 
diff --git a/WordPress/Classes/Utility/Migrations/32-33/BlogToBlog32to33.swift b/WordPress/Classes/Utility/Migrations/32-33/BlogToBlog32to33.swift
@@ -1,3 +1,4 @@
+import SFHFKeychainUtils
 import UIKit
 
 class BlogToBlog32to33: NSEntityMigrationPolicy {
diff --git a/WordPress/Classes/ViewRelated/NUX/Helpers/WordPressAuthenticationManager.swift b/WordPress/Classes/ViewRelated/NUX/Helpers/WordPressAuthenticationManager.swift
@@ -1,4 +1,5 @@
 import Foundation
+import SFHFKeychainUtils
 import WordPressAuthenticator
 import Gridicons
 import UIKit
diff --git a/WordPress/JetpackStatsWidgets/Remote service/StatsWidgetsService.swift b/WordPress/JetpackStatsWidgets/Remote service/StatsWidgetsService.swift
@@ -1,3 +1,4 @@
+import SFHFKeychainUtils
 import WordPressKit
 import JetpackStatsWidgetsCore
 import WordPressShared
diff --git a/WordPress/JetpackStatsWidgets/Supporting Files/JetpackStatsWidgets-Bridging-Header.h b/WordPress/JetpackStatsWidgets/Supporting Files/JetpackStatsWidgets-Bridging-Header.h
@@ -1,2 +1 @@
-#import "SFHFKeychainUtils.h"
 #import "Constants.h"
diff --git a/WordPress/WordPress.xcodeproj/project.pbxproj b/WordPress/WordPress.xcodeproj/project.pbxproj
@@ -3297,9 +3297,6 @@
 /* Begin PBXFileSystemSynchronizedBuildFileExceptionSet section */
 		24CE68AE2CD3375300C7B37D /* Exceptions for "Classes" folder in "WordPress" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Utility/Migrations/20-21/SafeReaderTopicToReaderTopic.m",
 				"ViewRelated/Me/All Domains/Coordinators/AllDomainsAddDomainCoordinator.swift",
@@ -3314,9 +3311,6 @@
 		};
 		24CE68AF2CD3375300C7B37D /* Exceptions for "Classes" folder in "WordPressShareExtension" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Extensions/Colors and Styles/WPStyleGuide+ApplicationStyles.swift",
 				"Extensions/Colors and Styles/WPStyleGuide+Gridicon.swift",
@@ -3337,7 +3331,6 @@
 				Utility/BuildInformation/FeatureFlagRolloutStore.swift,
 				Utility/KeychainUtils.swift,
 				Utility/Logging/CocoaLumberjack.swift,
-				Utility/SFHFKeychainUtils.m,
 				ViewRelated/Aztec/Extensions/FormatBarItemProviders.swift,
 				"ViewRelated/Aztec/Extensions/Header+WordPress.swift",
 				"ViewRelated/Aztec/Extensions/TextList+WordPress.swift",
@@ -3351,9 +3344,6 @@
 		};
 		24CE68B02CD3375300C7B37D /* Exceptions for "Classes" folder in "WordPressDraftActionExtension" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Extensions/Colors and Styles/WPStyleGuide+ApplicationStyles.swift",
 				"Extensions/Colors and Styles/WPStyleGuide+Gridicon.swift",
@@ -3374,7 +3364,6 @@
 				Utility/BuildInformation/FeatureFlagRolloutStore.swift,
 				Utility/KeychainUtils.swift,
 				Utility/Logging/CocoaLumberjack.swift,
-				Utility/SFHFKeychainUtils.m,
 				ViewRelated/Aztec/Extensions/FormatBarItemProviders.swift,
 				"ViewRelated/Aztec/Extensions/Header+WordPress.swift",
 				"ViewRelated/Aztec/Extensions/TextList+WordPress.swift",
@@ -3388,9 +3377,6 @@
 		};
 		24CE68B22CD3375300C7B37D /* Exceptions for "Classes" folder in "WordPressNotificationServiceExtension" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Extensions/String+Helpers.swift",
 				"Extensions/UIImage+Extensions.swift",
@@ -3416,7 +3402,6 @@
 				Utility/FormattableContent/FormattableRangesFactory.swift,
 				Utility/FormattableContent/FormattableTextContent.swift,
 				Utility/KeychainUtils.swift,
-				Utility/SFHFKeychainUtils.m,
 				ViewRelated/Notifications/FormattableContent/FormattableCommentContent.swift,
 				ViewRelated/Notifications/FormattableContent/FormattableUserContent.swift,
 				ViewRelated/Notifications/FormattableContent/Notifiable.swift,
@@ -3446,9 +3431,6 @@
 		};
 		24CE68B52CD3375300C7B37D /* Exceptions for "Classes" folder in "Jetpack" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Utility/App Configuration/AppConfiguration.swift",
 				"Utility/App Configuration/AppConstants.swift",
@@ -3460,9 +3442,6 @@
 		};
 		24CE68B62CD3375300C7B37D /* Exceptions for "Classes" folder in "JetpackShareExtension" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Extensions/Colors and Styles/WPStyleGuide+ApplicationStyles.swift",
 				"Extensions/Colors and Styles/WPStyleGuide+Gridicon.swift",
@@ -3481,7 +3460,6 @@
 				Utility/BuildInformation/FeatureFlagRolloutStore.swift,
 				Utility/KeychainUtils.swift,
 				Utility/Logging/CocoaLumberjack.swift,
-				Utility/SFHFKeychainUtils.m,
 				ViewRelated/Aztec/Extensions/FormatBarItemProviders.swift,
 				"ViewRelated/Aztec/Extensions/Header+WordPress.swift",
 				"ViewRelated/Aztec/Extensions/TextList+WordPress.swift",
@@ -3495,9 +3473,6 @@
 		};
 		24CE68B72CD3375300C7B37D /* Exceptions for "Classes" folder in "JetpackDraftActionExtension" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Extensions/Colors and Styles/WPStyleGuide+ApplicationStyles.swift",
 				"Extensions/Colors and Styles/WPStyleGuide+Gridicon.swift",
@@ -3516,7 +3491,6 @@
 				Utility/BuildInformation/FeatureFlagRolloutStore.swift,
 				Utility/KeychainUtils.swift,
 				Utility/Logging/CocoaLumberjack.swift,
-				Utility/SFHFKeychainUtils.m,
 				ViewRelated/Aztec/Extensions/FormatBarItemProviders.swift,
 				"ViewRelated/Aztec/Extensions/Header+WordPress.swift",
 				"ViewRelated/Aztec/Extensions/TextList+WordPress.swift",
@@ -3530,9 +3504,6 @@
 		};
 		24CE68B82CD3375300C7B37D /* Exceptions for "Classes" folder in "JetpackNotificationServiceExtension" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				"Extensions/String+Helpers.swift",
 				"Extensions/UIImage+Extensions.swift",
@@ -3556,7 +3527,6 @@
 				Utility/FormattableContent/FormattableRangesFactory.swift,
 				Utility/FormattableContent/FormattableTextContent.swift,
 				Utility/KeychainUtils.swift,
-				Utility/SFHFKeychainUtils.m,
 				ViewRelated/Notifications/FormattableContent/FormattableCommentContent.swift,
 				ViewRelated/Notifications/FormattableContent/FormattableUserContent.swift,
 				ViewRelated/Notifications/FormattableContent/Notifiable.swift,
@@ -3571,9 +3541,6 @@
 		};
 		24CE68B92CD3375300C7B37D /* Exceptions for "Classes" folder in "JetpackStatsWidgets" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				Services/KeyValueDatabase.swift,
 				System/Constants/Constants.m,
@@ -3586,21 +3553,16 @@
 				Utility/BuildInformation/FeatureFlagRolloutStore.swift,
 				Utility/KeychainUtils.swift,
 				Utility/Logging/CocoaLumberjack.swift,
-				Utility/SFHFKeychainUtils.m,
 				"ViewRelated/Stats/Extensions/Double+Stats.swift",
 				"ViewRelated/Stats/Extensions/NumberFormatter+Stats.swift",
 			);
 			target = 0107E0B128F97D5000DE87DB /* JetpackStatsWidgets */;
 		};
 		24CE68BA2CD3375300C7B37D /* Exceptions for "Classes" folder in "JetpackIntents" target */ = {
 			isa = PBXFileSystemSynchronizedBuildFileExceptionSet;
-			additionalCompilerFlagsByRelativePath = {
-				Utility/SFHFKeychainUtils.m = "-fno-objc-arc";
-			};
 			membershipExceptions = (
 				System/Constants/Constants.m,
 				Utility/Logging/CocoaLumberjack.swift,
-				Utility/SFHFKeychainUtils.m,
 			);
 			target = 0107E13828FE9DB200DE87DB /* JetpackIntents */;
 		};
diff --git a/WordPress/WordPressDraftActionExtension/WordPressDraftActionExtension-Bridging-Header.h b/WordPress/WordPressDraftActionExtension/WordPressDraftActionExtension-Bridging-Header.h
@@ -2,5 +2,4 @@
 #import "Constants.h"
 
 // Shared Helpers
-#import "SFHFKeychainUtils.h"
 #import "TextBundleWrapper.h"
diff --git a/WordPress/WordPressNotificationServiceExtension/Sources/NotificationService.swift b/WordPress/WordPressNotificationServiceExtension/Sources/NotificationService.swift
@@ -1,3 +1,4 @@
+import SFHFKeychainUtils
 import UserNotifications
 
 import WordPressKit
diff --git a/WordPress/WordPressNotificationServiceExtension/Sources/WordPressNotificationServiceExtension-Bridging-Header.h b/WordPress/WordPressNotificationServiceExtension/Sources/WordPressNotificationServiceExtension-Bridging-Header.h
@@ -1,5 +1,2 @@
 // Main App Helpers
 #import "Constants.h"
-
-// Shared Helpers
-#import "SFHFKeychainUtils.h"
diff --git a/WordPress/WordPressShareExtension/WordPressShare-Bridging-Header.h b/WordPress/WordPressShareExtension/WordPressShare-Bridging-Header.h
@@ -2,5 +2,4 @@
 #import "Constants.h"
 
 // Shared Helpers
-#import "SFHFKeychainUtils.h"
 #import "TextBundleWrapper.h"
diff --git a/WordPress/WordPressTest/KeychainTest.m b/WordPress/WordPressTest/KeychainTest.m
@@ -1,6 +1,7 @@
+// TODO: Port to yet to create SFHFKeychainUtils test package
 #import <UIKit/UIKit.h>
 #import <XCTest/XCTest.h>
-#import "SFHFKeychainUtils.h"
+@import SFHFKeychainUtils;
 
 @interface KeychainTest : XCTestCase
 {
diff --git a/WordPress/WordPressTest/KeychainUtilsTests.swift b/WordPress/WordPressTest/KeychainUtilsTests.swift
@@ -1,3 +1,5 @@
+// TODO: Port to yet to create SFHFKeychainUtils test package
+import SFHFKeychainUtils
 import XCTest
 @testable import WordPress
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+@import SFHFKeychainUtils;`
`1`	`2`	`#import "WPAccount.h"`
`2`	`3`	`#import "WordPress-Swift.h"`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import SFHFKeychainUtils`
	`2`	`+`
`1`	`3`	`protocol CredentialsProvider {`
`2`	`4`	`func getPassword(username: String, service: String) -> String?`
`3`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import Foundation`
	`2`	`+import SFHFKeychainUtils`
`2`	`3`
`3`	`4`	`@objc`
`4`	`5`	`open class NotificationSupportService: NSObject {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import JetpackStatsWidgetsCore`
	`2`	`+import SFHFKeychainUtils`
`2`	`3`	`import WidgetKit`
`3`	`4`
`4`	`5`	`class StatsWidgetsStore {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import SFHFKeychainUtils`
`1`	`2`	`import UIKit`
`2`	`3`	`import CocoaLumberjackSwift`
`3`	`4`	`import Reachability`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import SFHFKeychainUtils`
	`2`	`+`
`1`	`3`	`@objcMembers`
`2`	`4`	`class KeychainUtils: NSObject {`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import SFHFKeychainUtils`
`1`	`2`	`import WordPressKit`
`2`	`3`	`import JetpackStatsWidgetsCore`
`3`	`4`	`import WordPressShared`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`		`-#import "SFHFKeychainUtils.h"`
`2`	`1`	`#import "Constants.h"`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import SFHFKeychainUtils`
`1`	`2`	`import UserNotifications`
`2`	`3`
`3`	`4`	`import WordPressKit`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
	`1`	`+// TODO: Port to yet to create SFHFKeychainUtils test package`
`1`	`2`	`#import <UIKit/UIKit.h>`
`2`	`3`	`#import <XCTest/XCTest.h>`
`3`		`-#import "SFHFKeychainUtils.h"`
	`4`	`+@import SFHFKeychainUtils;`
`4`	`5`
`5`	`6`	`@interface KeychainTest : XCTestCase`
`6`	`7`	`{`