fix: better ios step logging

Author: noomorph

src/steps/description-maker/ios/__fixtures__/broken.jsonl

@@ -0,0 +1,24 @@
+5
+[]
+{}
+"{}"
+"abc"
+{"type":"anything"}
+{"type":"anything","params":null}
+{"type":"deliverPayload","params":null}
+{"type":"invoke","params":null}
+{"type":"invoke","params":{"type":"action"}}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":null}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[]}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":null}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":{"type":"unknown"}}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":{"type":"and"}}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":{"type":"and","predicates":null}}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":{"type":"and","predicates":[]}}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":{"type":"id"}}}
+{"type":"invoke","params":{"type":"action","action":"accessibilityAction","params":[],"predicate":{"type":"id","value":null}}}
+{"type":"invoke","params":{"type":"action","action":"longPress","params":[],"predicate":{"type":"id","value":"draggable"},"targetElement":null}}
+{"type":"invoke","params":{"type":"expectation","predicate":null,"modifiers":["not"],"expectation":"toExist"}}
+{"type":"invoke","params":{"type":"expectation","predicate":{"type":"and","predicates":[{"type":"id","value":"Father883","isRegex":false},{"type":"ancestor","predicate":{}}]},"modifiers":null,"expectation":"toExist"}}
+{"type":"invoke","params":{"type":"expectation","predicate":{"type":"and","predicates":[{"type":"id","value":"Father883","isRegex":false},{"type":"ancestor","predicate":{}}]},"modifiers":["not"],"expectation":null}}
+{"type":"invoke","params":{"type":"expectation","predicate":{"type":"and","predicates":[{"type":"id","value":"Father883","isRegex":false},{"type":"ancestor","predicate":{}}]},"modifiers":["not"],"expectation":"toBeWeird"}}

src/steps/description-maker/ios/__fixtures__/tap-with-ancestor.json

@@ -4,12 +4,20 @@
     "type": "action",
     "action": "tap",
     "predicate": {
-      "type": "id",
-      "value": "childButton",
-      "ancestor": {
-        "type": "id",
-        "value": "parentView"
-      }
+      "type": "and",
+      "predicates": [
+        {
+          "type": "id",
+          "value": "childButton"
+        },
+        {
+          "type": "ancestor",
+          "predicate": {
+            "type": "id",
+            "value": "parentView"
+          }
+        }
+      ]
     }
   }
 }

src/steps/description-maker/ios/__snapshots__/ios-description-maker.test.ts.snap

@@ -9,14 +9,32 @@ export type PredicateType =
   | 'accessibilityLabel'
   | 'accessibilityIdentifier';
 
