Allow click actions to fail silently with an additional parameter (#1444)

* Allow click actions to fail silently with an additional parameter

* Make the failSilently directive work per-element

Author: brianhall

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

@@ -469,6 +469,46 @@ test.describe('Broker Protection communications', () => {
             await page.waitForURL((url) => url.hash === '#no', { timeout: 2000 });
         });
 
+        test('clicking selectors that do not exists should fail', async ({ page }, workerInfo) => {
+            const dbp = BrokerProtectionPage.create(page, workerInfo.project.use);
+            await dbp.enabled();
+            await dbp.navigatesTo('clicks.html');
+            await dbp.receivesAction('click-nonexistent-selector.json');
+            const response = await dbp.collector.waitForMessage('actionCompleted');
+
+            dbp.isErrorMessage(response);
+        });
+
+        test('clicking buttons that are disabled should fail', async ({ page }, workerInfo) => {
+            const dbp = BrokerProtectionPage.create(page, workerInfo.project.use);
+            await dbp.enabled();
+            await dbp.navigatesTo('clicks.html');
+            await dbp.receivesAction('click-disabled-button.json');
+            const response = await dbp.collector.waitForMessage('actionCompleted');
+
+            dbp.isErrorMessage(response);
+        });
+
+        test('clicking selectors that do not exist when failSilently is enabled should not fail', async ({ page }, workerInfo) => {
+            const dbp = BrokerProtectionPage.create(page, workerInfo.project.use);
+            await dbp.enabled();
+            await dbp.navigatesTo('clicks.html');
+            await dbp.receivesAction('click-nonexistent-selector-failSilently.json');
+            const response = await dbp.collector.waitForMessage('actionCompleted');
+
+            dbp.isSuccessMessage(response);
+        });
+
+        test('clicking buttons that are disabled when failSilently is enabled should not fail', async ({ page }, workerInfo) => {
+            const dbp = BrokerProtectionPage.create(page, workerInfo.project.use);
+            await dbp.enabled();
+            await dbp.navigatesTo('clicks.html');
+            await dbp.receivesAction('click-disabled-button-failSilently.json');
+            const response = await dbp.collector.waitForMessage('actionCompleted');
+
+            dbp.isSuccessMessage(response);
+        });
+
         test('getCaptchaInfo', async ({ page }, workerInfo) => {
             const dbp = BrokerProtectionPage.create(page, workerInfo.project.use);
             await dbp.enabled();

injected/integration-test/test-pages/broker-protection/actions/click-disabled-button-failSilently.json

@@ -0,0 +1,16 @@
+{
+    "state": {
+      "action": {
+        "actionType": "click",
+        "id": "1",
+        "elements": [
+          {
+            "type": "button",
+            "selector": ".btn",
+            "failSilently": true
+          }
+        ]
+      }
+    }
+  }
+  

injected/integration-test/test-pages/broker-protection/actions/click-disabled-button.json

@@ -0,0 +1,15 @@
+{
+    "state": {
+      "action": {
+        "actionType": "click",
+        "id": "1",
+        "elements": [
+          {
+            "type": "button",
+            "selector": ".btn"
+          }
+        ]
+      }
+    }
+  }
+  

injected/integration-test/test-pages/broker-protection/actions/click-nonexistent-selector-failSilently.json

@@ -0,0 +1,16 @@
+{
+    "state": {
+      "action": {
+        "actionType": "click",
+        "id": "1",
+        "elements": [
+          {
+            "type": "button",
+            "selector": ".test",
+            "failSilently": true
+          }
+        ]
+      }
+    }
+  }
+  

injected/integration-test/test-pages/broker-protection/actions/click-nonexistent-selector.json

@@ -0,0 +1,15 @@
+{
+    "state": {
+      "action": {
+        "actionType": "click",
+        "id": "1",
+        "elements": [
+          {
+            "type": "button",
+            "selector": ".test"
+          }
+        ]
+      }
+    }
+  }
+  

injected/integration-test/test-pages/broker-protection/pages/clicks.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>Broker Protection</title>
+</head>
+<body>
+    <div class="result">
+        <div class="name">John Doe</div>
+        <div class="age">32</div>
+        <div class="locations" data-id="1">
+            <span>New York, NY</span>
+            <span>Los Angeles, CA</span>
+            <a href="#" class="view-more">View More</a>
+        </div>
+        <button disabled class="btn">View More</button>
+    </div>
+</body>
+</html>

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

@@ -51,6 +51,10 @@ export function click(action, userData, root = document) {
         const elements = getElements(rootElement, element.selector);
 
         if (!elements?.length) {
+            if (element.failSilently) {
+                return new SuccessResponse({ actionID: action.id, actionType: action.actionType, response: null });
+            }
+
             return new ErrorResponse({
                 actionID: action.id,
                 message: `could not find element to click with selector '${element.selector}'!`,
@@ -63,7 +67,7 @@ export function click(action, userData, root = document) {
             const elem = elements[i];
 
             if ('disabled' in elem) {
-                if (elem.disabled) {
+                if (elem.disabled && !element.failSilently) {
                     return new ErrorResponse({ actionID: action.id, message: `could not click disabled element ${element.selector}'!` });
                 }
             }