dont use message for opening links - detect custom scheme instead

Author: Shane Osbourne

packages/special-pages/pages/duckplayer/src/js/index.js

@@ -25,22 +25,20 @@
  * On Page Load
  *   - {@link DuckPlayerPageMessages.onUserValuesChanged} begins immediately. It expects an initial value, and then will continue to listen for updates
  *
- * Then the following 2 messages can be sent at any time
+ * Then the following message can be sent at any time
  *   - {@link DuckPlayerPageMessages.setUserValues}
- *   - {@link DuckPlayerPageMessages.openSettings}
  *
  * Please see {@link DuckPlayerPageMessages} for the up-to-date list
  */
 import {
     Messaging,
     WindowsMessagingConfig,
-    WebkitMessagingConfig,
     MessagingContext, TestTransportConfig
 } from '../../../../../messaging/index.js'
-import { DuckPlayerPageMessages, UserValues, OpenSettings } from './messages'
+import { DuckPlayerPageMessages, UserValues } from './messages'
 
 // for docs
-export { DuckPlayerPageMessages, UserValues, OpenSettings }
+export { DuckPlayerPageMessages, UserValues }
 
 const VideoPlayer = {
     /**
@@ -520,10 +518,9 @@ const Setting = {
         })
 
         const settingsIcon = Setting.settingsIcon()
-        settingsIcon.addEventListener('click', (e) => {
-            e.preventDefault()
-            Comms.messaging.openSettings(new OpenSettings({ target: 'duckplayer' }))
-        })
+
+        // windows settings - we will need to alter for other platforms.
+        settingsIcon.setAttribute('href', 'duck://settings/duckplayer')
     }
 }
 

packages/special-pages/pages/duckplayer/src/js/messages.js

@@ -31,20 +31,6 @@ export class DuckPlayerPageMessages {
         return this.messaging.request('getUserValues')
     }
 
-    /**
-     * This occurs when a user has clicked on the 'Settings Cog'
-     *
-     * **OpenSettings example**
-     * ```json
-     * { "target": "duckplayer" }
-     * ```
-     *
-     * @param {OpenSettings} openSettings
-     */
-    openSettings (openSettings) {
-        this.messaging.notify('openSettings', openSettings)
-    }
-
     /**
      * This is a subscription that we set up when the page loads.
      * We use this value to show/hide the checkboxes.
@@ -77,7 +63,7 @@ export class DuckPlayerPageMessages {
 }
 
 /**
- * This data structure is sent to enable settings to be updated
+ * This data structure is sent to enable user settings to be updated
  *
  * ```js
  * [[include:packages/special-pages/pages/duckplayer/src/js/messages.example.js]]```
@@ -105,13 +91,3 @@ export class UserValues {
         this.overlayInteracted = params.overlayInteracted
     }
 }
-
-export class OpenSettings {
-    /**
-     * @param {object} params
-     * @param {"duckplayer"} params.target
-     */
-    constructor (params) {
-        this.target = params.target
-    }
-}

packages/special-pages/tests/duckplayer.spec.js

@@ -60,8 +60,7 @@ test.describe('duckplayer toolbar', () => {
         await duckplayer.hasLoadedIframe()
 
         await page.mouse.move(1, 1)
-        await duckplayer.clickToOpenSettings()
-        await duckplayer.didOpenSettingsInNewPage(page)
+        await duckplayer.opensSettingsInNewTab()
     })
     test('opening in youtube', async ({ page }, workerInfo) => {
         const duckplayer = DuckPlayerPage.create(page, workerInfo)

packages/special-pages/tests/page-objects/duck-player.js

@@ -141,25 +141,18 @@ export class DuckPlayerPage {
         await expect(this.page.locator('.info-icon-tooltip')).toBeHidden()
     }
 
-    async clickToOpenSettings () {
+    async opensSettingsInNewTab () {
+        // duck:// scheme will fail, but we can assert that it was tried and grab the URL
+        const failure = new Promise(resolve => {
+            this.page.context().on('requestfailed', f => {
+                resolve(f.url())
+            })
+        })
+
         await this.page.locator('.open-settings').click()
-    }
 
-    /**
-     * @param {import("@playwright/test").Page} otherPage
-     */
-    async didOpenSettingsInNewPage (otherPage) {
-        const calls = await this.mocks.waitForCallCount({ method: 'openSettings', count: 1 })
-        expect(calls[0]).toMatchObject({
-            payload: {
-                context: 'specialPages',
-                featureName: 'duckPlayerPage',
-                method: 'openSettings',
-                params: {
-                    target: 'duckplayer'
-                }
-            }
-        })
+        // this is for windows, we'll need to support more
+        expect(await failure).toEqual('duck://settings/duckplayer')
     }
 
     async clickPlayOnYouTube () {