Release build 4.18.0 [ci release]

Author: shakyShane

README.md

@@ -78,3 +78,92 @@ To handle the difference in scope injection we expose multiple utilities which b
         - Stores the native original property in _native such that it can be called elsewhere if needed without going through the proxy.
 - DDGReflect
     - Calls into wrappedJSObject.Reflect for Firefox but otherwise exactly the same as [window.Reflect](Sources/BrowserServicesKit/UserScript/ContentScopeUserScript.swift) 
+
+### Testing Locally
+
+Depending on what you are changing, you may need to run the build processes locally, or individual tests. 
+The following all run within GitHub Actions when you create a pull request, but you can run them locally as well.
+
+- eslint
+- Typescript 
+- Unit tests (jasmine)
+- Feature Integration Tests (puppeteer)
+- Feature Integration Tests (playwright)
+- Special Pages Integration Tests (playwright)
+- Feature Build process + Special Pages Build process
+
+If you want to get a good feeling for whether a PR or CI run will pass/fail, you can run the `test` command 
+which chains most of the following together
+
+```shell
+# run this if you want some confidence that your PR will pass
+npm test
+```
+
+#### eslint
+
+```shell
+# run eslint to check for errors
+npm run lint
+
+# run eslint and attempt to fix errors
+npm run lint-fix
+```
+
+#### Typescript
+
+```shell
+# run Typescript to check for errors
+npm run tsc
+
+# run Typescript in watch mode
+npm run tsc-watch
+```
+
+#### Unit Tests (jasmine)
+
+Everything for unit-testing is located in the `unit-test` folder. Jasmine configuration is in `unit-test/jasmine.json`.
+
+```shell
+npm run test-unit
+```
+
+#### Feature Integration Tests (puppeteer)
+
+Everything within `integration-test` (minus the playwright folder) is controlled by Jasmine + Puppeteer.
+The configuration is within `integration-test/config.js`
+
+Note: when you run this command, it will also be executed all workspaces too. For example, within `packages/special-pages` 
+
+```shell
+npm run test-int
+```
+
+#### Feature Integration Tests (playwright)
+Everything within `integration-test/playwright` is integration tests controlled by Playwright. These should be defaulted
+to for any new tests that include UI elements (such as click to load)
+
+```shell
+npm run playwright
+```
+
+#### Special Pages Integration Tests (playwright)
+There are tests within `packages/special-pages/tests` that are dedicated to testing the special pages.
+These tests will be ran automatically when you execute `npm run test-int` from the root. But during development
+you might find it useful to run them individually.
+
+```shell
+cd packages/special-pages
+npm run test-int
+```
+
+#### Feature Build process
+
+To produce all artefacts that are used by platforms, just run the `npm run build` command.
+This will create platform specific code within the `build` folder (that is not checked in)
+
+```shell
+npm run build
+```
+
+Note: This will also execute the build process witin `packages/special-pages`

Sources/ContentScopeScripts/dist/contentScope.js

@@ -224,3 +224,12 @@ test.describe('Duck Player Overlays on Video Player in YouTube.com', () => {
         await overlays.userSettingWasUpdatedTo('always ask remembered') // updated
     })
 })
+
+test.describe('serp proxy', () => {
+    test('serp proxy is enabled', async ({ page }, workerInfo) => {
+        const overlays = DuckplayerOverlays.create(page, workerInfo)
+        await overlays.serpProxyEnabled()
+        await overlays.gotoSerpProxyPage()
+        await overlays.userValuesCallIsProxied()
+    })
+})

build/android/contentScope.js

@@ -35,6 +35,7 @@ const userValues = {
 export class DuckplayerOverlays {
     overlaysPage = '/duckplayer/pages/overlays.html'
     playerPage = '/duckplayer/pages/player.html'
+    serpProxyPage = '/duckplayer/pages/serp-proxy.html'
     /**
      * @param {import("@playwright/test").Page} page
      * @param {import("@duckduckgo/messaging/lib/test-utils.mjs").PlatformInfo} platform
@@ -55,6 +56,25 @@ export class DuckplayerOverlays {
         await this.page.goto(this.playerPage + '?videoID=123')
     }
 
+    async gotoSerpProxyPage () {
+        await this.page.goto(this.serpProxyPage)
+    }
+
+    async userValuesCallIsProxied () {
+        const calls = await this.page.evaluate(readOutgoingMessages)
+        expect(calls).toMatchObject([
+            {
+                payload: {
+                    context: 'contentScopeScripts',
+                    featureName: 'duckPlayer',
+                    params: {},
+                    method: 'getUserValues',
+                    id: 'getUserValues.response'
+                }
+            }
+        ])
+    }
+
     async overlayBlocksVideo () {
         await this.page.locator('ddg-video-overlay').waitFor({ state: 'visible', timeout: 1000 })
         await this.page.getByRole('link', { name: 'Watch in Duck Player' }).waitFor({ state: 'visible', timeout: 1000 })
@@ -72,6 +92,13 @@ export class DuckplayerOverlays {
         await this.setup({ config: loadConfig('overlays') })
     }
 
+    async serpProxyEnabled () {
+        const config = loadConfig('overlays')
+        const domains = config.features.duckPlayer.settings.domains[0].patchSettings
+        config.features.duckPlayer.settings.domains[0].patchSettings = domains.filter(x => x.path === '/overlays/serpProxy/state')
+        await this.setup({ config })
+    }
+
     async videoOverlayDoesntShow () {
         expect(await this.page.locator('ddg-video-overlay').count()).toBe(0)
     }

build/contentScope.js

@@ -8,6 +8,9 @@
         "overlays": {
           "youtube": {
             "state": "disabled"
+          },
+          "serpProxy": {
+            "state": "disabled"
           }
         },
         "domains": [
@@ -18,6 +21,11 @@
                 "op": "replace",
                 "path": "/overlays/youtube/state",
                 "value": "enabled"
+              },
+              {
+                "op": "replace",
+                "path": "/overlays/serpProxy/state",
+                "value": "enabled"
               }
             ]
           }