Merge branch 'trunk' into woo-pos-enable-barcode-scanning-i2-feature-flag

Author: staskus

.buildkite/commands/build-for-testing.sh

@@ -18,5 +18,5 @@ echo "--- :hammer_and_wrench: Building"
 bundle exec fastlane build_for_testing
 
 echo "--- :arrow_up: Upload Build Products"
-tar -cf build-products.tar DerivedData/Build/Products/
+tar -cf build-products.tar DerivedData/Build/Products/ DerivedData/Index.noindex/DataStore/
 buildkite-agent artifact upload build-products.tar

.buildkite/commands/run-periphery.sh

@@ -0,0 +1,44 @@
+#!/bin/bash -eu
+
+if .buildkite/commands/should-skip-job.sh --job-type validation; then
+  exit 0
+fi
+
+### Prepare
+
+echo '--- 📦 Downloading Build Artifacts'
+buildkite-agent artifact download build-products.tar .
+tar -xf build-products.tar
+
+### Run the Tests
+
+PERIPHERY_OUTPUT_FILE="periphery-errors.txt"
+
+echo '+++ :zombie: Detecting unused code'
+set +e
+# This is the script in the root.
+./Scripts/Periphery/setup-and-run-periphery.sh \
+  --strict --quiet --skip-build --index-store-path 'DerivedData/Index.noindex/DataStore/' \
+  --write-results "$PERIPHERY_OUTPUT_FILE"
+TESTS_EXIT_STATUS=$?
+set -e
+
+# Handle the result of the periphery scan
+if [[ "$TESTS_EXIT_STATUS" -ne 0 ]]; then
+  echo '😱 Unused code detected!'
+  echo ''
+  echo '💡 You can run Periphery locally by calling `setup-and-run-periphery.sh` from `./Scripts/Periphery/` in the repo.'
+  echo ''
+  echo 'If you think there is a false positive violation, please check the known issues of Periphery at https://github.com/peripheryapp/periphery/issues.'
+  echo 'If you think a violation is valid but it should be surpressed for any reason, please apply the `// periphery: ignore - {your-reason-here}` comment.'
+  echo ''
+  # Add the periphery errors as a Buildkite annotation
+  (echo "### Periphery found unused code"; echo ''; echo '```'; cat "$PERIPHERY_OUTPUT_FILE"; echo ''; echo '```') \
+    | buildkite-agent annotate --context periphery --style error
+else
+  echo '😊 No unused code found.'
+  buildkite-agent annotate --context periphery --style success 'No unused code found by Periphery :tada:'
+fi
+
+echo '--- 🚦 Report Exit code'
+exit $TESTS_EXIT_STATUS

.buildkite/pipeline.yml

@@ -79,6 +79,14 @@ steps:
         agents:
           queue: linter
 
+      - label: "🧟 Detect unused code"
+        command: ".buildkite/commands/run-periphery.sh"
+        depends_on: build
+        plugins: [$CI_TOOLKIT]
+        notify:
+          - github_commit_status:
+              context: Periphery - Detect unused code
+
       - label: 🧹 Lint Translations
         command: gplint /workdir/WooCommerce/Resources/AppStoreStrings.pot
         plugins:

.gitignore

@@ -102,3 +102,6 @@ WooCommerce/WooCommerceScreenshots/Mocks/vendor/
 Modules/.build
 Modules/.swiftpm/configuration/registries.json
 Modules/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+
+# Periphery install
+vendor/Periphery/

.periphery.yml

