monocart-reporter 2.9.6 → 2.9.7

package/lib/plugins/network/network.js

@@ -1,186 +1,186 @@
-const fs = require('fs');
-const path = require('path');
-const Util = require('../../utils/util.js');
-const Assets = require('../../assets.js');
-
-const getHarData = (har) => {
-    if (typeof har === 'string') {
-        if (!fs.existsSync(har)) {
-            return;
-        }
-        return Util.readJSONSync(har);
-    }
-    if (Buffer.isBuffer(har)) {
-        return JSON.parse(har.toString('utf-8'));
-    }
-};
-
-// http://www.softwareishard.com/blog/har-12-spec/
-const getNetworkSummary = (log) => {
-
-    const { entries, pages } = log;
-
-    const waterfalls = {};
-    pages.forEach((page) => {
-        const pageTimings = page.pageTimings;
-        const timestampStart = new Date(page.startedDateTime).getTime();
-        const time = Math.max(pageTimings.onContentLoad, pageTimings.onLoad) || 0;
-        waterfalls[page.id] = {
-            timestampStart,
-            start: 0,
-            time,
-            ... pageTimings,
-            entries: []
-        };
-    });
-
-    const summary = {
-        requests: entries.length,
-        size: 0,
-        status: {},
-        methods: {},
-        waterfalls
-    };
-
-    const countField = (k, v) => {
-        if (summary[k][v]) {
-            summary[k][v] += 1;
-        } else {
-            summary[k][v] = 1;
-        }
-    };
-
-    const countRequest = (req) => {
-        const {
-            bodySize, headersSize, method
-        } = req;
-        countField('methods', method);
-
-        summary.size += Math.max(bodySize, 0) + Math.max(headersSize, 0);
-    };
-
-    const countResponse = (res) => {
-        const {
-            bodySize, headersSize, status
-        } = res;
-        countField('status', status);
-
-        summary.size += (Math.max(headersSize, 0) + Math.max(bodySize, 0));
-    };
-
-    const countWaterfall = (entry) => {
-
-        const pageWaterfall = waterfalls[entry.pageref];
-
-        const timestampStart = new Date(entry.startedDateTime).getTime();
-        const entryWaterfall = {
-            start: timestampStart - pageWaterfall.timestampStart,
-            time: Math.max(entry.time, 0),
-            ... entry.timings
-        };
-
-        pageWaterfall.time = Math.max(pageWaterfall.time, entryWaterfall.start + entryWaterfall.time);
-        pageWaterfall.entries.push(entryWaterfall);
-
-    };
-
-    entries.forEach((entry) => {
-
-        countRequest(entry.request);
-        countResponse(entry.response);
-        countWaterfall(entry);
-
-    });
-
-    return summary;
-};
-
-const saveNetworkHtmlReport = async (reportData, _options) => {
-
-    const { htmlDir, inline } = _options;
-
-    // deps
-    const jsFiles = ['monocart-reporter-network'];
-
-    const options = {
-        inline,
-        reportData,
-        jsFiles,
-        assetsPath: '../assets',
-        outputDir: htmlDir,
-        htmlFile: 'index.html',
-
-        reportDataFile: 'network-data.js'
-    };
-
-    const htmlPath = await Assets.saveHtmlReport(options);
-
-    return htmlPath;
-};
-
-const attachNetworkReport = async (har, testInfo, options = {}) => {
-
-    const logging = Util.resolveLogging(testInfo, options);
-    Util.initLoggingLevel(logging, 'network');
-
-    const harData = getHarData(har);
-    if (!harData || !harData.log) {
-        Util.logError(`failed to load HAR: ${har}`);
-        return;
-    }
-
-    const outputDir = Util.resolveOutputDir(testInfo);
-
-    options = {
-        // default title
-        name: `Network Report - ${testInfo.title}`,
-        outputDir,
-        outputName: `network-${Util.resolveTestIdWithRetry(testInfo)}`,
-        inline: false,
-        ... options
-    };
-
-    const htmlDir = path.resolve(options.outputDir, options.outputName);
-    if (!fs.existsSync(htmlDir)) {
-        fs.mkdirSync(htmlDir, {
-            recursive: true
-        });
-    }
-    options.htmlDir = htmlDir;
-
-    const summary = getNetworkSummary(harData.log);
-
-    // save har
-    const reportData = {
-        name: options.name,
-        summary,
-        ... harData
-    };
-
-    const htmlPath = await saveNetworkHtmlReport(reportData, options);
-
-    const report = {
-        name: options.name,
-        ... harData.log,
-        htmlPath,
-        summary
-    };
-    delete report.entries;
-
-    // save report json
-    const definition = Util.attachments.network;
-    const reportPath = path.resolve(htmlDir, definition.reportFile);
-    Util.writeJSONSync(reportPath, report);
-
-    testInfo.attachments.push({
-        name: definition.name,
-        contentType: definition.contentType,
-        path: path.resolve(htmlDir, 'index.html')
-    });
-
-    return report;
-};
-
-module.exports = {
-    attachNetworkReport
-};
+const fs = require('fs');
+const path = require('path');
+const Util = require('../../utils/util.js');
+const Assets = require('../../assets.js');
+
+const getHarData = (har) => {
+    if (typeof har === 'string') {
+        if (!fs.existsSync(har)) {
+            return;
+        }
+        return Util.readJSONSync(har);
+    }
+    if (Buffer.isBuffer(har)) {
+        return JSON.parse(har.toString('utf-8'));
+    }
+};
+
+// http://www.softwareishard.com/blog/har-12-spec/
+const getNetworkSummary = (log) => {
+
+    const { entries, pages } = log;
+
+    const waterfalls = {};
+    pages.forEach((page) => {
+        const pageTimings = page.pageTimings;
+        const timestampStart = new Date(page.startedDateTime).getTime();
+        const time = Math.max(pageTimings.onContentLoad, pageTimings.onLoad) || 0;
+        waterfalls[page.id] = {
+            timestampStart,
+            start: 0,
+            time,
+            ... pageTimings,
+            entries: []
+        };
+    });
+
+    const summary = {
+        requests: entries.length,
+        size: 0,
+        status: {},
+        methods: {},
+        waterfalls
+    };
+
+    const countField = (k, v) => {
+        if (summary[k][v]) {
+            summary[k][v] += 1;
+        } else {
+            summary[k][v] = 1;
+        }
+    };
+
+    const countRequest = (req) => {
+        const {
+            bodySize, headersSize, method
+        } = req;
+        countField('methods', method);
+
+        summary.size += Math.max(bodySize, 0) + Math.max(headersSize, 0);
+    };
+
+    const countResponse = (res) => {
+        const {
+            bodySize, headersSize, status
+        } = res;
+        countField('status', status);
+
+        summary.size += (Math.max(headersSize, 0) + Math.max(bodySize, 0));
+    };
+
+    const countWaterfall = (entry) => {
+
+        const pageWaterfall = waterfalls[entry.pageref];
+
+        const timestampStart = new Date(entry.startedDateTime).getTime();
+        const entryWaterfall = {
+            start: timestampStart - pageWaterfall.timestampStart,
+            time: Math.max(entry.time, 0),
+            ... entry.timings
+        };
+
+        pageWaterfall.time = Math.max(pageWaterfall.time, entryWaterfall.start + entryWaterfall.time);
+        pageWaterfall.entries.push(entryWaterfall);
+
+    };
+
+    entries.forEach((entry) => {
+
+        countRequest(entry.request);
+        countResponse(entry.response);
+        countWaterfall(entry);
+
+    });
+
+    return summary;
+};
+
+const saveNetworkHtmlReport = async (reportData, _options) => {
+
+    const { htmlDir, inline } = _options;
+
+    // deps
+    const jsFiles = ['monocart-reporter-network'];
+
+    const options = {
+        inline,
+        reportData,
+        jsFiles,
+        assetsPath: '../assets',
+        outputDir: htmlDir,
+        htmlFile: 'index.html',
+
+        reportDataFile: 'network-data.js'
+    };
+
+    const htmlPath = await Assets.saveHtmlReport(options);
+
+    return htmlPath;
+};
+
+const attachNetworkReport = async (har, testInfo, options = {}) => {
+
+    const logging = Util.resolveLogging(testInfo, options);
+    Util.initLoggingLevel(logging, 'network');
+
+    const harData = getHarData(har);
+    if (!harData || !harData.log) {
+        Util.logError(`failed to load HAR: ${har}`);
+        return;
+    }
+
+    const outputDir = Util.resolveOutputDir(testInfo);
+
+    options = {
+        // default title
+        name: `Network Report - ${testInfo.title}`,
+        outputDir,
+        outputName: `network-${Util.resolveTestIdWithRetry(testInfo)}`,
+        inline: false,
+        ... options
+    };
+
+    const htmlDir = path.resolve(options.outputDir, options.outputName);
+    if (!fs.existsSync(htmlDir)) {
+        fs.mkdirSync(htmlDir, {
+            recursive: true
+        });
+    }
+    options.htmlDir = htmlDir;
+
+    const summary = getNetworkSummary(harData.log);
+
+    // save har
+    const reportData = {
+        name: options.name,
+        summary,
+        ... harData
+    };
+
+    const htmlPath = await saveNetworkHtmlReport(reportData, options);
+
+    const report = {
+        name: options.name,
+        ... harData.log,
+        htmlPath,
+        summary
+    };
+    delete report.entries;
+
+    // save report json
+    const definition = Util.attachments.network;
+    const reportPath = path.resolve(htmlDir, definition.reportFile);
+    Util.writeJSONSync(reportPath, report);
+
+    testInfo.attachments.push({
+        name: definition.name,
+        contentType: definition.contentType,
+        path: path.resolve(htmlDir, 'index.html')
+    });
+
+    return report;
+};
+
+module.exports = {
+    attachNetworkReport
+};

