@memlab/core 1.0.0

package/dist/lib/Console.js

@@ -0,0 +1,344 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = __importDefault(require("fs"));
+const readline_1 = __importDefault(require("readline"));
+const string_width_1 = __importDefault(require("string-width"));
+const stdout = process.stdout;
+const TABLE_MAX_WIDTH = 50;
+const prevLine = '\x1b[F';
+const eraseLine = '\x1b[K';
+const barComplete = chalk_1.default.green('\u2588');
+const barIncomplete = chalk_1.default.grey('\u2591');
+function formatTableArg(arg) {
+    if (!Array.isArray(arg)) {
+        return arg;
+    }
+    arg.forEach(obj => {
+        if (typeof obj !== 'object') {
+            return;
+        }
+        for (const key of Object.keys(obj)) {
+            const value = obj[key];
+            if (typeof value !== 'string') {
+                continue;
+            }
+            if (value.length <= TABLE_MAX_WIDTH) {
+                continue;
+            }
+            obj[key] = value.substring(0, TABLE_MAX_WIDTH) + '...';
+        }
+    });
+}
+class MemLabConsole {
+    constructor() {
+        this.config = {};
+        this.log = [];
+        this.styles = {
+            top: (msg) => msg,
+            high: chalk_1.default.dim.bind(chalk_1.default),
+            mid: chalk_1.default.yellow.bind(chalk_1.default),
+            low: chalk_1.default.grey.bind(chalk_1.default),
+            success: chalk_1.default.green.bind(chalk_1.default),
+            error: chalk_1.default.red.bind(chalk_1.default),
+            warning: chalk_1.default.yellow.bind(chalk_1.default),
+        };
+        this.sections = {
+            dict: Object.create(null),
+            arr: [{ name: 'header', msgs: [] }],
+        };
+        this.init();
+    }
+    static getInstance() {
+        if (MemLabConsole.singleton) {
+            return MemLabConsole.singleton;
+        }
+        const inst = new MemLabConsole();
+        MemLabConsole.singleton = inst;
+        // clean up output
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        process.on('exit', (_code) => {
+            inst.flushLog();
+            inst.clearPrevOverwriteMsg();
+        });
+        return inst;
+    }
+    style(msg, name) {
+        if (Object.prototype.hasOwnProperty.call(this.styles, name)) {
+            return this.styles[name](msg);
+        }
+        return this.styles.low(msg);
+    }
+    init() {
+        this.beginSection('main-section-DO-NOT-USE');
+    }
+    getLastSection() {
+        const list = this.sections.arr;
+        return list[list.length - 1];
+    }
+    getLastMsg() {
+        const lastSection = this.getLastSection();
+        if (!lastSection || !lastSection.msgs) {
+            return null;
+        }
+        const msgs = lastSection.msgs;
+        return msgs.length === 0 ? null : msgs[msgs.length - 1];
+    }
+    logMsg(msg) {
+        // remove control characters
+        const rawMsg = msg
+            // eslint-disable-next-line no-control-regex
+            .replace(/[\u0000-\u001F\u007F-\u009F]/g, '')
+            .replace(/\[\d{1,3}m/g, '');
+        this.log.push(rawMsg);
+        if (this.log.length > 20) {
+            this.flushLog();
+        }
+    }
+    flushLog() {
+        const str = this.log.join('\n');
+        if (str.length > 0) {
+            const file = this.config.consoleLogFile;
+            fs_1.default.appendFile(file, str + '\n', 'UTF-8', () => {
+                // NOOP
+            });
+        }
+        this.log = [];
+    }
+    pushMsg(msg, options = {}) {
+        const len = this.sections.arr.length;
+        if (this.config.isContinuousTest || len === 0) {
+            return;
+        }
+        // calculate each line's visible width
+        const lines = msg.split('\n').map(line => (0, string_width_1.default)(line));
+        const section = this.getLastSection();
+        section === null || section === void 0 ? void 0 : section.msgs.push({ lines, options });
+        this.logMsg(msg);
+    }
+    clearPrevMsgInLastSection() {
+        const lastSection = this.getLastSection();
+        this.clearPrevMsgInSection(lastSection);
+    }
+    clearPrevMsgInSection(section) {
+        var _a;
+        if (this.config.isContinuousTest) {
+            return;
+        }
+        if (!section || section.msgs.length === 0) {
+            return;
+        }
+        stdout.write(eraseLine);
+        const msg = section.msgs.pop();
+        if (!msg) {
+            return;
+        }
+        const lines = msg.lines;
+        while (lines.length > 0) {
+            const line = (_a = lines.pop()) !== null && _a !== void 0 ? _a : 0;
+            const width = stdout.columns;
+            let n = line === 0 ? 1 : Math.ceil(line / width);
+            while (n-- > 0) {
+                stdout.write(prevLine + eraseLine);
+            }
+        }
+    }
+    clearPrevSection() {
+        var _a;
+        if (this.config.isContinuousTest) {
+            return;
+        }
+        const lastSection = this.getLastSection();
+        if (!lastSection) {
+            return;
+        }
+        while (((_a = lastSection === null || lastSection === void 0 ? void 0 : lastSection.msgs) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+            this.clearPrevMsgInSection(lastSection);
+        }
+        this.sections.arr.pop();
+        delete this.sections.dict[lastSection.name];
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    shouldBeConcise(_msgType) {
+        if (!this.config || !this.config.runningMode) {
+            return false;
+        }
+        return this.config.runningMode.shouldUseConciseConsole();
+    }
+    clearPrevOverwriteMsg() {
+        var _a;
+        if (this.config.isContinuousTest) {
+            return;
+        }
+        const lastMsg = this.getLastMsg();
+        if (!lastMsg || !((_a = lastMsg.options) === null || _a === void 0 ? void 0 : _a.isOverwrite)) {
+            return;
+        }
+        this.clearPrevMsgInLastSection();
+    }
+    printStr(msg, options = {}) {
+        if (this.config.isTest || this.config.muteConsole) {
+            return;
+        }
+        console.log(msg);
+        this.pushMsg(msg, options);
+    }
+    beginSection(name) {
+        if (this.config.isContinuousTest) {
+            return;
+        }
+        this.clearPrevOverwriteMsg();
+        if (this.sections.dict[name]) {
+            this.endSection(name);
+        }
+        const section = { name, msgs: [] };
+        this.sections.dict[name] = section;
+        this.sections.arr.push(section);
+    }
+    endSection(name) {
+        if (this.config.isContinuousTest || this.sections.arr.length === 0) {
+            return;
+        }
+        if (!this.sections.dict[name]) {
+            return;
+        }
+        let section;
+        do {
+            section = this.getLastSection();
+            this.clearPrevSection();
+        } while ((section === null || section === void 0 ? void 0 : section.name) !== name);
+    }
+    setConfig(config) {
+        this.config = config;
+    }
+    table(...args) {
+        if (this.shouldBeConcise('table') ||
+            this.config.isTest ||
+            this.config.muteConsole) {
+            return;
+        }
+        this.clearPrevOverwriteMsg();
+        // make sure the values are not too big
+        formatTableArg(args[0]);
+        if (args[0].length === 0) {
+            return;
+        }
+        console.table(...args);
+    }
+    trace() {
+        if (this.config.isTest || this.config.muteConsole) {
+            return;
+        }
+        console.trace();
+    }
+    topLevel(msg) {
+        if (this.shouldBeConcise('topLevel')) {
+            return this.overwrite(msg);
+        }
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'top'));
+    }
+    highLevel(msg) {
+        if (this.shouldBeConcise('highLevel')) {
+            return this.overwrite(msg);
+        }
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'high'));
+    }
+    midLevel(msg) {
+        if (this.shouldBeConcise('midLevel')) {
+            return this.overwrite(msg);
+        }
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'mid'));
+    }
+    lowLevel(msg) {
+        if (this.shouldBeConcise('lowLevel')) {
+            return this.overwrite(msg);
+        }
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'low'));
+    }
+    success(msg) {
+        if (this.shouldBeConcise('success')) {
+            return this.overwrite(msg);
+        }
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'success'));
+    }
+    // top level error, only used before halting the execution
+    criticalError(msg) {
+        this.clearPrevOverwriteMsg();
+        this.logMsg(msg);
+        console.error(msg);
+    }
+    error(msg) {
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'error'));
+    }
+    warning(msg) {
+        this.clearPrevOverwriteMsg();
+        this.printStr(this.style(msg, 'warning'));
+    }
+    nextLine() {
+        if (this.shouldBeConcise('nextLine')) {
+            return this.overwrite('');
+        }
+        this.clearPrevOverwriteMsg();
+        this.printStr('');
+    }
+    overwrite(msg, options = {}) {
+        if (this.config.isTest || this.config.muteConsole) {
+            return;
+        }
+        if (this.config.isContinuousTest) {
+            return console.log(msg);
+        }
+        this.clearPrevOverwriteMsg();
+        const str = this.style(msg, options.level || 'low');
+        this.printStr(str, { isOverwrite: true });
+    }
+    waitForConsole(query) {
+        const rl = readline_1.default.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        this.pushMsg(query);
+        return new Promise(resolve => rl.question(query, ans => {
+            rl.close();
+            resolve(ans);
+        }));
+    }
+    progress(cur, total, options = {}) {
+        let width = Math.floor(stdout.columns * 0.8);
+        width = Math.min(width, 80);
+        const messageMaxWidth = Math.floor(width * 0.3);
+        let message = options.message || '';
+        const messageWidth = Math.min(message.length, messageMaxWidth);
+        message = message.substring(0, messageWidth);
+        // calculate progress bar
+        const barWidth = width - messageWidth - 1;
+        const barBodyWidth = barWidth - 2;
+        const changeIndex = Math.floor((cur / total) * barBodyWidth);
+        let bar = '';
+        for (let i = 0; i < barBodyWidth; ++i) {
+            bar += i < changeIndex ? barComplete : barIncomplete;
+        }
+        const percent = Math.floor((cur / total) * 100);
+        const progress = `${message}: |${bar}| ${percent}/100`;
+        this.overwrite(progress, { level: 'top' });
+    }
+}
+exports.default = MemLabConsole.getInstance();

