@memlab/core 1.1.17 → 1.1.18

package/dist/lib/Config.d.ts

@@ -8,8 +8,7 @@
  * @oncall web_perf_infra
  */
 import type { LaunchOptions, Permission } from 'puppeteer';
-import type { AnyFunction, AnyValue, IClusterStrategy, IRunningMode, IScenario, Nullable, Optional, QuickExperiment, ILeakFilter, IPackageInfo } from './Types';
-import { IHeapConfig } from '..';
+import type { AnyFunction, AnyValue, FileOption, IClusterStrategy, IRunningMode, IScenario, IHeapConfig, Nullable, Optional, QuickExperiment, ILeakFilter, IPackageInfo } from './Types';
 interface BrowserLaunchArgumentOptions {
     headless?: boolean;
     userDataDir?: string;
@@ -217,6 +216,8 @@ export declare class MemLabConfig {
     set disableWebSecurity(disable: boolean);
     get disableWebSecurity(): boolean;
     get browserBinaryPath(): string;
+    set defaultFileManagerOption(fileOption: FileOption);
+    get defaultFileManagerOption(): FileOption;
     set reportLeaksInTimers(shouldReport: boolean);
     get reportLeaksInTimers(): boolean;
     setDevice(deviceName: string, options?: {

package/dist/lib/Config.js

@@ -8,6 +8,29 @@
  * @format
  * @oncall web_perf_infra
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -17,7 +40,7 @@ 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 FileManager_1 = __importStar(require("./FileManager"));
 const InternalValueSetter_1 = require("./InternalValueSetter");
 const devices = Constant_1.default.isFRL
     ? {}
@@ -429,6 +452,17 @@ class MemLabConfig {
     get browserBinaryPath() {
         return path_1.default.join(this.browserDir, this.browser);
     }
+    // Default input option for file manager.
+    // If no other input option is provided, the file manager
+    // will generate directories and files based on this default option.
+    set defaultFileManagerOption(fileOption) {
+        FileManager_1.FileManager.defaultFileOption = fileOption;
+        // initialize file and directory paths
+        FileManager_1.default.initDirs(this, fileOption);
+    }
+    get defaultFileManagerOption() {
+        return FileManager_1.FileManager.defaultFileOption;
+    }
     set reportLeaksInTimers(shouldReport) {
         if (shouldReport) {
             this.removeFromSet(this.nodeNameBlockList, this._timerNodes);

package/dist/lib/FileManager.d.ts

@@ -8,35 +8,31 @@
  * @oncall web_perf_infra
  */
 import type { MemLabConfig } from './Config';
-import type { AnyValue, Optional } from './Types';
-/** @internal */
-export declare type FileOption = {
-    workDir?: Optional<string>;
-    clear?: boolean;
-    transient?: boolean;
-};
+import type { AnyValue, FileOption } from './Types';
 /** @internal */
 export declare class FileManager {
     getDefaultWorkDir(): string;
     generateTmpHeapDir(): string;
     private static transientInstanceIdx;
+    static defaultFileOption: FileOption;
     getWorkDir(options?: FileOption): string;
     getChromeBinaryZipFile(): string;
     getChromeBinaryTimeStampFile(): string;
     getChromeBinaryDir(): string;
-    clearUserDataDir(options: FileOption): void;
-    getDataBaseDir(options: FileOption): string;
+    getDataBaseDir(options?: FileOption): string;
     getCodeDataDir(): string;
     getClusterSampleDataDir(): string;
-    getUserDataDir(options: FileOption): string;
-    getCurDataDir(options: FileOption): string;
+    getUserDataDir(options?: FileOption): string;
+    clearUserDataDir(options?: FileOption): void;
+    getCurDataDir(options?: FileOption): string;
     getWebSourceDir(options?: FileOption): string;
     getWebSourceMetaFile(options?: FileOption): string;
     getDebugDataDir(options?: FileOption): string;
     getDebugSourceFile(options?: FileOption): string;
-    getPersistDataDir(options: FileOption): string;
+    getPersistDataDir(options?: FileOption): string;
     getLoggerOutDir(options?: FileOption): string;
     getHeapAnalysisLogDir(options?: FileOption): string;
+    getHeapSaveLogJSONFile(options?: FileOption): string;
     getTraceClustersDir(options?: FileOption): string;
     getTraceJSONDir(options?: FileOption): string;
     getUnclassifiedTraceClusterDir(options?: FileOption): string;

package/dist/lib/FileManager.js

@@ -24,7 +24,7 @@ function joinAndProcessDir(options, ...args) {
     const filepath = path_1.default.join(...args);
     if (!fs_extra_1.default.existsSync(filepath)) {
         try {
-            fs_extra_1.default.mkdirSync(filepath);
+            fs_extra_1.default.mkdirpSync(filepath);
         }
         catch (ex) {
             const err = Utils_1.default.getError(ex);
@@ -43,11 +43,11 @@ class FileManager {
     generateTmpHeapDir() {
         const dirPath = path_1.default.join(this.getTmpDir(), 'memlab-' + Utils_1.default.getUniqueID());
         if (!fs_extra_1.default.existsSync(dirPath)) {
-            fs_extra_1.default.mkdirSync(dirPath);
+            fs_extra_1.default.mkdirpSync(dirPath);
         }
         return dirPath;
     }
-    getWorkDir(options = {}) {
+    getWorkDir(options = FileManager.defaultFileOption) {
         // workDir options supercedes all the other options
         if (options.workDir) {
             return path_1.default.resolve(options.workDir);
@@ -73,11 +73,7 @@ class FileManager {
     getChromeBinaryDir() {
         return path_1.default.join(this.getDefaultWorkDir(), 'chrome');
     }
-    clearUserDataDir(options) {
-        const userDataDir = this.getUserDataDir(options);
-        this.rmDir(userDataDir);
-    }
-    getDataBaseDir(options) {
+    getDataBaseDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getWorkDir(options), 'data');
     }
     getCodeDataDir() {
@@ -86,66 +82,74 @@ class FileManager {
     getClusterSampleDataDir() {
         return path_1.default.join(this.getCodeDataDir(), 'cluster');
     }
-    getUserDataDir(options) {
+    getUserDataDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataBaseDir(options), 'profile');
     }
-    getCurDataDir(options) {
+    clearUserDataDir(options = FileManager.defaultFileOption) {
+        const userDataDir = this.getUserDataDir(options);
+        this.rmDir(userDataDir);
+    }
+    getCurDataDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataBaseDir(options), 'cur');
     }
-    getWebSourceDir(options = {}) {
+    getWebSourceDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getCurDataDir(options), 'code');
     }
-    getWebSourceMetaFile(options = {}) {
+    getWebSourceMetaFile(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getWebSourceDir(options), 'files.json');
     }
-    getDebugDataDir(options = {}) {
+    getDebugDataDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataBaseDir(options), 'debug');
     }
-    getDebugSourceFile(options = {}) {
+    getDebugSourceFile(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDebugDataDir(options), 'file.js');
     }
-    getPersistDataDir(options) {
+    getPersistDataDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataBaseDir(options), 'persist');
     }
-    getLoggerOutDir(options = {}) {
+    getLoggerOutDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataBaseDir(options), 'logger');
     }
     // all heap analysis results generated
-    getHeapAnalysisLogDir(options = {}) {
+    getHeapAnalysisLogDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getLoggerOutDir(options), 'heap-analysis');
     }
+    // memlab save-heap result log file
+    getHeapSaveLogJSONFile(options = FileManager.defaultFileOption) {
+        return path_1.default.join(this.getHeapAnalysisLogDir(options), 'save-heap.json');
+    }
     // all trace clusters generated from the current run
-    getTraceClustersDir(options = {}) {
+    getTraceClustersDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getLoggerOutDir(options), 'trace-clusters');
     }
     // stores JSON file (with heap object and reference details for visualization)
     // of all trace clusters (each cluster has a representative trace)
-    getTraceJSONDir(options = {}) {
+    getTraceJSONDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getLoggerOutDir(options), 'trace-jsons');
     }
-    getUnclassifiedTraceClusterDir(options = {}) {
+    getUnclassifiedTraceClusterDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getLoggerOutDir(options), 'unclassified-clusters');
     }
-    getUniqueTraceClusterDir(options = {}) {
+    getUniqueTraceClusterDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getLoggerOutDir(options), 'unique-trace-clusters');
     }
-    getNewUniqueTraceClusterDir(options = {}) {
+    getNewUniqueTraceClusterDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getUniqueTraceClusterDir(options), 'add');
     }
-    getStaleUniqueTraceClusterDir(options = {}) {
+    getStaleUniqueTraceClusterDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getUniqueTraceClusterDir(options), 'delete');
     }
-    getAllClusterSummaryFile(options = {}) {
+    getAllClusterSummaryFile(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getUniqueTraceClusterDir(options), 'unique-clusters-summary.txt');
     }
-    getExistingUniqueTraceClusterDir(options = {}) {
+    getExistingUniqueTraceClusterDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getUniqueTraceClusterDir(options), 'existing');
     }
     getAllFilesInDir(dir) {
         const files = fs_extra_1.default.readdirSync(dir);
         return files.map((file) => path_1.default.join(dir, file));
     }
-    getDataOutDir(options = {}) {
+    getDataOutDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataBaseDir(options), 'out');
     }
     getCoreProjectBaseDir() {
@@ -157,19 +161,19 @@ class FileManager {
     getDocDir() {
         return path_1.default.join(this.getMonoRepoDir(), 'website', 'docs');
     }
-    getReportOutDir(options = {}) {
+    getReportOutDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getPersistDataDir(options), 'reports');
     }
-    getPreviewReportDir(options = {}) {
+    getPreviewReportDir(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getPersistDataDir(options), 'report-preview');
     }
-    getLeakSummaryFile(options = {}) {
+    getLeakSummaryFile(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getDataOutDir(options), 'leaks.txt');
     }
-    getRunMetaFile(options = {}) {
+    getRunMetaFile(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getCurDataDir(options), 'run-meta.json');
     }
-    getSnapshotSequenceMetaFile(options = {}) {
+    getSnapshotSequenceMetaFile(options = FileManager.defaultFileOption) {
         return path_1.default.join(this.getCurDataDir(options), 'snap-seq.json');
     }
     getInputDataDir() {
@@ -192,6 +196,7 @@ class FileManager {
         }
         return ret;
     }
+    // system default tmp dir
     getTmpDir() {
         return os_1.default.tmpdir();
     }
@@ -211,7 +216,7 @@ class FileManager {
         return { controlWorkDir, testWorkDir };
     }
     // create a unique log file created for heap analysis output
-    initNewHeapAnalysisLogFile(options = {}) {
+    initNewHeapAnalysisLogFile(options = FileManager.defaultFileOption) {
         const dir = this.getHeapAnalysisLogDir(options);
         const file = path_1.default.join(dir, `analysis-${Utils_1.default.getUniqueID()}-out.log`);
         if (!fs_extra_1.default.existsSync(file)) {
@@ -222,10 +227,10 @@ class FileManager {
     getAndInitTSCompileIntermediateDir() {
         const dir = path_1.default.join(this.getTmpDir(), 'memlab-code');
         this.rmDir(dir);
-        fs_extra_1.default.mkdirSync(dir);
+        fs_extra_1.default.mkdirpSync(dir);
         return dir;
     }
-    clearDataDirs(options = {}) {
+    clearDataDirs(options = FileManager.defaultFileOption) {
         const curDataDir = this.getCurDataDir(options);
         if (!fs_extra_1.default.existsSync(curDataDir)) {
             return;
@@ -249,7 +254,7 @@ class FileManager {
             fs_extra_1.default.emptyDirSync(dir);
         }
     }
-    emptyTraceLogDataDir(options = {}) {
+    emptyTraceLogDataDir(options = FileManager.defaultFileOption) {
         // all leak trace clusters
         this.emptyDirIfExists(this.getTraceClustersDir(options));
         // all JSON files for trace visualization
@@ -290,7 +295,7 @@ class FileManager {
             this.iterateAllFiles(filepath, callback);
         });
     }
-    rmWorkDir(options = {}) {
+    rmWorkDir(options = FileManager.defaultFileOption) {
         try {
             this.rmDir(this.getWorkDir(options));
         }
@@ -303,7 +308,7 @@ class FileManager {
         const internalDir = Constant_1.default.internalDir;
         return filePath.includes(`${sep}${internalDir}${sep}`);
     }
-    initDirs(config, options = {}) {
+    initDirs(config, options = FileManager.defaultFileOption) {
         config.monoRepoDir = Constant_1.default.monoRepoDir;
         // make sure getWorkDir is called first before
         // any other get file or get dir calls
@@ -356,4 +361,5 @@ class FileManager {
 }
 exports.FileManager = FileManager;
 FileManager.transientInstanceIdx = 0;
+FileManager.defaultFileOption = {};
 exports.default = new FileManager();

package/dist/lib/Types.d.ts

@@ -43,6 +43,12 @@ export declare type HaltOrThrowOptions = {
     printCallback?: () => void;
 };
 /** @internal */
+export declare type FileOption = {
+    workDir?: Optional<string>;
+    clear?: boolean;
+    transient?: boolean;
+};
+/** @internal */
 export declare type CLIOptions = {
     cliArgs: ParsedArgs;
     configFromOptions?: AnyRecord;

package/dist/lib/Utils.d.ts

@@ -122,7 +122,7 @@ declare function getError(maybeError: unknown): Error;
 declare function isNodeDominatedByDeletionsArray(node: IHeapNode): boolean;
 declare function getUniqueID(): string;
 declare function getClosureSourceUrl(node: IHeapNode): Nullable<string>;
-export declare function runShell(command: string, options?: ShellOptions): string;
+export declare function runShell(command: string, options?: ShellOptions): Nullable<string>;
 export declare function getRetainedSize(node: IHeapNode): number;
 export declare function aggregateDominatorMetrics(ids: HeapNodeIdSet, snapshot: IHeapSnapshot, checkNodeCb: (node: IHeapNode) => boolean, nodeMetricsCb: (node: IHeapNode) => number): number;
 declare const _default: {

package/dist/lib/Utils.js

@@ -1764,7 +1764,7 @@ function runShell(command, options = {}) {
     if (process_1.default.platform !== 'win32') {
         execOptions.shell = '/bin/bash';
     }
-    let ret = '';
+    let ret = null;
     try {
         ret = child_process_1.default.execSync(command, execOptions);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/core",
-  "version": "1.1.17",
+  "version": "1.1.18",
   "license": "MIT",
   "description": "memlab core libraries",
   "author": "Liang Gong <lgong@fb.com>",