WAT-4466

core/types/src/browser-proxy/enums.ts

@@ -90,4 +90,6 @@ export const enum BrowserProxyActions {
     isStable = 'isStable',
     waitForEnabled = 'waitForEnabled',
     waitForStable = 'waitForStable',
+    setCustomBrowserClientConfig = 'setCustomBrowserClientConfig',
+    getCustomBrowserClientConfig = 'getCustomBrowserClientConfig',
 }

core/types/src/web-application/index.ts

@@ -31,6 +31,7 @@ export interface IWebApplicationConfig {
     screenshotsEnabled: boolean;
     screenshotPath: string;
     devtool: null | IDevtoolRuntimeConfiguration;
+    seleniumConfig?: any;
 }
 
 export type WindowFeatureBoolean = 'yes' | 'no';

packages/e2e-test-app/src/mock-web-server.ts

@@ -8,6 +8,7 @@ const upload = multer({storage: multer.memoryStorage()});
 
 export class MockWebServer {
     private httpServerInstance: Http.Server;
+    private static seleniumHubHeaders: Http.IncomingHttpHeaders[] = [];
 
     start(): Promise<void> {
         return new Promise<void>((resolve) => {
@@ -39,6 +40,29 @@ export class MockWebServer {
             });
         });
 
+        // mock any request that contains /wd/hub
+        app.all('/wd/hub/*', (req, res) => {
+            // get request headers
+            const headers = req.headers;
+            // store headers for later use
+            MockWebServer.seleniumHubHeaders.push(headers);
+            res.status(200).json({
+                status: 0,
+                value: {
+                    sessionId: 'mock-session-id',
+                    capabilities: {
+                        browserName: 'mock-browser',
+                        platformName: 'mock-platform',
+                    },
+                },
+            });
+        });
+
+        // endpoint to retrieve stored headers
+        app.get('/selenium-headers', (req, res) => {
+            res.status(200).json(MockWebServer.seleniumHubHeaders);
+        });
+
         return app;
     }
 }

packages/e2e-test-app/test/selenium/test/set-custom-config.spec.js

@@ -0,0 +1,30 @@
+import {run} from 'testring';
+
+run(async (api) => {
+    const app = api.application;
+    await app.client.setCustomBrowserClientConfig({
+        hostname: 'localhost',
+        port: 8080,
+        headers: {
+            'X-Testring-Custom-Header': 'TestringCustomValue',
+        },
+    });
+    const config = await app.client.getCustomBrowserClientConfig();
+    await app.assert.equal(
+        config.headers['X-Testring-Custom-Header'],
+        'TestringCustomValue',
+    );
+    await app.url('https://example.com');
+    // make api request to localhost:8080/selenium-headers to retrieve captured headers
+    const response = await api.http.get({
+        url: 'http://localhost:8080/selenium-headers',
+    });
+    const parsedResponse = JSON.parse(response);
+    await app.assert.isAbove(parsedResponse.length, 0);
+    for (let capturedHeaders of parsedResponse) {
+        await app.assert.equal(
+            capturedHeaders['x-testring-custom-header'],
+            'TestringCustomValue',
+        );
+    }
+});

packages/plugin-selenium-driver/src/plugin/index.ts

@@ -20,6 +20,7 @@ import type {ClickOptions, MockFilterOptions} from 'webdriverio';
 import type {JsonCompatible} from '@wdio/types';
 import type {RespondWithOptions} from 'webdriverio/build/utils/interception/types';
 import webdriver from 'webdriver';
+import {WebdriverIOConfig} from '@wdio/types/build/Capabilities';
 
 type BrowserObjectCustom = WebdriverIO.Browser & {
     sessionId: string;
@@ -75,6 +76,8 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
 
     private browserClients: Map<string, browserClientItem> = new Map();
 
+    private customBrowserClientsConfigs: Map<string, WebdriverIOConfig> = new Map();
+
     private waitForReadyState: Promise<void> = Promise.resolve();
 
     private localSelenium: ChildProcess;
@@ -268,6 +271,22 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
         }
     }
 
+    public setCustomBrowserClientConfig(
+        applicant: string,
+        config: WebdriverIOConfig,
+    ) {
+        this.customBrowserClientsConfigs.set(
+            applicant,
+            config
+        );
+    }
+
+    public getCustomBrowserClientConfig(
+        applicant: string,
+    ) {
+        return this.customBrowserClientsConfigs.get(applicant);
+    }
+
     private async createClient(
         applicant: string,
         config?: Partial<WebdriverIO.Config>,
@@ -294,6 +313,7 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
             {},
             this.config,
             (config as any) || {},
+            this.customBrowserClientsConfigs.get(applicant) || {},
         ]);
         const client = await remote(_config);
 
@@ -425,6 +445,7 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
             await delay(this.config.delayAfterSessionClose);
         }
         this.browserClients.delete(applicant);
+        this.customBrowserClientsConfigs.delete(applicant);
     }
 
     public async kill() {
@@ -1109,6 +1130,7 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
 
         await client.deleteSession();
         this.browserClients.delete(applicant);
+        this.customBrowserClientsConfigs.delete(applicant);
         await this.createClient(applicant, {
             capabilities: {
                 'goog:chromeOptions': {

packages/web-application/src/web-application.ts

@@ -308,6 +308,7 @@ export class WebApplication extends PluggableModule {
             return `Wait for stable ${this.formatXpath(xpath)} for ${timeout}`;
         },
     };
+    private initPromise: Promise<any> = Promise.resolve();
 
     constructor(
         protected testUID: string,
@@ -317,6 +318,9 @@ export class WebApplication extends PluggableModule {
         super();
         this.config = this.getConfig(config);
         this.decorateMethods();
+        if (config.seleniumConfig) {
+            this.initPromise = this.client.setCustomBrowserClientConfig(this.config.seleniumConfig);
+        }
     }
 
     protected getConfig(
@@ -348,6 +352,7 @@ export class WebApplication extends PluggableModule {
 
             // eslint-disable-next-line no-async-promise-executor
             const promise = new Promise(async (resolve, reject) => {
+                await this.initPromise;
                 const logger = self.logger;
                 const message = logFn.apply(self, args);
                 let result;

packages/web-application/src/web-client.ts

@@ -63,6 +63,14 @@ export class WebClient implements IWebApplicationClient {
         return this.makeRequest(BrowserProxyActions.refresh, []);
     }
 
+    public setCustomBrowserClientConfig(config) {
+        return this.makeRequest(BrowserProxyActions.setCustomBrowserClientConfig, [config]);
+    }
+
+    public getCustomBrowserClientConfig() {
+        return this.makeRequest(BrowserProxyActions.getCustomBrowserClientConfig, []);
+    }
+
     public getHubConfig() {
         return this.makeRequest(BrowserProxyActions.getHubConfig, []);
     }