@@ -0,0 +1,68 @@
+# This option tells Periphery to not report any Swift code as unused if it's accessible from Objective-C. This includes any class that inherits from NSObject, and any method or property marked with the @objc or @objcMembers attribute.
+#  Woocommerce-ios, is a mixed Swift and Objective-C project. Swift code is often called from Objective-C and vice-versa. Without this flag, Periphery would incorrectly flag Swift code that is only used by Objective-C parts of the app as "unused," which would be a false positive. Setting this to true is essential for getting accurate results in a mixed-language codebase.
+retain_objc_accessible: true
+
+# This option prevents Periphery from flagging unused parameters in protocol method implementations.
+# Often, a protocol will define a method with parameters that are needed by some, but not all, conforming types. If a specific implementation doesn't need to use a parameter, Swift still requires that the method signature matches the protocol exactly. Periphery would normally see this unused parameter and flag it. However, removing it would cause a compile error because the method signature would no longer match the protocol. This flag tells Periphery to ignore these cases, avoiding false positives.
+retain_unused_protocol_func_params: true
+
+# This option retains all code within a previews struct that conforms to SwiftUI's PreviewProvider protocol.
+# SwiftUI Previews are a powerful feature for UI development in Xcode. The code you write for previews is often not directly called from your main application target; it's used by Xcode's canvas. Periphery would see this and incorrectly mark the preview code as unused. This flag correctly tells Periphery to always keep preview provider code, which is the desired behavior.
+retain_swift_ui_previews: true
+
+# This option disables the check for public declarations that are only used within their own module.
+# Normally, Periphery would suggest changing public to internal or private in these cases to reduce the public API surface of a module.
+disable_redundant_public_analysis: false
+
+# By default, Periphery will scan all targets in your project, including test targets. 
+# This can lead to false positives, as test code is not part of the main application. 
+# This option tells Periphery to exclude all test targets from the scan, ensuring that only the application code is analyzed.
+exclude_tests: true
+
+schemes:
+- WooCommerce
+
+project: WooCommerce.xcworkspace
+
+# Used for local run by `periphery scan`
+# This will not conflict with CI build configuration because of build skipping by `--skip-build` and `--index-store-path`
+build_arguments:
+- -xcconfig
+- config/WooCommerce.debug.xcconfig
+
+# A baseline is used to manage the large number of warnings from a mature codebase.
+# It contains a snapshot of all "existing/acceptable" warnings. Periphery will ignore all
+# warnings in this file, allowing you to focus on new issues in pull requests.
+#
+# After fixing existing warnings, regenerate this file with:
+# periphery scan --write-baseline Scripts/Periphery/periphery_baseline.json
+baseline: Scripts/Periphery/periphery_baseline.json
+
+exclude_targets:
+- GenerateCredentials
+- WooCommerceScreenshots
+- WordPressAuthenticator
+- WordPressAuthenticatorTests
+- WooCommerceTests
+- WooCommerceUITests
+- NotificationExtension
+- StoreWidgetsExtension
+- WatchWidgetsExtension
+- "Woo Watch App"
+- Fakes
+- XcodeTarget_WooCommerceTests
+- XcodeTarget_WooCommerceUITests
+- XcodeTarget_WordPressAuthenticatorTests
+
+index_exclude:
+- Pods/*
+- vendor/**
+- BuildTools/.build/**
+- "**/Tests/*"
+- "**/Test*/*"
+- "docs/*"
+- "fastlane/*"
+- "config/*"
+- "**/*.xib"
+- "**/*.storyboard"
+- "**/*.generated.swift"

Modules/Sources/Fakes/Networking.generated.swift

@@ -631,6 +631,18 @@ extension Networking.InboxNote {
         )
     }
 }
+extension Networking.JetpackConnectionData {
+    /// Returns a "ready to use" type filled with fake values.
+    ///
+    public static func fake() -> Networking.JetpackConnectionData {
+        .init(
+            currentUser: .fake(),
+            isRegistered: .fake(),
+            connectionOwner: .fake(),
+            blogID: .fake()
+        )
+    }
+}
 extension Networking.JetpackUser {
     /// Returns a "ready to use" type filled with fake values.
     ///
@@ -640,7 +652,8 @@ extension Networking.JetpackUser {
             isPrimary: .fake(),
             username: .fake(),
             wpcomUser: .fake(),
-            gravatar: .fake()
+            gravatar: .fake(),
+            blogID: .fake()
         )
     }
 }

Modules/Sources/Networking/Mapper/JetpackConnectionDataMapper.swift

