feat: generate "X-Request-ID" header for each browser request (backport to v7)

README.md

@@ -1087,6 +1087,20 @@ Allows to intercept [HTTP request options](https://github.com/sindresorhus/got#o
 (RequestOptions) => RequestOptions
 ```
 
+In runtime a unique `X-Request-ID` header is generated for each browser request which consists of `${FIRST_X_REQ_ID}__${LAST_X_REQ_ID}`, where:
+- `FIRST_X_REQ_ID` - unique uuid for each test (different for each retry), allows to find all requests related to a single test run;
+- `LAST_X_REQ_ID` - unique uuid for each browser request, allows to find one unique request in one test (together with `FIRST_X_REQ_ID`).
+
+Header `X-Request-ID` can be useful if you manage the cloud with browsers yourself and collect logs with requests. Real-world example: `2f31ffb7-369d-41f4-bbb8-77744615d2eb__e8d011d8-bb76-42b9-b80e-02f03b8d6fe1`.
+
+To override generated `X-Request-ID` to your own value you need specify it in `transformRequest` handler. Example:
+
+```javascript
+transformRequest: (req) => {
+    req.handler["X-Request-ID"] = "my_x_req_id";
+}
+```
+
 ####  transformResponse
 Allows to intercept [HTTP response object](https://github.com/sindresorhus/got#response) after a WebDriver response has arrived. Default value is `null`. If function is passed then it takes `Response` (original response object) as the first and `RequestOptions` as the second argument. Should return modified `Response`. Example:
 

src/browser-pool/basic-pool.js

@@ -23,8 +23,7 @@ module.exports = class BasicPool extends Pool {
     }
 
     async getBrowser(id, opts = {}) {
-        const { version } = opts;
-        const browser = Browser.create(this._config, id, version);
+        const browser = Browser.create(this._config, { ...opts, id });
 
         try {
             await browser.init();

src/browser/browser.js

@@ -1,7 +1,9 @@
 "use strict";
 
+const crypto = require("crypto");
 const _ = require("lodash");
 const { SAVE_HISTORY_MODE } = require("../constants/config");
+const { X_REQUEST_ID_DELIMITER } = require("../constants/browser");
 const history = require("./history");
 const addRunStepCommand = require("./commands/runStep");
 
@@ -19,13 +21,14 @@ const CUSTOM_SESSION_OPTS = [
 ];
 
 module.exports = class Browser {
-    static create(config, id, version) {
-        return new this(config, id, version);
+    static create(config, opts) {
+        return new this(config, opts);
     }
 
-    constructor(config, id, version) {
-        this.id = id;
-        this.version = version;
+    constructor(config, opts) {
+        this.id = opts.id;
+        this.version = opts.version;
+        this.testXReqId = opts.testXReqId;
 
         this._config = config.forBrowser(this.id);
         this._debug = config.system.debug;
@@ -82,7 +85,21 @@ module.exports = class Browser {
 
     _getSessionOptsFromConfig(optNames = CUSTOM_SESSION_OPTS) {
         return optNames.reduce((options, optName) => {
-            if (!_.isNull(this._config[optName])) {
+            if (optName === "transformRequest") {
+                options[optName] = req => {
+                    if (!_.isNull(this._config[optName])) {
+                        req = this._config[optName](req);
+                    }
+
+                    if (!req.headers["X-Request-ID"]) {
+                        req.headers["X-Request-ID"] = `${
+                            this.testXReqId
+                        }${X_REQUEST_ID_DELIMITER}${crypto.randomUUID()}`;
+                    }
+
+                    return req;
+                };
+            } else if (!_.isNull(this._config[optName])) {
                 options[optName] = this._config[optName];
             }
 

src/browser/existing-browser.js

@@ -19,14 +19,14 @@ const { isSupportIsolation } = require("../utils/browser");
 const OPTIONAL_SESSION_OPTS = ["transformRequest", "transformResponse"];
 
 module.exports = class ExistingBrowser extends Browser {
-    static create(config, id, version, emitter) {
-        return new this(config, id, version, emitter);
+    static create(config, opts) {
+        return new this(config, opts);
     }
 
-    constructor(config, id, version, emitter) {
-        super(config, id, version);
+    constructor(config, opts) {
+        super(config, opts);
 
-        this._emitter = emitter;
+        this._emitter = opts.emitter;
         this._camera = Camera.create(this._config.screenshotMode, () => this._takeScreenshot());
 
         this._meta = this._initMeta();
@@ -165,6 +165,7 @@ module.exports = class ExistingBrowser extends Browser {
         return {
             pid: process.pid,
             browserVersion: this.version,
+            testXReqId: this.testXReqId,
             ...this._config.meta,
         };
     }

src/browser/new-browser.js

@@ -31,8 +31,8 @@ const headlessBrowserOptions = {
 };
 
 module.exports = class NewBrowser extends Browser {
-    constructor(config, id, version) {
-        super(config, id, version);
+    constructor(config, opts) {
+        super(config, opts);
 
         signalHandler.on("exit", () => this.quit());
     }

src/constants/browser.ts

@@ -1 +1,2 @@
 export const MIN_CHROME_VERSION_SUPPORT_ISOLATION = 93;
+export const X_REQUEST_ID_DELIMITER = "__";

src/runner/browser-agent.js

@@ -1,11 +1,11 @@
 "use strict";
 
 module.exports = class BrowserAgent {
-    static create(id, version, pool) {
-        return new this(id, version, pool);
+    static create(opts = {}) {
+        return new this(opts);
     }
 
-    constructor(id, version, pool) {
+    constructor({ id, version, pool }) {
         this.browserId = id;
 
         this._version = version;

src/runner/browser-runner.js

@@ -48,7 +48,11 @@ module.exports = class BrowserRunner extends Runner {
     }
 
     async _runTest(test) {
-        const browserAgent = BrowserAgent.create(this._browserId, test.browserVersion, this._browserPool);
+        const browserAgent = BrowserAgent.create({
+            id: this._browserId,
+            version: test.browserVersion,
+            pool: this._browserPool,
+        });
         const runner = TestRunner.create(test, this._config, browserAgent);
 
         runner.on(Events.TEST_BEGIN, test => this._suiteMonitor.testBegin(test));

src/runner/test-runner/high-priority-browser-agent.js

@@ -9,8 +9,8 @@ module.exports = class HighPriorityBrowserAgent {
         this._browserAgent = browserAgent;
     }
 
-    getBrowser() {
-        return this._browserAgent.getBrowser({ highPriority: true });
+    getBrowser(opts = {}) {
+        return this._browserAgent.getBrowser({ ...opts, highPriority: true });
     }
 
     freeBrowser(...args) {

src/runner/test-runner/regular-test-runner.js

@@ -1,5 +1,6 @@
 "use strict";
 
+const crypto = require("crypto");
 const _ = require("lodash");
 const Runner = require("../runner");
 const logger = require("../../utils/logger");
@@ -64,6 +65,7 @@ module.exports = class RegularTestRunner extends Runner {
             sessionCaps: this._browser.capabilities,
             sessionOpts: this._browser.publicAPI.options,
             file: this._test.file,
+            testXReqId: this._browser.testXReqId,
         });
     }
 
@@ -80,7 +82,7 @@ module.exports = class RegularTestRunner extends Runner {
 
     async _getBrowser() {
         try {
-            this._browser = await this._browserAgent.getBrowser();
+            this._browser = await this._browserAgent.getBrowser({ testXReqId: crypto.randomUUID() });
             this._test.sessionId = this._browser.sessionId;
 
             return this._browser;

src/worker/runner/browser-agent.js

@@ -1,24 +1,25 @@
 "use strict";
 
 module.exports = class BrowserAgent {
-    static create(browserId, browserVersion, pool) {
-        return new BrowserAgent(browserId, browserVersion, pool);
+    static create(opts) {
+        return new this(opts);
     }
 
-    constructor(browserId, browserVersion, pool) {
-        this.browserId = browserId;
-        this.browserVersion = browserVersion;
+    constructor({ id, version, pool }) {
+        this.browserId = id;
+        this.browserVersion = version;
 
         this._pool = pool;
     }
 
-    getBrowser({ sessionId, sessionCaps, sessionOpts }) {
+    getBrowser({ sessionId, sessionCaps, sessionOpts, testXReqId }) {
         return this._pool.getBrowser({
             browserId: this.browserId,
             browserVersion: this.browserVersion,
             sessionId,
             sessionCaps,
             sessionOpts,
+            testXReqId,
         });
     }
 

src/worker/runner/browser-pool.js

@@ -16,8 +16,13 @@ module.exports = class BrowserPool {
         this._calibrator = new Calibrator();
     }
 
-    async getBrowser({ browserId, browserVersion, sessionId, sessionCaps, sessionOpts }) {
-        const browser = Browser.create(this._config, browserId, browserVersion, this._emitter);
+    async getBrowser({ browserId, browserVersion, sessionId, sessionCaps, sessionOpts, testXReqId }) {
+        const browser = Browser.create(this._config, {
+            id: browserId,
+            version: browserVersion,
+            testXReqId,
+            emitter: this._emitter,
+        });
 
         try {
             await browser.init({ sessionId, sessionCaps, sessionOpts }, this._calibrator);

src/worker/runner/index.js

@@ -27,12 +27,12 @@ module.exports = class Runner extends AsyncEmitter {
         ]);
     }
 
-    async runTest(fullTitle, { browserId, browserVersion, file, sessionId, sessionCaps, sessionOpts }) {
+    async runTest(fullTitle, { browserId, browserVersion, file, sessionId, sessionCaps, sessionOpts, testXReqId }) {
         const tests = await this._testParser.parse({ file, browserId });
         const test = tests.find(t => t.fullTitle() === fullTitle);
-        const browserAgent = BrowserAgent.create(browserId, browserVersion, this._browserPool);
+        const browserAgent = BrowserAgent.create({ id: browserId, version: browserVersion, pool: this._browserPool });
         const runner = TestRunner.create(test, this._config.forBrowser(browserId), browserAgent);
 
-        return runner.run({ sessionId, sessionCaps, sessionOpts });
+        return runner.run({ sessionId, sessionCaps, sessionOpts, testXReqId });
     }
 };

src/worker/runner/test-runner/index.js

@@ -22,14 +22,14 @@ module.exports = class TestRunner {
         this._browserAgent = browserAgent;
     }
 
-    async run({ sessionId, sessionCaps, sessionOpts }) {
+    async run({ sessionId, sessionCaps, sessionOpts, testXReqId }) {
         const test = this._test;
         const hermioneCtx = test.hermioneCtx || {};
 
         let browser;
 
         try {
-            browser = await this._browserAgent.getBrowser({ sessionId, sessionCaps, sessionOpts });
+            browser = await this._browserAgent.getBrowser({ sessionId, sessionCaps, sessionOpts, testXReqId });
         } catch (e) {
             throw Object.assign(e, { hermioneCtx });
         }

test/src/browser-pool/basic-pool.js

@@ -33,13 +33,13 @@ describe("browser-pool/basic-pool", () => {
 
         await mkPool_({ config }).getBrowser("broId");
 
-        assert.calledWith(Browser.create, config, "broId");
+        assert.calledWith(Browser.create, config, { id: "broId" });
     });
 
     it("should create new browser with specified version when requested", async () => {
         await mkPool_().getBrowser("broId", { version: "1.0" });
 
-        assert.calledWith(Browser.create, sinon.match.any, "broId", "1.0");
+        assert.calledWith(Browser.create, sinon.match.any, { id: "broId", version: "1.0" });
     });
 
     it("should init browser", async () => {