package/dist/lib/Constant.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+declare const constants: {
+    isFB: boolean;
+    isFRL: boolean;
+    defaultEngine: string;
+    supportedEngines: string[];
+    supportedBrowsers: any;
+    internalDir: string;
+    monoRepoDir: string;
+    defaultUserAgent: string;
+    V8SyntheticRoots: string[];
+    namePrefixForScenarioFromFile: string;
+    unset: string;
+};
+export declare type Constants = typeof constants;
+declare const _default: {
+    isFB: boolean;
+    isFRL: boolean;
+    defaultEngine: string;
+    supportedEngines: string[];
+    supportedBrowsers: any;
+    internalDir: string;
+    monoRepoDir: string;
+    defaultUserAgent: string;
+    V8SyntheticRoots: string[];
+    namePrefixForScenarioFromFile: string;
+    unset: string;
+};
+export default _default;
+//# sourceMappingURL=Constant.d.ts.map

package/dist/lib/Constant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constant.d.ts","sourceRoot":"","sources":["../../src/lib/Constant.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,QAAA,MAAM,SAAS;;;;;;;;;;;;CAyCd,CAAC;AAOF,oBAAY,SAAS,GAAG,OAAO,SAAS,CAAC;;;;;;;;;;;;;;AACzC,wBAA8E"}

