Add internal Checkout Kit telemetry foundations

.ci/changed-file-filters.yml

@@ -6,6 +6,7 @@ android:
   - &exclude-docs-directory '!**/docs/**'
 swift:
   - 'platforms/swift/**'
+  - 'telemetry/languages/swift/**'
   - *exclude-markdown
   - *exclude-docs-directory
 reactNative:
@@ -14,8 +15,15 @@ reactNative:
   - *exclude-docs-directory
 web:
   - 'platforms/web/**'
+  - 'telemetry/languages/typescript/**'
+  - 'telemetry/contract/**'
   - *exclude-markdown
   - *exclude-docs-directory
+# Markdown stays included here: the metrics contract is a markdown document
+# and contract changes must run the telemetry checks.
+telemetry:
+  - 'telemetry/**'
+  - *exclude-docs-directory
 protocol:
   - 'protocol/**'
   - *exclude-markdown

.github/workflows/android-publish.yml

@@ -69,8 +69,7 @@ jobs:
 
       - name: Publish Package
         run: |
-          ./gradlew \
-            :lib:publishReleasePublicationToOssrh-staging-apiRepository
+          ./gradlew :lib:publishReleasePublicationToOssrh-staging-apiRepository
         env:
           OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}

.github/workflows/ci.yml

@@ -35,6 +35,7 @@ jobs:
       reactNativeIos: ${{ steps.platform.outputs.reactNative == 'true' || steps.platform.outputs.protocolTypescript == 'true' || steps.platform.outputs.protocolShared == 'true' || steps.infra.outputs.reactNativeCommon == 'true' || steps.infra.outputs.reactNativeIos == 'true' }}
       reactNativeAndroid: ${{ steps.platform.outputs.reactNative == 'true' || steps.platform.outputs.protocolTypescript == 'true' || steps.platform.outputs.protocolShared == 'true' || steps.infra.outputs.reactNativeCommon == 'true' || steps.infra.outputs.reactNativeAndroid == 'true' }}
       web: ${{ steps.platform.outputs.web == 'true' || steps.platform.outputs.protocolTypescript == 'true' || steps.platform.outputs.protocolShared == 'true' || steps.infra.outputs.web == 'true' }}
+      telemetry: ${{ steps.platform.outputs.telemetry == 'true' || steps.infra.outputs.telemetry == 'true' }}
       protocol: ${{ steps.platform.outputs.protocolTypescript == 'true' || steps.platform.outputs.protocolShared == 'true' || steps.infra.outputs.protocol == 'true' }}
       scripts: ${{ steps.infra.outputs.scripts == 'true' }}
     steps:
@@ -101,6 +102,11 @@ jobs:
               - '.github/actions/setup/**'
               - '.ci/changed-file-filters.yml'
               - '.github/workflows/ci.yml'
+            telemetry:
+              - '.github/workflows/telemetry-test.yml'
+              - '.github/actions/setup/**'
+              - '.ci/changed-file-filters.yml'
+              - '.github/workflows/ci.yml'
             protocol:
               - '.github/workflows/protocol-test.yml'
               - '.github/actions/setup/**'
@@ -208,6 +214,14 @@ jobs:
       pull-requests: write
     uses: ./.github/workflows/web.yml
 
+  telemetry-test:
+    name: Telemetry
+    needs: changes
+    if: needs.changes.outputs.telemetry == 'true'
+    permissions:
+      contents: read
+    uses: ./.github/workflows/telemetry-test.yml
+
   protocol-test:
     name: Protocol
     needs: changes
@@ -265,6 +279,7 @@ jobs:
       - rn-check-packed-files
       - rn-lint
       - web
+      - telemetry-test
       - protocol-test
       - scripts-test
       - breaking-changes

.github/workflows/telemetry-test.yml

@@ -0,0 +1,37 @@
+name: Telemetry
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Typecheck, lint, test
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+    defaults:
+      run:
+        # The TypeScript telemetry package is a member of the web pnpm
+        # workspace, so dependency install and filtered runs happen there.
+        working-directory: platforms/web
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Setup Node.js, pnpm, and install dependencies
+        uses: ./.github/actions/setup
+        with:
+          node-version-file: platforms/web/package.json
+          cache-dependency-path: platforms/web/pnpm-lock.yaml
+          package-json-file: platforms/web/package.json
+          working-directory: platforms/web
+
+      - name: Typecheck
+        run: pnpm --filter @shopify/checkout-kit-telemetry run typecheck
+
+      - name: Lint
+        run: pnpm --filter @shopify/checkout-kit-telemetry run lint
+
+      - name: Test
+        run: pnpm --filter @shopify/checkout-kit-telemetry run test

.swiftlint.yml

@@ -11,6 +11,8 @@ disabled_rules:
 included:
   - platforms/swift/Sources
   - platforms/swift/Tests
+  - telemetry/languages/swift/Sources
+  - telemetry/languages/swift/Tests
 
 excluded:
   - platforms/swift/Samples

Package.swift

