Add iOS Harness barcode scan E2E

Author: mrousavy

.github/workflows/harness-ios.yml

@@ -0,0 +1,235 @@
+name: Harness iOS
+
+concurrency:
+  group: harness-ios-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+    inputs:
+      device_model:
+        description: "Preferred iOS Simulator device model"
+        required: false
+        default: "iPhone 16 Pro"
+        type: string
+      ios_version:
+        description: "Preferred iOS runtime version. Leave empty to use any available matching device."
+        required: false
+        default: ""
+        type: string
+      xcode_version:
+        description: "Preferred Xcode version. Leave empty to use the runner default."
+        required: false
+        default: ""
+        type: string
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/workflows/harness-ios.yml"
+      - "apps/example/**"
+      - "packages/react-native-data-scanner/ios/**"
+      - "packages/react-native-data-scanner/cpp/**"
+      - "packages/react-native-data-scanner/nitrogen/generated/shared/**"
+      - "packages/react-native-data-scanner/nitrogen/generated/ios/**"
+      - "packages/react-native-data-scanner/*.podspec"
+      - "packages/react-native-data-scanner/react-native.config.js"
+      - "packages/react-native-data-scanner/nitro.json"
+      - "package.json"
+      - "bun.lock"
+  pull_request:
+    paths:
+      - ".github/workflows/harness-ios.yml"
+      - "apps/example/**"
+      - "packages/react-native-data-scanner/ios/**"
+      - "packages/react-native-data-scanner/cpp/**"
+      - "packages/react-native-data-scanner/nitrogen/generated/shared/**"
+      - "packages/react-native-data-scanner/nitrogen/generated/ios/**"
+      - "packages/react-native-data-scanner/*.podspec"
+      - "packages/react-native-data-scanner/react-native.config.js"
+      - "packages/react-native-data-scanner/nitro.json"
+      - "package.json"
+      - "bun.lock"
+
+env:
+  DEVICE_MODEL: ${{ github.event.inputs.device_model || 'iPhone 16 Pro' }}
+  IOS_VERSION: ${{ github.event.inputs.ios_version || '' }}
+  XCODE_VERSION: ${{ github.event.inputs.xcode_version || '' }}
+  IOS_BUNDLE_ID: com.margelo.datascanner.example
+  HARNESS_IOS_BUNDLE_ID: com.margelo.datascanner.example
+  IOS_SCHEME: DataScannerExample
+  IOS_APP_PATH: apps/example/ios/build/Build/Products/Debug-iphonesimulator/DataScannerExample.app
+  HARNESS_DEBUG: 1
+
+jobs:
+  harness_ios:
+    name: Harness iOS
+    runs-on: macos-26
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 1
+
+      - uses: oven-sh/setup-bun@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: "24"
+
+      - name: Select Xcode
+        run: |
+          set -euo pipefail
+
+          if [ -n "$XCODE_VERSION" ] && [ -d "/Applications/Xcode_${XCODE_VERSION}.app" ]; then
+            sudo xcode-select -s "/Applications/Xcode_${XCODE_VERSION}.app/Contents/Developer"
+          fi
+
+          xcodebuild -version
+
+      - name: Install npm dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Prebuild iOS app
+        working-directory: apps/example
+        run: CI=1 bunx expo prebuild --platform ios --clean --no-install
+
+      - name: Restore CocoaPods cache
+        uses: actions/cache@v5
+        with:
+          path: |
+            apps/example/ios/Pods
+            ~/Library/Caches/CocoaPods
+            ~/.cocoapods
+          key: ${{ runner.os }}-${{ runner.arch }}-pods-${{ hashFiles('bun.lock', 'apps/example/ios/Podfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ runner.arch }}-pods-
+
+      - name: Install Pods
+        working-directory: apps/example/ios
+        run: pod install
+
+      - name: Boot iOS Simulator
+        run: |
+          set -euo pipefail
+
+          selection="$(
+            xcrun simctl list devices available --json | node -e '
+              const fs = require("fs");
+              const data = JSON.parse(fs.readFileSync(0, "utf8"));
+              const preferredModel = process.env.DEVICE_MODEL;
+              const preferredVersion = process.env.IOS_VERSION;
+
+              const candidates = Object.entries(data.devices ?? {})
+                .filter(([runtime]) => runtime.includes("iOS"))
+                .flatMap(([runtime, devices]) =>
+                  (devices ?? [])
+                    .filter((device) => device.isAvailable !== false)
+                    .map((device) => {
+                      const runtimeMatch = runtime.match(/iOS-(\d+(?:-\d+)*)$/);
+                      const version = runtimeMatch?.[1]?.replace(/-/g, ".") ?? "";
+                      return { runtime, version, device };
+                    })
+                );
+
+              const exact =
+                preferredVersion === ""
+                  ? undefined
+                  : candidates.find(({ version, device }) =>
+                      device.name === preferredModel && version === preferredVersion
+                    );
+              const matchingModel = candidates.find(({ device }) => device.name === preferredModel);
+              const matchingPhone = candidates.find(({ device }) => device.name.includes("iPhone"));
+              const fallback = candidates[0];
+              const selected = exact ?? matchingModel ?? matchingPhone ?? fallback;
+
+              if (selected == null) {
+                console.error("No available iOS simulator found.");
+                process.exit(1);
+              }
+
+              process.stdout.write(JSON.stringify({
+                udid: selected.device.udid,
+                name: selected.device.name,
+                version: selected.version,
+              }));
+            '
+          )"
+
+          echo "$selection"
+          echo "SIMULATOR_UDID=$(node -e 'process.stdout.write(JSON.parse(process.argv[1]).udid)' "$selection")" >> "$GITHUB_ENV"
+          echo "HARNESS_IOS_DEVICE=$(node -e 'process.stdout.write(JSON.parse(process.argv[1]).name)' "$selection")" >> "$GITHUB_ENV"
+          echo "HARNESS_IOS_VERSION=$(node -e 'process.stdout.write(JSON.parse(process.argv[1]).version)' "$selection")" >> "$GITHUB_ENV"
+
+          simulator_udid="$(node -e 'process.stdout.write(JSON.parse(process.argv[1]).udid)' "$selection")"
+          xcrun simctl boot "$simulator_udid" || true
+
+          xcrun simctl bootstatus "$simulator_udid" -b &
+          bootstatus_pid=$!
+          bootstatus_timed_out=0
+          boot_deadline=$((SECONDS + 240))
+
+          while kill -0 "$bootstatus_pid" >/dev/null 2>&1; do
+            if (( SECONDS >= boot_deadline )); then
+              echo "Timed out waiting for simulator bootstatus. Checking simulator state..."
+              kill "$bootstatus_pid" >/dev/null 2>&1 || true
+              wait "$bootstatus_pid" >/dev/null 2>&1 || true
+
+              state="$(
+                xcrun simctl list devices available --json | node -e '
+                  const fs = require("fs");
+                  const data = JSON.parse(fs.readFileSync(0, "utf8"));
+                  const udid = process.argv[1];
+                  const devices = Object.values(data.devices ?? {}).flat();
+                  process.stdout.write(devices.find((device) => device.udid === udid)?.state ?? "");
+                ' "$simulator_udid"
+              )"
+
+              echo "Simulator state after bootstatus timeout: ${state:-unknown}"
+              if [ "$state" = "Booted" ]; then
+                bootstatus_timed_out=1
+                break
+              fi
+
+              xcrun simctl list devices available
+              exit 1
+            fi
+
+            sleep 2
+          done
+
+          if [ "$bootstatus_timed_out" = "0" ]; then
+            wait "$bootstatus_pid"
+          fi
+
+      - name: Restore DerivedData cache
+        uses: actions/cache@v5
+        with:
+          path: apps/example/ios/build
+          key: ${{ runner.os }}-${{ runner.arch }}-xcode-dd-${{ hashFiles('bun.lock', 'apps/example/ios/Podfile.lock', 'apps/example/ios/**/*.pbxproj') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ runner.arch }}-xcode-dd-
+
+      - name: Build iOS app
+        working-directory: apps/example/ios
+        run: |
+          set -o pipefail
+          xcodebuild \
+            -workspace "${IOS_SCHEME}.xcworkspace" \
+            -scheme "$IOS_SCHEME" \
+            -configuration Debug \
+            -sdk iphonesimulator \
+            -destination "id=$SIMULATOR_UDID" \
+            -derivedDataPath build \
+            -UseModernBuildSystem=YES \
+            ONLY_ACTIVE_ARCH=YES \
+            CODE_SIGNING_ALLOWED=NO \
+            build
+
+      - name: Install iOS app
+        run: xcrun simctl install "$SIMULATOR_UDID" "$IOS_APP_PATH"
+
+      - name: Run Harness tests with serve-sim camera
+        working-directory: apps/example
+        run: bash ./scripts/run-harness-ios-ci.sh

.gitignore

@@ -70,6 +70,8 @@ android/keystores/debug.keystore
 
 # Expo
 .expo/
+apps/example/android/
+apps/example/ios/
 
 # Turborepo
 .turbo/

apps/example/__tests__/data-scanner.ios.harness.ts

@@ -0,0 +1,69 @@
+import { describe, expect, it } from 'react-native-harness'
+import {
+  DataScanner,
+  type ScanBarcodeOptions,
+  type ScannedBarcode,
+} from 'react-native-data-scanner'
+
+const expectedQRCodeValue =
+  'https://margelo.com/react-native-data-scanner/harness'
+
+describe('DataScanner.scanBarcode', () => {
+  it('scans a QR code with an explicit target format', async () => {
+    const barcode = await scanBarcode({
+      targetFormats: ['qr'],
+      qualityLevel: 'fast',
+    })
+
+    expect(barcode.format).toBe('qr')
+    expect(barcode.value).toBe(expectedQRCodeValue)
+  })
+
+  it('scans a QR code with high-accuracy options', async () => {
+    const barcode = await scanBarcode({
+      targetFormats: ['qr'],
+      qualityLevel: 'accurate',
+      enableHighFrameRateTracking: true,
+    })
+
+    expect(barcode).toStrictEqual({
+      format: 'qr',
+      value: expectedQRCodeValue,
+    })
+  })
+})
+
+async function scanBarcode(
+  options: ScanBarcodeOptions
+): Promise<ScannedBarcode> {
+  return await withTimeout(
+    DataScanner.scanBarcode(options),
+    30_000,
+    `scan barcode with options ${JSON.stringify(options)}`
+  )
+}
+
+async function withTimeout<T>(
+  promise: Promise<T>,
+  timeoutMs: number,
+  label: string
+): Promise<T> {
+  let timeout: ReturnType<typeof setTimeout> | undefined
+
+  try {
+    return await Promise.race([
+      promise,
+      new Promise<never>((_, reject) => {
+        timeout = setTimeout(() => {
+          reject(
+            new Error(`Timed out after ${timeoutMs}ms while waiting to ${label}.`)
+          )
+        }, timeoutMs)
+      }),
+    ])
+  } finally {
+    if (timeout != null) {
+      clearTimeout(timeout)
+    }
+  }
+}

apps/example/assets/harness-qr.png

@@ -0,0 +1,4 @@
+export default {
+  preset: 'react-native-harness',
+  testMatch: ['<rootDir>/**/__tests__/**/*.harness.[jt]s?(x)'],
+}

apps/example/jest.harness.config.mjs

@@ -11,14 +11,23 @@
     "react-native": "0.85.3"
   },
   "devDependencies": {
+    "@react-native-harness/platform-apple": "1.4.0-rc.1",
     "@types/react": "~19.2.2",
+    "jest": "^29.7.0",
+    "react-native-harness": "1.4.0-rc.1",
+    "serve-sim": "0.1.39",
     "typescript": "~6.0.3"
   },
   "scripts": {
     "start": "expo start",
     "android": "expo run:android",
     "ios": "expo run:ios",
-    "web": "expo start --web"
+    "web": "expo start --web",
+    "test:harness": "react-native-harness",
+    "test:harness:ios": "react-native-harness --harnessRunner ios"
+  },
+  "engines": {
+    "node": ">=20.19.4"
   },
   "private": true
 }

