@memlab/cli 1.0.29 → 1.0.30

package/bin/memlab.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node --expose-gc --max-old-space-size=4096
+#!/usr/bin/env -S node --expose-gc --max-old-space-size=4096
 
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.

package/dist/commands/heap/HeapAnalysisCommand.d.ts

@@ -7,15 +7,17 @@
  * @format
  * @oncall web_perf_infra
  */
-import type { CLIOptions, CommandOptionExample } from '@memlab/core';
+import type { BaseOption, CLIOptions, CommandOptionExample } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';
 export default class RunHeapAnalysisCommand extends BaseCommand {
     getCommandName(): string;
     getDescription(): string;
     getCategory(): CommandCategory;
     getPrerequisites(): BaseCommand[];
+    getOptions(): BaseOption[];
     getSubCommands(): BaseCommand[];
     getExamples(): CommandOptionExample[];
+    private errorIfNoSubCommand;
     run(options: CLIOptions): Promise<void>;
 }
 //# sourceMappingURL=HeapAnalysisCommand.d.ts.map

package/dist/commands/heap/HeapAnalysisCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HeapAnalysisCommand.d.ts","sourceRoot":"","sources":["../../../src/commands/heap/HeapAnalysisCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAE,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAGnE,OAAO,WAAW,EAAE,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAO/D,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,WAAW;IAC7D,cAAc,IAAI,MAAM;IAIxB,cAAc,IAAI,MAAM;IAIxB,WAAW,IAAI,eAAe;IAI9B,gBAAgB,IAAI,WAAW,EAAE;IAIjC,cAAc,IAAI,WAAW,EAAE;IAU/B,WAAW,IAAI,oBAAoB,EAAE;IAI/B,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAqB9C"}
+{"version":3,"file":"HeapAnalysisCommand.d.ts","sourceRoot":"","sources":["../../../src/commands/heap/HeapAnalysisCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAG/E,OAAO,WAAW,EAAE,EAAC,eAAe,EAAC,MAAM,mBAAmB,CAAC;AAS/D,MAAM,CAAC,OAAO,OAAO,sBAAuB,SAAQ,WAAW;IAC7D,cAAc,IAAI,MAAM;IAIxB,cAAc,IAAI,MAAM;IAIxB,WAAW,IAAI,eAAe;IAI9B,gBAAgB,IAAI,WAAW,EAAE;IAIjC,UAAU,IAAI,UAAU,EAAE;IAI1B,cAAc,IAAI,WAAW,EAAE;IAU/B,WAAW,IAAI,oBAAoB,EAAE;YAIvB,mBAAmB;IAwB3B,GAAG,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAc9C"}

package/dist/commands/heap/HeapAnalysisCommand.js

@@ -50,12 +50,13 @@ const heap_analysis_1 = require("@memlab/heap-analysis");
 const HeapAnalysisSubCommandWrapper_1 = __importDefault(require("./HeapAnalysisSubCommandWrapper"));
 const HelperCommand_1 = __importDefault(require("../helper/HelperCommand"));
 const InitDirectoryCommand_1 = __importDefault(require("../InitDirectoryCommand"));
+const HeapAnalysisPluginOption_1 = __importDefault(require("../../options/heap/HeapAnalysisPluginOption"));
 class RunHeapAnalysisCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'analyze';
     }
     getDescription() {
-        return 'Run heap analysis plugins';
+        return 'Run heap analysis on heap snapshots.\n';
     }
     getCategory() {
         return BaseCommand_1.CommandCategory.COMMON;
@@ -63,6 +64,9 @@ class RunHeapAnalysisCommand extends BaseCommand_1.default {
     getPrerequisites() {
         return [new InitDirectoryCommand_1.default()];
     }
+    getOptions() {
+        return [new HeapAnalysisPluginOption_1.default()];
+    }
     getSubCommands() {
         const analyses = [...heap_analysis_1.heapAnalysisLoader.loadAllAnalysis().values()];
         return analyses.map((analysis) => {
@@ -75,23 +79,38 @@ class RunHeapAnalysisCommand extends BaseCommand_1.default {
     getExamples() {
         return ['<PLUGIN_NAME> [PLUGIN_OPTIONS]'];
     }
+    errorIfNoSubCommand(args, analysisMap) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args && args._.length >= 2 && analysisMap.has(args._[1])) {
+                return;
+            }
+            const helper = new HelperCommand_1.default();
+            const modules = new Map();
+            for (const subCommand of this.getSubCommands()) {
+                modules.set(subCommand.getCommandName(), subCommand);
+            }
+            const errMsg = args && args._.length < 2
+                ? `\n  Heap analysis plugin name missing\n`
+                : `\n  Invalid command \`memlab ${this.getCommandName()} ${args === null || args === void 0 ? void 0 : args._[1]}\`\n`;
+            core_1.info.error(errMsg);
+            yield helper.run({ cliArgs: args, modules, command: this });
+            core_1.utils.haltOrThrow(errMsg, { printErrorBeforeHalting: false });
+        });
+    }
     run(options) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            // process command line arguments and load analysis modules
             const args = options.cliArgs;
-            const analysisMap = heap_analysis_1.heapAnalysisLoader.loadAllAnalysis();
-            if (!args || args._.length < 2 || !analysisMap.has(args._[1])) {
-                const helper = new HelperCommand_1.default();
-                const modules = new Map();
-                for (const subCommand of this.getSubCommands()) {
-                    modules.set(subCommand.getCommandName(), subCommand);
-                }
-                const errMsg = args && args._.length < 2
-                    ? `\n  Heap analysis plugin name missing\n`
-                    : `\n  Invalid command \`memlab ${this.getCommandName()} ${args === null || args === void 0 ? void 0 : args._[1]}\`\n`;
-                core_1.info.error(errMsg);
-                yield helper.run({ cliArgs: args, modules, command: this });
-                core_1.utils.haltOrThrow(errMsg, { printErrorBeforeHalting: false });
+            let plugin = (_a = options.configFromOptions) === null || _a === void 0 ? void 0 : _a.heapAnalysisPlugin;
+            if (plugin != null) {
+                plugin = `${plugin}`;
             }
+            const analysisMap = heap_analysis_1.heapAnalysisLoader.loadAllAnalysis({
+                heapAnalysisPlugin: plugin,
+                errorWhenPluginFailed: true,
+            });
+            yield this.errorIfNoSubCommand(args, analysisMap);
         });
     }
 }

