feat: add self-healing capabilities (#69)

Miki-Session · web-flow · commit d11d03391be7 · 2025-09-03T16:20:20.000+10:00
* feat: add fuse.js

* feat: add custom category for healed tests

* feat: add self-healing locators

* feat: strip system element prefixes

* fix: remove findwithfallback from checkmodalstrings
diff --git a/package.json b/package.json
@@ -37,6 +37,7 @@
     "eslint": "^9.14.0",
     "eslint-plugin-perfectionist": "^4.15.0",
     "fs-extra": "^11.3.0",
+    "fuse.js": "^7.1.0",
     "gh-pages": "^6.3.0",
     "glob": "^11.0.3",
     "globals": "^15.12.0",
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -18,7 +18,18 @@ const useAllure = process.env.CI === '1' && process.env.ALLURE_ENABLED !== 'fals
 const baseReporter: ReporterDescription = [
   './node_modules/@session-foundation/playwright-reporter/dist/index.js',
 ];
-const allureReporter: ReporterDescription = ['allure-playwright', { resultsDir: allureResultsDir }];
+const allureReporter: ReporterDescription = [
+  'allure-playwright',
+  {
+    resultsDir: allureResultsDir,
+    categories: [
+      {
+        name: 'Self-healed tests', // Custom category to group healed tests for better visibility
+        messageRegex: '.*healed.*',
+      },
+    ],
+  },
+];
 
 export default defineConfig({
   timeout: 480000,
diff --git a/run/test/specs/disappear_after_send_off_1o1.spec.ts b/run/test/specs/disappear_after_send_off_1o1.spec.ts
@@ -83,8 +83,7 @@ async function disappearAfterSendOff1o1(platform: SupportedPlatformsType, testIn
   await sleepFor(500);
   await bob1.checkModalStrings(
     englishStrippedStr('disappearingMessagesFollowSetting').toString(),
-    englishStrippedStr('disappearingMessagesFollowSettingOff').toString(),
-    false
+    englishStrippedStr('disappearingMessagesFollowSettingOff').toString()
   );
   await bob1.clickOnElementAll({ strategy: 'accessibility id', selector: 'Confirm' });
   // Check conversation subtitle?
diff --git a/run/test/specs/disappearing_link.spec.ts b/run/test/specs/disappearing_link.spec.ts
@@ -108,8 +108,7 @@ async function disappearingLinkMessage1o1Android(
     await test.step(TestSteps.VERIFY.GENERIC_MODAL, async () => {
       await alice1.checkModalStrings(
         englishStrippedStr('linkPreviewsEnable').toString(),
-        englishStrippedStr('linkPreviewsFirstDescription').toString(),
-        false
+        englishStrippedStr('linkPreviewsFirstDescription').toString()
       );
     });
     await alice1.clickOnByAccessibilityID('Enable');
diff --git a/run/test/specs/group_disappearing_messages_link.spec.ts b/run/test/specs/group_disappearing_messages_link.spec.ts
@@ -48,8 +48,7 @@ async function disappearingLinkMessageGroup(platform: SupportedPlatformsType, te
     await test.step(TestSteps.VERIFY.GENERIC_MODAL, async () => {
       await alice1.checkModalStrings(
         englishStrippedStr('linkPreviewsEnable').toString(),
-        englishStrippedStr('linkPreviewsFirstDescription').toString(),
-        false
+        englishStrippedStr('linkPreviewsFirstDescription').toString()
       );
     });
     // Accept link preview modal
diff --git a/run/test/specs/group_message_link_preview.spec.ts b/run/test/specs/group_message_link_preview.spec.ts
@@ -96,8 +96,7 @@ async function sendLinkGroupAndroid(platform: SupportedPlatformsType, testInfo:
   // Accept dialog for link preview
   await alice1.checkModalStrings(
     englishStrippedStr('linkPreviewsEnable').toString(),
-    englishStrippedStr('linkPreviewsFirstDescription').toString(),
-    true
+    englishStrippedStr('linkPreviewsFirstDescription').toString()
   );
   await alice1.clickOnByAccessibilityID('Enable');
   //wait for preview to generate
diff --git a/run/test/specs/linked_device_hide_note_to_self.spec.ts b/run/test/specs/linked_device_hide_note_to_self.spec.ts
@@ -46,8 +46,7 @@ async function hideNoteToSelf(platform: SupportedPlatformsType, testInfo: TestIn
     await test.step(TestSteps.VERIFY.GENERIC_MODAL, async () => {
       await alice1.checkModalStrings(
         englishStrippedStr('noteToSelfHide').toString(),
-        englishStrippedStr('hideNoteToSelfDescription').toString(), // This one fails on iOS, see SES-4144
-        false
+        englishStrippedStr('hideNoteToSelfDescription').toString() // This one fails on iOS, see SES-4144
       );
     });
     await alice1.clickOnByAccessibilityID('Hide');
diff --git a/run/test/specs/message_link_preview.spec.ts b/run/test/specs/message_link_preview.spec.ts
@@ -82,8 +82,7 @@ async function sendLinkAndroid(platform: SupportedPlatformsType, testInfo: TestI
   // Accept dialog for link preview
   await alice1.checkModalStrings(
     englishStrippedStr('linkPreviewsEnable').toString(),
-    englishStrippedStr('linkPreviewsFirstDescription').toString(),
-    true
+    englishStrippedStr('linkPreviewsFirstDescription').toString()
   );
   await alice1.clickOnElementAll({
     strategy: 'accessibility id',
diff --git a/run/test/specs/message_requests_block.spec.ts b/run/test/specs/message_requests_block.spec.ts
@@ -41,8 +41,7 @@ async function blockedRequest(platform: SupportedPlatformsType, testInfo: TestIn
   await sleepFor(1000);
   await device2.checkModalStrings(
     englishStrippedStr('block').toString(),
-    englishStrippedStr('blockDescription').withArgs({ name: alice.userName }).toString(),
-    false
+    englishStrippedStr('blockDescription').withArgs({ name: alice.userName }).toString()
   );
   await device2.clickOnByAccessibilityID('Block'); // This is an old Android modal so can't use the modern locator class
   // "messageRequestsNonePending": "No pending message requests",
diff --git a/run/test/specs/message_requests_clear_all.spec.ts b/run/test/specs/message_requests_clear_all.spec.ts
@@ -29,8 +29,7 @@ async function clearAllRequests(platform: SupportedPlatformsType, testInfo: Test
   await device2.clickOnByAccessibilityID('Clear all');
   await device2.checkModalStrings(
     englishStrippedStr('clearAll').toString(),
-    englishStrippedStr('messageRequestsClearAllExplanation').toString(),
-    true
+    englishStrippedStr('messageRequestsClearAllExplanation').toString()
   );
   await device2.clickOnByAccessibilityID('Clear');
   // "messageRequestsNonePending": "No pending message requests",
diff --git a/run/test/specs/message_requests_decline.spec.ts b/run/test/specs/message_requests_decline.spec.ts
@@ -51,8 +51,7 @@ async function declineRequest(platform: SupportedPlatformsType, testInfo: TestIn
     .onAndroid()
     .checkModalStrings(
       englishStrippedStr('delete').toString(),
-      englishStrippedStr('messageRequestsContactDelete').toString(),
-      false
+      englishStrippedStr('messageRequestsContactDelete').toString()
     );
   await device2.clickOnElementAll(new DeleteMesssageRequestConfirmation(device2));
   // "messageRequestsNonePending": "No pending message requests",
diff --git a/run/test/specs/message_requests_delete.spec.ts b/run/test/specs/message_requests_delete.spec.ts
@@ -41,8 +41,7 @@ async function deleteRequest(platform: SupportedPlatformsType, testInfo: TestInf
     .onAndroid()
     .checkModalStrings(
       englishStrippedStr('delete').toString(),
-      englishStrippedStr('messageRequestsContactDelete').toString(),
-      false
+      englishStrippedStr('messageRequestsContactDelete').toString()
     );
   await device2.clickOnElementAll(new DeleteMesssageRequestConfirmation(device2));
   // "messageRequestsNonePending": "No pending message requests",
diff --git a/run/test/specs/user_actions_block_conversation_list.spec.ts b/run/test/specs/user_actions_block_conversation_list.spec.ts
@@ -37,8 +37,7 @@ async function blockUserInConversationList(platform: SupportedPlatformsType, tes
   await alice1.clickOnElementAll(new LongPressBlockOption(alice1));
   await alice1.checkModalStrings(
     englishStrippedStr('block').toString(),
-    englishStrippedStr('blockDescription').withArgs({ name: USERNAME.BOB }).toString(),
-    false
+    englishStrippedStr('blockDescription').withArgs({ name: USERNAME.BOB }).toString()
   );
   await alice1.clickOnByAccessibilityID('Block');
   // Once you block the conversation disappears from the home screen
diff --git a/run/test/specs/user_actions_delete_conversation.spec.ts b/run/test/specs/user_actions_delete_conversation.spec.ts
@@ -47,8 +47,7 @@ async function deleteConversation(platform: SupportedPlatformsType, testInfo: Te
         englishStrippedStr('conversationsDelete').toString(),
         englishStrippedStr('deleteConversationDescription')
           .withArgs({ name: USERNAME.BOB })
-          .toString(),
-        false
+          .toString()
       );
     });
     await alice1.clickOnByAccessibilityID('Delete');
diff --git a/run/test/specs/user_actions_unblock_user.spec.ts b/run/test/specs/user_actions_unblock_user.spec.ts
@@ -33,8 +33,7 @@ async function unblockUser(platform: SupportedPlatformsType, testInfo: TestInfo)
   await alice1.clickOnElementAll(new BlockUser(alice1));
   await alice1.checkModalStrings(
     englishStrippedStr('block').toString(),
-    englishStrippedStr('blockDescription').withArgs({ name: bob.userName }).toString(),
-    true
+    englishStrippedStr('blockDescription').withArgs({ name: bob.userName }).toString()
   );
   await alice1.clickOnElementAll(new BlockUserConfirmationModal(alice1));
   await alice1.navigateBack();
@@ -59,8 +58,7 @@ async function unblockUser(platform: SupportedPlatformsType, testInfo: TestInfo)
   await alice1.clickOnElementAll(new BlockedBanner(alice1));
   await alice1.checkModalStrings(
     englishStrippedStr('blockUnblock').toString(),
-    englishStrippedStr('blockUnblockName').withArgs({ name: bob.userName }).toString(),
-    false
+    englishStrippedStr('blockUnblockName').withArgs({ name: bob.userName }).toString()
   );
   await alice1.clickOnElementAll({ strategy: 'accessibility id', selector: 'Unblock' });
   await alice1.verifyElementNotPresent({ ...new BlockedBanner(alice1).build(), maxWait: 2000 });
diff --git a/run/test/specs/utils/open_app.ts b/run/test/specs/utils/open_app.ts
@@ -31,7 +31,7 @@ export const openAppMultipleDevices = async (
 ): Promise<DeviceWrapper[]> => {
   // Create an array of promises for each device
   const devicePromises = Array.from({ length: numberOfDevices }, (_, index) =>
-    openAppOnPlatform(platform, index as CapabilitiesIndexType)
+    openAppOnPlatform(platform, index as CapabilitiesIndexType, testInfo)
   );
 
   // Use Promise.all to wait for all device apps to open
@@ -47,12 +47,15 @@ export const openAppMultipleDevices = async (
 
 const openAppOnPlatform = async (
   platform: SupportedPlatformsType,
-  capabilitiesIndex: CapabilitiesIndexType
+  capabilitiesIndex: CapabilitiesIndexType,
+  testInfo: TestInfo
 ): Promise<{
   device: DeviceWrapper;
 }> => {
   console.info('starting capabilitiesIndex', capabilitiesIndex, platform);
-  return platform === 'ios' ? openiOSApp(capabilitiesIndex) : openAndroidApp(capabilitiesIndex);
+  return platform === 'ios'
+    ? openiOSApp(capabilitiesIndex, testInfo)
+    : openAndroidApp(capabilitiesIndex, testInfo);
 };
 
 export const openAppOnPlatformSingleDevice = async (
@@ -61,7 +64,7 @@ export const openAppOnPlatformSingleDevice = async (
 ): Promise<{
   device: DeviceWrapper;
 }> => {
-  const result = await openAppOnPlatform(platform, 0);
+  const result = await openAppOnPlatform(platform, 0, testInfo);
 
   registerDevicesForTest(testInfo, [result.device], platform);
 
@@ -76,8 +79,8 @@ export const openAppTwoDevices = async (
   device2: DeviceWrapper;
 }> => {
   const [app1, app2] = await Promise.all([
-    openAppOnPlatform(platform, 0),
-    openAppOnPlatform(platform, 1),
+    openAppOnPlatform(platform, 0, testInfo),
+    openAppOnPlatform(platform, 1, testInfo),
   ]);
 
   const result = { device1: app1.device, device2: app2.device };
@@ -96,9 +99,9 @@ export const openAppThreeDevices = async (
   device3: DeviceWrapper;
 }> => {
   const [app1, app2, app3] = await Promise.all([
-    openAppOnPlatform(platform, 0),
-    openAppOnPlatform(platform, 1),
-    openAppOnPlatform(platform, 2),
+    openAppOnPlatform(platform, 0, testInfo),
+    openAppOnPlatform(platform, 1, testInfo),
+    openAppOnPlatform(platform, 2, testInfo),
   ]);
 
   const result = {
@@ -122,10 +125,10 @@ export const openAppFourDevices = async (
   device4: DeviceWrapper;
 }> => {
   const [app1, app2, app3, app4] = await Promise.all([
-    openAppOnPlatform(platform, 0),
-    openAppOnPlatform(platform, 1),
-    openAppOnPlatform(platform, 2),
-    openAppOnPlatform(platform, 3),
+    openAppOnPlatform(platform, 0, testInfo),
+    openAppOnPlatform(platform, 1, testInfo),
+    openAppOnPlatform(platform, 2, testInfo),
+    openAppOnPlatform(platform, 3, testInfo),
   ]);
 
   const result = {
@@ -204,7 +207,8 @@ async function waitForEmulatorToBeRunning(emulatorName: string) {
 }
 
 const openAndroidApp = async (
-  capabilitiesIndex: CapabilitiesIndexType
+  capabilitiesIndex: CapabilitiesIndexType,
+  testInfo: TestInfo
 ): Promise<{
   device: DeviceWrapper;
 }> => {
@@ -254,7 +258,7 @@ const openAndroidApp = async (
   const device = new AndroidUiautomator2Driver(opts);
   const udid = getAndroidUdid(actualCapabilitiesIndex);
   console.log(`udid: ${udid}`);
-  const wrappedDevice = new DeviceWrapper(device, udid);
+  const wrappedDevice = new DeviceWrapper(device, udid, testInfo);
 
   await runScriptAndLog(`${getAdbFullPath()} -s ${targetName} shell settings put global heads_up_notifications_enabled 0
     `);
@@ -277,7 +281,8 @@ const openAndroidApp = async (
 };
 
 const openiOSApp = async (
-  capabilitiesIndex: CapabilitiesIndexType
+  capabilitiesIndex: CapabilitiesIndexType,
+  testInfo: TestInfo
 ): Promise<{
   device: DeviceWrapper;
 }> => {
@@ -294,7 +299,7 @@ const openiOSApp = async (
   const capabilities = getIosCapabilities(actualCapabilitiesIndex as CapabilitiesIndexType);
   const udid = capabilities.alwaysMatch['appium:udid'] as string;
 
-  const { device: wrappedDevice } = await cleanPermissions(opts, udid, capabilities);
+  const { device: wrappedDevice } = await cleanPermissions(opts, udid, capabilities, testInfo);
   return { device: wrappedDevice };
 };
 
diff --git a/run/test/specs/utils/permissions.ts b/run/test/specs/utils/permissions.ts
@@ -1,3 +1,4 @@
+import { TestInfo } from '@playwright/test';
 import { W3CCapabilities } from '@wdio/types/build/Capabilities';
 import { XCUITestDriver, XCUITestDriverOpts } from 'appium-xcuitest-driver/build/lib/driver';
 
@@ -8,7 +9,8 @@ import { runScriptAndLog } from './utilities';
 export const cleanPermissions = async (
   opts: XCUITestDriverOpts,
   udid: string,
-  capabilities: W3CCapabilities
+  capabilities: W3CCapabilities,
+  testInfo: TestInfo
 ) => {
   let wrappedDevice: DeviceWrapper | null = null;
   const maxRetries = 3;
@@ -17,7 +19,7 @@ export const cleanPermissions = async (
   do {
     try {
       const device: XCUITestDriver = new XCUITestDriver(opts);
-      wrappedDevice = new DeviceWrapper(device, udid);
+      wrappedDevice = new DeviceWrapper(device, udid, testInfo);
 
       await wrappedDevice.createSession(capabilities);
       // This function closes any pop up that hasn't been dismissed from a previous test (only happens for iOS currently)
diff --git a/run/test/specs/voice_calls.spec.ts b/run/test/specs/voice_calls.spec.ts
@@ -166,8 +166,7 @@ async function voiceCallAndroid(platform: SupportedPlatformsType, testInfo: Test
     await test.step(TestSteps.VERIFY.SPECIFIC_MODAL('enable calls permission'), async () => {
       await alice1.checkModalStrings(
         englishStrippedStr('callsPermissionsRequired').toString(),
-        englishStrippedStr('callsPermissionsRequiredDescription').toString(),
-        false
+        englishStrippedStr('callsPermissionsRequiredDescription').toString()
       );
       await alice1.clickOnElementAll({
         strategy: 'accessibility id',
@@ -177,8 +176,7 @@ async function voiceCallAndroid(platform: SupportedPlatformsType, testInfo: Test
     await test.step(TestSteps.VERIFY.SPECIFIC_MODAL('beta calls'), async () => {
       await alice1.checkModalStrings(
         englishStrippedStr('callsVoiceAndVideoBeta').toString(),
-        englishStrippedStr('callsVoiceAndVideoModalDescription').toString(),
-        false
+        englishStrippedStr('callsVoiceAndVideoModalDescription').toString()
       );
       await alice1.clickOnByAccessibilityID('Enable');
     });
@@ -188,8 +186,7 @@ async function voiceCallAndroid(platform: SupportedPlatformsType, testInfo: Test
     await test.step(TestSteps.VERIFY.SPECIFIC_MODAL('notifications permission'), async () => {
       await alice1.checkModalStrings(
         englishStrippedStr('sessionNotifications').toString(),
-        englishStrippedStr('callsNotificationsRequired').toString(),
-        false
+        englishStrippedStr('callsNotificationsRequired').toString()
       );
       await alice1.clickOnElementAll(new NotificationSettings(alice1));
       await alice1.clickOnElementAll(new NotificationSwitch(alice1));
diff --git a/run/types/DeviceWrapper.ts b/run/types/DeviceWrapper.ts
diff --git a/run/types/sessionIt.ts b/run/types/sessionIt.ts
diff --git a/yarn.lock b/yarn.lock
