fix(platform-ios): persist xctest startup logs

V3RON · V3RON · commit 4f92d79f62f3 · 2026-04-30T07:53:12.000+02:00
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -104,6 +104,14 @@ jobs:
             echo "HARNESS_RUNNER=$HARNESS_RUNNER"
             echo "HARNESS_EXIT_CODE=$HARNESS_EXIT_CODE"
 
+      - name: Upload Harness logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: harness-logs-e2e-android
+          path: apps/playground/.harness/logs
+          if-no-files-found: ignore
+
   e2e-ios:
     name: E2E iOS
     runs-on: macos-latest
@@ -197,6 +205,14 @@ jobs:
             echo "HARNESS_RUNNER=$HARNESS_RUNNER"
             echo "HARNESS_EXIT_CODE=$HARNESS_EXIT_CODE"
 
+      - name: Upload Harness logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: harness-logs-e2e-ios
+          path: apps/playground/.harness/logs
+          if-no-files-found: ignore
+
   e2e-web:
     name: E2E Web
     runs-on: ubuntu-22.04
@@ -243,6 +259,14 @@ jobs:
             echo "HARNESS_RUNNER=$HARNESS_RUNNER"
             echo "HARNESS_EXIT_CODE=$HARNESS_EXIT_CODE"
 
+      - name: Upload Harness logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: harness-logs-e2e-web
+          path: apps/playground/.harness/logs
+          if-no-files-found: ignore
+
   crash-validate-android:
     name: Crash Validation Android
     runs-on: ubuntu-22.04
@@ -349,6 +373,14 @@ jobs:
             exit 1
           fi
 
+      - name: Upload Harness logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: harness-logs-crash-validate-android
+          path: apps/playground/.harness/logs
+          if-no-files-found: ignore
+
   crash-validate-ios:
     name: Crash Validation iOS
     runs-on: macos-latest
@@ -465,3 +497,11 @@ jobs:
             echo "ERROR: No crash report artifacts found in $CRASH_DIR"
             exit 1
           fi
