fix: Cache Functionality Fixes and Comprehensive Test Suite (#91)

Co-authored-by: Gareth Reese <[email protected]>
Co-authored-by: Gareth Reese <[email protected]>

Author: matthewelwell

.github/workflows/pull-request.yml

@@ -7,48 +7,39 @@ on:
         branches: [main]
 
 jobs:
-    macos-build-14:
+    macos-latest:
         # macOS-latest images are not the most recent
-        # The macos-latest workflow label currently uses the macOS 12 runner image, which doesn't include the build-tools we need
         # The vast majority of macOS developers would be using the latest version of macOS
         # Current list here: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-github-hosted-runners
-        runs-on: macOS-14 
-
-        steps:
-            - uses: actions/checkout@v4
-            - name: Build (macOS)
-              run: swift build -v
-            - name: Run tests
-              run: swift test -v
-
-    macos-build-13:
-        # Let's also check that the code builds on macOS 13
-        # At 23rd April 2023 the 'latest' macOS version is macOS 12
-        runs-on: macOS-13
-
+        runs-on: macOS-latest
         steps:
             - uses: actions/checkout@v4
+            - name: Check for FLAGSMITH_TEST_API_KEY
+              run: |
+                if [ -z "$FLAGSMITH_TEST_API_KEY" ]; then
+                  echo "Warning: FLAGSMITH_TEST_API_KEY environment variable is not set"
+                  exit 1
+                fi
+              env:
+                FLAGSMITH_TEST_API_KEY: ${{ secrets.FLAGSMITH_TEST_API_KEY }}
             - name: Build (macOS)
-              run: swift build -v
-            - name: Run tests
-              run: swift test -v
-
-    ubuntu-build:
-        runs-on: ubuntu-latest
-
-        steps:
-            - uses: actions/checkout@v4
-            - name: Build (Ubuntu)
-              run: swift build -v
+              run: swift --version && swift build
             - name: Run tests
-              run: swift test -v
-
+              run: swift test
+              env:
+                FLAGSMITH_TEST_API_KEY: ${{ secrets.FLAGSMITH_TEST_API_KEY }}
     swift-lint:
-
         runs-on: ubuntu-latest
-
         steps:
             - uses: actions/checkout@v4
+            - name: Check for FLAGSMITH_TEST_API_KEY
+              run: |
+                if [ -z "$FLAGSMITH_TEST_API_KEY" ]; then
+                  echo "Warning: FLAGSMITH_TEST_API_KEY environment variable is not set"
+                  exit 1
+                fi
+              env:
+                FLAGSMITH_TEST_API_KEY: ${{ secrets.FLAGSMITH_TEST_API_KEY }}
 
             - name: Run SwiftLint
               uses: norio-nomura/[email protected]

.gitignore

@@ -52,3 +52,6 @@ Carthage/Build
 # This was causing confusion on PRs and is really just a record of the last time the example
 # pods were re-built from scratch. It's not useful to keep in the repo.
 Example/Podfile.lock
+
+# Test configuration with real API keys (do not commit)
+FlagsmithClient/Tests/test-config.json

Example/FlagsmithClient.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 46;
+	objectVersion = 77;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -143,14 +143,14 @@
 				};
 			};
 			buildConfigurationList = 607FACCB1AFB9204008FA782 /* Build configuration list for PBXProject "FlagsmithClient" */;
-			compatibilityVersion = "Xcode 3.2";
 			developmentRegion = en;
 			hasScannedForEncodings = 0;
 			knownRegions = (
 				en,
 				Base,
 			);
 			mainGroup = 607FACC71AFB9204008FA782;
+			preferredProjectObjectVersion = 77;
 			productRefGroup = 607FACD11AFB9204008FA782 /* Products */;
 			projectDirPath = "";
 			projectRoot = "";
@@ -201,13 +201,16 @@
 			buildActionMask = 2147483647;
 			files = (
 			);
+			inputFileListPaths = (
+				"${PODS_ROOT}/Target Support Files/Pods-FlagsmithClient_Example/Pods-FlagsmithClient_Example-frameworks-${CONFIGURATION}-input-files.xcfilelist",
+			);
 			inputPaths = (
-				"${PODS_ROOT}/Target Support Files/Pods-FlagsmithClient_Example/Pods-FlagsmithClient_Example-frameworks.sh",
-				"${BUILT_PRODUCTS_DIR}/FlagsmithClient/FlagsmithClient.framework",
 			);
 			name = "[CP] Embed Pods Frameworks";
+			outputFileListPaths = (
+				"${PODS_ROOT}/Target Support Files/Pods-FlagsmithClient_Example/Pods-FlagsmithClient_Example-frameworks-${CONFIGURATION}-output-files.xcfilelist",
+			);
 			outputPaths = (
-				"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/FlagsmithClient.framework",
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
@@ -350,7 +353,8 @@
 				IPHONEOS_DEPLOYMENT_TARGET = 14.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
-				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
+				SWIFT_COMPILATION_MODE = wholemodule;
+				SWIFT_OPTIMIZATION_LEVEL = "-O";
 				VALIDATE_PRODUCT = YES;
 			};
 			name = Release;
@@ -362,7 +366,11 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				DEVELOPMENT_TEAM = RYCT86V4LM;
 				INFOPLIST_FILE = FlagsmithClient/Info.plist;
-				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
+				IPHONEOS_DEPLOYMENT_TARGET = 15.6;
+				LD_RUNPATH_SEARCH_PATHS = (
+					"$(inherited)",
+					"@executable_path/Frameworks",
+				);
 				MODULE_NAME = ExampleApp;
 				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)";
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -377,7 +385,11 @@
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				DEVELOPMENT_TEAM = RYCT86V4LM;
 				INFOPLIST_FILE = FlagsmithClient/Info.plist;
-				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
+				IPHONEOS_DEPLOYMENT_TARGET = 15.6;
+				LD_RUNPATH_SEARCH_PATHS = (
+					"$(inherited)",
+					"@executable_path/Frameworks",
+				);
 				MODULE_NAME = ExampleApp;
 				PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)";
 				PRODUCT_NAME = "$(TARGET_NAME)";

Example/FlagsmithClient/AppDelegate.swift

@@ -25,7 +25,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
   func application(_ application: UIApplication,
                    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
     // Override point for customization after application launch.
-    Flagsmith.shared.apiKey = "<add your API key from the Flagsmith settings page>"
+    Flagsmith.shared.apiKey = "<add your API key from the Flagsmith dashboard project settings, account, API Key tab here>"
 
     // set default flags
     Flagsmith.shared.defaultFlags = [Flag(featureName: "feature_a", enabled: false),