Merge branch 'main' into dbajpeyi/fix/animate-export-once

Author: dbajpeyi

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/message-bridge-android.spec.js

@@ -0,0 +1,84 @@
+import { test, expect } from '@playwright/test';
+import { ResultsCollector } from './page-objects/results-collector.js';
+import { readOutgoingMessages } from '@duckduckgo/messaging/lib/test-utils.mjs';
+
+const ENABLED_CONFIG = 'integration-test/test-pages/message-bridge/config/message-bridge-enabled.json';
+const DISABLED_CONFIG = 'integration-test/test-pages/message-bridge/config/message-bridge-disabled.json';
+const ENABLED_HTML = '/message-bridge/pages/enabled.html';
+const DISABLED_HTML = '/message-bridge/pages/disabled.html';
+
+test('message bridge when enabled (android)', async ({ page }, testInfo) => {
+    const pageWorld = ResultsCollector.create(page, testInfo.project.use);
+
+    // seed the request->re
+    pageWorld.withMockResponse({
+        sampleData: /** @type {any} */ ({
+            ghi: 'jkl',
+        }),
+    });
+
+    pageWorld.withUserPreferences({
+        messageSecret: 'ABC',
+        javascriptInterface: 'javascriptInterface',
+        messageCallback: 'messageCallback',
+    });
+
+    // now load the page
+    await pageWorld.load(ENABLED_HTML, ENABLED_CONFIG);
+
+    // simulate a push event
+    await pageWorld.simulateSubscriptionMessage('exampleFeature', 'onUpdate', { abc: 'def' });
+
+    // get all results
+    const results = await pageWorld.results();
+    expect(results['Creating the bridge']).toStrictEqual([
+        { name: 'bridge.notify', result: 'function', expected: 'function' },
+        { name: 'bridge.request', result: 'function', expected: 'function' },
+        { name: 'bridge.subscribe', result: 'function', expected: 'function' },
+        { name: 'data', result: [{ abc: 'def' }, { ghi: 'jkl' }], expected: [{ abc: 'def' }, { ghi: 'jkl' }] },
+    ]);
+
+    // verify messaging calls
+    const calls = await page.evaluate(readOutgoingMessages);
+    expect(calls.length).toBe(2);
+    const pixel = calls[0].payload;
+    const request = calls[1].payload;
+
+    expect(pixel).toStrictEqual({
+        context: 'contentScopeScripts',
+        featureName: 'exampleFeature',
+        method: 'pixel',
+        params: {},
+    });
+
+    const { id, ...rest } = /** @type {import("@duckduckgo/messaging").RequestMessage} */ (request);
+
+    expect(rest).toStrictEqual({
+        context: 'contentScopeScripts',
+        featureName: 'exampleFeature',
+        method: 'sampleData',
+        params: {},
+    });
+
+    if (!('id' in request)) throw new Error('unreachable');
+
+    expect(typeof request.id).toBe('string');
+    expect(request.id.length).toBeGreaterThan(10);
+});
+
+test('message bridge when disabled (android)', async ({ page }, testInfo) => {
+    const pageWorld = ResultsCollector.create(page, testInfo.project.use);
+
+    // now load the main page
+    await pageWorld.load(DISABLED_HTML, DISABLED_CONFIG);
+
+    // verify no outgoing calls were made
+    const calls = await page.evaluate(readOutgoingMessages);
+    expect(calls).toHaveLength(0);
+
+    // get all results
+    const results = await pageWorld.results();
+    expect(results['Creating the bridge, but it is unavailable']).toStrictEqual([
+        { name: 'error', result: 'Did not install Message Bridge', expected: 'Did not install Message Bridge' },
+    ]);
+});

injected/integration-test/page-objects/duckplayer-overlays.js

@@ -80,6 +80,11 @@ export class DuckplayerOverlays {
             },
             sendDuckPlayerPixel: {},
         });
+        this.collector.withUserPreferences({
+            messageSecret: 'ABC',
+            javascriptInterface: 'javascriptInterface',
+            messageCallback: 'messageCallback',
+        });
         page.on('console', (msg) => {
             console.log(msg.type(), msg.text());
         });

injected/integration-test/page-objects/results-collector.js

@@ -172,6 +172,7 @@ export class ResultsCollector {
             messagingContext: this.messagingContext('n/a'),
             responses: this.#mockResponses,
             messageCallback: 'messageCallback',
+            javascriptInterface: this.#userPreferences.javascriptInterface,
         });
 
         const wrapFn = this.build.switch({
@@ -234,6 +235,8 @@ export class ResultsCollector {
             name,
             payload,
             injectName: this.build.name,
+            messageCallback: this.#userPreferences.messageCallback,
+            messageSecret: this.#userPreferences.messageSecret,
         });
     }
 

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/integration-test/type-helpers.mjs

@@ -62,6 +62,7 @@ export class Build {
             apple: () => '../Sources/ContentScopeScripts/dist/contentScope.js',
             'apple-isolated': () => '../Sources/ContentScopeScripts/dist/contentScopeIsolated.js',
             'android-autofill-password-import': () => '../build/android/autofillPasswordImport.js',
+            'android-broker-protection': () => '../build/android/brokerProtection.js',
         });
         return readFileSync(path, 'utf8');
     }