@memlab/cli 1.0.17 → 1.0.20

package/dist/options/e2e/SkipScrollOption.js

@@ -17,18 +17,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 SkipScrollOption extends core_1.BaseOption {
     getOptionName() {
-        return 'skip-scroll';
+        return OptionConstant_1.default.optionNames.SKIP_SCROLL;
     }
     getDescription() {
         return 'skip scrolling target page in browser';
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (args['skip-scroll']) {
+            if (args[this.getOptionName()]) {
                 config.skipScroll = true;
             }
         });

package/dist/options/e2e/SkipSnapshotOption.js

@@ -17,18 +17,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 SkipSnapshotOption extends core_1.BaseOption {
     getOptionName() {
-        return 'skip-snapshot';
+        return OptionConstant_1.default.optionNames.SKIP_SNAPSHOT;
     }
     getDescription() {
         return 'skip taking heap snapshots';
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (args['skip-snapshot']) {
+            if (args[this.getOptionName()]) {
                 config.skipSnapshot = true;
             }
         });

package/dist/options/e2e/SkipWarmupOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 SkipWarmupOption extends core_1.BaseOption {
     getOptionName() {
-        return 'skip-warmup';
+        return OptionConstant_1.default.optionNames.SKIP_WARMUP;
     }
     getDescription() {
         return 'skip warming up web server';

package/dist/options/heap/BaselineFileOption.js

@@ -23,9 +23,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const core_1 = require("@memlab/core");
+const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
 class BaselineFileOption extends core_1.BaseOption {
     getOptionName() {
-        return 'baseline';
+        return OptionConstant_1.default.optionNames.BASELINE;
     }
     getDescription() {
         return 'set file path of the baseline heap snapshot';
@@ -35,10 +36,11 @@ class BaselineFileOption extends core_1.BaseOption {
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!args.baseline) {
+            const name = this.getOptionName();
+            if (!args[name]) {
                 return;
             }
-            const file = args.baseline;
+            const file = args[name];
             if (!fs_1.default.existsSync(file)) {
                 core_1.utils.haltOrThrow(`Invalid snapshot file: ${file}`);
             }

package/dist/options/heap/FinalFileOption.js

@@ -23,9 +23,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const core_1 = require("@memlab/core");
+const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
 class FinalFileOption extends core_1.BaseOption {
     getOptionName() {
-        return 'final';
+        return OptionConstant_1.default.optionNames.FINAL;
     }
     getDescription() {
         return 'set file path of the final heap snapshot';
@@ -35,10 +36,11 @@ class FinalFileOption extends core_1.BaseOption {
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!args.final) {
+            const name = this.getOptionName();
+            if (!args[name]) {
                 return;
             }
-            const file = args.final;
+            const file = args[name];
             if (!fs_1.default.existsSync(file)) {
                 core_1.utils.haltOrThrow(`Invalid snapshot file: ${file}`);
             }

package/dist/options/heap/HeapNodeIdOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 HeapNodeIdOption extends core_1.BaseOption {
     getOptionName() {
-        return 'node-id';
+        return OptionConstant_1.default.optionNames.NODE_ID;
     }
     getDescription() {
         return 'set heap node ID';

package/dist/options/heap/JSEngineOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 JSEngineOption extends core_1.BaseOption {
     getOptionName() {
-        return 'engine';
+        return OptionConstant_1.default.optionNames.ENGINE;
     }
     getDescription() {
         return 'set the JavaScript engine (default to V8)';
@@ -31,10 +35,11 @@ class JSEngineOption extends core_1.BaseOption {
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!args.engine) {
+            const name = this.getOptionName();
+            if (!args[name]) {
                 return;
             }
-            config.jsEngine = args.engine;
+            config.jsEngine = args[name];
             config.specifiedEngine = true;
             if (core_1.constant.supportedEngines.indexOf(config.jsEngine) < 0) {
                 core_1.utils.haltOrThrow(`Invalid engine: ${config.jsEngine} ` +

package/dist/options/heap/LeakClusterSizeThresholdOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 LeakClusterSizeThresholdOption extends core_1.BaseOption {
     getOptionName() {
-        return 'ignore-leak-cluster-size-below';
+        return OptionConstant_1.default.optionNames.IGNORE_LEAK_CLUSTER_SIZE_BELOW;
     }
     getDescription() {
         return 'ignore memory leaks with aggregated retained size smaller than the threshold';

package/dist/options/heap/LogTraceAsClusterOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 LogTraceAsClusterOption extends core_1.BaseOption {
     getOptionName() {
-        return 'save-trace-as-unclassified-cluster';
+        return OptionConstant_1.default.optionNames.SAVE_TRACE_AS_UNCLASSIFIED_CLUSTER;
     }
     getDescription() {
         return 'dump each retainer trace as an unclassified trace cluster';

package/dist/options/heap/OversizeThresholdOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 OversizeThresholdOption extends core_1.BaseOption {
     getOptionName() {
-        return 'trace-object-size-above';
+        return OptionConstant_1.default.optionNames.TRACE_OBJECT_SIZE_ABOVE;
     }
     getDescription() {
         return ('objects with retained size (bytes) ' +

package/dist/options/heap/SnapshotDirectoryOption.js

@@ -23,9 +23,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const core_1 = require("@memlab/core");
+const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
 class SnapshotDirectoryOption extends core_1.BaseOption {
     getOptionName() {
-        return 'snapshot-dir';
+        return OptionConstant_1.default.optionNames.SNAPSHOT_DIR;
     }
     getDescription() {
         return 'set directory path containing all heap snapshots under analysis';
@@ -35,10 +36,11 @@ class SnapshotDirectoryOption extends core_1.BaseOption {
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!args['snapshot-dir']) {
+            const name = this.getOptionName();
+            if (!args[name]) {
                 return;
             }
-            const dir = args['snapshot-dir'];
+            const dir = args[name];
             if (!fs_1.default.existsSync(dir)) {
                 core_1.utils.haltOrThrow(`Invalid directory: ${dir}`);
             }

package/dist/options/heap/SnapshotFileOption.js

@@ -23,9 +23,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const core_1 = require("@memlab/core");
+const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
 class SnapshotFileOption extends core_1.BaseOption {
     getOptionName() {
-        return 'snapshot';
+        return OptionConstant_1.default.optionNames.SNAPSHOT;
     }
     getDescription() {
         return 'set file path of the heap snapshot under analysis';
@@ -35,10 +36,11 @@ class SnapshotFileOption extends core_1.BaseOption {
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!args.snapshot) {
+            const name = this.getOptionName();
+            if (!args[name]) {
                 return;
             }
-            const file = args.snapshot;
+            const file = args[name];
             if (!fs_1.default.existsSync(file)) {
                 core_1.utils.haltOrThrow(`Invalid snapshot file: ${file}`);
             }

package/dist/options/heap/TargetFileOption.js

@@ -23,9 +23,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const core_1 = require("@memlab/core");
+const OptionConstant_1 = __importDefault(require("../lib/OptionConstant"));
 class TargetFileOption extends core_1.BaseOption {
     getOptionName() {
-        return 'target';
+        return OptionConstant_1.default.optionNames.TARGET;
     }
     getDescription() {
         return 'set file path of the target heap snapshot';
@@ -35,10 +36,11 @@ class TargetFileOption extends core_1.BaseOption {
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!args.target) {
+            const name = this.getOptionName();
+            if (!args[name]) {
                 return;
             }
-            const file = args.target;
+            const file = args[name];
             if (!fs_1.default.existsSync(file)) {
                 core_1.utils.haltOrThrow(`Invalid snapshot file: ${file}`);
             }

package/dist/options/heap/TraceAllObjectsOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 TraceAllObjectsOption extends core_1.BaseOption {
     getOptionName() {
-        return 'trace-all-objects';
+        return OptionConstant_1.default.optionNames.TRACE_ALL_OBJECTS;
     }
     getDescription() {
         return 'dump retainer trace for all allocated objects (ignore the leak filter)';

package/dist/options/heap/leak-filter/LeakFilterFileOption.js

@@ -17,11 +17,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 LeakFilterFileOption extends core_1.BaseOption {
     getOptionName() {
-        return 'leak-filter';
+        return OptionConstant_1.default.optionNames.LEAK_FILTER;
     }
     getDescription() {
         return 'specify a definition JS file for leak filter';

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

@@ -0,0 +1,116 @@
+/**
+ * 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
+ */
+declare const optionConstants: {
+    optionNames: {
+        APP: string;
+        BASELINE: string;
+        CONTINUS_TEST: string;
+        DEVICE: string;
+        DISABLE_WEB_SECURITY: string;
+        DISABLE_XVFB: string;
+        ENGINE: string;
+        FINAL: string;
+        FULL: string;
+        HEADFUL: string;
+        HELP: string;
+        IGNORE_LEAK_CLUSTER_SIZE_BELOW: string;
+        INTERACTION: string;
+        LEAK_FILTER: string;
+        LOCAL_PUPPETEER: string;
+        LOG_SCRIPT: string;
+        ML_CLUSTERING: string;
+        ML_CLUSTERING_MAX_DF: string;
+        ML_LINKAGE_MAX_DIST: string;
+        NODE_ID: string;
+        REWRITE_JS: string;
+        RUN_MODE: string;
+        RUN_NUM: string;
+        SAVE_TRACE_AS_UNCLASSIFIED_CLUSTER: string;
+        SC: string;
+        SCENARIO: string;
+        SILENT: string;
+        SKIP_EXTRA_OP: string;
+        SKIP_EXTRA_OPS: string;
+        SKIP_GC: string;
+        SKIP_SCREENSHOT: string;
+        SKIP_SCROLL: string;
+        SKIP_SNAPSHOT: string;
+        SKIP_WARMUP: string;
+        SNAPSHOT: string;
+        SNAPSHOT_DIR: string;
+        TARGET: string;
+        TRACE_ALL_OBJECTS: string;
+        TRACE_OBJECT_SIZE_ABOVE: string;
+        USER_AGENT: string;
+        VERBOSE: string;
+        WORK_DIR: string;
+        DEBUG: string;
+    };
+    optionShortcuts: {
+        H: string;
+        S: string;
+        V: string;
+    };
+};
+export declare type OptionConstants = typeof optionConstants;
+declare const _default: {
+    optionNames: {
+        APP: string;
+        BASELINE: string;
+        CONTINUS_TEST: string;
+        DEVICE: string;
+        DISABLE_WEB_SECURITY: string;
+        DISABLE_XVFB: string;
+        ENGINE: string;
+        FINAL: string;
+        FULL: string;
+        HEADFUL: string;
+        HELP: string;
+        IGNORE_LEAK_CLUSTER_SIZE_BELOW: string;
+        INTERACTION: string;
+        LEAK_FILTER: string;
+        LOCAL_PUPPETEER: string;
+        LOG_SCRIPT: string;
+        ML_CLUSTERING: string;
+        ML_CLUSTERING_MAX_DF: string;
+        ML_LINKAGE_MAX_DIST: string;
+        NODE_ID: string;
+        REWRITE_JS: string;
+        RUN_MODE: string;
+        RUN_NUM: string;
+        SAVE_TRACE_AS_UNCLASSIFIED_CLUSTER: string;
+        SC: string;
+        SCENARIO: string;
+        SILENT: string;
+        SKIP_EXTRA_OP: string;
+        SKIP_EXTRA_OPS: string;
+        SKIP_GC: string;
+        SKIP_SCREENSHOT: string;
+        SKIP_SCROLL: string;
+        SKIP_SNAPSHOT: string;
+        SKIP_WARMUP: string;
+        SNAPSHOT: string;
+        SNAPSHOT_DIR: string;
+        TARGET: string;
+        TRACE_ALL_OBJECTS: string;
+        TRACE_OBJECT_SIZE_ABOVE: string;
+        USER_AGENT: string;
+        VERBOSE: string;
+        WORK_DIR: string;
+        DEBUG: string;
+    };
+    optionShortcuts: {
+        H: string;
+        S: string;
+        V: string;
+    };
+};
+export default _default;
+//# sourceMappingURL=OptionConstant.d.ts.map

package/dist/options/lib/OptionConstant.js

@@ -0,0 +1,67 @@
+"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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const optionNames = {
+    APP: 'app',
+    BASELINE: 'baseline',
+    CONTINUS_TEST: 'ContinuousTest',
+    DEVICE: 'device',
+    DISABLE_WEB_SECURITY: 'disable-web-security',
+    DISABLE_XVFB: 'disable-xvfb',
+    ENGINE: 'engine',
+    FINAL: 'final',
+    FULL: 'full',
+    HEADFUL: 'headful',
+    HELP: 'help',
+    IGNORE_LEAK_CLUSTER_SIZE_BELOW: 'ignore-leak-cluster-size-below',
+    INTERACTION: 'interaction',
+    LEAK_FILTER: 'leak-filter',
+    LOCAL_PUPPETEER: 'local-puppeteer',
+    LOG_SCRIPT: 'log-script',
+    ML_CLUSTERING: 'ml-clustering',
+    ML_CLUSTERING_MAX_DF: 'ml-clustering-max-df',
+    ML_LINKAGE_MAX_DIST: 'ml-linkage-max-dist',
+    NODE_ID: 'node-id',
+    REWRITE_JS: 'rewrite-js',
+    RUN_MODE: 'run-mode',
+    RUN_NUM: 'run-num',
+    SAVE_TRACE_AS_UNCLASSIFIED_CLUSTER: 'save-trace-as-unclassified-cluster',
+    SC: 'sc',
+    SCENARIO: 'scenario',
+    SILENT: 'silent',
+    SKIP_EXTRA_OP: 'skip-extra-op',
+    SKIP_EXTRA_OPS: 'skip-extra-ops',
+    SKIP_GC: 'skip-gc',
+    SKIP_SCREENSHOT: 'skip-screenshot',
+    SKIP_SCROLL: 'skip-scroll',
+    SKIP_SNAPSHOT: 'skip-snapshot',
+    SKIP_WARMUP: 'skip-warmup',
+    SNAPSHOT: 'snapshot',
+    SNAPSHOT_DIR: 'snapshot-dir',
+    TARGET: 'target',
+    TRACE_ALL_OBJECTS: 'trace-all-objects',
+    TRACE_OBJECT_SIZE_ABOVE: 'trace-object-size-above',
+    USER_AGENT: 'user-agent',
+    VERBOSE: 'verbose',
+    WORK_DIR: 'work-dir',
+    DEBUG: 'debug',
+};
+const optionShortcuts = {
+    H: 'h',
+    S: 's',
+    V: 'v',
+};
+const optionConstants = {
+    optionNames,
+    optionShortcuts,
+};
+exports.default = (0, core_1.setInternalValue)(optionConstants, __filename, core_1.constant.internalDir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/cli",
-  "version": "1.0.17",
+  "version": "1.0.20",
   "license": "MIT",
   "description": "command line interface for memlab",
   "author": "Liang Gong <lgong@fb.com>",
@@ -60,7 +60,7 @@
   "scripts": {
     "preinstall": "node bin/preinstall",
     "build-pkg": "tsc",
-    "publish-patch": "npm version patch --force && npm publish",
+    "publish-patch": "npm publish",
     "clean-pkg": "rm -rf ./dist && rm -rf ./node_modules && rm -f ./tsconfig.tsbuildinfo"
   },
   "bugs": {