monocart-reporter 1.6.36 → 1.7.0

package/README.md

@@ -34,6 +34,7 @@
     - [Compare Istanbul, V8 and V8 to Istanbul](#compare-istanbul-v8-and-v8-to-istanbul)
     - [Global Coverage Report](#global-coverage-report) for Component Testing
 * [Attach Network Report](#attach-network-report)
+* [Global State Management](#global-state-management)
 * [Merge Shard Reports](#merge-shard-reports)
 * [onEnd hook](#onend-hook)
     - [Send Email](#send-email)
@@ -628,18 +629,17 @@ Attach a code coverage report with API `attachCoverageReport(data, testInfo, opt
 - `data` There are two supported data inputs `Istanbul` (Object) or `V8` (Array)
 - `testInfo` see [TestInfo](https://playwright.dev/docs/api/class-testinfo)
 - `options` (Object)
-    - Istanbul only:
-    - `watermarks` (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report)
-    - `lcov` (Boolean) Whether to create `lcov.info`
-    - `sourcePath` (Function) source path handler, return a new source path
-    - V8 only:
-    - `toIstanbul` (Boolean) Whether to convert to Istanbul report
-    - `watermarks` (Array) Defaults to `[50, 80]` 
+    - `title` (String) report title.
+    - `toIstanbul` (Boolean) Whether to convert to Istanbul report from V8 list.
     - `entryFilter` (Function) A filter function to execute for each element in the V8 list.
     - `unpackSourceMap` (Boolean) Whether to unpack all sources from the source map if a related source map file is found.
     - `excludeDistFile` (Boolean) Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
     - `sourceFilter` (Function) A filter function to execute for each element in the sources which unpacked from the source map.
+    - `watermarks` (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report) | (Array) V8 watermarks, Defaults to `[50, 80]`.
+    - `lcov` (Boolean) Whether to create `lcov.info`. Istanbul only.
+    - `sourcePath` (Function) source path handler, return a new source path. Istanbul only.
     - `inline` (Boolean) Whether inline all scripts to the single HTML file.
+    - `debug` (Boolean) The temporary artifacts will not be removed.
 
  (see example: [report-coverage.spec.js](https://github.com/cenfun/monocart-reporter/blob/main/tests/report-coverage/report-coverage.spec.js))
 
@@ -762,7 +762,6 @@ Attach a network report with API `attachNetworkReport(har, testInfo)`. Arguments
  Generate HAR with `recordHar` option in browser.newContext() (see example: [report-network.spec.js](https://github.com/cenfun/monocart-reporter/blob/main/tests/report-network/report-network.spec.js) preview [report](https://cenfun.github.io/monocart-reporter/network-1a18723ee59b36867898/index.html))
 
 ```js
-// CommonJS
 const fs = require('fs');
 const path = require('path');
 const { test } = require('@playwright/test');
@@ -828,6 +827,94 @@ test('finally, attach HAR', async () => {
 ```
 Preview [Network HTML Report](https://cenfun.github.io/monocart-reporter/network-38e613e8d93547bdb27f/index.html)
 
+
+## Global State Management
+When tests are executed in [isolation](https://playwright.dev/docs/browser-contexts) mode, the reporter and each test may run in a different process, they cannot share data with each other. we can start a local WebSocket server to serve the global data, and read/write the global data with `useState` API from a test.
+- setup global state
+```js
+module.exports = {
+    reporter: [
+        ['list'],
+        ['monocart-reporter', {  
+            name: "My Test Report",
+            outputFile: './test-results/report.html',
+            state: {
+                data: {
+                    count: 0
+                },
+                server: {
+                    // port: 8130
+                },
+                onClose: (data, config) => {
+                    // save state data to global metadata
+                    Object.assign(config.metadata, data);
+                }
+            }
+        }]
+    ]
+};
+```
+- get/set/remove global data
+```js
+const { test } = require('@playwright/test');
+const { useState } = require('monocart-reporter');
+test('state test', async ({ browserName }) => {
+    const state = useState({
+        // port: 8130
+    });
+
+    const count = await state.get('count');
+    console.log('count', count);
+
+    await state.set('count', count + 1);
+
+    await state.set({
+        browser: browserName,
+        someKey: 'some value'
+    });
+
+    const [browser, someKey] = await state.get('browser', 'someKey');
+    console.log(browser, someKey);
+
+    await state.remove('someKey');
+
+    const all = await state.get();
+    console.log(all);
+});
+``` 
+- customize sending and receiving messages
+```js
+module.exports = {
+    reporter: [
+        ['list'],
+        ['monocart-reporter', {  
+            name: "My Test Report",
+            outputFile: './test-results/report.html',
+            state: {
+                // receive messages and send back response
+                onReceive: function(... args) {
+                    console.log('receive on server', args);
+                    return ['custom response', ... args];
+                }
+            }
+        }]
+    ]
+};
+```
+```js
+const { test } = require('@playwright/test');
+const { useState } = require('monocart-reporter');
+test('state test', async ({ browserName }) => {
+    const state = useState({
+        // port: 8130
+    });
+    // send messages
+    const res = await state.send('string data', {});
+    console.log('receive on client', res);
+});
+``` 
+
+
 ## Merge Shard Reports
 There will be multiple reports to be generated if Playwright test executes in sharding mode. for example:
 ```sh

package/lib/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const fs = require('fs');
 const path = require('path');
@@ -94,14 +94,17 @@ const start = function() {
     const args = process.argv.slice(2);
     const command = args.shift();
     // console.log(command, args);
-    if (command === 'show-report') {
+    if (command === 'show' || command === 'show-report') {
         serveReport(args, true);
         return;
     }
 
-    if (command === 'serve-report') {
+    if (command === 'serve' || command === 'serve-report') {
         serveReport(args, false);
+        return;
     }
+
+    EC.logRed(`Not found command: ${command}`);
 };
 
 start();

package/lib/default/options.js

@@ -20,6 +20,8 @@ module.exports = {
     //     sourceFilter: (sourceName) => sourceName.search(/src\/.+/) !== -1,
     // },
 
+    state: null,
+
     // trend data handler
     trend: null,
     // trend: () => './test-results/report.json',

package/lib/generate-report.js

@@ -1,7 +1,7 @@
 const path = require('path');
 const EC = require('eight-colors');
 const CG = require('console-grid');
-const { nodemailer } = require('./runtime/monocart-vendor.js');
+const nodemailer = require('nodemailer');
 const Util = require('./utils/util.js');
 const emailPlugin = require('./plugins/email.js');
 

package/lib/index.d.ts

@@ -0,0 +1,127 @@
+import { TestInfo } from "@playwright/test"
+
+/**
+ * merge
+ */
+export function merge(
+    reportDataList: [],
+    options?: any
+): Promise<void>;
+
+/**
+ * audit
+ */
+export type AuditReportOptions = {
+    title?: string,
+    outputDir?: string,
+    outputName?: string
+};
+
+export function attachAuditReport(
+    runnerResult: any,
+    testInfo: TestInfo,
+    options?: AuditReportOptions
+): Promise<any>;
+
+
+/**
+ * coverage
+ */
+export function addCoverageReport(
+    v8list: any[],
+    testInfo: TestInfo
+): Promise<any | void>;
+
+export type CoverageReportOptions = {
+
+    title?: string,
+    outputDir?: string,
+    outputName?: string,
+
+    // Whether to convert to Istanbul report
+    toIstanbul?: boolean,
+
+    // A filter function to execute for each element in the V8 list.
+    entryFilter?: (entry: any) => boolean,
+
+    // Whether to unpack all sources from the source map if a related source map file is found.
+    unpackSourceMap?: boolean,
+    // Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
+    excludeDistFile?: boolean,
+
+    // A filter function to execute for each element in the sources which unpacked from the source map.
+    sourceFilter?: (sourcePath: string) => boolean,
+
+    sourcePath?: (sourcePath: string) => string,
+
+    sourceFinder?: (filePath: string) => string,
+
+    // Whether to create `lcov.info`
+    lcov?: boolean,
+
+    watermarks?: [number, number] | {
+        statements: [number, number],
+        functions: [number, number],
+        branches: [number, number],
+        lines: [number, number]
+    },
+
+    // Whether inline all scripts to the single HTML file.
+    inline?: boolean,
+
+    debug?: boolean
+};
+
+export function attachCoverageReport(
+    coverage: any[] | any,
+    testInfo: TestInfo,
+    options?: CoverageReportOptions
+): Promise<any>;
+
+
+
+/**
+ * network
+ */
+export type NetworkReportOptions = {
+    title?: string,
+    outputDir?: string,
+    outputName?: string,
+
+    // Whether inline all scripts to the single HTML file.
+    inline?: boolean
+};
+
+export function attachNetworkReport(
+    har: string | Buffer,
+    testInfo: TestInfo,
+    options?: NetworkReportOptions
+): Promise<any>;
+
+
+/**
+ * state
+ */
+export type StateOptions = {
+    host?: string,
+    port?: number,
+    timeout?: number
+};
+
+export type State = {
+    get: {
+        (key: string): Promise<any>,
+        (...args: string[]): Promise<any[]>
+    },
+    set: {
+        (key: string, value: any): Promise<void>,
+        (obj: object): Promise<void>
+    },
+    remove: {
+        (key: string): Promise<void>,
+        (...args: string[]): Promise<void>
+    },
+    send: (...args: any[]) => Promise<any>
+}
+
+export function useState(options?: StateOptions): State;

package/lib/index.js

@@ -10,18 +10,23 @@ const { attachAuditReport } = require('./plugins/audit/audit.js');
 const { addCoverageReport, attachCoverageReport } = require('./plugins/coverage/coverage.js');
 const { attachNetworkReport } = require('./plugins/network/network.js');
 
+const { createStateServer, useState } = require('./plugins/state/state.js');
+
 // custom reporter
 // https://playwright.dev/docs/test-reporters#custom-reporters
 class Reporter {
 
     static merge = merge;
 
-    static addCoverageReport = addCoverageReport;
-
     static attachAuditReport = attachAuditReport;
+
+    static addCoverageReport = addCoverageReport;
     static attachCoverageReport = attachCoverageReport;
+
     static attachNetworkReport = attachNetworkReport;
 
+    static useState = useState;
+
     constructor(userOptions = {}) {
 
         const timestampStart = Date.now();
@@ -41,6 +46,11 @@ class Reporter {
 
         this.tickTime = this.options.tickTime || 1000;
         this.tickStart();
+
+        const stateOptions = this.options.state;
+        if (stateOptions) {
+            this.stateServer = createStateServer(stateOptions);
+        }
     }
 
     printsToStdio() {
@@ -67,14 +77,14 @@ class Reporter {
         // console.log(`onBegin: ${suite.allTests().length} tests`);
     }
 
-    // Called on some global error, for example unhandled exception in the worker process.
-    onError(error) {
-        // EC.logRed(error);
-    }
-
     onTestBegin(test, result) {
         // console.log(`onTestBegin ${test.title}`);
 
+        // there maybe multiple test running at same time
+        // currentTest only for missing logs
+        // do NOT using for test info
+        this.currentTest = test;
+
         // Note that do not use this because is parallel
         if (!test.timestamps) {
             test.timestamps = [];
@@ -93,6 +103,7 @@ class Reporter {
 
     onStdErr(chunk, test, result) {
         // Note that output may happen when no test is running, in which case this will be void.
+        test = test || this.currentTest;
         if (test) {
             test.logs.push(EC.red(chunk));
         }
@@ -100,11 +111,23 @@ class Reporter {
 
     onStdOut(chunk, test, result) {
         // Note that output may happen when no test is running, in which case this will be void.
+        test = test || this.currentTest;
         if (test) {
             test.logs.push(chunk);
         }
     }
 
+    // Called on some global error, for example unhandled exception in the worker process.
+    onError(error) {
+        // EC.logRed(error);
+
+        // add the error to test logs
+        if (this.currentTest) {
+            this.currentTest.logs.push(EC.red(error.message));
+        }
+
+    }
+
     // onStepBegin(test, result, step)
     // onStepEnd(test, result, step)
 
@@ -123,6 +146,14 @@ class Reporter {
     }
 
     async onEnd(result) {
+
+        this.currentTest = null;
+
+        if (this.stateServer) {
+            await this.stateServer.close(this.config);
+            this.stateServer = null;
+        }
+
         // console.log(`onEnd: ${result.status}`);
         // console.log(result);
         this.tickStop();

package/lib/index.mjs

@@ -5,8 +5,11 @@ export { MonocartReporter };
 
 export const merge = MonocartReporter.merge;
 
-export const addCoverageReport = MonocartReporter.addCoverageReport;
-
 export const attachAuditReport = MonocartReporter.attachAuditReport;
+
+export const addCoverageReport = MonocartReporter.addCoverageReport;
 export const attachCoverageReport = MonocartReporter.attachCoverageReport;
+
 export const attachNetworkReport = MonocartReporter.attachNetworkReport;
+
+export const useState = MonocartReporter.useState;

package/lib/plugins/coverage/coverage.js

@@ -8,12 +8,12 @@ const {
     initV8ListAndSourcemap, unpackV8List, mergeV8Coverage, saveV8Report
 } = require('./v8/v8.js');
 
-// ========================================================================================================
-
-const defaultV8Options = {
+const defaultOptions = {
 
     // Defaults to test title
-    // title: '',
+    // title
+    // outputDir
+    // outputName
 
     // (Boolean) Whether to convert to Istanbul report
     toIstanbul: false,
@@ -25,25 +25,10 @@ const defaultV8Options = {
     // (Boolean) Whether to exclude the dist file (usually minified) if the sources are successfully unpacked from the source map.
     excludeDistFile: true,
     // (Function) A filter function to execute for each element in the sources which unpacked from the source map.
-    sourceFilter: null
-
-    // (Array) Defaults to `[50, 80]`
-    // watermarks: [50, 80],
-
-    // (Boolean) Whether inline all scripts to the single HTML file.
-    // inline: false
-};
-
-const defaultIstanbulOptions = {
-
-    // Defaults to test title
-    // title: '',
-
-    // when toIstanbul = true
-    entryFilter: null,
-    unpackSourceMap: true,
     sourceFilter: null,
 
+    // Istanbul Only
+
     // source path handler
     sourcePath: null,
 
@@ -55,8 +40,16 @@ const defaultIstanbulOptions = {
 
     // (Object) Istanbul watermarks, see [here](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report)
     // watermarks: {},
+    // (Array) V8 watermarks, Defaults to `[50, 80]`
+    // watermarks: [50, 80],
+
+    // (Boolean) Whether inline all scripts to the single HTML file.
+    // inline: false,
+
+    // debug: false
 };
 
+
 // ========================================================================================================
 
 const saveReportAttachment = (testInfo, report, htmlDir) => {
@@ -77,12 +70,9 @@ const saveReportAttachment = (testInfo, report, htmlDir) => {
 
 const generateIstanbulReport = (coverageData, testInfo, options) => {
 
-    options = {
-        ... defaultIstanbulOptions,
-        ... options
-    };
+    const fileSources = options.fileSources || {};
 
-    const report = saveIstanbulReport(coverageData, options.fileSources, options);
+    const report = saveIstanbulReport(coverageData, fileSources, options);
 
     saveReportAttachment(testInfo, report, options.htmlDir);
 
@@ -94,12 +84,6 @@ const generateIstanbulReport = (coverageData, testInfo, options) => {
 
 const generateV8Coverage = async (v8list, testInfo, options) => {
 
-    // v8list options, also for init / source map handler
-    options = {
-        ... defaultV8Options,
-        ... options
-    };
-
     // init v8list and unpack sourcemap
     const inlineSourceMap = true;
     v8list = await initV8ListAndSourcemap(v8list, options, inlineSourceMap);
@@ -107,10 +91,6 @@ const generateV8Coverage = async (v8list, testInfo, options) => {
     // ================================================================
 
     if (options.toIstanbul) {
-        options = {
-            ... defaultIstanbulOptions,
-            ... options
-        };
 
         const { coverageData, fileSources } = await convertV8ToIstanbul(v8list, options);
 
@@ -141,6 +121,7 @@ const attachCoverageReport = (coverageInput, testInfo, options = {}) => {
     }
 
     options = {
+        ... defaultOptions,
         // default title
         title: `Coverage Report - ${testInfo.title}`,
         outputDir: Util.resolveOutputDir(testInfo),
@@ -187,7 +168,7 @@ const addCoverageReport = async (v8list, testInfo) => {
     const outputDir = path.dirname(outputFile);
 
     const options = {
-        ... defaultV8Options,
+        ... defaultOptions,
         // use reporter dir as output dir, NOT test output dir
         outputDir,
         outputName: 'coverage',
@@ -237,22 +218,12 @@ const addCoverageReport = async (v8list, testInfo) => {
 
 const getGlobalCoverageData = async (dataList, options) => {
 
-    options = {
-        ... defaultV8Options,
-        ... options
-    };
-
     // merge v8list first
     const v8list = await mergeV8Coverage(dataList, options);
     // console.log('after merge', v8list.map((it) => it.url));
 
     if (options.toIstanbul) {
 
-        options = {
-            ... defaultIstanbulOptions,
-            ... options
-        };
-
         const { coverageData, fileSources } = await convertV8ToIstanbul(v8list, options);
 
         const report = await saveIstanbulReport(coverageData, fileSources, options);
@@ -279,6 +250,7 @@ const generateGlobalCoverageReport = async (dataList, reporterOptions) => {
 
     const coverageOptions = reporterOptions.coverage || {};
     const options = {
+        ... defaultOptions,
         title: `Coverage Report - ${reporterOptions.name}`,
         outputDir,
         outputName: 'coverage',

package/lib/plugins/coverage/istanbul/istanbul.js

@@ -28,11 +28,14 @@ const saveIstanbulReport = (coverageData, fileSources, options) => {
         data = {};
         Object.keys(coverageData).forEach((sourcePath) => {
             const d = coverageData[sourcePath];
-            const newSourcePath = options.sourcePath(sourcePath, fileSources);
-            if (newSourcePath) {
+            const s = fileSources[sourcePath];
+            const newSourcePath = options.sourcePath(sourcePath);
+            if (newSourcePath && newSourcePath !== sourcePath) {
                 sourcePath = newSourcePath;
+                // related updates
+                fileSources[sourcePath] = s;
+                d.path = sourcePath;
             }
-            d.path = sourcePath;
             data[sourcePath] = d;
         });
     }
@@ -181,14 +184,25 @@ const convertV8ToIstanbul = async (v8list, options) => {
             return p;
         };
 
+        let failed = false;
         await v8toIstanbul.load().catch((e) => {
-            EC.logRed(`[MCR] ${item.filename} v8toIstanbul.load:`, e.message);
+            EC.logRed(`[MCR] ${item.sourcePath} v8toIstanbul.load:`, e.message);
+            failed = true;
         });
 
+        if (failed) {
+            continue;
+        }
+
         try {
             v8toIstanbul.applyCoverage(item.functions);
         } catch (e) {
-            EC.logRed(`[MCR] ${item.filename} v8toIstanbul.applyCoverage:`, e.message);
+            EC.logRed(`[MCR] ${item.sourcePath} v8toIstanbul.applyCoverage:`, e.message);
+            failed = true;
+        }
+
+        if (failed) {
+            continue;
         }
 
         const istanbulData = v8toIstanbul.toIstanbul();

package/lib/plugins/coverage/v8/source-map.js

@@ -99,7 +99,7 @@ const findOriginalEndPosition = (consumer, eLoc, generatedMapping, range) => {
 
 // =========================================================================================================
 
-const getOriginalMappings = (generatedMapping, consumer, options) => {
+const getOriginalMappings = (consumer, options) => {
 
     // source filter
     let sourceList = consumer.sources;
@@ -152,7 +152,7 @@ const unpackJsSourceMap = async (item, v8list, options) => {
 
     const generatedMapping = new PositionMapping(item.source);
     const consumer = await new SourceMapConsumer(sourceMap);
-    const originalMappings = getOriginalMappings(generatedMapping, consumer, options);
+    const originalMappings = getOriginalMappings(consumer, options);
 
     // generated ranges to original ranges
     item.ranges.forEach((range) => {
@@ -419,6 +419,12 @@ const filterSourceMapList = (v8list, options) => {
         return;
     }
 
+    // do not remove in debug mode
+    if (options.debug) {
+        return sourceMapList;
+    }
+
+    // remove dist file if found sourceMap
     if (options.excludeDistFile) {
         indexes.reverse();
         indexes.forEach((i) => {

package/lib/plugins/coverage/v8/v8-summary.js

@@ -17,7 +17,7 @@ const getCssSummary = (item) => {
     const uncovered = total - covered;
 
     return {
-        name: item.filename,
+        name: item.sourcePath,
         type: item.type,
         url: item.url,
         total,
@@ -59,7 +59,7 @@ const getJsSummary = (item) => {
     const covered = total - uncovered;
 
     return {
-        name: item.filename,
+        name: item.sourcePath,
         type: item.type,
         url: item.url,
         total,