@memlab/core 1.0.0

package/dist/lib/Config.js

@@ -0,0 +1,427 @@
+"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
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemLabConfig = exports.ErrorHandling = void 0;
+const path_1 = __importDefault(require("path"));
+const RunningModes_1 = __importDefault(require("../modes/RunningModes"));
+const Console_1 = __importDefault(require("./Console"));
+const Constant_1 = __importDefault(require("./Constant"));
+const FileManager_1 = __importDefault(require("./FileManager"));
+const InternalValueSetter_1 = require("./InternalValueSetter");
+const devices = Constant_1.default.isFRL
+    ? {}
+    : Constant_1.default.isFB
+        ? require('puppeteer-core/DeviceDescriptors')
+        : // eslint-disable-next-line @typescript-eslint/no-var-requires
+            require('puppeteer').devices;
+// default viewport config for desktop
+const windowWidth = 1680;
+const windowHeight = 1080;
+const defaultViewport = {
+    width: windowWidth,
+    height: windowHeight,
+    deviceScaleFactor: 1,
+};
+var ErrorHandling;
+(function (ErrorHandling) {
+    ErrorHandling[ErrorHandling["Halt"] = 1] = "Halt";
+    ErrorHandling[ErrorHandling["Throw"] = 2] = "Throw";
+})(ErrorHandling = exports.ErrorHandling || (exports.ErrorHandling = {}));
+class MemLabConfig {
+    constructor(options = {}) {
+        // init properties, they can be configured manually
+        this.init(options);
+        // init built-in properties, they should not be configured manually
+        this.initInternalConfigs();
+    }
+    initInternalConfigs() {
+        // DO NOT SET PARAMETER HERE
+        this._reportLeaksInTimers = false;
+        this._deviceManualOverridden = false;
+        this._timerNodes = ['Pending activities'];
+        this._timerEdges = [];
+        this.targetApp = Constant_1.default.unset;
+        this.targetTab = Constant_1.default.unset;
+        this.analysisMode = Constant_1.default.unset;
+        this.focusFiberNodeId = 1;
+        this.isFB = Constant_1.default.isFB;
+        // assuming the Evn doesn't support Xvfb before checking
+        this.machineSupportsXVFB = false;
+        // by default we want to use Xvfb if the Env supports it
+        this.useXVFB = true;
+        this.specifiedEngine = false;
+        // set puppeteer configuration
+        this.puppeteerConfig = {
+            devtools: this.openDevtoolsConsole,
+            // IMPORTANT: test ContinuousTest before change this config
+            ignoreHTTPSErrors: true,
+            userDataDir: this.userDataDir,
+            // Chromium in ContinuousTest needs this args
+            args: [
+                '--no-sandbox',
+                // Disable popup notification
+                '--disable-notifications',
+                // Automatically allows media stream requests
+                '--use-fake-ui-for-media-stream',
+                // Feeds fake video stream
+                '--use-fake-device-for-media-stream',
+                // V8 GC move fewer objects around
+                '--js-flags="--no-move-object-start"',
+                // Alreay on by default, just want to make sure
+                '--enable-precise-memory-info',
+                'browser-test',
+            ],
+            defaultViewport,
+        };
+        // by default don't emulate any device, use the desktop config
+        this.emulateDevice = null;
+        // the default JS engine of snapshot
+        this.jsEngine = Constant_1.default.defaultEngine;
+        // the default browser (Chromium)
+        this._browser = 'chrome';
+        // a set of additional GKs to be enabled
+        this.addEnableGK = new Set();
+        // a set of additional GKs to be disabled
+        this.addDisableGK = new Set();
+        // a list of additional QEs to be enabled
+        this.qes = [];
+        // check if running in ondemand devvm
+        this.isOndemand = false;
+        // configuration for analyzing external snapshots
+        this.useExternalSnapshot = false;
+        // new version of heap snapshot has a detachedness field
+        this.snapshotHasDetachedness = false;
+        // by default running in regular mode
+        this.runningMode = RunningModes_1.default.get('regular', this);
+        // external heap snapshot paths, if enabled
+        this.externalSnapshotFilePaths = [];
+        // mute the console output, if enabled
+        this.muteConsole = false;
+        // log all leak traces, each as an unclassified cluster
+        this.logUnclassifiedClusters = false;
+        // by default halt the program when utils.haltOrThrow is calleds
+        this.errorHandling = ErrorHandling.Halt;
+    }
+    // initialize configurable parameters
+    init(options = {}) {
+        // if true dump extra debug info to terminal
+        this.verbose = false;
+        // dump the web console's output to terminal
+        this.dumpWebConsole = false;
+        // open dev-tools console when interacting with the page
+        this.openDevtoolsConsole = false;
+        // clear console, this may eliminate leaks retained by console
+        this.clearConsole = false;
+        // consider dev-tools console when search for leak trace
+        this.traverseDevToolsConsole = true;
+        // if true skip all warmup
+        this.skipWarmup = false;
+        // if true skip all snapshots
+        this.skipSnapshot = false;
+        // if true skip all screenshots
+        this.skipScreenshot = false;
+        // if true skip all scrolling
+        this.skipScroll = false;
+        // if true skip all extra operations on target and final
+        this.skipExtraOps = false;
+        // if true skip all GC
+        this.skipGC = false;
+        // true if running in ContinuousTest
+        this.isContinuousTest = false;
+        // true if running a local test
+        this.isTest = false;
+        // true if running in local puppeteer mode
+        this.isLocalPuppeteer = false;
+        // true if pausing on every step
+        this.isManualDebug = false;
+        // number of warmup repeat in each browser tab instance
+        this.warmupRepeat = 2;
+        // default waiting time when there is no page load checker callback
+        this.delayWhenNoPageLoadCheck = 2000;
+        // repeat the intermediate sequence
+        this.repeatIntermediateTabs = 1;
+        // the # of retries when interaction fails
+        this.interactionFailRetry = 1;
+        // the # of retries when initial load fails
+        this.initialLoadFailRetry = 2;
+        // timeout for checking the presence of non-optional click target
+        this.presenceCheckTimeout = 120000;
+        // default waiting time before exit when exception occurs during page interaction
+        this.delayBeforeExitUponException = 120 * 1000;
+        // Chrome window width
+        this.windowWidth = windowWidth;
+        // Chrome window height
+        this.windowHeight = windowHeight;
+        // disable all scroll
+        this.disableScroll = false;
+        // default number of scrolls on target page
+        this.scrollRepeat = 5;
+        // extra waiting time for the target page
+        this.extraWaitingForTarget = 0;
+        // extra waiting time for the final page
+        this.extraWaitingForFinal = 0;
+        // if a click operation does not setup a delay, use this delay after click
+        this.defaultAfterClickDelay = 2000;
+        // delay after garbage collection
+        this.waitAfterGC = 1400;
+        // delay after checking visual completion
+        this.waitAfterPageLoad = 500;
+        // delay after browser interaction
+        this.waitAfterOperation = 200;
+        // timeout for warmup page load (30 seconds)
+        this.warmupPageLoadTimeout = 30 * 1000;
+        // timeout for initial page load (10 minute)
+        this.initialPageLoadTimeout = 10 * 60 * 1000;
+        // extra delay after scrolling
+        this.waitAfterScrolling = 5000;
+        // extra delay after typing
+        this.waitAfterTyping = 1000;
+        // default repeat for stress testing
+        this.stressTestRepeat = 5;
+        // only show leaks with detached HTML elements
+        this.avoidLeakWithoutDetachedElements = false;
+        // if true, hide potential browser memory leak
+        this.hideBrowserLeak = true;
+        // recursively dump the key object of the WeakMap
+        this.chaseWeakMapEdge = true;
+        // consider outstanding Fiber nodes from target page as leaks
+        this.detectFiberNodeLeak = true;
+        // granted permissions to browser, so it won't ask by popping up dialog
+        this.grantedPermissions = [
+            'geolocation',
+            'camera',
+            'microphone',
+            'accelerometer',
+            'gyroscope',
+            'magnetometer',
+            'payment-handler',
+            'background-sync',
+        ];
+        // unbounded growth check only reports objects that are monotonic increasing
+        this.monotonicUnboundGrowthOnly = false;
+        // object size below the threshold won't be reported
+        this.unboundSizeThreshold = 10 * 1024;
+        // if true reset the GK list in visit synthesizer
+        this.resetGK = false;
+        // default userAgent, if undefined use puppeteer's default value
+        this.defaultUserAgent = Constant_1.default.defaultUserAgent;
+        // dump the heap node information in path summary (focuse mode)
+        this.dumpNodeInfo = false;
+        // the max steps when doing BFS search for shortest path
+        this.maxSearchSteps = Infinity;
+        // the max number of outgoing edges to be considered for a single node,
+        // when doing BFS search for shortest path
+        this.maxSearchReferences = Infinity;
+        // the set of nodes to expand one more level in the HTML report
+        this.nodeToShowMoreInfo = new Set();
+        // if true ignore DevTools console leak
+        this.ignoreDevToolsConsoleLeak = false;
+        // if true ignore InternalNode when searching for leak trace
+        this.ignoreInternalNode = false;
+        // node names excluded from the trace finding
+        this.nodeNameBlockList = new Set(['system / PropertyCell']);
+        // edge names excluded from the trace finding
+        this.edgeNameBlockList = new Set(['feedback_cell']);
+        // node names less preferable in trace finding
+        this.nodeNameGreyList = new Set([
+            'InternalNode',
+            'Pending activities',
+            ...Constant_1.default.V8SyntheticRoots,
+        ]);
+        // edge names less preferable in trace finding
+        this.edgeNameGreyList = new Set(['alternate', 'firstEffect', 'lastEffect']);
+        // browser port for debugging
+        this.localBrowserPort = 57305;
+        // skip running the following test types in ContinuousTest
+        this.ignoreTypesInContinuousTest = new Set();
+        // skip running the following apps in ContinuousTest
+        this.ignoreAppsInContinuousTest = new Set();
+        // a threshold hold to prevent exceeding refer header size limit
+        this.URLParamLengthLimit = 400;
+        // a set of ignored edges when clustering object shapes
+        this.edgeIgnoreSetInShape = new Set(['__proto__', 'map']);
+        // a set of ignored nodes when clustering object shapes
+        this.nodeIgnoreSetInShape = new Set([
+            '(closure)',
+            '(array)',
+            '(number)',
+            '(system)',
+            'system / Context',
+            'system / Oddball',
+        ]);
+        // if true consider over sized objects as memory leak
+        this.oversizeObjectAsLeak = false;
+        // if larger than this threshold, consider as memory leak
+        this.oversizeThreshold = 0;
+        // initialize file and directory paths
+        FileManager_1.default.initDirs(this, options);
+    }
+    getAdditionalConfigInContinuousTest(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _app, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _interaction) {
+        return [];
+    }
+    // default config instance created from CLI
+    static getInstance() {
+        if (!MemLabConfig.instance) {
+            const config = new MemLabConfig();
+            // do not consider objects kept alive by timers as leaks
+            config.reportLeaksInTimers = true;
+            // assign configuration to console manager
+            Console_1.default.setConfig(config);
+            // set the singleton
+            MemLabConfig.instance = config;
+        }
+        return MemLabConfig.instance;
+    }
+    static resetConfigWithTranscientDir() {
+        const config = MemLabConfig.getInstance();
+        FileManager_1.default.initDirs(config, { transcient: true });
+        return config;
+    }
+    haltOrThrow(msg, 
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    secondaryPrintCallback = () => { }) {
+        if (this.errorHandling === ErrorHandling.Halt) {
+            Console_1.default.error(msg);
+            secondaryPrintCallback();
+            process.exit(1);
+        }
+        else {
+            throw new Error(msg);
+        }
+    }
+    setTarget(app, tab) {
+        this.targetApp = app;
+        this.targetTab = tab;
+    }
+    set scenario(scenario) {
+        this._scenario = scenario;
+        if (scenario == null) {
+            return;
+        }
+        // set leak filter
+        const { leakFilter, beforeLeakFilter } = scenario;
+        if (typeof leakFilter !== 'function') {
+            return;
+        }
+        this.externalLeakFilter = { leakFilter };
+        // set leak filter init callback
+        if (typeof beforeLeakFilter === 'function') {
+            this.externalLeakFilter.beforeLeakFilter = beforeLeakFilter;
+        }
+    }
+    get scenario() {
+        return this._scenario;
+    }
+    set isFullRun(isFull) {
+        this._isFullRun = isFull;
+    }
+    get isFullRun() {
+        return this._isFullRun;
+    }
+    set browser(v) {
+        if (!Constant_1.default.supportedBrowsers[v]) {
+            this.haltOrThrow(`Invalid browser: ${v} ` +
+                `(supported browsers: ${Object.keys(Constant_1.default.supportedBrowsers).join(', ')})`);
+        }
+        this._browser = Constant_1.default.supportedBrowsers[v];
+        this.puppeteerConfig.executablePath = this.browserBinaryPath;
+        if (this.verbose) {
+            Console_1.default.lowLevel(`set browser: ${this.puppeteerConfig.executablePath}`);
+        }
+    }
+    get browser() {
+        return this._browser || 'google-chrome';
+    }
+    get browserBinaryPath() {
+        return path_1.default.join(this.browserDir, this.browser);
+    }
+    set reportLeaksInTimers(flag) {
+        if (typeof flag !== 'boolean') {
+            return;
+        }
+        if (flag) {
+            this.removeFromSet(this.nodeNameBlockList, this._timerNodes);
+            this.removeFromSet(this.edgeNameBlockList, this._timerEdges);
+        }
+        else {
+            this.addToSet(this.nodeNameBlockList, this._timerNodes);
+            this.addToSet(this.edgeNameBlockList, this._timerEdges);
+        }
+        this._reportLeaksInTimers = flag;
+    }
+    get reportLeaksInTimers() {
+        return this._reportLeaksInTimers;
+    }
+    setDevice(deviceName, options = {}) {
+        if (!options.manualOverride && this._deviceManualOverridden) {
+            return;
+        }
+        this._deviceManualOverridden = !!options.manualOverride;
+        // set pc device
+        if (deviceName == null || deviceName === 'pc') {
+            this.emulateDevice = null;
+            this.defaultUserAgent = Constant_1.default.defaultUserAgent;
+            this.puppeteerConfig.defaultViewport = defaultViewport;
+            return;
+        }
+        // set mobile device
+        const name = deviceName.split('-').join(' ');
+        if (!devices[name]) {
+            const supportedDevices = Array.from(Object.keys(devices))
+                .filter(name => isNaN(parseInt(name, 10)))
+                .map(name => name.split(' ').join('-'));
+            this.haltOrThrow(`Invalid device: ${name}`, () => {
+                Console_1.default.lowLevel(`(supported devies: ${supportedDevices.join(', ')})`);
+            });
+        }
+        this.emulateDevice = devices[name];
+        this.puppeteerConfig.defaultViewport = null;
+        this.defaultUserAgent = null;
+    }
+    removeFromSet(set, list) {
+        for (const v of list) {
+            set.delete(v);
+        }
+    }
+    addToSet(set, list) {
+        for (const v of list) {
+            set.add(v);
+        }
+    }
+    enableXvfb(display) {
+        var _a;
+        this.useXVFB = true;
+        this.puppeteerConfig.devtools = true;
+        (_a = this.puppeteerConfig.args) === null || _a === void 0 ? void 0 : _a.push(`--display=${display}`);
+    }
+    disableXvfb() {
+        const args = [];
+        for (const arg of this.puppeteerConfig.args || []) {
+            if (!arg.startsWith('--display=')) {
+                args.push(arg);
+            }
+        }
+        this.puppeteerConfig.args = args;
+        this.puppeteerConfig.devtools = false;
+        this.useXVFB = false;
+    }
+}
+exports.MemLabConfig = MemLabConfig;
+const config = MemLabConfig.getInstance();
+(0, InternalValueSetter_1.setInternalValue)(config, __filename, Constant_1.default.internalDir);
+exports.default = config;

