fix(ios): preserve snapshot error context

Author: thymikee

packages/capture-kit/src/ios-snapshot-engine/errors.test.ts

@@ -3,15 +3,23 @@ import { test } from 'vitest';
 import { toIosSnapshotEngineErrorDetails } from './errors.ts';
 import { IosSnapshotEngineError } from './types.ts';
 
-test('engine error details expose only the public reason and field', () => {
+test('engine error details preserve typed public context', () => {
   const error = new IosSnapshotEngineError('invalid-viewport', 'invalid viewport', {
     field: 'viewport',
     index: 4,
+    parentIndex: 2,
     frame: { x: 0, y: 0, width: 10, height: 10 },
+    clip: { x: 1, y: 2, width: 3, height: 4 },
+    projection: 'regular',
   });
 
   assert.deepEqual(toIosSnapshotEngineErrorDetails(error), {
     reason: 'invalid-viewport',
     field: 'viewport',
+    index: 4,
+    parentIndex: 2,
+    frame: { x: 0, y: 0, width: 10, height: 10 },
+    clip: { x: 1, y: 2, width: 3, height: 4 },
+    projection: 'regular',
   });
 });

packages/capture-kit/src/ios-snapshot-engine/errors.ts

@@ -1,15 +1,23 @@
-import type { IosSnapshotEngineError, IosSnapshotEngineFailureReason } from './types.ts';
+import type {
+  IosSnapshotEngineError,
+  IosSnapshotEngineFailureDetails,
+  IosSnapshotEngineFailureReason,
+} from './types.ts';
 
-export type IosSnapshotEnginePublicErrorDetails = Readonly<{
-  reason: IosSnapshotEngineFailureReason;
-  field?: string;
-}>;
+export type IosSnapshotEnginePublicErrorDetails = Readonly<
+  IosSnapshotEngineFailureDetails & { reason: IosSnapshotEngineFailureReason }
+>;
 
 export function toIosSnapshotEngineErrorDetails(
   error: IosSnapshotEngineError,
 ): IosSnapshotEnginePublicErrorDetails {
   return {
     reason: error.reason,
-    ...(error.details.field ? { field: error.details.field } : {}),
+    ...(error.details.index !== undefined ? { index: error.details.index } : {}),
+    ...(error.details.parentIndex !== undefined ? { parentIndex: error.details.parentIndex } : {}),
+    ...(error.details.frame !== undefined ? { frame: error.details.frame } : {}),
+    ...(error.details.clip !== undefined ? { clip: error.details.clip } : {}),
+    ...(error.details.projection !== undefined ? { projection: error.details.projection } : {}),
+    ...(error.details.field !== undefined ? { field: error.details.field } : {}),
   };
 }

packages/provider-webdriver/src/webdriver-ios-snapshot.test.ts

@@ -49,13 +49,17 @@ test('Appium iOS snapshots acquire facts and publish regular output through the
 });
 
 test('Appium iOS options become an engine plan and engine-owned projection', () => {
-  const acquired = acquireWebDriverIosSnapshot(SOURCE, {
-    raw: true,
-    interactiveOnly: true,
-    depth: 1,
-    scope: 'Continue',
-    customActions: true,
-  });
+  const acquired = acquireWebDriverIosSnapshot(
+    SOURCE,
+    {
+      raw: true,
+      interactiveOnly: true,
+      depth: 1,
+      scope: 'Continue',
+      customActions: true,
+    },
+    'ios-2',
+  );
 
   assert.equal(acquired.input.stage, 'acquired');
   assert.deepEqual(acquired.plan.narrowing, {
@@ -71,7 +75,7 @@ test('Appium iOS options become an engine plan and engine-owned projection', ()
     customActions: true,
     acquisitionIntent: 'full',
   });
-  assert.deepEqual(acquired.input.acquisition.lineage, {});
+  assert.deepEqual(acquired.input.acquisition.lineage, { targetId: 'ios-2' });
   assert.deepEqual(acquired.input.acquisition.viewport, {
     kind: 'reported',
     rect: { x: 0, y: 0, width: 390, height: 844 },
@@ -82,7 +86,7 @@ test('Appium iOS options become an engine plan and engine-owned projection', ()
     published.result.nodes?.map((node) => [node.type, node.label, node.depth, node.parentIndex]),
     [['XCUIElementTypeButton', 'Continue', 0, undefined]],
   );
-  assert.deepEqual(published.publication.comparisonIdentity.lineage, {});
+  assert.deepEqual(published.publication.comparisonIdentity.lineage, { targetId: 'ios-2' });
 });
 
 test('Appium regular presentation omits unavailable hittability while raw preserves supplied facts', async () => {
@@ -93,8 +97,9 @@ test('Appium regular presentation omits unavailable hittability while raw preser
 
   const regular = await captureWebDriverIosSnapshot({ source: async () => source });
   const regularButton = regular.nodes?.find((node) => node.label === 'Continue');
+  assert.ok(regularButton);
   assert.equal(regularButton?.hittable, undefined);
-  assert.equal('hittable' in (regularButton ?? {}), false);
+  assert.equal('hittable' in regularButton, false);
 
   const raw = await captureWebDriverIosSnapshot({ source: async () => source }, { raw: true });
   assert.equal(raw.nodes?.find((node) => node.label === 'Continue')?.hittable, true);