fix: remove unknown capabilities when running local browser

gemini-testing · Dec 25, 2024 · 781ca7b · 781ca7b
1 parent 0a7f786
commit 781ca7b
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 3 deletions.
diff --git a/src/browser/new-browser.ts b/src/browser/new-browser.ts
@@ -1,7 +1,7 @@
 import { URLSearchParams } from "url";
 
 import URI from "urijs";
-import { isBoolean, assign, isEmpty } from "lodash";
+import { isBoolean, assign, isEmpty, set } from "lodash";
 import { remote, RemoteOptions } from "webdriverio";
 
 import { Browser, BrowserOpts } from "./browser";
@@ -10,7 +10,13 @@ import { runGroup } from "./history";
 import { warn } from "../utils/logger";
 import { getNormalizedBrowserName } from "../utils/browser";
 import { getInstance } from "../config/runtime-config";
-import { DEVTOOLS_PROTOCOL, WEBDRIVER_PROTOCOL, LOCAL_GRID_URL } from "../constants/config";
+import {
+    DEVTOOLS_PROTOCOL,
+    WEBDRIVER_PROTOCOL,
+    LOCAL_GRID_URL,
+    W3C_CAPABILITIES,
+    VENDOR_CAPABILITIES,
+} from "../constants/config";
 import { Config } from "../config";
 import { BrowserConfig } from "../config/browser-config";
 import { gridUrl as DEFAULT_GRID_URL } from "../config/defaults";
@@ -254,7 +260,18 @@ export class NewBrowser extends Browser {
             capabilities[capabilitySettings.capabilityName]!.binary ||= executablePath;
         }
 
-        return capabilities;
+        const filteredCapabilities: WebdriverIO.Capabilities = Object.keys(capabilities)
+            .filter(capabilityName => {
+                const isW3CCapability = W3C_CAPABILITIES.includes(capabilityName);
+                const isVendorSpecificCapability = VENDOR_CAPABILITIES[browserNameW3C].includes(capabilityName);
+
+                return isW3CCapability || isVendorSpecificCapability;
+            })
+            .reduce((acc, capabilityName) => {
+                return set(acc, [capabilityName], capabilities[capabilityName as keyof WebdriverIO.Capabilities]);
+            }, {});
+
+        return filteredCapabilities;
     }
 
     protected _getGridHost(url: URI): string {

diff --git a/src/constants/config.ts b/src/constants/config.ts
@@ -1,3 +1,5 @@
+import { BrowserName, type W3CBrowserName } from "../browser/types";
+
 export const WEBDRIVER_PROTOCOL = "webdriver";
 export const DEVTOOLS_PROTOCOL = "devtools";
 export const SAVE_HISTORY_MODE = {
@@ -8,3 +10,29 @@ export const SAVE_HISTORY_MODE = {
 export const NODEJS_TEST_RUN_ENV = "nodejs";
 export const BROWSER_TEST_RUN_ENV = "browser";
 export const LOCAL_GRID_URL = "local";
+
+// https://www.w3.org/TR/webdriver/#capabilities
+export const W3C_CAPABILITIES = [
+    "browserName",
+    "browserVersion",
+    "platformName",
+    "acceptInsecureCerts",
+    "pageLoadStrategy",
+    "proxy",
+    "setWindowRect",
+    "timeouts",
+    "strictFileInteractability",
+    "unhandledPromptBehavior",
+    "userAgent",
+];
+
+export const VENDOR_CAPABILITIES: Record<W3CBrowserName, string[]> = {
+    // https://developer.chrome.com/docs/chromedriver/capabilities
+    [BrowserName.CHROME]: ["goog:chromeOptions", "perfLoggingPrefs"],
+    // https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions
+    [BrowserName.FIREFOX]: ["moz:firefoxOptions"],
+    // https://learn.microsoft.com/en-us/microsoft-edge/webdriver-chromium/capabilities-edge-options
+    [BrowserName.EDGE]: ["ms:edgeOptions"],
+    // https://developer.apple.com/documentation/webkit/about-webdriver-for-safari
+    [BrowserName.SAFARI]: ["safari:automaticInspection", "safari:automaticProfiling", "useTechnologyPreview"],
+};
diff --git a/test/src/browser/new-browser.js b/test/src/browser/new-browser.js
@@ -432,6 +432,37 @@ describe("NewBrowser", () => {
                     },
                 });
             });
+
+            it("should remove unknown capabilities", async () => {
+                installBrowserStub.withArgs("chrome", "115.0").resolves("/browser/path/chrome/115.0");
+                RuntimeConfig.getInstance.returns({ local: true });
+                const wdPool = mkWdPool_({ gridUrl: "http://localhost:23456/" });
+                const browser = mkBrowser_(
+                    {
+                        gridUrl: "http://localhost:4444/wd/hub",
+                        automationProtocol: "webdriver",
+                        desiredCapabilities: {
+                            browserName: "chrome",
+                            browserVersion: "115.0",
+                            "selenoid:options": { baz: "qux" },
+                            "moz:firefoxOptions": {},
+                            perfLoggingPrefs: { foo: "bar" },
+                        },
+                    },
+                    { wdPool },
+                );
+
+                await browser.init();
+
+                assert.deepEqual(webdriverio.remote.lastCall.args[0].capabilities, {
+                    browserName: "chrome",
+                    browserVersion: "115.0",
+                    "goog:chromeOptions": {
+                        binary: "/browser/path/chrome/115.0",
+                    },
+                    perfLoggingPrefs: { foo: "bar" },
+                });
+            });
         });
     });