-export interface Predicate {
-  type: PredicateType | 'and';
-  value: string | string[] | number | boolean;
+export type Predicate =
+  | AtomicPredicate
+  | AncestorPredicate
+  | DescendantPredicate
+  | CompoundPredicate;
+
+export interface CompoundPredicate {
+  type: 'and';
+  predicates?: Predicate[];
+}
+
+export interface AncestorPredicate {
+  type: 'ancestor';
+  predicate?: Predicate;
+}
+
+export interface DescendantPredicate {
+  type: 'descendant';
+  predicate?: Predicate;
+}
+
+export interface AtomicPredicate {
+  type?: PredicateType;
+  value?: string | string[] | number | boolean;
   isRegex?: boolean;
   atIndex?: number;
-  predicates?: Predicate[];
-  ancestor?: Predicate;
-  descendant?: Predicate;
   targetElement?: {
     predicate: Predicate;
   };
@@ -51,7 +69,10 @@ export type ScrollEdge = 'top' | 'bottom' | 'left' | 'right';
 
 //#region Base Invocation
 interface BaseInvocation {
-  predicate: Predicate;
+  type?: string;
+  action?: unknown;
+  expectation?: unknown;
+  predicate?: Predicate;
   timeout?: number;
   atIndex?: number;
   params?: readonly unknown[];
@@ -61,13 +82,13 @@ interface BaseInvocation {
 //#region Invocations
 export interface ExpectationInvocation extends BaseInvocation {
   type: 'expectation';
-  expectation: DetoxExpectation;
+  expectation?: DetoxExpectation;
   modifiers?: ExpectationModifier[];
 }
 
 export interface BaseActionInvocation extends BaseInvocation {
   type: 'action';
-  action: DetoxAction;
+  action?: DetoxAction;
   while?: ExpectationInvocation;
 }
 //#endregion Invocations
@@ -151,16 +172,16 @@ export type ActionParams =
 //#region Messages
 export interface InvokeMessage {
   type: 'invoke';
-  params: Invocation;
+  params?: Invocation;
 }
 
 export interface DeliverPayloadMessage {
   type: 'deliverPayload';
-  params: DeliverPayloadParams;
+  params?: DeliverPayloadParams;
 }
 
 export interface DeliverPayloadParams {
-  url: string;
+  url?: string;
   delayPayload?: boolean;
   viewHierarchyURL?: string;
   detoxUserActivityDataURL?: string;

src/steps/description-maker/ios/detox-payload.ts

@@ -18,15 +18,15 @@ const actionFormatters: ActionFormatterMap = {
 
   scroll: ({ predicate, params: [distance, direction], while: whileCondition }) => {
     return concat(
-      msg(`Scroll ${direction} on`, { direction, distance }),
+      msg(`Scroll ${direction || 'somewhere'} on`, { direction, distance }),
       p(predicate),
       formatWhileCondition(whileCondition),
     );
   },
 
   scrollTo: ({ predicate, params: [edge, normalizedX, normalizedY] }) =>
     concat(
-      msg(`Scroll to ${edge}`, {
+      msg(`Scroll to ${edge || 'edge'}`, {
         edge,
         ...(normalizedX !== undefined && { x: normalizedX, y: normalizedY }),
       }),
@@ -40,7 +40,7 @@ const actionFormatters: ActionFormatterMap = {
   typeText: ({ predicate, params: [text] }) => concat(msg('Type text in', { text }), p(predicate)),
 
   accessibilityAction: ({ predicate, params: [action] }) =>
-    concat(msg(`Activate a11y "${action}" on`, { action }), p(predicate)),
+    concat(msg(`Activate a11y ${action ? `"${action}"` : 'action'} on`, { action }), p(predicate)),
 
   setDatePickerDate: ({ predicate, params: [date, format] }) =>
     concat('Set date picker', p(predicate), msg(`${date}`, { date, format })),
@@ -49,5 +49,6 @@ const actionFormatters: ActionFormatterMap = {
 // Main entry point that routes to the correct formatter based on action type
 export const formatAction = (action: ActionInvocation): StepDescription | null => {
   const formatter = actionFormatters[action.action];
-  return formatter ? formatter(action as any) : null;
+  const safeAction = action?.params ? action : { ...action, params: [] };
+  return formatter ? formatter(safeAction as any) : null;
 };

src/steps/description-maker/ios/formatters/action-formatters.ts

@@ -1,19 +1,23 @@
 import type { StepDescription } from '../../types';
-import type { ExpectationInvocation } from '../detox-payload';
+import type { ExpectationInvocation, Invocation } from '../detox-payload';
 import { formatPredicate } from './predicate-formatters';
 import { concat, msg, percent, truncate } from './utils';
 
 const formatExpectationVerb = (invocation: ExpectationInvocation): string => {
   const hasNot = invocation.modifiers?.includes('not');
-  const verb = invocation.expectation
-    .replace(/([A-Z])/g, ' $1')
+  const verb = invocation
+    .expectation!.replace(/([A-Z])/g, ' $1')
     .toLowerCase()
     .trim();
   return `${hasNot ? 'not ' : ''}${verb}`;
 };
 
 const formatExpectationParams = (invocation: ExpectationInvocation): StepDescription | null => {
-  const [expected] = invocation.params || [];
+  if (!Array.isArray(invocation.params)) {
+    return null;
+  }
+
+  const [expected] = invocation.params;
 
   switch (invocation.expectation) {
     case 'toBeVisible': {
@@ -38,11 +42,15 @@ export const formatWhileCondition = (
     : null;
 };
 
-export const formatExpectation = (invocation: ExpectationInvocation): StepDescription => {
+export const formatExpectation = (invocation: Invocation): StepDescription | null => {
+  if (!invocation.expectation) {
+    return null;
+  }
+
   return concat(
     'Expect',
     formatPredicate(invocation.predicate),
-    formatExpectationVerb(invocation),
-    formatExpectationParams(invocation),
+    formatExpectationVerb(invocation as ExpectationInvocation),
+    formatExpectationParams(invocation as ExpectationInvocation),
   );
 };

src/steps/description-maker/ios/formatters/expectation-formatters.ts

@@ -15,12 +15,20 @@ const messageFormatters: MessageFormatterMap = {
     const invocation = message.params;
     return formatInvocation(invocation);
   },
-  deliverPayload: ({ params: { url, delayPayload } }) =>
-    msg('Deliver payload', { url, delayPayload }),
+  deliverPayload: (message) => {
+    const data = message.params
+      ? {
+          url: message.params.url,
+          delayPayload: message.params.delayPayload,
+        }
+      : undefined;
+
+    return msg('Deliver payload', data);
+  },
 };
 
-const formatInvocation = (invocation: Invocation): StepDescription | null => {
-  switch (invocation.type) {
+const formatInvocation = (invocation?: Invocation): StepDescription | null => {
+  switch (invocation?.type) {
     case 'action': {
       return formatAction(invocation);
     }