@testring/plugin-selenium-driver 0.6.2 → 0.6.3

package/dist/plugin/index.js

@@ -15,6 +15,7 @@ const deepmerge = require("deepmerge");
 const child_process_1 = require("@testring/child-process");
 const logger_1 = require("@testring/logger");
 const devtool_extension_1 = require("@testring/devtool-extension");
+const code_coverage_client_1 = require("@nullcc/code-coverage-client");
 // Stupidly needed thing for making our own requests
 const _webdriverReq = require('webdriver/build/request');
 const WebDriverRequest = _webdriverReq.default;
@@ -31,6 +32,7 @@ const DEFAULT_CONFIG = {
             args: [],
         },
     },
+    cdpCoverage: false
 };
 function delay(timeout) {
     return new Promise((resolve) => setTimeout(() => resolve(), timeout));
@@ -266,14 +268,57 @@ class SeleniumPlugin {
                 throw Error('Session can not be null');
             }
             const customClient = this.addCustromMethods(client);
+            let cdpCoverageCollector;
+            if (this.config.cdpCoverage) {
+                this.logger.debug('Started to init cdp coverage....');
+                cdpCoverageCollector = yield this.enableCDPCoverageClient(client);
+                this.logger.debug('ended to init cdp coverage....');
+            }
             this.browserClients.set(applicant, {
                 client: customClient,
                 sessionId,
                 initTime: Date.now(),
+                cdpCoverageCollector: cdpCoverageCollector
+                    ? cdpCoverageCollector
+                    : null,
             });
             this.logger.debug(`Started session for applicant: ${applicant}. Session id: ${sessionId}`);
         });
     }
+    enableCDPCoverageClient(client) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.config.host === undefined) {
+                return null;
+            }
+            //accurate
+            if (!client.capabilities['se:cdp']) {
+                return null;
+            }
+            const cdpAddress = client.capabilities['se:cdp'];
+            const collector = new code_coverage_client_1.CDPCoverageCollector({
+                wsEndpoint: cdpAddress,
+            });
+            yield collector.init();
+            yield collector.start();
+            return collector;
+        });
+    }
+    getCdpCoverageFile(applicant) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const clientData = this.browserClients.get(applicant);
+            this.logger.debug(`start upload coverage for applicant ${applicant}`);
+            if (!clientData) {
+                return;
+            }
+            const coverageCollector = clientData.cdpCoverageCollector;
+            if (!coverageCollector) {
+                return;
+            }
+            const { coverage } = yield coverageCollector.collect();
+            yield coverageCollector.stop();
+            return [Buffer.from(JSON.stringify(coverage))];
+        });
+    }
     addCustromMethods(client) {
         // Creating our delete selenium session to be able to close
         // session if it's id is changed while we are running test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testring/plugin-selenium-driver",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "main": "./dist/index.js",
   "typings": "./src/index.ts",
   "repository": {
@@ -10,11 +10,12 @@
   "author": "RingCentral",
   "license": "MIT",
   "dependencies": {
-    "@testring/child-process": "0.6.2",
-    "@testring/devtool-extension": "0.6.2",
-    "@testring/logger": "0.6.2",
-    "@testring/plugin-api": "0.6.2",
-    "@testring/types": "0.6.2",
+    "@nullcc/code-coverage-client": "1.4.2",
+    "@testring/child-process": "0.6.3",
+    "@testring/devtool-extension": "0.6.3",
+    "@testring/logger": "0.6.3",
+    "@testring/plugin-api": "0.6.3",
+    "@testring/types": "0.6.3",
     "@types/deepmerge": "2.2.0",
     "@types/node": "18.11.18",
     "chromedriver": "*",

package/src/plugin/index.ts

@@ -9,6 +9,7 @@ import * as deepmerge from 'deepmerge';
 import {spawn} from '@testring/child-process';
 import {loggerClient} from '@testring/logger';
 import {absoluteExtensionPath} from '@testring/devtool-extension';
+import {CDPCoverageCollector} from '@nullcc/code-coverage-client';
 
 import type {Cookie} from '@wdio/protocols';
 import type {
@@ -32,6 +33,7 @@ type browserClientItem = {
     client: BrowserObjectCustom;
     sessionId: string;
     initTime: number;
+    cdpCoverageCollector: CDPCoverageCollector;
 };
 
 const DEFAULT_CONFIG: SeleniumPluginConfig = {
@@ -47,6 +49,7 @@ const DEFAULT_CONFIG: SeleniumPluginConfig = {
             args: [] as string[],
         },
     },
+    cdpCoverage: false
 };
 
 function delay(timeout) {
@@ -360,10 +363,19 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
             client as BrowserObjectCustom,
         );
 
+        let cdpCoverageCollector;
+        if (this.config.cdpCoverage) {
+            this.logger.debug('Started to init cdp coverage....');
+            cdpCoverageCollector = await this.enableCDPCoverageClient(client);
+            this.logger.debug('ended to init cdp coverage....');
+        }
         this.browserClients.set(applicant, {
             client: customClient,
             sessionId,
             initTime: Date.now(),
+            cdpCoverageCollector: cdpCoverageCollector
+                ? cdpCoverageCollector
+                : null,
         });
 
         this.logger.debug(
@@ -371,6 +383,38 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
         );
     }
 
+    private async enableCDPCoverageClient(client) {
+        if (this.config.host === undefined) {
+            return null;
+        }
+        //accurate
+        if (!client.capabilities['se:cdp']) {
+            return null;
+        }
+        const cdpAddress = client.capabilities['se:cdp'];
+        const collector = new CDPCoverageCollector({
+            wsEndpoint: cdpAddress,
+        });
+        await collector.init();
+        await collector.start();
+        return collector;
+    }
+
+    public async getCdpCoverageFile(applicant: string) {
+        const clientData = this.browserClients.get(applicant);
+        this.logger.debug(`start upload coverage for applicant ${applicant}`);
+        if (!clientData) {
+            return;
+        }
+        const coverageCollector = clientData.cdpCoverageCollector;
+        if (!coverageCollector) {
+            return;
+        }
+        const {coverage} = await coverageCollector.collect();
+        await coverageCollector.stop();
+        return [Buffer.from(JSON.stringify(coverage))];
+    }
+
     protected addCustromMethods(
         client: BrowserObjectCustom,
     ): BrowserObjectCustom {
@@ -855,6 +899,7 @@ export class SeleniumPlugin implements IBrowserProxyPlugin {
 
         return client.getWindowHandles();
     }
+
     // @deprecated
     public async windowHandles(applicant: string) {
         return this.getTabIds(applicant);

package/src/types.ts

@@ -7,4 +7,5 @@ export type SeleniumPluginConfig = RemoteOptions & {
     clientTimeout: number;
     host?: string; // fallback for configuration. In WebdriverIO 5 field host renamed to hostname
     desiredCapabilities?: WebDriver.DesiredCapabilities[]; // fallback for configuration. In WebdriverIO 5 field renamed
+    cdpCoverage: boolean;
 };