package/dist/options/e2e/SetChromiumBinaryOption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SetChromiumBinaryOption.d.ts","sourceRoot":"","sources":["../../../src/options/e2e/SetChromiumBinaryOption.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAI1C,OAAO,EAAc,UAAU,EAAC,MAAM,cAAc,CAAC;AAGrD,MAAM,CAAC,OAAO,OAAO,uBAAwB,SAAQ,UAAU;IAC7D,aAAa,IAAI,MAAM;IAIvB,cAAc,IAAI,MAAM;IAIlB,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAgBnE"}
+{"version":3,"file":"SetChromiumBinaryOption.d.ts","sourceRoot":"","sources":["../../../src/options/e2e/SetChromiumBinaryOption.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAQ,UAAU,EAAC,MAAM,cAAc,CAAC;AAG/C,MAAM,CAAC,OAAO,OAAO,uBAAwB,SAAQ,UAAU;IAC7D,aAAa,IAAI,MAAM;IAIvB,cAAc,IAAI,MAAM;IAIlB,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAOnE"}

package/dist/options/e2e/SetChromiumBinaryOption.js

@@ -12,8 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
 const core_1 = require("@memlab/core");
 const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
 class SetChromiumBinaryOption extends core_1.BaseOption {
@@ -28,14 +26,7 @@ class SetChromiumBinaryOption extends core_1.BaseOption {
             const name = this.getOptionName();
             const arg = args[name];
             if (arg) {
-                const binaryPath = path_1.default.resolve(process.cwd(), arg);
-                if (!fs_1.default.existsSync(binaryPath)) {
-                    throw core_1.utils.haltOrThrow(`Chromium binary does not exist: ${binaryPath}`);
-                }
-                if (config.verbose) {
-                    core_1.info.lowLevel(`Using ${binaryPath} as Chromium binary for E2E run`);
-                }
-                config.puppeteerConfig.executablePath = binaryPath;
+                core_1.utils.setChromiumBinary(config, arg);
             }
         });
     }

