feat: add verify wrapper for playwright's expect

Author: mikimandoki

run/test/utils/conversation_order.ts

@@ -1,6 +1,5 @@
-import { expect } from '@playwright/test';
-
 import { DeviceWrapper } from '../../types/DeviceWrapper';
+import { verify } from './utilities';
 
 // Returns the names of all conversation list items in their current DOM order
 export const getConversationOrder = async (device: DeviceWrapper): Promise<string[]> => {
@@ -27,5 +26,5 @@ export const assertPinOrder = (
   }
   const expected = [...pinnedExpected, ...unpinnedExpected];
 
-  expect(afterOrder, 'Conversation order is not correct').toEqual(expected);
+  verify(afterOrder, 'Conversation order is not correct').toEqual(expected);
 };

run/test/utils/utilities.ts

@@ -1,3 +1,4 @@
+import { expect } from '@playwright/test';
 import { exec as execNotPromised } from 'child_process';
 import * as fs from 'fs';
 import { pick } from 'lodash';
@@ -150,3 +151,44 @@ export async function forceStopAndRestart(device: DeviceWrapper): Promise<void>
   // Ensure we're on the home screen again
   await device.waitForTextElementToBePresent(new PlusButton(device));
 }
+
+/**
+ * Drop-in replacement for Playwright's `expect()` that keeps Allure reports clean.
+ *
+ * Playwright dumps the full diff (received vs expected) into the error message, which
+ * ends up verbatim in Allure — too technical for customers. `verify()` catches
+ * assertion errors and rethrows with only the human-readable `message`, preserving the diffs
+ * in the runner logs.
+ *
+ * @param actual - The value being asserted
+ * @param message - Business-readable failure message — this is all Allure will show on failure.
+ *
+ * @example
+ * verify(messages, 'Conversation messages are in the wrong order').toEqual(expected);
+ * verify(isVisible, 'Blocked user banner should not be visible').not.toBe(true);
+ */
+export function verify<T>(actual: T, message: string) {
+  const matchers = expect(actual, message);
+
+  function wrapMatchers(obj: typeof matchers): typeof matchers {
+    return new Proxy(obj, {
+      get(target, prop: string | symbol) {
+        const val = Reflect.get(target, prop, target);
+        if (prop === 'not') return wrapMatchers(val as typeof matchers);
+        if (typeof val === 'function') {
+          return (...args: unknown[]) => {
+            try {
+              return (val as (...a: unknown[]) => unknown).apply(target, args);
+            } catch {
+              console.log(`${message}\n  actual:  `, actual, '\n  expected:', args[0]);
+              throw new Error(message);
+            }
+          };
+        }
+        return val;
+      },
+    });
+  }
+
+  return wrapMatchers(matchers);
+}

run/types/DeviceWrapper.ts

@@ -1,7 +1,7 @@
 import type { Constraints, DefaultCreateSessionResult } from '@appium/types';
 
 import { getImageOccurrence } from '@appium/opencv';
-import { expect, TestInfo } from '@playwright/test';
+import { TestInfo } from '@playwright/test';
 import { AndroidUiautomator2Driver } from 'appium-uiautomator2-driver';
 import { W3CUiautomator2DriverCaps } from 'appium-uiautomator2-driver/build/lib/types';
 import { W3CXCUITestDriverCaps, XCUITestDriver } from 'appium-xcuitest-driver/build/lib/driver';
@@ -78,7 +78,7 @@ import { getAdbFullPath } from '../test/utils/binaries';
 import { parseDataImage } from '../test/utils/check_colour';
 import { isSameColor } from '../test/utils/check_colour';
 import { SupportedPlatformsType } from '../test/utils/open_app';
-import { isDeviceAndroid, isDeviceIOS, runScriptAndLog } from '../test/utils/utilities';
+import { isDeviceAndroid, isDeviceIOS, runScriptAndLog, verify } from '../test/utils/utilities';
 import { CTAConfig, ctaConfigs, CTAType } from './cta';
 import {
   AccessibilityId,
@@ -1887,7 +1887,7 @@ export class DeviceWrapper {
   ) {
     const el = await this.waitForTextElementToBePresent(element);
     const received = await this.getAttribute(attribute, el.ELEMENT);
-    expect(received, 'Element attribute value mismatch').toBe(value);
+    verify(received, 'Element attribute value mismatch').toBe(value);
   }
 
   public async disappearRadioButtonSelected(
@@ -2682,7 +2682,7 @@ export class DeviceWrapper {
     for (let i = 0; i < SAMPLE_SIZE; i++) {
       colors.add(await this.getElementPixelColor(locator));
     }
-    expect(
+    verify(
       colors.size,
       `Expected element to be animated but detected 1 unique color: ${[...colors][0]}`
     ).toBeGreaterThan(1);