@@ -0,0 +1,60 @@
+import Codegen
+import Foundation
+
+/// Mapper: Jetpack connection data
+///
+struct JetpackConnectionDataMapper: Mapper {
+
+    func map(response: Data) throws -> JetpackConnectionData {
+        let decoder = JSONDecoder()
+        return try decoder.decode(JetpackConnectionData.self, from: response)
+    }
+}
+
+/// JetpackConnectionData Disposable Entity:
+/// This entity allows us to parse JetpackUser with JSONDecoder.
+///
+public struct JetpackConnectionData: Decodable, GeneratedFakeable, GeneratedCopiable {
+    /// The connection state for the authenticated user
+    public let currentUser: JetpackUser
+
+    /// Whether the site is already registered with Jetpack.
+    /// This field is available only from Jetpack 14.4, so would be nil on older versions.
+    /// Ref: pe5sF9-401-p2
+    /// periphery: ignore - used in UI module
+    public let isRegistered: Bool?
+
+    /// Username of the Jetpack connection owner.
+    /// This field is non-nil for sites that already register a connection with Jetpack.
+    /// periphery: ignore - used in UI module
+    public let connectionOwner: String?
+
+    /// WP blog ID, available only if site has once connected to Jetpack.
+    /// periphery: ignore - used in UI module
+    public let blogID: Int64?
+
+    /// periphery: ignore - used by codegen
+    public init(currentUser: JetpackUser,
+                isRegistered: Bool?,
+                connectionOwner: String?,
+                blogID: Int64?) {
+        self.currentUser = currentUser
+        self.isRegistered = isRegistered
+        self.connectionOwner = connectionOwner
+        self.blogID = blogID
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        currentUser = try container.decode(JetpackUser.self, forKey: .currentUser)
+        isRegistered = try container.decodeIfPresent(Bool.self, forKey: .isRegistered)
+        connectionOwner = try? container.decodeIfPresent(String.self, forKey: .connectionOwner)
+        blogID = currentUser.blogID // moved to data for easier access
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case currentUser
+        case isRegistered
+        case connectionOwner
+    }
+}

Modules/Sources/Networking/Mapper/JetpackConnectionProvisionMapper.swift

@@ -0,0 +1,21 @@
+import Foundation
+
+/// Mapper: Jetpack connection registration
+///
+/// periphery: ignore - used in `JetpackConnectionRemote`
+struct JetpackConnectionProvisionMapper: Mapper {
+
+    /// (Attempts) to extract the updated `currentUser` field from a given JSON Encoded response.
+    ///
+    func map(response: Data) throws -> JetpackConnectionProvisionResponse {
+        let decoder = JSONDecoder()
+        decoder.keyDecodingStrategy = .convertFromSnakeCase
+        return try decoder.decode(JetpackConnectionProvisionResponse.self, from: response)
+    }
+}
+
+public struct JetpackConnectionProvisionResponse: Decodable {
+    public let userId: Int64
+    public let scope: String
+    public let secret: String
+}

Modules/Sources/Networking/Mapper/JetpackConnectionRegistrationMapper.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+/// Mapper: Jetpack connection registration
+///
+/// periphery: ignore - used in `JetpackConnectionRemote`
+struct JetpackConnectionRegistrationMapper: Mapper {
+
+    /// (Attempts) to extract the updated `currentUser` field from a given JSON Encoded response.
+    ///
+    func map(response: Data) throws -> JetpackConnectionRegistration {
+        let decoder = JSONDecoder()
+        return try decoder.decode(JetpackConnectionRegistration.self, from: response)
+    }
+}
+
+struct JetpackConnectionRegistration: Decodable {
+    let authorizeUrl: String
+}

Modules/Sources/Networking/Mapper/JetpackConnectionURLMapper.swift

@@ -8,7 +8,7 @@ struct JetpackConnectionURLMapper: Mapper {
     ///
     func map(response: Data) throws -> URL {
         guard let escapedString = String(data: response, encoding: .utf8) else {
-            throw JetpackConnectionRemote.ConnectionError.malformedURL
+            throw JetpackConnectionError.malformedURL
         }
         // The API returns an escaped string with double quotes, so we need to clean it up.
         let urlString = escapedString