apps/example/package.json

@@ -0,0 +1,51 @@
+import {
+  applePlatform,
+  appleSimulator,
+} from '@react-native-harness/platform-apple'
+import { fileURLToPath } from 'node:url'
+
+const iosBundleId =
+  process.env.HARNESS_IOS_BUNDLE_ID ?? 'com.margelo.datascanner.example'
+const iosDevice = process.env.HARNESS_IOS_DEVICE ?? 'iPhone 16 Pro'
+const iosVersion = process.env.HARNESS_IOS_VERSION ?? '18.6'
+const entryPoint = fileURLToPath(new URL('./index.ts', import.meta.url))
+
+const cameraDylib = process.env.HARNESS_IOS_CAMERA_DYLIB?.trim()
+const cameraSharedMemoryName =
+  process.env.HARNESS_IOS_CAMERA_SHM_NAME?.trim()
+const cameraMirrorMode = process.env.HARNESS_IOS_CAMERA_MIRROR_MODE?.trim()
+
+const iosEnvironment =
+  cameraDylib && cameraSharedMemoryName
+    ? {
+        DYLD_INSERT_LIBRARIES: cameraDylib,
+        SIMCAM_SHM_NAME: cameraSharedMemoryName,
+        ...(cameraMirrorMode ? { SIMCAM_MIRROR_MODE: cameraMirrorMode } : {}),
+      }
+    : undefined
+
+const config = {
+  entryPoint,
+  appRegistryComponentName: 'main',
+  runners: [
+    applePlatform({
+      name: 'ios',
+      device: appleSimulator(iosDevice, iosVersion),
+      bundleId: iosBundleId,
+      appLaunchOptions: iosEnvironment
+        ? {
+            environment: iosEnvironment,
+          }
+        : undefined,
+    }),
+  ],
+  defaultRunner: 'ios',
+  bridgeTimeout: 120_000,
+  bundleStartTimeout: 90_000,
+  maxAppRestarts: 3,
+  detectNativeCrashes: true,
+  forwardClientLogs: true,
+  resetEnvironmentBetweenTestFiles: true,
+}
+
+export default config