@@ -21,7 +21,7 @@ let package = Package(
         .library(
             name: "EmbeddedCheckoutProtocol",
             targets: ["EmbeddedCheckoutProtocol"]
-        )
+        ),
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -36,8 +36,13 @@ let package = Package(
             path: "protocol/languages/swift/Sources/UniversalCommerceProtocol/EmbeddedCheckoutProtocol"
         ),
         .target(
-            name: "ShopifyCheckoutKit",
+            name: "CheckoutKitTelemetry",
             dependencies: ["EmbeddedCheckoutProtocol"],
+            path: "telemetry/languages/swift/Sources/CheckoutKitTelemetry"
+        ),
+        .target(
+            name: "ShopifyCheckoutKit",
+            dependencies: ["EmbeddedCheckoutProtocol", "CheckoutKitTelemetry"],
             path: "platforms/swift/Sources/ShopifyCheckoutKit",
             resources: [.process("Assets.xcassets")]
         ),
@@ -53,9 +58,14 @@ let package = Package(
             path: "protocol/languages/swift/Tests/EmbeddedCheckoutProtocolTests",
             resources: [.copy("Fixtures")]
         ),
+        .testTarget(
+            name: "CheckoutKitTelemetryTests",
+            dependencies: ["CheckoutKitTelemetry"],
+            path: "telemetry/languages/swift/Tests/CheckoutKitTelemetryTests"
+        ),
         .testTarget(
             name: "ShopifyCheckoutKitTests",
-            dependencies: ["ShopifyCheckoutKit"],
+            dependencies: ["ShopifyCheckoutKit", "CheckoutKitTelemetry"],
             path: "platforms/swift/Tests/ShopifyCheckoutKitTests"
         ),
         .testTarget(

ShopifyCheckoutKit.podspec

@@ -28,6 +28,7 @@ Pod::Spec.new do |s|
     core.source_files = [
       'platforms/swift/Sources/ShopifyCheckoutKit/**/*.swift',
       'protocol/languages/swift/Sources/UniversalCommerceProtocol/EmbeddedCheckoutProtocol/**/*.swift',
+      'telemetry/languages/swift/Sources/CheckoutKitTelemetry/**/*.swift',
     ]
     core.resource_bundles = {
       'ShopifyCheckoutKit' => ['platforms/swift/Sources/ShopifyCheckoutKit/Assets.xcassets']

dev.yml

@@ -136,6 +136,7 @@ commands:
       /opt/dev/bin/dev react-native lint
       /opt/dev/bin/dev web lint
       /opt/dev/bin/dev protocol lint
+      /opt/dev/bin/dev telemetry typecheck
 
   test:
     desc: Run tests across all supported workspaces
@@ -146,6 +147,7 @@ commands:
       /opt/dev/bin/dev react-native test
       /opt/dev/bin/dev web test
       /opt/dev/bin/dev protocol test typescript
+      /opt/dev/bin/dev telemetry test typescript
 
   apollo:
     desc: "Apollo GraphQL schema and code generation commands"
@@ -237,6 +239,55 @@ commands:
         desc: Verify protocol codegen tools match protocol/package.json
         run: ./protocol/scripts/check_codegen_tools.sh "$@"
 
+  telemetry:
+    desc: "Checkout telemetry package commands"
+    subcommands:
+      test:
+        desc: "Run telemetry tests for every language, or a single one. Usage: dev telemetry test [typescript|swift|kotlin]"
+        syntax: "[typescript|swift|kotlin]"
+        run: |
+          set -e
+          run_typescript() { (cd telemetry/languages/typescript && pnpm test); }
+          run_swift() {
+            # xcode_run only auto-discovers test targets under
+            # platforms/swift/Tests, so pass the telemetry target/suite
+            # pair explicitly.
+            (cd platforms/swift && ./Scripts/xcode_run test ShopifyCheckoutKit-Package CheckoutKitTelemetryTests/CheckoutKitTelemetryTests)
+          }
+          run_kotlin() {
+            platforms/android/gradlew -p platforms/android :lib:testDebugUnitTest \
+              --tests "com.shopify.checkoutkit.telemetry.*" \
+              --tests "com.shopify.checkoutkit.Telemetry*" \
+              --console=plain
+          }
+          case "${1:-all}" in
+            typescript|ts) run_typescript ;;
+            swift|ios) run_swift ;;
+            kotlin|android) run_kotlin ;;
+            all) run_typescript; run_swift; run_kotlin ;;
+            *) echo "Usage: dev telemetry test [typescript|swift|kotlin]"; exit 1 ;;
+          esac
+      typecheck:
+        desc: "Type-check the TypeScript telemetry package"
+        run: cd telemetry/languages/typescript && pnpm typecheck
+      lint:
+        desc: "Lint the TypeScript and Swift telemetry sources (Kotlin lives in the Android lib and is covered by dev android lint)"
+        run: |
+          set -e
+          (cd telemetry/languages/typescript && pnpm lint)
+          # SwiftLint's scope comes from .swiftlint.yml's `included`, which
+          # covers the telemetry Swift sources. Use the Mintfile-pinned
+          # binary so results match CI.
+          swiftlint_bin="$(cd platforms/swift && mint which swiftlint)"
+          "$swiftlint_bin" lint --strict --no-cache --quiet
+      check:
+        desc: "Type-check, lint, and test the telemetry packages in every language"
+        run: |
+          set -e
+          /opt/dev/bin/dev telemetry typecheck
+          /opt/dev/bin/dev telemetry lint
+          /opt/dev/bin/dev telemetry test
+
   # Android
   android:
     aliases: ["kotlin"]

platforms/android/lib/build.gradle

@@ -121,7 +121,6 @@ dependencies {
     mockitoAgent libs.mockito.core
 
     api project(':embedded-checkout-protocol')
-
     testImplementation libs.junit
     testImplementation libs.robolectric
     testImplementation libs.mockito.core