Support conditional actions with expectations (#1144)

* Stub out expectations with actions

* Add failSilently flag

* Change test for failSilently

* Ensure actions only run for successful expectations, update tests

* Localize type alterations

* Rewrite logic, make execution of steps async, catch secondary errors and add test to validate

* Remove silly error message

Author: brianhall

injected/integration-test/broker-protection.spec.js

@@ -1,4 +1,4 @@
-import { test } from '@playwright/test'
+import { test, expect } from '@playwright/test'
 import { BrokerProtectionPage } from './page-objects/broker-protection.js'
 
 test.describe('Broker Protection communications', () => {
@@ -490,6 +490,56 @@ test.describe('Broker Protection communications', () => {
         })
     })
 
+    test('expectation with actions', async ({ page }, workerInfo) => {
+        const dbp = BrokerProtectionPage.create(page, workerInfo)
+        await dbp.enabled()
+        await dbp.navigatesTo('expectation-actions.html')
+        await dbp.receivesAction('expectation-actions.json')
+        const response = await dbp.waitForMessage('actionCompleted')
+
+        dbp.isSuccessMessage(response)
+        await page.waitForURL(url => url.hash === '#1', { timeout: 2000 })
+    })
+
+    test('expectation fails when failSilently is not present', async ({ page }, workerInfo) => {
+        const dbp = BrokerProtectionPage.create(page, workerInfo)
+        await dbp.enabled()
+        await dbp.navigatesTo('expectation-actions.html')
+        await dbp.receivesAction('expectation-actions-fail.json')
+
+        const response = await dbp.waitForMessage('actionCompleted')
+        dbp.isErrorMessage(response)
+
+        const currentUrl = page.url()
+        expect(currentUrl).not.toContain('#')
+    })
+
+    test('expectation succeeds when failSilently is present', async ({ page }, workerInfo) => {
+        const dbp = BrokerProtectionPage.create(page, workerInfo)
+        await dbp.enabled()
+        await dbp.navigatesTo('expectation-actions.html')
+        await dbp.receivesAction('expectation-actions-fail-silently.json')
+
+        const response = await dbp.waitForMessage('actionCompleted')
+        dbp.isSuccessMessage(response)
+
+        const currentUrl = page.url()
+        expect(currentUrl).not.toContain('#')
+    })
+
+    test('expectation succeeds but subaction fails should throw error', async ({ page }, workerInfo) => {
+        const dbp = BrokerProtectionPage.create(page, workerInfo)
+        await dbp.enabled()
+        await dbp.navigatesTo('expectation-actions.html')
+        await dbp.receivesAction('expectation-actions-subaction-fail.json')
+
+        const response = await dbp.waitForMessage('actionCompleted')
+        dbp.isErrorMessage(response)
+
+        const currentUrl = page.url()
+        expect(currentUrl).not.toContain('#')
+    })
+
     test.describe('retrying', () => {
         test('retrying a click', async ({ page }, workerInfo) => {
             const dbp = BrokerProtectionPage.create(page, workerInfo)

injected/integration-test/test-pages/broker-protection/actions/expectation-actions-fail-silently.json

@@ -0,0 +1,27 @@
+{
+    "state": {
+      "action": {
+        "actionType": "expectation",
+        "id": "2",
+        "expectations": [
+          {
+            "type": "text",
+            "selector": "body",
+            "expect": "How old is Jane Doe?",
+            "failSilently": true
+          }
+        ],
+        "actions": [
+            {
+                "actionType": "click",
+                "elements": [
+                    {
+                        "type": "button",
+                        "selector": ".view-more"
+                    }
+                ]
+            }
+        ]
+      }
+    }
+  }

injected/integration-test/test-pages/broker-protection/actions/expectation-actions-fail.json

@@ -0,0 +1,31 @@
+{
+    "state": {
+      "action": {
+        "actionType": "expectation",
+        "id": "2",
+        "retry": {
+          "environment": "web",
+          "interval": { "ms": 1000 },
+          "maxAttempts": 1
+        },
+        "expectations": [
+          {
+            "type": "text",
+            "selector": "body",
+            "expect": "How old is Jane Doe?"
+          }
+        ],
+        "actions": [
+            {
+                "actionType": "click",
+                "elements": [
+                    {
+                        "type": "button",
+                        "selector": ".view-more"
+                    }
+                ]
+            }
+        ]
+      }
+    }
+  }

injected/integration-test/test-pages/broker-protection/actions/expectation-actions-subaction-fail.json

@@ -0,0 +1,31 @@
+{
+    "state": {
+      "action": {
+        "actionType": "expectation",
+        "id": "2",
+        "retry": {
+            "environment": "web",
+            "interval": { "ms": 1000 },
+            "maxAttempts": 1
+        },
+        "expectations": [
+          {
+            "type": "text",
+            "selector": "body",
+            "expect": "How old is John Doe?"
+          }
+        ],
+        "actions": [
+            {
+                "actionType": "click",
+                "elements": [
+                    {
+                        "type": "button",
+                        "selector": ".view-less"
+                    }
+                ]
+            }
+        ]
+      }
+    }
+  }

injected/integration-test/test-pages/broker-protection/actions/expectation-actions.json

@@ -0,0 +1,26 @@
+{
+    "state": {
+      "action": {
+        "actionType": "expectation",
+        "id": "2",
+        "expectations": [
+          {
+            "type": "text",
+            "selector": "body",
+            "expect": "How old is John Doe?"
+          }
+        ],
+        "actions": [
+            {
+                "actionType": "click",
+                "elements": [
+                    {
+                        "type": "button",
+                        "selector": ".view-more"
+                    }
+                ]
+            }
+        ]
+      }
+    }
+  }

injected/integration-test/test-pages/broker-protection/pages/expectation-actions.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>Broker Protection</title>
+</head>
+<body>
+    <div class="result">
+        How old is John Doe?
+        <a href="#" class="view-more" data-id="1">View More</a>
+    </div>
+    <script>
+        document.querySelector('.view-more').addEventListener('click', function(e) {
+            e.preventDefault();
+            const id = this.getAttribute('data-id');
+
+            window.location.hash = id;
+            this.removeEventListener('click', arguments.callee);
+        })
+    </script>
+</body>
+</html>

injected/src/features/broker-protection/actions/expectation.js

@@ -1,23 +1,48 @@
 import { getElement } from '../utils.js'
 import { ErrorResponse, SuccessResponse } from '../types.js'
+import { execute } from '../execute.js'
 
 /**
  * @param {Record<string, any>} action
- * @param {Document | HTMLElement} root
- * @return {import('../types.js').ActionResponse}
+ * @param {Record<string, any>} userData
+ * @param {Document} root
+ * @return {Promise<import('../types.js').ActionResponse>}
  */
-export function expectation (action, root = document) {
+export async function expectation (action, userData, root = document) {
     const results = expectMany(action.expectations, root)
 
-    const errors = results.filter(x => x.result === false).map(x => {
-        if ('error' in x) return x.error
-        return 'unknown error'
-    })
+    // filter out good results + silent failures, leaving only fatal errors
+    const errors = results
+        .filter((x, index) => {
+            if (x.result === true) return false
+            if (action.expectations[index].failSilently) return false
+            return true
+        }).map((x) => {
+            return 'error' in x ? x.error : 'unknown error'
+        })
 
     if (errors.length > 0) {
         return new ErrorResponse({ actionID: action.id, message: errors.join(', ') })
     }
 
+    // only run later actions if every expectation was met
+    const runActions = results.every(x => x.result === true)
+    const secondaryErrors = []
+
+    if (action.actions?.length && runActions) {
+        for (const subAction of action.actions) {
+            const result = await execute(subAction, userData, root)
+
+            if ('error' in result) {
+                secondaryErrors.push(result.error)
+            }
+        }
+
+        if (secondaryErrors.length > 0) {
+            return new ErrorResponse({ actionID: action.id, message: secondaryErrors.join(', ') })
+        }
+    }
+
     return new SuccessResponse({ actionID: action.id, actionType: action.actionType, response: null })
 }
 

injected/src/features/broker-protection/execute.js

@@ -25,7 +25,7 @@ export async function execute (action, inputData, root = document) {
         case 'click':
             return click(action, data(action, inputData, 'userProfile'), root)
         case 'expectation':
-            return expectation(action, root)
+            return await expectation(action, data(action, inputData, 'userProfile'), root)
         case 'fillForm':
             return fillForm(action, data(action, inputData, 'extractedProfile'), root)
         case 'getCaptchaInfo':

injected/src/features/broker-protection/types.js

@@ -1,7 +1,7 @@
 /**
  * @typedef {SuccessResponse | ErrorResponse} ActionResponse
  * @typedef {{ result: true } | { result: false; error: string }} BooleanResult
- * @typedef {{type: "element" | "text" | "url"; selector: string; parent?: string; expect?: string}} Expectation
+ * @typedef {{type: "element" | "text" | "url"; selector: string; parent?: string; expect?: string; failSilently?: boolean}} Expectation
  */
 
 /**