package/lib/plugins/state/client.js

@@ -1,152 +1,152 @@
-const { WebSocket } = require('../../packages/monocart-reporter-vendor.js');
-const Util = require('../../utils/util.js');
-
-const getServerUrl = (options = {}) => {
-    return `ws://${options.host}:${options.port}`;
-};
-
-class Client {
-
-    constructor(clientOptions) {
-        this.options = clientOptions;
-        this.requests = new Map();
-        this.resolves = [];
-
-        const serverUrl = getServerUrl(clientOptions);
-
-        // https://github.com/websockets/ws/blob/master/doc/ws.md
-        const ws = new WebSocket(serverUrl);
-
-        ws.on('error', (err) => {
-
-            // socket hang up: the port is exists but not websocket server
-            // connect ECONNREFUSED: websocket server unavailable
-
-            if (Util.isList(this.resolves)) {
-                this.resolves.forEach((item) => {
-                    item.reject(err);
-                });
-                this.resolves = null;
-            } else {
-                Util.logError(`websocket error: ${err.message}`);
-            }
-
-        });
-
-        ws.on('message', (data) => {
-            this.onMessage(data);
-        });
-
-        ws.on('open', () => {
-            this.ws = ws;
-            if (Util.isList(this.resolves)) {
-                this.resolves.forEach((item) => {
-                    item.resolve(ws);
-                });
-                this.resolves = null;
-            }
-        });
-    }
-
-    connect() {
-        return new Promise((resolve, reject) => {
-
-            if (this.ws) {
-                resolve(this.ws);
-                return;
-            }
-
-            if (this.resolves) {
-                this.resolves.push({
-                    resolve,
-                    reject
-                });
-            } else {
-                reject(new Error('an error occurs when connecting websocket server'));
-            }
-        });
-    }
-
-    onMessage(buf) {
-        const message = JSON.parse(buf.toString());
-        if (!message) {
-            return;
-        }
-        const { id, data } = message;
-        if (!id) {
-            return;
-        }
-
-        const req = this.requests.get(id);
-        if (!req) {
-            return;
-        }
-
-        this.requests.delete(id);
-
-        clearTimeout(req.timeout_id);
-        req.resolve(data);
-
-    }
-
-    async execute(data) {
-
-        let err;
-        const ws = await this.connect().catch((e) => {
-            err = e;
-        });
-
-        return new Promise((resolve, reject) => {
-
-            if (!ws) {
-                reject(err);
-                return;
-            }
-
-            const id = Util.uid();
-            const timeout = this.options.timeout;
-            const timeout_id = setTimeout(() => {
-                this.requests.delete(id);
-                reject(new Error(`timed out receiving message from websocket server: ${timeout}ms`));
-            }, timeout);
-
-            this.requests.set(id, {
-                resolve,
-                timeout_id
-            });
-
-            const message = JSON.stringify({
-                id,
-                data
-            });
-            ws.send(message);
-        });
-    }
-
-    state() {
-        return {
-            get: (... args) => {
-                return this.execute(['get', ... args]);
-            },
-
-            set: (... args) => {
-                return this.execute(['set', ... args]);
-            },
-
-            remove: (... args) => {
-                return this.execute(['remove', ... args]);
-            },
-
-            send: (... args) => {
-                return this.execute(['send', ... args]);
-            }
-        };
-    }
-
-}
-
-
-module.exports = {
-    getServerUrl,
-    Client
-};
+const { WebSocket } = require('../../packages/monocart-reporter-vendor.js');
+const Util = require('../../utils/util.js');
+
+const getServerUrl = (options = {}) => {
+    return `ws://${options.host}:${options.port}`;
+};
+
+class Client {
+
+    constructor(clientOptions) {
+        this.options = clientOptions;
+        this.requests = new Map();
+        this.resolves = [];
+
+        const serverUrl = getServerUrl(clientOptions);
+
+        // https://github.com/websockets/ws/blob/master/doc/ws.md
+        const ws = new WebSocket(serverUrl);
+
+        ws.on('error', (err) => {
+
+            // socket hang up: the port is exists but not websocket server
+            // connect ECONNREFUSED: websocket server unavailable
+
+            if (Util.isList(this.resolves)) {
+                this.resolves.forEach((item) => {
+                    item.reject(err);
+                });
+                this.resolves = null;
+            } else {
+                Util.logError(`websocket error: ${err.message}`);
+            }
+
+        });
+
+        ws.on('message', (data) => {
+            this.onMessage(data);
+        });
+
+        ws.on('open', () => {
+            this.ws = ws;
+            if (Util.isList(this.resolves)) {
+                this.resolves.forEach((item) => {
+                    item.resolve(ws);
+                });
+                this.resolves = null;
+            }
+        });
+    }
+
+    connect() {
+        return new Promise((resolve, reject) => {
+
+            if (this.ws) {
+                resolve(this.ws);
+                return;
+            }
+
+            if (this.resolves) {
+                this.resolves.push({
+                    resolve,
+                    reject
+                });
+            } else {
+                reject(new Error('an error occurs when connecting websocket server'));
+            }
+        });
+    }
+
+    onMessage(buf) {
+        const message = JSON.parse(buf.toString());
+        if (!message) {
+            return;
+        }
+        const { id, data } = message;
+        if (!id) {
+            return;
+        }
+
+        const req = this.requests.get(id);
+        if (!req) {
+            return;
+        }
+
+        this.requests.delete(id);
+
+        clearTimeout(req.timeout_id);
+        req.resolve(data);
+
+    }
+
+    async execute(data) {
+
+        let err;
+        const ws = await this.connect().catch((e) => {
+            err = e;
+        });
+
+        return new Promise((resolve, reject) => {
+
+            if (!ws) {
+                reject(err);
+                return;
+            }
+
+            const id = Util.uid();
+            const timeout = this.options.timeout;
+            const timeout_id = setTimeout(() => {
+                this.requests.delete(id);
+                reject(new Error(`timed out receiving message from websocket server: ${timeout}ms`));
+            }, timeout);
+
+            this.requests.set(id, {
+                resolve,
+                timeout_id
+            });
+
+            const message = JSON.stringify({
+                id,
+                data
+            });
+            ws.send(message);
+        });
+    }
+
+    state() {
+        return {
+            get: (... args) => {
+                return this.execute(['get', ... args]);
+            },
+
+            set: (... args) => {
+                return this.execute(['set', ... args]);
+            },
+
+            remove: (... args) => {
+                return this.execute(['remove', ... args]);
+            },
+
+            send: (... args) => {
+                return this.execute(['send', ... args]);
+            }
+        };
+    }
+
+}
+
+
+module.exports = {
+    getServerUrl,
+    Client
+};