package/dist/lib/Constant.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const InternalValueSetter_1 = require("./InternalValueSetter");
+const constants = {
+    isFB: false,
+    isFRL: false,
+    defaultEngine: 'v8',
+    supportedEngines: ['v8', 'hermes'],
+    supportedBrowsers: Object.create(null),
+    internalDir: 'fb-internal',
+    monoRepoDir: '',
+    defaultUserAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2)' +
+        ' AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.0 Safari/537.36',
+    V8SyntheticRoots: [
+        '(GC roots)',
+        '(Internalized strings)',
+        '(External strings)',
+        '(Read-only roots)',
+        '(Strong roots)',
+        '(Smi roots)',
+        '(Bootstrapper)',
+        '(Stack roots)',
+        '(Relocatable)',
+        '(Debugger)',
+        '(Compilation cache)',
+        '(Handle scope)',
+        '(Builtins)',
+        '(Global handles)',
+        '(Eternal handles)',
+        '(Thread manager)',
+        '(Strong roots)',
+        '(Extensions)',
+        '(Code flusher)',
+        '(Startup object cache)',
+        '(Read-only object cache)',
+        '(Weak collections)',
+        '(Wrapper tracing)',
+        '(Write barrier)',
+        '(Retain maps)',
+        '(Unknown)',
+    ],
+    namePrefixForScenarioFromFile: '',
+    unset: 'UNSET',
+};
+Object.assign(constants.supportedBrowsers, {
+    chromium: 'chrome',
+    chrome: 'google-chrome',
+});
+exports.default = (0, InternalValueSetter_1.setInternalValue)(constants, __filename, constants.internalDir);