package/dist/options/heap/HeapAnalysisPluginOption.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+import type { ParsedArgs } from 'minimist';
+import { MemLabConfig } from '@memlab/core';
+import { BaseOption } from '@memlab/core';
+export default class HeapAnalysisPluginOption extends BaseOption {
+    getOptionName(): string;
+    getDescription(): string;
+    parse(config: MemLabConfig, args: ParsedArgs): Promise<{
+        workDir?: string;
+    }>;
+}
+//# sourceMappingURL=HeapAnalysisPluginOption.d.ts.map

package/dist/options/heap/HeapAnalysisPluginOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HeapAnalysisPluginOption.d.ts","sourceRoot":"","sources":["../../../src/options/heap/HeapAnalysisPluginOption.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACzC,OAAO,EAAY,YAAY,EAAC,MAAM,cAAc,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AAGxC,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,UAAU;IAC9D,aAAa,IAAI,MAAM;IAIvB,cAAc,IAAI,MAAM;IAOlB,KAAK,CACT,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;CAS/B"}

package/dist/options/heap/HeapAnalysisPluginOption.js

@@ -0,0 +1,46 @@
+"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.
+ *
+ * @format
+ * @oncall web_perf_infra
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
+class HeapAnalysisPluginOption extends core_1.BaseOption {
+    getOptionName() {
+        return OptionConstant_1.default.optionNames.HEAP_ANALYSIS_PLUGIN_FILE;
+    }
+    getDescription() {
+        return ('specify the external heap analysis plugin file ' +
+            '(must be a vanilla JS file ended with `Analysis.js` suffix)');
+    }
+    parse(config, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const name = this.getOptionName();
+            const ret = {};
+            const heapAnalysisPlugin = args[name];
+            if (heapAnalysisPlugin) {
+                ret.heapAnalysisPlugin = heapAnalysisPlugin;
+            }
+            return ret;
+        });
+    }
+}
+exports.default = HeapAnalysisPluginOption;

package/dist/options/lib/OptionConstant.d.ts

@@ -24,6 +24,7 @@ declare const optionConstants: {
         FINAL: string;
         FULL: string;
         HEADFUL: string;
+        HEAP_ANALYSIS_PLUGIN_FILE: string;
         HELP: string;
         IGNORE_LEAK_CLUSTER_SIZE_BELOW: string;
         INTERACTION: string;
@@ -87,6 +88,7 @@ declare const _default: {
         FINAL: string;
         FULL: string;
         HEADFUL: string;
+        HEAP_ANALYSIS_PLUGIN_FILE: string;
         HELP: string;
         IGNORE_LEAK_CLUSTER_SIZE_BELOW: string;
         INTERACTION: string;

package/dist/options/lib/OptionConstant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OptionConstant.d.ts","sourceRoot":"","sources":["../../../src/options/lib/OptionConstant.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAkEH,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGpB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACrD,wBAIE"}
+{"version":3,"file":"OptionConstant.d.ts","sourceRoot":"","sources":["../../../src/options/lib/OptionConstant.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAmEH,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAGpB,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACrD,wBAIE"}

package/dist/options/lib/OptionConstant.js

@@ -26,6 +26,7 @@ const optionNames = {
     FINAL: 'final',
     FULL: 'full',
     HEADFUL: 'headful',
+    HEAP_ANALYSIS_PLUGIN_FILE: 'analysis-plugin',
     HELP: 'help',
     IGNORE_LEAK_CLUSTER_SIZE_BELOW: 'ignore-leak-cluster-size-below',
     INTERACTION: 'interaction',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/cli",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "license": "MIT",
   "description": "command line interface for memlab",
   "author": "Liang Gong <lgong@fb.com>",
@@ -26,10 +26,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@memlab/api": "^1.0.11",
-    "@memlab/core": "^1.1.13",
-    "@memlab/e2e": "^1.0.11",
-    "@memlab/heap-analysis": "^1.0.7",
+    "@memlab/api": "^1.0.27",
+    "@memlab/core": "^1.1.28",
+    "@memlab/e2e": "^1.0.28",
+    "@memlab/heap-analysis": "^1.0.25",
     "ansi": "^0.3.1",
     "babar": "^0.2.0",
     "blessed": "^0.1.81",