monocart-reporter 2.9.6 → 2.9.8

package/lib/visitor.js

@@ -1,915 +1,915 @@
-const fs = require('fs');
-const path = require('path');
-const EC = require('eight-colors');
-const {
-    StackUtils, codeFrameColumns, sanitize
-} = require('./packages/monocart-reporter-vendor.js');
-const Util = require('./utils/util.js');
-const commentsPlugin = require('./plugins/comments.js');
-const getDefaultColumns = require('./default/columns.js');
-
-class Visitor {
-    constructor(root, options) {
-        this.root = root;
-        this.options = options;
-
-        // console.log(options);
-
-        if (typeof options.visitor === 'function') {
-            this.customCommonVisitor = options.visitor;
-        }
-
-    }
-
-    async start() {
-
-        const columns = getDefaultColumns();
-        // default columns not detailed in report
-        columns.forEach((item) => {
-            item.detailed = false;
-        });
-
-        // custom column formatters with string passed to JSON
-        this.formatters = {};
-
-        // user defined custom columns
-        const handler = this.options.columns;
-        if (!this.columnsUpdated && typeof handler === 'function') {
-            // prevent repeated execution
-            this.columnsUpdated = true;
-
-            // update default columns by user
-            handler.call(this, columns);
-
-            // maybe a tree
-            const customVisitors = [];
-            this.initCustomHandler(columns, customVisitors, this.formatters);
-            if (customVisitors.length) {
-                this.customVisitors = customVisitors;
-            }
-        }
-
-        // console.log(customFormatters);
-
-        this.columns = columns;
-        this.rows = [];
-        this.jobs = [];
-        this.artifacts = [];
-
-        await this.visit(this.root, this.rows);
-
-        this.duplicatedErrorsHandler(this.rows);
-
-    }
-
-    // ==============================================================================================
-
-    initCustomHandler(list, visitors, formatters) {
-
-        list.forEach((column) => {
-            if (column.id) {
-
-                // custom visitor
-                if (typeof column.visitor === 'function') {
-
-                    visitors.push({
-                        id: column.id,
-                        visitor: column.visitor
-                    });
-
-                    // remove function (can not be in JSON)
-                    delete column.visitor;
-
-                }
-
-                // custom formatter
-                if (typeof column.formatter === 'function') {
-
-                    formatters[column.id] = column.formatter.toString();
-
-                    // remove function (can not be in JSON)
-                    delete column.formatter;
-                }
-
-            }
-
-            // drill down
-            if (Util.isList(column.subs)) {
-                this.initCustomHandler(column.subs, visitors, formatters);
-            }
-        });
-    }
-
-    // generate the column data from playwright metadata
-    // data.type is suite, metadata is Suite, https://playwright.dev/docs/api/class-suite
-    // data.type is case, metadata is TestCase, https://playwright.dev/docs/api/class-testcase
-    // data.type is step, metadata is TestStep, https://playwright.dev/docs/api/class-teststep
-    async customVisitorsHandler(data, metadata) {
-
-        if (this.options.customFieldsInComments) {
-            const customData = commentsPlugin(metadata);
-            Object.assign(data, customData);
-        }
-
-        // for all data
-        if (this.customCommonVisitor) {
-            await this.customCommonVisitor.call(this, data, metadata);
-        }
-
-        // for single column data (high priority)
-        if (this.customVisitors) {
-            for (const item of this.customVisitors) {
-                const res = await item.visitor.call(this, data, metadata);
-                if (typeof res !== 'undefined') {
-                    data[item.id] = res;
-                }
-            }
-        }
-    }
-
-    // ==============================================================================================
-
-    async visit(suite, list) {
-        if (!suite._entries) {
-            return;
-        }
-        // suite -> tests/test case -> test result -> test step
-        for (const entry of suite._entries) {
-            // only case has results
-            if (entry.results) {
-                await this.testCaseHandler(entry, list);
-            } else {
-                await this.testSuiteHandler(entry, list);
-            }
-        }
-    }
-
-    // ==============================================================================================
-
-    /*
-    Project suite #1. Has a child suite for each test file in the project.
-        File suite #1
-            TestCase #1
-            Suite corresponding to a test.describe(title, callback) group
-                TestCase #1 in a group
-                    TestStep
-    */
-    async testSuiteHandler(suite, list) {
-
-        // sometimes project title is empty
-        const suiteType = suite._type;
-        let suiteTitle = Util.formatPath(suite.title);
-        if (!suiteTitle) {
-            suiteTitle = suiteType;
-        }
-
-        // suite uid for report
-        const suiteStr = [suite._fileId].concat(suite.titlePath()).filter((it) => it).join(' ');
-        // console.log(suiteStr);
-        const suiteId = Util.calculateId(suiteStr);
-
-        const group = {
-            id: suiteId,
-            title: suiteTitle,
-            type: 'suite',
-            // root, project, file, describe
-            suiteType: suiteType,
-            // all test cases in this suite and its descendants
-            caseNum: suite.allTests().length,
-            subs: []
-        };
-
-        if (suiteType === 'project') {
-            this.projectMetadataHandler(group, suite);
-        }
-
-        if (suite.location) {
-            group.location = this.locationHandler(suite.location);
-        }
-
-        await this.customVisitorsHandler(group, suite);
-
-        list.push(group);
-        // drill down
-        await this.visit(suite, group.subs);
-    }
-
-    projectMetadataHandler(project, suite) {
-        const sp = suite._fullProject;
-        if (!sp) {
-            return;
-        }
-
-        const projectMetadata = sp.project && sp.project.metadata;
-        if (!projectMetadata) {
-            return;
-        }
-
-        const config = sp.fullConfig && sp.fullConfig.config;
-        const configMetadata = config && config.metadata;
-        if (configMetadata && configMetadata === projectMetadata) {
-            return;
-        }
-
-        project.metadata = projectMetadata;
-    }
-
-    // ==============================================================================================
-
-    async testCaseHandler(testCase, list) {
-
-        // duration
-        // total of testResult.duration is not exact, it will cost time before/between/after result
-        const caseTimestamps = [].concat(testCase.timestamps);
-        const duration = caseTimestamps.pop() - caseTimestamps.shift();
-
-        // Unique test ID that is computed based on the test file name, test title and project name
-
-        // 6113402d7bc11a0fb7a9-281a9986cca0dfd6fa4b
-        // const repeatEachIndexSuffix = repeatEachIndex ? ` (repeat:${repeatEachIndex})` : '';
-        // At the point of the query, suite is not yet attached to the project, so we only get file, describe and test titles.
-        // const testIdExpression = `[project=${project._internal.id}]${test.titlePath().join('\x1e')}${repeatEachIndexSuffix}`;
-        // const testId = fileId + '-' + calculateSha1(testIdExpression).slice(0, 20);
-
-        const caseId = Util.calculateId(testCase.id);
-
-        const caseItem = {
-            id: caseId,
-            title: testCase.title,
-            type: 'case',
-            caseType: '',
-
-            // Whether the test is considered running fine. Non-ok tests fail the test run with non-zero exit code.
-            ok: testCase.ok(),
-
-            // Testing outcome for this test. Note that outcome is not the same as testResult.status:
-            // returns: <"skipped"|"expected"|"unexpected"|"flaky">
-            outcome: testCase.outcome(),
-
-            expectedStatus: testCase.expectedStatus,
-            location: this.locationHandler(testCase.location),
-
-            // custom collection
-            logs: testCase.logs,
-            timestamps: testCase.timestamps,
-
-            duration,
-
-            // annotations, string or array
-            annotations: this.getCaseAnnotations(testCase.annotations),
-            // new syntax in playwright v1.42
-            tags: testCase.tags,
-
-            // repeatEachIndex: testCase.repeatEachIndex,
-
-            // The maximum number of retries given to this test in the configuration
-            // retries: testCase.retries,
-
-            // The timeout given to the test.
-            // Affected by testConfig.timeout, testProject.timeout, test.setTimeout(timeout), test.slow() and testInfo.setTimeout(timeout).
-            timeout: testCase.timeout,
-
-            // ===============================================================
-            // merge all results (retry multiple times)
-
-            attachments: [],
-
-            // errors thrown during the test execution.
-            // error is first errors
-            errors: [],
-
-            retry: 0,
-
-            // <"passed"|"failed"|"timedOut"|"skipped">
-            status: '',
-
-            // all results steps
-            stepNum: 0,
-            stepFailed: 0,
-            stepSubs: false,
-            subs: []
-        };
-
-        const resultsTimestamps = [].concat(testCase.timestamps);
-
-        for (const testResult of testCase.results) {
-
-            const retry = testResult.retry;
-
-            caseItem.retry = retry;
-            caseItem.status = testResult.status;
-
-            const attachments = this.initAttachmentsRetry(testResult.attachments, retry);
-            caseItem.attachments = caseItem.attachments.concat(attachments);
-            caseItem.errors = caseItem.errors.concat(testResult.errors);
-
-            // The worker index is used to reference a specific browser instance
-            // The parallel index coordinates the parallel execution of tests across multiple worker instances.
-            // https://playwright.dev/docs/test-parallel#worker-index-and-parallel-index
-
-            // result duration
-            const time_start = resultsTimestamps.shift();
-            const time_end = resultsTimestamps.shift();
-            const resultDuration = time_end - time_start;
-
-            // console.log(resultDuration, testResult.duration);
-
-            this.jobs.push({
-                caseId,
-                // worker
-                parallelIndex: testResult.parallelIndex,
-                // job
-                workerIndex: testResult.workerIndex,
-                timestamp: time_start,
-                duration: resultDuration
-            });
-
-            // concat all steps
-            if (caseItem.subs.length) {
-                caseItem.subs.push(this.getRetryStep(retry));
-            }
-
-            const steps = await this.testStepHandler(testResult.steps, caseItem);
-
-            caseItem.subs = caseItem.subs.concat(steps);
-        }
-
-        // 'passed', 'flaky', 'skipped', 'failed'
-        // after all required status in results
-        caseItem.caseType = this.getCaseType(caseItem);
-
-        // will no steps if someone skipped
-        if (!caseItem.subs.length) {
-            delete caseItem.subs;
-        }
-
-        this.attachmentsHandler(caseItem, caseId);
-        this.caseErrorsHandler(caseItem);
-
-        await this.customVisitorsHandler(caseItem, testCase);
-
-        list.push(caseItem);
-    }
-
-    getCaseType(item) {
-        // ok includes outcome === 'expected' || 'flaky' || 'skipped'
-        if (item.ok) {
-            if (item.outcome === 'skipped' || item.status === 'skipped') {
-                return 'skipped';
-            }
-            if (item.outcome === 'flaky') {
-                return 'flaky';
-            }
-            return 'passed';
-        }
-        return 'failed';
-    }
-
-    getCaseAnnotations(annotations) {
-        // array
-        if (Util.isList(annotations)) {
-            return annotations;
-        }
-
-        // string from comments
-        if (typeof annotations === 'string' && annotations) {
-            return annotations;
-        }
-
-    }
-
-    initAttachmentsRetry(attachments, retry) {
-        attachments.forEach((item) => {
-            item.retry = retry;
-        });
-        return attachments;
-    }
-
-    // ==============================================================================================
-
-    getRetryStep(retry) {
-        const stepId = Util.uid();
-        return {
-            id: stepId,
-            title: `Retry #${retry}`,
-            type: 'step',
-            stepType: 'retry',
-            // for retry color
-            status: 'retry',
-            retry
-        };
-    }
-
-    async testStepHandler(steps, caseItem) {
-
-        const list = [];
-
-        for (const testStep of steps) {
-
-            // random id for report
-            const stepId = Util.uid();
-
-            const step = {
-                id: stepId,
-                title: testStep.title,
-                type: 'step',
-                stepType: testStep.category,
-
-                duration: testStep.duration,
-                location: this.locationHandler(testStep.location)
-            };
-            this.stepErrorsHandler(step, testStep, caseItem);
-            if (Util.isList(testStep.steps)) {
-                // console.log(testStep.title);
-                caseItem.stepSubs = true;
-                step.subs = await this.testStepHandler(testStep.steps, caseItem);
-            }
-
-            await this.customVisitorsHandler(step, testStep);
-
-            caseItem.stepNum += 1;
-            list.push(step);
-        }
-
-        return this.dedupeSteps(list);
-    }
-
-    dedupeSteps(stepList) {
-        if (stepList.length < 8) {
-            return stepList;
-        }
-
-        const diffProps = (step, lastStep, props) => {
-            for (const k of props) {
-                if (step[k] !== lastStep[k]) {
-                    return true;
-                }
-            }
-            return false;
-        };
-
-        const canMerge = (step, lastStep) => {
-
-            // stepType: category
-            // location is string now
-            if (diffProps(step, lastStep, ['title', 'stepType', 'location'])) {
-                return false;
-            }
-
-            if (lastStep.subs || lastStep.errors) {
-                return false;
-            }
-
-            if (step.subs || step.errors) {
-                return false;
-            }
-
-            return true;
-        };
-
-        const list = [];
-        const endStep = stepList.reduce((lastStep, step) => {
-            if (canMerge(step, lastStep)) {
-                if (lastStep.count) {
-                    lastStep.duration += step.duration;
-                    lastStep.count += 1;
-                    return lastStep;
-                }
-                const mergedStep = {
-                    ... lastStep,
-                    duration: lastStep.duration + step.duration,
-                    count: 2
-                };
-                // console.log(mergedStep);
-                return mergedStep;
-            }
-
-            list.push(lastStep);
-            return step;
-        });
-
-        list.push(endStep);
-
-        return list;
-    }
-
-    attachmentsHandler(caseItem, caseId) {
-        const attachments = caseItem.attachments;
-        delete caseItem.attachments;
-        if (!Util.isList(attachments)) {
-            return;
-        }
-
-        const title = caseItem.title;
-
-        const list = [];
-
-        attachments.forEach((item, i) => {
-
-            // metadata with body
-            if (this.testMetadataHandler(item, caseItem)) {
-                return;
-            }
-
-            // fixed expected image path
-            this.expectedAttachmentHandler(item, attachments);
-
-            if (item.body) {
-                if (!item.path) {
-                    this.saveAttachmentBodyHandler(item, i, caseId);
-                }
-            }
-
-            // text attachment may no path
-            if (!item.path) {
-                list.push(item);
-                return;
-            }
-
-            // before path change
-            // Attachments with a text/html content type can now be opened in a new tab in the HTML report.
-            // This is useful for including third-party reports or other HTML content in the Playwright test report and distributing it to your team.
-            this.reportHandler(item, 'audit', title);
-            this.reportHandler(item, 'coverage', title);
-            this.reportHandler(item, 'network', title);
-
-            // content: text
-            this.testContentHandler(item);
-
-            const o = this.options;
-            // store relative path first
-            this.copyAttachmentsHandler(item);
-            item.path = Util.relativePath(item.path, o.outputDir);
-
-            // custom attachment path
-            const attachmentPathHandler = o.attachmentPath;
-            if (typeof attachmentPathHandler === 'function') {
-                const extras = Util.getAttachmentPathExtras(o);
-                const newPath = attachmentPathHandler(item.path, extras);
-                // if forgot return new path
-                if (newPath) {
-                    item.path = newPath;
-                }
-            }
-
-            list.push(item);
-
-        });
-
-        if (list.length) {
-            caseItem.attachments = list;
-        }
-    }
-
-    copyAttachmentsHandler(item) {
-
-        const { attachmentsDir } = this.options;
-        if (!attachmentsDir) {
-            return;
-        }
-
-        if (!fs.existsSync(attachmentsDir)) {
-            fs.mkdirSync(attachmentsDir, {
-                recursive: true
-            });
-        }
-
-        // custom report
-        if (item.report) {
-            return;
-        }
-
-        const oldPath = item.path;
-        const filename = Util.calculateSha1(oldPath);
-        const ext = path.extname(oldPath);
-        const newPath = path.resolve(attachmentsDir, `${filename}${ext}`);
-        fs.cpSync(oldPath, newPath, {
-            force: true,
-            recursive: true
-        });
-
-        item.path = newPath;
-
-    }
-
-    getImageCategory(item) {
-        if (item.contentType && item.contentType.startsWith('image/')) {
-            if (item.name) {
-                const match = item.name.match(/^(.*)-(expected|actual|diff)(\.[^.]+)?$/);
-                if (match) {
-                    // , name, category, extension
-                    return match[2];
-                }
-            }
-        }
-    }
-
-    expectedAttachmentHandler(item, attachments) {
-        const category = this.getImageCategory(item);
-        if (category !== 'expected') {
-            return;
-        }
-
-        const actualItem = attachments.find((it) => {
-            if (it.retry !== item.retry) {
-                return false;
-            }
-            const c = this.getImageCategory(it);
-            if (c === 'actual') {
-                return true;
-            }
-            return false;
-        });
-        if (!actualItem) {
-            return;
-        }
-
-        // console.log(item, actualItem);
-
-        const itemDir = path.dirname(actualItem.path);
-        const itemPath = path.resolve(itemDir, item.name);
-
-        if (fs.existsSync(itemPath)) {
-            item.path = itemPath;
-        }
-
-        // no need copy the expected file, it exists
-
-    }
-
-    reportHandler(item, itemName, title) {
-
-        const definition = Util.attachments[itemName];
-        if (!definition) {
-            return;
-        }
-
-        if (item.name !== definition.name || item.contentType !== definition.contentType) {
-            return;
-        }
-
-        // itemName = item.name = definition.name
-
-        const jsonPath = path.resolve(path.dirname(item.path), definition.reportFile);
-        if (!fs.existsSync(jsonPath)) {
-            return;
-        }
-
-        const report = Util.readJSONSync(jsonPath);
-        if (!report) {
-            return;
-        }
-
-        this.artifacts.push({
-            type: itemName,
-            name: report.name || title,
-            path: Util.relativePath(item.path)
-        });
-
-        item.report = report;
-
-    }
-
-    testMetadataHandler(item, caseItem) {
-        const definition = Util.attachments.metadata;
-        if (item.name !== definition.name || item.contentType !== definition.contentType) {
-            return;
-        }
-
-        // console.log(item);
-        // name, path(undefined), contentType, body, retry
-
-        let content = item.body;
-        if (Buffer.isBuffer(content)) {
-            content = content.toString('utf8');
-        }
-        if (!content) {
-            return;
-        }
-
-        let metadata;
-        try {
-            metadata = JSON.parse(content);
-        } catch (e) {
-            // invalid json format
-        }
-
-        if (!metadata) {
-            return;
-        }
-
-        Object.assign(caseItem, metadata);
-        return true;
-    }
-
-    testContentHandler(item) {
-        if (item.content) {
-            return;
-        }
-        if (Util.isTextType(item.contentType)) {
-            item.content = Util.readFileSync(item.path);
-        }
-    }
-
-    contentToString(content) {
-        if (typeof content === 'string') {
-            return content;
-        }
-
-        if (Buffer.isBuffer(content)) {
-            return content.toString('utf8');
-        }
-
-        return content.toString();
-    }
-
-    saveAttachmentBodyHandler(item, i, caseId) {
-
-        const content = item.body;
-        delete item.body;
-
-        // if text content no need save file, just show the content
-        const contentType = item.contentType;
-        if (Util.isTextType(contentType)) {
-            // body is buffer
-            item.content = this.contentToString(content);
-            return;
-        }
-
-        // testOutputDir is for test results not reporter
-        const { outputDir, testOutputDir } = this.options;
-
-        const attachmentsPath = path.resolve(testOutputDir || outputDir, caseId);
-        if (!fs.existsSync(attachmentsPath)) {
-            fs.mkdirSync(attachmentsPath, {
-                recursive: true
-            });
-        }
-
-        // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
-        const types = {
-            'text/plain': 'txt',
-            'application/octet-stream': 'bin'
-        };
-
-        const filename = sanitize(`${item.name}-${i + 1}`);
-
-        let ext = 'bin';
-        if (contentType) {
-            ext = types[contentType] || contentType.split('/').pop().slice(0, 4);
-        }
-        const filePath = path.resolve(attachmentsPath, `${filename}.${ext}`);
-        fs.writeFileSync(filePath, content);
-        item.path = filePath;
-
-    }
-
-    locationHandler(location) {
-        if (!location) {
-            return '';
-        }
-        const file = Util.relativePath(location.file);
-        return `${file}:${location.line}:${location.column}`;
-    }
-
-    // ==============================================================================================
-
-    caseErrorsHandler(caseItem) {
-
-        const errors = caseItem.errors;
-        if (Util.isList(errors)) {
-            caseItem.errors = this.errorsHandler(errors);
-            return;
-        }
-
-        // missed errors for unexpected
-        if (caseItem.outcome === 'unexpected') {
-            const error = {
-                message: EC.red(`Expected to "${caseItem.expectedStatus}", but "${caseItem.status}"`)
-            };
-            caseItem.errors = this.errorsHandler([error]);
-            return;
-        }
-
-        delete caseItem.errors;
-
-    }
-
-    stepErrorsHandler(step, testStep, caseItem) {
-        const error = testStep.error;
-        if (!error) {
-            return;
-        }
-        caseItem.stepFailed += 1;
-        step.errors = this.errorsHandler([error]);
-    }
-
-    errorsHandler(errors) {
-        return errors.map((err) => {
-            // error to string
-            err = err.stack || err.message || err.value || err;
-            if (typeof err === 'string') {
-                return err;
-            }
-            return `${err}`;
-        });
-    }
-
-    // ==============================================================================================
-
-    duplicatedErrorsHandler(rows) {
-
-        Util.forEach(rows, (item) => {
-            if (!item.errors) {
-                return;
-            }
-
-            // for mark errors and sort by errors
-            item.errorNum = item.errors.length;
-
-            const errors = item.errors.filter((err) => {
-                const sub = this.findSubByError(item.subs, err);
-                if (sub) {
-                    // keep first error id with last sub id
-                    if (!item.errorId) {
-                        item.errorId = sub.id;
-                    }
-                    return false;
-                }
-                return true;
-            });
-            if (errors.length) {
-                item.errors = this.errorsToSnippets(errors);
-            } else {
-                delete item.errors;
-            }
-
-        });
-
-    }
-
-    findSubByError(subs, err) {
-        let sub;
-        Util.forEach(subs, (item) => {
-            if (item.errors) {
-                if (item.errors.find((e) => e === err)) {
-                    sub = item;
-                    // return false to break loop
-                    return false;
-                }
-            }
-        });
-        if (sub && sub.subs) {
-            const s = this.findSubByError(sub.subs, err);
-            if (s) {
-                return s;
-            }
-        }
-        return sub;
-    }
-
-    errorsToSnippets(errors) {
-        return errors.map((err, i) => {
-            const lines = err.split('\n');
-            const firstStackLine = lines.findIndex((line) => line.trim().startsWith('at '));
-            if (firstStackLine === -1) {
-                return `${err}\n`;
-            }
-
-            const line = lines[firstStackLine];
-
-            const stackUtils = new StackUtils();
-            const location = stackUtils.parseLine(line);
-            if (!location) {
-                return err;
-            }
-            const file = location.file;
-            // may in anonymous script by addInitScript
-            // file: 'eval at evaluate (:195:30), <anonymous>',
-            if (!file || !fs.existsSync(file)) {
-                return err;
-            }
-            const source = fs.readFileSync(file, 'utf8');
-            const codeFrame = codeFrameColumns(source, {
-                start: location
-            }, {
-                highlightCode: true,
-                // forceColor: true
-                // linesAbove: 2,
-                linesBelow: 0
-            });
-
-            if (!codeFrame) {
-                return err;
-            }
-
-            lines.splice(firstStackLine, 0, `\n${codeFrame}\n`);
-
-            // console.log(codeFrame);
-            return lines.join('\n');
-        });
-    }
-
-}
-
-module.exports = Visitor;
+const fs = require('fs');
+const path = require('path');
+const EC = require('eight-colors');
+const {
+    StackUtils, codeFrameColumns, sanitize
+} = require('./packages/monocart-reporter-vendor.js');
+const Util = require('./utils/util.js');
+const commentsPlugin = require('./plugins/comments.js');
+const getDefaultColumns = require('./default/columns.js');
+
+class Visitor {
+    constructor(root, options) {
+        this.root = root;
+        this.options = options;
+
+        // console.log(options);
+
+        if (typeof options.visitor === 'function') {
+            this.customCommonVisitor = options.visitor;
+        }
+
+    }
+
+    async start() {
+
+        const columns = getDefaultColumns();
+        // default columns not detailed in report
+        columns.forEach((item) => {
+            item.detailed = false;
+        });
+
+        // custom column formatters with string passed to JSON
+        this.formatters = {};
+
+        // user defined custom columns
+        const handler = this.options.columns;
+        if (!this.columnsUpdated && typeof handler === 'function') {
+            // prevent repeated execution
+            this.columnsUpdated = true;
+
+            // update default columns by user
+            handler.call(this, columns);
+
+            // maybe a tree
+            const customVisitors = [];
+            this.initCustomHandler(columns, customVisitors, this.formatters);
+            if (customVisitors.length) {
+                this.customVisitors = customVisitors;
+            }
+        }
+
+        // console.log(customFormatters);
+
+        this.columns = columns;
+        this.rows = [];
+        this.jobs = [];
+        this.artifacts = [];
+
+        await this.visit(this.root, this.rows);
+
+        this.duplicatedErrorsHandler(this.rows);
+
+    }
+
+    // ==============================================================================================
+
+    initCustomHandler(list, visitors, formatters) {
+
+        list.forEach((column) => {
+            if (column.id) {
+
+                // custom visitor
+                if (typeof column.visitor === 'function') {
+
+                    visitors.push({
+                        id: column.id,
+                        visitor: column.visitor
+                    });
+
+                    // remove function (can not be in JSON)
+                    delete column.visitor;
+
+                }
+
+                // custom formatter
+                if (typeof column.formatter === 'function') {
+
+                    formatters[column.id] = column.formatter.toString();
+
+                    // remove function (can not be in JSON)
+                    delete column.formatter;
+                }
+
+            }
+
+            // drill down
+            if (Util.isList(column.subs)) {
+                this.initCustomHandler(column.subs, visitors, formatters);
+            }
+        });
+    }
+
+    // generate the column data from playwright metadata
+    // data.type is suite, metadata is Suite, https://playwright.dev/docs/api/class-suite
+    // data.type is case, metadata is TestCase, https://playwright.dev/docs/api/class-testcase
+    // data.type is step, metadata is TestStep, https://playwright.dev/docs/api/class-teststep
+    async customVisitorsHandler(data, metadata) {
+
+        if (this.options.customFieldsInComments) {
+            const customData = commentsPlugin(metadata);
+            Object.assign(data, customData);
+        }
+
+        // for all data
+        if (this.customCommonVisitor) {
+            await this.customCommonVisitor.call(this, data, metadata);
+        }
+
+        // for single column data (high priority)
+        if (this.customVisitors) {
+            for (const item of this.customVisitors) {
+                const res = await item.visitor.call(this, data, metadata);
+                if (typeof res !== 'undefined') {
+                    data[item.id] = res;
+                }
+            }
+        }
+    }
+
+    // ==============================================================================================
+
+    async visit(suite, list) {
+        if (!suite._entries) {
+            return;
+        }
+        // suite -> tests/test case -> test result -> test step
+        for (const entry of suite._entries) {
+            // only case has results
+            if (entry.results) {
+                await this.testCaseHandler(entry, list);
+            } else {
+                await this.testSuiteHandler(entry, list);
+            }
+        }
+    }
+
+    // ==============================================================================================
+
+    /*
+    Project suite #1. Has a child suite for each test file in the project.
+        File suite #1
+            TestCase #1
+            Suite corresponding to a test.describe(title, callback) group
+                TestCase #1 in a group
+                    TestStep
+    */
+    async testSuiteHandler(suite, list) {
+
+        // sometimes project title is empty
+        const suiteType = suite._type;
+        let suiteTitle = Util.formatPath(suite.title);
+        if (!suiteTitle) {
+            suiteTitle = suiteType;
+        }
+
+        // suite uid for report
+        const suiteStr = [suite._fileId].concat(suite.titlePath()).filter((it) => it).join(' ');
+        // console.log(suiteStr);
+        const suiteId = Util.calculateId(suiteStr);
+
+        const group = {
+            id: suiteId,
+            title: suiteTitle,
+            type: 'suite',
+            // root, project, file, describe
+            suiteType: suiteType,
+            // all test cases in this suite and its descendants
+            caseNum: suite.allTests().length,
+            subs: []
+        };
+
+        if (suiteType === 'project') {
+            this.projectMetadataHandler(group, suite);
+        }
+
+        if (suite.location) {
+            group.location = this.locationHandler(suite.location);
+        }
+
+        await this.customVisitorsHandler(group, suite);
+
+        list.push(group);
+        // drill down
+        await this.visit(suite, group.subs);
+    }
+
+    projectMetadataHandler(project, suite) {
+        const sp = suite._fullProject;
+        if (!sp) {
+            return;
+        }
+
+        const projectMetadata = sp.project && sp.project.metadata;
+        if (!projectMetadata) {
+            return;
+        }
+
+        const config = sp.fullConfig && sp.fullConfig.config;
+        const configMetadata = config && config.metadata;
+        if (configMetadata && configMetadata === projectMetadata) {
+            return;
+        }
+
+        project.metadata = projectMetadata;
+    }
+
+    // ==============================================================================================
+
+    async testCaseHandler(testCase, list) {
+
+        // duration
+        // total of testResult.duration is not exact, it will cost time before/between/after result
+        const caseTimestamps = [].concat(testCase.timestamps);
+        const duration = caseTimestamps.pop() - caseTimestamps.shift();
+
+        // Unique test ID that is computed based on the test file name, test title and project name
+
+        // 6113402d7bc11a0fb7a9-281a9986cca0dfd6fa4b
+        // const repeatEachIndexSuffix = repeatEachIndex ? ` (repeat:${repeatEachIndex})` : '';
+        // At the point of the query, suite is not yet attached to the project, so we only get file, describe and test titles.
+        // const testIdExpression = `[project=${project._internal.id}]${test.titlePath().join('\x1e')}${repeatEachIndexSuffix}`;
+        // const testId = fileId + '-' + calculateSha1(testIdExpression).slice(0, 20);
+
+        const caseId = Util.calculateId(testCase.id);
+
+        const caseItem = {
+            id: caseId,
+            title: testCase.title,
+            type: 'case',
+            caseType: '',
+
+            // Whether the test is considered running fine. Non-ok tests fail the test run with non-zero exit code.
+            ok: testCase.ok(),
+
+            // Testing outcome for this test. Note that outcome is not the same as testResult.status:
+            // returns: <"skipped"|"expected"|"unexpected"|"flaky">
+            outcome: testCase.outcome(),
+
+            expectedStatus: testCase.expectedStatus,
+            location: this.locationHandler(testCase.location),
+
+            // custom collection
+            logs: testCase.logs,
+            timestamps: testCase.timestamps,
+
+            duration,
+
+            // annotations, string or array
+            annotations: this.getCaseAnnotations(testCase.annotations),
+            // new syntax in playwright v1.42
+            tags: testCase.tags,
+
+            // repeatEachIndex: testCase.repeatEachIndex,
+
+            // The maximum number of retries given to this test in the configuration
+            // retries: testCase.retries,
+
+            // The timeout given to the test.
+            // Affected by testConfig.timeout, testProject.timeout, test.setTimeout(timeout), test.slow() and testInfo.setTimeout(timeout).
+            timeout: testCase.timeout,
+
+            // ===============================================================
+            // merge all results (retry multiple times)
+
+            attachments: [],
+
+            // errors thrown during the test execution.
+            // error is first errors
+            errors: [],
+
+            retry: 0,
+
+            // <"passed"|"failed"|"timedOut"|"skipped">
+            status: '',
+
+            // all results steps
+            stepNum: 0,
+            stepFailed: 0,
+            stepSubs: false,
+            subs: []
+        };
+
+        const resultsTimestamps = [].concat(testCase.timestamps);
+
+        for (const testResult of testCase.results) {
+
+            const retry = testResult.retry;
+
+            caseItem.retry = retry;
+            caseItem.status = testResult.status;
+
+            const attachments = this.initAttachmentsRetry(testResult.attachments, retry);
+            caseItem.attachments = caseItem.attachments.concat(attachments);
+            caseItem.errors = caseItem.errors.concat(testResult.errors);
+
+            // The worker index is used to reference a specific browser instance
+            // The parallel index coordinates the parallel execution of tests across multiple worker instances.
+            // https://playwright.dev/docs/test-parallel#worker-index-and-parallel-index
+
+            // result duration
+            const time_start = resultsTimestamps.shift();
+            const time_end = resultsTimestamps.shift();
+            const resultDuration = time_end - time_start;
+
+            // console.log(resultDuration, testResult.duration);
+
+            this.jobs.push({
+                caseId,
+                // worker
+                parallelIndex: testResult.parallelIndex,
+                // job
+                workerIndex: testResult.workerIndex,
+                timestamp: time_start,
+                duration: resultDuration
+            });
+
+            // concat all steps
+            if (caseItem.subs.length) {
+                caseItem.subs.push(this.getRetryStep(retry));
+            }
+
+            const steps = await this.testStepHandler(testResult.steps, caseItem);
+
+            caseItem.subs = caseItem.subs.concat(steps);
+        }
+
+        // 'passed', 'flaky', 'skipped', 'failed'
+        // after all required status in results
+        caseItem.caseType = this.getCaseType(caseItem);
+
+        // will no steps if someone skipped
+        if (!caseItem.subs.length) {
+            delete caseItem.subs;
+        }
+
+        this.attachmentsHandler(caseItem, caseId);
+        this.caseErrorsHandler(caseItem);
+
+        await this.customVisitorsHandler(caseItem, testCase);
+
+        list.push(caseItem);
+    }
+
+    getCaseType(item) {
+        // ok includes outcome === 'expected' || 'flaky' || 'skipped'
+        if (item.ok) {
+            if (item.outcome === 'skipped' || item.status === 'skipped') {
+                return 'skipped';
+            }
+            if (item.outcome === 'flaky') {
+                return 'flaky';
+            }
+            return 'passed';
+        }
+        return 'failed';
+    }
+
+    getCaseAnnotations(annotations) {
+        // array
+        if (Util.isList(annotations)) {
+            return annotations;
+        }
+
+        // string from comments
+        if (typeof annotations === 'string' && annotations) {
+            return annotations;
+        }
+
+    }
+
+    initAttachmentsRetry(attachments, retry) {
+        attachments.forEach((item) => {
+            item.retry = retry;
+        });
+        return attachments;
+    }
+
+    // ==============================================================================================
+
+    getRetryStep(retry) {
+        const stepId = Util.uid();
+        return {
+            id: stepId,
+            title: `Retry #${retry}`,
+            type: 'step',
+            stepType: 'retry',
+            // for retry color
+            status: 'retry',
+            retry
+        };
+    }
+
+    async testStepHandler(steps, caseItem) {
+
+        const list = [];
+
+        for (const testStep of steps) {
+
+            // random id for report
+            const stepId = Util.uid();
+
+            const step = {
+                id: stepId,
+                title: testStep.title,
+                type: 'step',
+                stepType: testStep.category,
+
+                duration: testStep.duration,
+                location: this.locationHandler(testStep.location)
+            };
+            this.stepErrorsHandler(step, testStep, caseItem);
+            if (Util.isList(testStep.steps)) {
+                // console.log(testStep.title);
+                caseItem.stepSubs = true;
+                step.subs = await this.testStepHandler(testStep.steps, caseItem);
+            }
+
+            await this.customVisitorsHandler(step, testStep);
+
+            caseItem.stepNum += 1;
+            list.push(step);
+        }
+
+        return this.dedupeSteps(list);
+    }
+
+    dedupeSteps(stepList) {
+        if (stepList.length < 8) {
+            return stepList;
+        }
+
+        const diffProps = (step, lastStep, props) => {
+            for (const k of props) {
+                if (step[k] !== lastStep[k]) {
+                    return true;
+                }
+            }
+            return false;
+        };
+
+        const canMerge = (step, lastStep) => {
+
+            // stepType: category
+            // location is string now
+            if (diffProps(step, lastStep, ['title', 'stepType', 'location'])) {
+                return false;
+            }
+
+            if (lastStep.subs || lastStep.errors) {
+                return false;
+            }
+
+            if (step.subs || step.errors) {
+                return false;
+            }
+
+            return true;
+        };
+
+        const list = [];
+        const endStep = stepList.reduce((lastStep, step) => {
+            if (canMerge(step, lastStep)) {
+                if (lastStep.count) {
+                    lastStep.duration += step.duration;
+                    lastStep.count += 1;
+                    return lastStep;
+                }
+                const mergedStep = {
+                    ... lastStep,
+                    duration: lastStep.duration + step.duration,
+                    count: 2
+                };
+                // console.log(mergedStep);
+                return mergedStep;
+            }
+
+            list.push(lastStep);
+            return step;
+        });
+
+        list.push(endStep);
+
+        return list;
+    }
+
+    attachmentsHandler(caseItem, caseId) {
+        const attachments = caseItem.attachments;
+        delete caseItem.attachments;
+        if (!Util.isList(attachments)) {
+            return;
+        }
+
+        const title = caseItem.title;
+
+        const list = [];
+
+        attachments.forEach((item, i) => {
+
+            // metadata with body
+            if (this.testMetadataHandler(item, caseItem)) {
+                return;
+            }
+
+            // fixed expected image path
+            this.expectedAttachmentHandler(item, attachments);
+
+            if (item.body) {
+                if (!item.path) {
+                    this.saveAttachmentBodyHandler(item, i, caseId);
+                }
+            }
+
+            // text attachment may no path
+            if (!item.path) {
+                list.push(item);
+                return;
+            }
+
+            // before path change
+            // Attachments with a text/html content type can now be opened in a new tab in the HTML report.
+            // This is useful for including third-party reports or other HTML content in the Playwright test report and distributing it to your team.
+            this.reportHandler(item, 'audit', title);
+            this.reportHandler(item, 'coverage', title);
+            this.reportHandler(item, 'network', title);
+
+            // content: text
+            this.testContentHandler(item);
+
+            const o = this.options;
+            // store relative path first
+            this.copyAttachmentsHandler(item);
+            item.path = Util.relativePath(item.path, o.outputDir);
+
+            // custom attachment path
+            const attachmentPathHandler = o.attachmentPath;
+            if (typeof attachmentPathHandler === 'function') {
+                const extras = Util.getAttachmentPathExtras(o);
+                const newPath = attachmentPathHandler(item.path, extras);
+                // if forgot return new path
+                if (newPath) {
+                    item.path = newPath;
+                }
+            }
+
+            list.push(item);
+
+        });
+
+        if (list.length) {
+            caseItem.attachments = list;
+        }
+    }
+
+    copyAttachmentsHandler(item) {
+
+        const { attachmentsDir } = this.options;
+        if (!attachmentsDir) {
+            return;
+        }
+
+        if (!fs.existsSync(attachmentsDir)) {
+            fs.mkdirSync(attachmentsDir, {
+                recursive: true
+            });
+        }
+
+        // custom report
+        if (item.report) {
+            return;
+        }
+
+        const oldPath = item.path;
+        const filename = Util.calculateSha1(oldPath);
+        const ext = path.extname(oldPath);
+        const newPath = path.resolve(attachmentsDir, `${filename}${ext}`);
+        fs.cpSync(oldPath, newPath, {
+            force: true,
+            recursive: true
+        });
+
+        item.path = newPath;
+
+    }
+
+    getImageCategory(item) {
+        if (item.contentType && item.contentType.startsWith('image/')) {
+            if (item.name) {
+                const match = item.name.match(/^(.*)-(expected|actual|diff)(\.[^.]+)?$/);
+                if (match) {
+                    // , name, category, extension
+                    return match[2];
+                }
+            }
+        }
+    }
+
+    expectedAttachmentHandler(item, attachments) {
+        const category = this.getImageCategory(item);
+        if (category !== 'expected') {
+            return;
+        }
+
+        const actualItem = attachments.find((it) => {
+            if (it.retry !== item.retry) {
+                return false;
+            }
+            const c = this.getImageCategory(it);
+            if (c === 'actual') {
+                return true;
+            }
+            return false;
+        });
+        if (!actualItem) {
+            return;
+        }
+
+        // console.log(item, actualItem);
+
+        const itemDir = path.dirname(actualItem.path);
+        const itemPath = path.resolve(itemDir, item.name);
+
+        if (fs.existsSync(itemPath)) {
+            item.path = itemPath;
+        }
+
+        // no need copy the expected file, it exists
+
+    }
+
+    reportHandler(item, itemName, title) {
+
+        const definition = Util.attachments[itemName];
+        if (!definition) {
+            return;
+        }
+
+        if (item.name !== definition.name || item.contentType !== definition.contentType) {
+            return;
+        }
+
+        // itemName = item.name = definition.name
+
+        const jsonPath = path.resolve(path.dirname(item.path), definition.reportFile);
+        if (!fs.existsSync(jsonPath)) {
+            return;
+        }
+
+        const report = Util.readJSONSync(jsonPath);
+        if (!report) {
+            return;
+        }
+
+        this.artifacts.push({
+            type: itemName,
+            name: report.name || title,
+            path: Util.relativePath(item.path)
+        });
+
+        item.report = report;
+
+    }
+
+    testMetadataHandler(item, caseItem) {
+        const definition = Util.attachments.metadata;
+        if (item.name !== definition.name || item.contentType !== definition.contentType) {
+            return;
+        }
+
+        // console.log(item);
+        // name, path(undefined), contentType, body, retry
+
+        let content = item.body;
+        if (Buffer.isBuffer(content)) {
+            content = content.toString('utf8');
+        }
+        if (!content) {
+            return;
+        }
+
+        let metadata;
+        try {
+            metadata = JSON.parse(content);
+        } catch (e) {
+            // invalid json format
+        }
+
+        if (!metadata) {
+            return;
+        }
+
+        Object.assign(caseItem, metadata);
+        return true;
+    }
+
+    testContentHandler(item) {
+        if (item.content) {
+            return;
+        }
+        if (Util.isTextType(item.contentType)) {
+            item.content = Util.readFileSync(item.path);
+        }
+    }
+
+    contentToString(content) {
+        if (typeof content === 'string') {
+            return content;
+        }
+
+        if (Buffer.isBuffer(content)) {
+            return content.toString('utf8');
+        }
+
+        return content.toString();
+    }
+
+    saveAttachmentBodyHandler(item, i, caseId) {
+
+        const content = item.body;
+        delete item.body;
+
+        // if text content no need save file, just show the content
+        const contentType = item.contentType;
+        if (Util.isTextType(contentType)) {
+            // body is buffer
+            item.content = this.contentToString(content);
+            return;
+        }
+
+        // testOutputDir is for test results not reporter
+        const { outputDir, testOutputDir } = this.options;
+
+        const attachmentsPath = path.resolve(testOutputDir || outputDir, caseId);
+        if (!fs.existsSync(attachmentsPath)) {
+            fs.mkdirSync(attachmentsPath, {
+                recursive: true
+            });
+        }
+
+        // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
+        const types = {
+            'text/plain': 'txt',
+            'application/octet-stream': 'bin'
+        };
+
+        const filename = sanitize(`${item.name}-${i + 1}`);
+
+        let ext = 'bin';
+        if (contentType) {
+            ext = types[contentType] || contentType.split('/').pop().slice(0, 4);
+        }
+        const filePath = path.resolve(attachmentsPath, `${filename}.${ext}`);
+        fs.writeFileSync(filePath, content);
+        item.path = filePath;
+
+    }
+
+    locationHandler(location) {
+        if (!location) {
+            return '';
+        }
+        const file = Util.relativePath(location.file);
+        return `${file}:${location.line}:${location.column}`;
+    }
+
+    // ==============================================================================================
+
+    caseErrorsHandler(caseItem) {
+
+        const errors = caseItem.errors;
+        if (Util.isList(errors)) {
+            caseItem.errors = this.errorsHandler(errors);
+            return;
+        }
+
+        // missed errors for unexpected
+        if (caseItem.outcome === 'unexpected') {
+            const error = {
+                message: EC.red(`Expected to "${caseItem.expectedStatus}", but "${caseItem.status}"`)
+            };
+            caseItem.errors = this.errorsHandler([error]);
+            return;
+        }
+
+        delete caseItem.errors;
+
+    }
+
+    stepErrorsHandler(step, testStep, caseItem) {
+        const error = testStep.error;
+        if (!error) {
+            return;
+        }
+        caseItem.stepFailed += 1;
+        step.errors = this.errorsHandler([error]);
+    }
+
+    errorsHandler(errors) {
+        return errors.map((err) => {
+            // error to string
+            err = err.stack || err.message || err.value || err;
+            if (typeof err === 'string') {
+                return err;
+            }
+            return `${err}`;
+        });
+    }
+
+    // ==============================================================================================
+
+    duplicatedErrorsHandler(rows) {
+
+        Util.forEach(rows, (item) => {
+            if (!item.errors) {
+                return;
+            }
+
+            // for mark errors and sort by errors
+            item.errorNum = item.errors.length;
+
+            const errors = item.errors.filter((err) => {
+                const sub = this.findSubByError(item.subs, err);
+                if (sub) {
+                    // keep first error id with last sub id
+                    if (!item.errorId) {
+                        item.errorId = sub.id;
+                    }
+                    return false;
+                }
+                return true;
+            });
+            if (errors.length) {
+                item.errors = this.errorsToSnippets(errors);
+            } else {
+                delete item.errors;
+            }
+
+        });
+
+    }
+
+    findSubByError(subs, err) {
+        let sub;
+        Util.forEach(subs, (item) => {
+            if (item.errors) {
+                if (item.errors.find((e) => e === err)) {
+                    sub = item;
+                    // return false to break loop
+                    return false;
+                }
+            }
+        });
+        if (sub && sub.subs) {
+            const s = this.findSubByError(sub.subs, err);
+            if (s) {
+                return s;
+            }
+        }
+        return sub;
+    }
+
+    errorsToSnippets(errors) {
+        return errors.map((err, i) => {
+            const lines = err.split('\n');
+            const firstStackLine = lines.findIndex((line) => line.trim().startsWith('at '));
+            if (firstStackLine === -1) {
+                return `${err}\n`;
+            }
+
+            const line = lines[firstStackLine];
+
+            const stackUtils = new StackUtils();
+            const location = stackUtils.parseLine(line);
+            if (!location) {
+                return err;
+            }
+            const file = location.file;
+            // may in anonymous script by addInitScript
+            // file: 'eval at evaluate (:195:30), <anonymous>',
+            if (!file || !fs.existsSync(file)) {
+                return err;
+            }
+            const source = fs.readFileSync(file, 'utf8');
+            const codeFrame = codeFrameColumns(source, {
+                start: location
+            }, {
+                highlightCode: true,
+                // forceColor: true
+                // linesAbove: 2,
+                linesBelow: 0
+            });
+
+            if (!codeFrame) {
+                return err;
+            }
+
+            lines.splice(firstStackLine, 0, `\n${codeFrame}\n`);
+
+            // console.log(codeFrame);
+            return lines.join('\n');
+        });
+    }
+
+}
+
+module.exports = Visitor;