added reuse session feature (#93)

* added reuse session feature

Author: AlexGalichenko

.github/workflows/pull-request.yml

@@ -18,6 +18,7 @@ jobs:
           node-version: ${{ matrix.version }}
       - run: npm ci
       - run: npm run build
+      - run: npm run test
       - run: npm run install:browsers
       - run: npm run test:e2e
       - name: junit report

.gitignore

@@ -3,7 +3,5 @@ lib/
 coverage/
 test-e2e/report.*
 .idea/
-customDir/
-dirToStoreTraces/
-dirToStoreVideos/
+traces/
 video/

CHANGELOG.md

@@ -8,6 +8,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 :beetle: - bugfix
 :x: - deprecation
 
+## [0.41.1]
+- :rocket: added _reuseSession_ option to keep browser/application opened after test ends
+
 ## [0.41.0]
 - :rocket: introduced browserManager object to control all launched browser and electron instances
 - :rocket: added steps to start/stop/switch to other browser/electron instances

README.md

@@ -136,6 +136,21 @@ To properly use globals exposed by @qavajs/steps-playwright add corresponding ty
 }
 ```
 
+## reuseSession
+reuseSession flag allows to share session between tests in frames of process. But setting of this flag
+transfers session control to user.
+
+```javascript
+module.exports = {
+    default: {
+        browser: {
+            reuseSession: true
+        }
+    }
+}
+```
+
+
 ## Development and testing
 Install dependencies
 `npm install`

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/steps-playwright",
-  "version": "0.41.0",
+  "version": "0.41.1",
   "description": "steps to interact with playwright",
   "main": "./index.js",
   "scripts": {
@@ -37,7 +37,7 @@
     "@types/express": "^4.17.21",
     "@vitest/coverage-v8": "^0.34.6",
     "@vitest/ui": "^0.34.6",
-    "electron": "^27.1.2",
+    "electron": "^27.1.3",
     "express": "^4.18.2",
     "ts-node": "^10.9.1",
     "typescript": "^5.3.2",

package.json

@@ -29,9 +29,16 @@ export class BrowserManager {
             this.setContext((driverInstance as any as ElectronApplication).context());
             this.setPage(await (driverInstance as any as ElectronApplication).firstWindow())
         } else {
-            const context = await driverInstance.newContext(driverConfig);
+            const firstContext = driverInstance.contexts()[0];
+            const context = driverConfig.reuseSession && firstContext
+                ? firstContext
+                : await driverInstance.newContext(driverConfig.capabilities);
             this.setContext(context);
-            this.setPage(await context.newPage());
+            const firstPage = this.context?.pages()[0];
+            const page = driverConfig.reuseSession && firstPage
+                ? firstPage
+                : await context.newPage();
+            this.setPage(page);
         }
         (this.context as NamedContext).name = 'default';
     }
@@ -88,7 +95,9 @@ export class BrowserManager {
     /**
      * return to default state (1 browser, no contexts)
      */
-    async teardown() {
+    async teardown({ reuseSession } = { reuseSession: false }) {
+        this.setDriver(this.drivers['default']);
+        if (reuseSession) return;
         for (const driverKey in this.drivers) {
             const driverInstance = this.drivers[driverKey] as any;
             if (driverInstance.firstWindow) {
@@ -97,7 +106,6 @@ export class BrowserManager {
                 await this.browserTeardown(driverInstance, driverKey);
             }
         }
-        this.driver = this.drivers['default'];
     }
 
     async browserTeardown(driverInstance: Browser, driverKey: string) {
@@ -120,7 +128,11 @@ export class BrowserManager {
     async close() {
         for (const driverKey in this.drivers) {
             const driverInstance = this.drivers[driverKey] as any;
-            await driverInstance.close();
+            if (driverInstance.firstWindow) {
+                await this.electronTeardown(driverInstance, driverKey);
+            } else {
+                await driverInstance.close();
+            }
             delete this.drivers[driverKey];
         }
     };

src/browserManager.ts

@@ -14,13 +14,12 @@ import { po } from '@qavajs/po-playwright';
 import {
     saveScreenshotAfterStep,
     saveScreenshotBeforeStep,
-    saveTrace,
-    saveVideo,
-    traceArchive
+    saveVideo
 } from './utils/utils';
 import { readFile } from 'node:fs/promises';
 import { createJSEngine } from './selectorEngines';
 import browserManager, {BrowserManager} from './browserManager';
+import tracingManager from './utils/tracingManager';
 
 declare global {
     var browser: Browser
@@ -47,12 +46,7 @@ Before({name: 'Init'}, async function () {
         config.driverConfig.capabilities.recordVideo = config.driverConfig.video;
     }
     await browserManager.launchDriver('default', config.driverConfig);
-    if (config.driverConfig.trace) {
-        await context.tracing.start({
-            screenshots: true,
-            snapshots: true
-        });
-    }
+    await tracingManager.start(driverConfig);
     po.init(page, { timeout: config.driverConfig.timeout.present, logger: this });
     po.register(config.pageObject);
     global.browserManager = browserManager;
@@ -80,20 +74,19 @@ AfterStep(async function (step: ITestStepHookParameter) {
 });
 
 After({name: 'Teardown'}, async function (scenario: ITestCaseHookParameter) {
-    if (saveTrace(config.driverConfig, scenario)) {
-        const path = traceArchive(config.driverConfig, scenario);
-        await context.tracing.stop({ path });
-        if (config.driverConfig?.trace.attach) {
-            const zipBuffer: Buffer = await readFile(path);
-            this.attach(zipBuffer.toString('base64'), 'base64:application/zip');
-        }
-    }
-    await browserManager.teardown();
+    await tracingManager.stop(config.driverConfig, this, scenario);
+    await browserManager.teardown({ reuseSession: config.driverConfig.reuseSession });
     if (saveVideo(config.driverConfig, scenario)) {
         if (config.driverConfig?.video.attach) {
-            const videoPath = await page.video()?.path() ?? '';
-            const zipBuffer: Buffer = await readFile(videoPath);
-            this.attach(zipBuffer.toString('base64'), 'base64:video/webm');
+            const video = page.video();
+            console.log(video)
+            if (video) {
+                const videoPath = await video.path();
+                const zipBuffer: Buffer = await readFile(videoPath);
+                this.attach(zipBuffer.toString('base64'), 'base64:video/webm');
+            } else {
+                console.warn('Video was not recorded');
+            }
         }
     }
 });

src/hooks.ts

@@ -17,7 +17,14 @@ When('I launch new driver as {string}', async function (driverName: string) {
  * @param {string} driverName - driver name
  * @param {string} config - json with browser config
  * @example
- * When I launch new driver as 'browser2'
+ * When I launch new driver as 'browser2':
+ * """
+ *     {
+ *       "capabilities": {
+ *           "browserName": "firefox"
+ *       }
+ *     }
+ * """
  */
 When('I launch new driver as {string}:', async function (driverName: string, rawConfig: string) {
     const config = await getValue(rawConfig);
@@ -40,7 +47,7 @@ When('I switch to {string} driver', async function (driverName: string) {
  * Close driver
  * @param {string} driverName - driver name
  * @example
- * When I close to 'browser2' driver
+ * When I close 'browser2' driver
  */
 When('I close {string} driver', async function (driverName: string) {
     await browserManager.closeDriver(driverName);
@@ -72,7 +79,7 @@ When('I switch to {string} browser context', async function (browserContextName:
  * Close browser context
  * @param {string} browserContextName - browser context name
  * @example
- * When I close to 'browser2' browser context
+ * When I close 'browser2' browser context
  */
 When('I close {string} browser context', async function (browserContextName: string) {
     await browserManager.closeContext(browserContextName);

src/multiBrowser.ts

@@ -0,0 +1,32 @@
+import { saveTrace, traceArchive } from './utils';
+import { readFile } from 'node:fs/promises';
+
+class TracingManager {
+
+    isTracingStarted = false;
+    async start(driverConfig: any) {
+        if (driverConfig.trace) {
+            if (!driverConfig.reuseSession || (driverConfig.reuseSession && !this.isTracingStarted)) {
+                this.isTracingStarted = true;
+                await context.tracing.start({
+                    screenshots: true,
+                    snapshots: true
+                });
+            }
+            await context.tracing.startChunk();
+        }
+    }
+
+    async stop(driverConfig: any, world: any, scenario: any) {
+        if (saveTrace(config.driverConfig, scenario)) {
+            const path = traceArchive(config.driverConfig, scenario);
+            await context.tracing.stopChunk({ path });
+            if (driverConfig?.trace.attach) {
+                const zipBuffer: Buffer = await readFile(path);
+                world.attach(zipBuffer.toString('base64'), 'base64:application/zip');
+            }
+        }
+    }
+}
+
+export default new TracingManager();