+
+      - name: Upload Harness logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: harness-logs-crash-validate-ios
+          path: apps/playground/.harness/logs
+          if-no-files-found: ignore
diff --git a/packages/platform-ios/src/__tests__/xctest-agent.test.ts b/packages/platform-ios/src/__tests__/xctest-agent.test.ts
@@ -3,6 +3,7 @@ import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import { createHash } from 'node:crypto';
+import { PassThrough } from 'node:stream';
 import { fileURLToPath } from 'node:url';
 
 const mocks = vi.hoisted(() => ({
@@ -101,6 +102,8 @@ const createLongRunningSubprocess = (options?: {
       return childProcess;
     }),
     signalCode: null,
+    stderr: new PassThrough(),
+    stdout: new PassThrough(),
   };
 
   const iterable = {
@@ -184,6 +187,9 @@ describe('xctest-agent orchestration', () => {
       path.join(buildRoot, 'device', 'build-manifest.json'),
       JSON.stringify({
         buildInputsHash: getCurrentInputsHash(),
+        codeSign: {
+          teamId: 'TESTTEAM01',
+        },
         destinationKind: 'device',
       }),
     );
@@ -237,8 +243,8 @@ describe('xctest-agent orchestration', () => {
       ]),
       expect.objectContaining({
         env: expect.objectContaining({
-          HARNESS_XCTEST_AGENT_MODE: 'test',
-          HARNESS_XCTEST_AGENT_PORT: '49152',
+          TEST_RUNNER_HARNESS_XCTEST_AGENT_MODE: 'test',
+          TEST_RUNNER_HARNESS_XCTEST_AGENT_PORT: '49152',
         }),
       }),
     );
@@ -249,6 +255,19 @@ describe('xctest-agent orchestration', () => {
     expect(mocks.configurePermissions).toHaveBeenCalledWith({
       autoAcceptPermissions: true,
     });
+    const logDirectories = fs.readdirSync(path.join(tempProjectRoot, '.harness', 'logs'));
+    expect(logDirectories).toHaveLength(1);
+    const xcodebuildLogPath = path.join(
+      tempProjectRoot,
+      '.harness',
+      'logs',
+      logDirectories[0]!,
+      'xcodebuild.log'
+    );
+    expect(fs.existsSync(xcodebuildLogPath)).toBe(true);
+    expect(fs.readFileSync(xcodebuildLogPath, 'utf8')).toContain(
+      'command=xcodebuild test-without-building'
+    );
 
     await controller.dispose();
 
diff --git a/packages/platform-ios/src/xctest-agent.ts b/packages/platform-ios/src/xctest-agent.ts
@@ -1,11 +1,14 @@
 import {
+  createHarnessArtifactDirectory,
   getAvailablePort,
   logger,
   spawn,
   type Subprocess,
 } from '@react-native-harness/tools';
 import fs from 'node:fs';
 import { createHash } from 'node:crypto';
+import { PassThrough, pipeline } from 'node:stream';
+import { promisify } from 'node:util';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import {
@@ -24,11 +27,12 @@ const XCTEST_AGENT_SCHEME_NAME = 'HarnessXCTestAgent';
 const XCTEST_AGENT_PORT_ENV = 'HARNESS_XCTEST_AGENT_PORT';
 const XCTEST_AGENT_TARGET_BUNDLE_ID_ENV =
   'HARNESS_XCTEST_AGENT_TARGET_BUNDLE_ID';
-const XCTEST_AGENT_STARTUP_TIMEOUT_MS = 30_000;
+const XCTEST_AGENT_STARTUP_TIMEOUT_MS = 60_000;
 const XCTEST_AGENT_SHUTDOWN_TIMEOUT_MS = 5_000;
 const XCTEST_AGENT_STARTUP_POLL_INTERVAL_MS = 250;
 const HARNESS_DIRNAME = '.harness';
 const XCTEST_AGENT_BUILD_DIRNAME = 'xctest-agent';
+const pipelineAsync = promisify(pipeline);
 
 type XCTestAgentTarget =
   | {
@@ -376,6 +380,53 @@ const getErrorMessage = (error: unknown): string => {
   return error instanceof Error ? error.message : String(error);
 };
 
+const attachProcessOutputLog = async (options: {
+  command: string;
+  logFilePath: string;
+  process: Subprocess;
+}) => {
+  fs.mkdirSync(path.dirname(options.logFilePath), { recursive: true });
+  fs.writeFileSync(
+    options.logFilePath,
+    [
+      `timestamp=${new Date().toISOString()}`,
+      `command=${options.command}`,
+      '',
+    ].join('\n'),
+    'utf8'
+  );
+  const output = fs.createWriteStream(options.logFilePath, { flags: 'a' });
+
+  const childProcess = await options.process.nodeChildProcess;
+  const mergedOutput = new PassThrough();
+  const forwardStream = async (
+    stream: NodeJS.ReadableStream | null | undefined,
+    label: 'stdout' | 'stderr'
+  ) => {
+    if (!stream) {
+      return;
+    }
+
+    for await (const chunk of stream) {
+      mergedOutput.write(`[${label}] `);
+      mergedOutput.write(chunk);
+      if (Buffer.isBuffer(chunk) ? !chunk.includes(0x0a) : !String(chunk).endsWith('\n')) {
+        mergedOutput.write('\n');
+      }
+    }
+  };
+
+  const pipeTask = pipelineAsync(mergedOutput, output);
+  const forwardTask = Promise.all([
+    forwardStream(childProcess.stdout, 'stdout'),
+    forwardStream(childProcess.stderr, 'stderr'),
+  ]).finally(() => {
+    mergedOutput.end();
+  });
+
+  void Promise.allSettled([pipeTask, forwardTask]);
+};
+
 export const createXCTestAgentController = (options: {
   appBundleId?: string;
   target: XCTestAgentTarget;
@@ -390,6 +441,13 @@ export const createXCTestAgentController = (options: {
     options.startupTimeoutMs ?? XCTEST_AGENT_STARTUP_TIMEOUT_MS;
   const shutdownTimeoutMs =
     options.shutdownTimeoutMs ?? XCTEST_AGENT_SHUTDOWN_TIMEOUT_MS;
+  const logArtifacts = createHarnessArtifactDirectory({
+    artifactType: 'logs',
+    bundleId: options.appBundleId,
+    platformId: 'ios',
+    runnerName: `xctest-agent-${target.kind}`,
+  });
+  const xcodebuildLogPath = path.join(logArtifacts.directoryPath, 'xcodebuild.log');
   let prepared = false;
   let agentProcess: Subprocess | null = null;
   let agentClient: ReturnType<typeof createXCTestAgentClient> | null = null;
@@ -493,23 +551,24 @@ export const createXCTestAgentController = (options: {
       target.kind
     );
     xctestAgentLogger.debug('Using XCTest agent port %d', port);
+    const xcodebuildArgs = [
+      'test-without-building',
+      '-project',
+      getXCTestAgentProjectFilePath(),
+      '-scheme',
+      XCTEST_AGENT_SCHEME_NAME,
+      '-destination',
+      getXCTestAgentRunDestination(target),
+      '-parallel-testing-enabled',
+      'NO',
+      '-maximum-parallel-testing-workers',
+      '1',
+      '-derivedDataPath',
+      getXCTestAgentDerivedDataPath(target),
+    ];
     agentProcess = spawn(
       'xcodebuild',
-      [
-        'test-without-building',
-        '-project',
-        getXCTestAgentProjectFilePath(),
-        '-scheme',
-        XCTEST_AGENT_SCHEME_NAME,
-        '-destination',
-        getXCTestAgentRunDestination(target),
-        '-parallel-testing-enabled',
-        'NO',
-        '-maximum-parallel-testing-workers',
-        '1',
-        '-derivedDataPath',
-        getXCTestAgentDerivedDataPath(target),
-      ],
+      xcodebuildArgs,
       {
         cwd: getXCTestAgentProjectRoot(),
         env: {
@@ -519,10 +578,14 @@ export const createXCTestAgentController = (options: {
             ...getLaunchEnvironment(),
           }),
         },
-        stdout: 'ignore',
-        stderr: 'ignore',
       }
     );
+    void attachProcessOutputLog({
+      command: ['xcodebuild', ...xcodebuildArgs].join(' '),
+      logFilePath: xcodebuildLogPath,
+      process: agentProcess,
+    });
+    xctestAgentLogger.info('Saving XCTest agent xcodebuild logs to %s', xcodebuildLogPath);
 
     const currentProcess = agentProcess;
     if (typeof currentProcess.catch === 'function') {
@@ -550,9 +613,10 @@ export const createXCTestAgentController = (options: {
       await client.configurePermissions(runtimeConfiguration.permissions);
     } catch (error) {
       xctestAgentLogger.warn(
-        'XCTest agent startup failed for %s: %s',
+        'XCTest agent startup failed for %s: %s (logs: %s)',
         target.kind,
-        getErrorMessage(error)
+        getErrorMessage(error),
+        xcodebuildLogPath
       );
       await transport.dispose();
       agentClient = null;
diff --git a/packages/tools/src/__tests__/harness-artifacts.test.ts b/packages/tools/src/__tests__/harness-artifacts.test.ts
@@ -0,0 +1,37 @@
+import { afterEach, describe, expect, it } from 'vitest';
+import fs from 'node:fs';
+import path from 'node:path';
+import { tmpdir } from 'node:os';
+import { createHarnessArtifactDirectory } from '../harness-artifacts.js';
+
+describe('createHarnessArtifactDirectory', () => {
+  const rootDir = fs.mkdtempSync(
+    path.join(tmpdir(), 'rn-harness-artifact-directories-')
+  );
+
+  afterEach(() => {
+    fs.rmSync(rootDir, { recursive: true, force: true });
+    fs.mkdirSync(rootDir, { recursive: true });
+  });
+
+  it('creates a reusable run directory inside the requested artifact type', () => {
+    const artifacts = createHarnessArtifactDirectory({
+      artifactType: 'logs',
+      bundleId: 'com.harnessplayground.dev',
+      platformId: 'ios',
+      rootDir,
+      runTimestamp: '2026-04-29T10-45-31-645Z',
+      runnerName: 'xctest-agent simulator',
+    });
+
+    expect(artifacts.rootDir).toBe(path.join(rootDir, 'logs'));
+    expect(artifacts.directoryPath).toBe(
+      path.join(
+        rootDir,
+        'logs',
+        '2026-04-29T10-45-31-645Z--ios--xctest-agent-simulator--com.harnessplayground.dev'
+      )
+    );
+    expect(fs.existsSync(artifacts.directoryPath)).toBe(true);
+  });
+});
diff --git a/packages/tools/src/harness-artifacts.ts b/packages/tools/src/harness-artifacts.ts
@@ -0,0 +1,49 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+const getDefaultHarnessRoot = () => path.join(process.cwd(), '.harness');
+
+const sanitizePathSegment = (value: string) =>
+  value
+    .replace(/[^a-zA-Z0-9._-]+/g, '-')
+    .replace(/-+/g, '-')
+    .replace(/^-|-$/g, '') || 'artifact';
+
+const formatRunTimestamp = (value: Date) =>
+  value.toISOString().replace(/[:.]/g, '-');
+
+export const createHarnessArtifactDirectory = ({
+  artifactType,
+  bundleId,
+  platformId,
+  rootDir = getDefaultHarnessRoot(),
+  runTimestamp = formatRunTimestamp(new Date()),
+  runnerName,
+}: {
+  artifactType: string;
+  bundleId?: string;
+  platformId: string;
+  rootDir?: string;
+  runTimestamp?: string;
+  runnerName: string;
+}) => {
+  const artifactRoot = path.join(rootDir, sanitizePathSegment(artifactType));
+  const runDirName = [
+    runTimestamp,
+    platformId,
+    runnerName,
+    bundleId,
+  ]
+    .filter(Boolean)
+    .map((value) => sanitizePathSegment(value))
+    .join('--');
+  const directoryPath = path.join(artifactRoot, runDirName);
+
+  fs.mkdirSync(directoryPath, { recursive: true });
+
+  return {
+    directoryPath,
+    rootDir: artifactRoot,
+    runTimestamp,
+  };
+};
diff --git a/packages/tools/src/index.ts b/packages/tools/src/index.ts
@@ -9,5 +9,6 @@ export * from './error.js';
 export * from './events.js';
 export * from './packages.js';
 export * from './crash-artifacts.js';
+export * from './harness-artifacts.js';
 export * from './regex.js';
 export * from './isInteractive.js';