package/dist/lib/Console.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { Chalk } from 'chalk';
+import type { MemLabConfig } from './Config';
+import { AnyValue } from './Types';
+interface MemlabConsoleStyles {
+    top: (msg: string) => string;
+    high: Chalk;
+    mid: Chalk;
+    low: Chalk;
+    success: Chalk;
+    error: Chalk;
+    warning: Chalk;
+}
+declare class MemLabConsole {
+    private config;
+    private sections;
+    private log;
+    private styles;
+    private static singleton;
+    protected constructor();
+    static getInstance(): MemLabConsole;
+    private style;
+    private init;
+    private getLastSection;
+    private getLastMsg;
+    private logMsg;
+    private flushLog;
+    private pushMsg;
+    private clearPrevMsgInLastSection;
+    private clearPrevMsgInSection;
+    private clearPrevSection;
+    private shouldBeConcise;
+    private clearPrevOverwriteMsg;
+    private printStr;
+    beginSection(name: string): void;
+    endSection(name: string): void;
+    setConfig(config: MemLabConfig): void;
+    table(...args: AnyValue[]): void;
+    trace(): void;
+    topLevel(msg: string): void;
+    highLevel(msg: string): void;
+    midLevel(msg: string): void;
+    lowLevel(msg: string): void;
+    success(msg: string): void;
+    criticalError(msg: string): void;
+    error(msg: string): void;
+    warning(msg: string): void;
+    nextLine(): void;
+    overwrite(msg: string, options?: {
+        level?: keyof MemlabConsoleStyles;
+    }): void;
+    waitForConsole(query: string): Promise<string>;
+    progress(cur: number, total: number, options?: {
+        message?: string;
+    }): void;
+}
+declare const _default: MemLabConsole;
+export default _default;
+//# sourceMappingURL=Console.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Console.d.ts","sourceRoot":"","sources":["../../src/lib/Console.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAc,EAAC,KAAK,EAAC,MAAM,OAAO,CAAC;AAInC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAC,QAAQ,EAAqB,MAAM,SAAS,CAAC;AAmDrD,UAAU,mBAAmB;IAC3B,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7B,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,KAAK,CAAC;IACX,GAAG,EAAE,KAAK,CAAC;IACX,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,KAAK,CAAC;CAChB;AAED,cAAM,aAAa;IACjB,OAAO,CAAC,MAAM,CAAoC;IAClD,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,GAAG,CAAgB;IAC3B,OAAO,CAAC,MAAM,CAQZ;IAEF,OAAO,CAAC,MAAM,CAAC,SAAS,CAAgB;IAExC,SAAS;WAQK,WAAW,IAAI,aAAa;IAiB1C,OAAO,CAAC,KAAK;IAOb,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,MAAM;IAYd,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,OAAO;IAYf,OAAO,CAAC,yBAAyB;IAKjC,OAAO,CAAC,qBAAqB;IAyB7B,OAAO,CAAC,gBAAgB;IAkBxB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,QAAQ;IAQT,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAahC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAc9B,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAIrC,KAAK,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI;IAiBhC,KAAK,IAAI,IAAI;IAOb,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAQ3B,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAQ5B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAQ3B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAQ3B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAS1B,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMhC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKxB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAK1B,QAAQ,IAAI,IAAI;IAQhB,SAAS,CACd,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;QAAC,KAAK,CAAC,EAAE,MAAM,mBAAmB,CAAA;KAAM,GAChD,IAAI;IAYA,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAc9C,QAAQ,CACb,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,OAAO,GAAE;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAM,GAC/B,IAAI;CAoBR;;AAED,wBAA2C"}