package/dist/lib/FileManager.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { MemLabConfig } from './Config';
+import type { AnyValue, Optional } from './Types';
+export declare type FileOption = {
+    workDir?: Optional<string>;
+    clear?: boolean;
+    transcient?: boolean;
+};
+export declare class FileManager {
+    getDefaultWorkDir(): string;
+    generateTmpHeapDir(): string;
+    private static transcientInstanceIdx;
+    getWorkDir(options?: FileOption): string;
+    getChromeBinaryZipFile(): string;
+    getChromeBinaryTimeStampFile(): string;
+    getChromeBinaryDir(): string;
+    clearUserDataDir(options: FileOption): void;
+    getDataBaseDir(options: FileOption): string;
+    getCodeDataDir(): string;
+    getClusterSampleDataDir(): string;
+    getUserDataDir(options: FileOption): string;
+    getCurDataDir(options: FileOption): string;
+    getPersistDataDir(options: FileOption): string;
+    getLoggerOutDir(options?: FileOption): string;
+    getTraceClustersDir(options?: FileOption): string;
+    getTraceJSONDir(options?: FileOption): string;
+    getUnclassifiedTraceClusterDir(options?: FileOption): string;
+    getUniqueTraceClusterDir(options?: FileOption): string;
+    getNewUniqueTraceClusterDir(options?: FileOption): string;
+    getStaleUniqueTraceClusterDir(options?: FileOption): string;
+    getAllClusterSummaryFile(options?: FileOption): string;
+    getExistingUniqueTraceClusterDir(options?: FileOption): string;
+    getAllFilesInDir(dir: string): string[];
+    getDataOutDir(options?: FileOption): string;
+    getCoreProjectBaseDir(): string;
+    getReportOutDir(options?: FileOption): string;
+    getPreviewReportDir(options?: FileOption): string;
+    getLeakSummaryFile(options?: FileOption): string;
+    getInputDataDir(): string;
+    getAllFilesInSubDirs(dir: string): string[];
+    getTmpDir(): string;
+    rmDir(dir: string): void;
+    getExperimentsDir(): string;
+    initExperimentDir(experimentId: string): {
+        controlWorkDir: string;
+        testWorkDir: string;
+    };
+    getAndInitTSCompileIntermediateDir(): string;
+    clearDataDirs(options?: FileOption): void;
+    emptyDirIfExists(dir: string): void;
+    emptyTraceLogDataDir(options?: FileOption): void;
+    resetBrowserDir(): void;
+    isDirectory(file: string): boolean;
+    iterateAllFiles(dir: string, callback: (filepath: string) => AnyValue): void;
+    rmWorkDir(options?: FileOption): void;
+    isWithinInternalDirectory(filePath: string): boolean;
+    initDirs(config: MemLabConfig, options?: FileOption): void;
+}
+declare const _default: FileManager;
+export default _default;
+//# sourceMappingURL=FileManager.d.ts.map

package/dist/lib/FileManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileManager.d.ts","sourceRoot":"","sources":["../../src/lib/FileManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAC,QAAQ,EAAE,QAAQ,EAAC,MAAM,SAAS,CAAC;AAyBhD,oBAAY,UAAU,GAAG;IACvB,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,qBAAa,WAAW;IACf,iBAAiB,IAAI,MAAM;IAI3B,kBAAkB,IAAI,MAAM;IAMnC,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAK;IAElC,UAAU,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAoB5C,sBAAsB,IAAI,MAAM;IAIhC,4BAA4B,IAAI,MAAM;IAItC,kBAAkB,IAAI,MAAM;IAI5B,gBAAgB,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAK3C,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;IAI3C,cAAc,IAAI,MAAM;IAIxB,uBAAuB,IAAI,MAAM;IAIjC,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;IAI3C,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;IAI1C,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM;IAI9C,eAAe,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAKjD,mBAAmB,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAMrD,eAAe,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAIjD,8BAA8B,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAIhE,wBAAwB,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAI1D,2BAA2B,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAI7D,6BAA6B,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAI/D,wBAAwB,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAO1D,gCAAgC,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAIlE,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAKvC,aAAa,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAI/C,qBAAqB,IAAI,MAAM;IAI/B,eAAe,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAIjD,mBAAmB,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAIrD,kBAAkB,CAAC,OAAO,GAAE,UAAe,GAAG,MAAM;IAIpD,eAAe,IAAI,MAAM;IAIzB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAiB3C,SAAS,IAAI,MAAM;IAInB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMxB,iBAAiB,IAAI,MAAM;IAI3B,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG;QAC9C,cAAc,EAAE,MAAM,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;KACrB;IAQM,kCAAkC,IAAI,MAAM;IAO5C,aAAa,CAAC,OAAO,GAAE,UAAe,GAAG,IAAI;IAkB7C,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMnC,oBAAoB,CAAC,OAAO,GAAE,UAAe,GAAG,IAAI;IAWpD,eAAe,IAAI,IAAI;IAcvB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAKlC,eAAe,CACpB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,QAAQ,GACvC,IAAI;IAYA,SAAS,CAAC,OAAO,GAAE,UAAe,GAAG,IAAI;IAQzC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAMpD,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,GAAE,UAAe,GAAG,IAAI;CAyGtE;;AAED,wBAAiC"}