@memlab/cli 1.0.4 → 1.0.7

package/README.md

@@ -3,5 +3,6 @@
 This is the memlab CLI library. It contains all memlab commands, command-line options, and command-line interfaces.
 The library supports adding new commands.
 
-## Full documentation
-https://facebookincubator.github.io/memlab
+## Online Resources
+* [Official Website and Demo](https://facebookincubator.github.io/memlab)
+* [Documentation](https://facebookincubator.github.io/memlab/docs/intro)

package/bin/memlab

@@ -10,5 +10,10 @@
  * @format
  */
 
-var cli = require("@memlab/cli");
-cli.run();
+var cli = require("../dist/index");
+
+// register the `@memlab/cli` package info
+// so that `memlab version` get use the info
+(cli.registerPackage()).then(() => {
+  cli.run();
+});

package/dist/commands/GetVersionCommand.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { CLIOptions } from '@memlab/core';
+import BaseCommand from '../BaseCommand';
+export default class GetVersionCommand extends BaseCommand {
+    getCommandName(): string;
+    getDescription(): string;
+    private loadDepencyPackageInfo;
+    run(options: CLIOptions): Promise<void>;
+}
+//# sourceMappingURL=GetVersionCommand.d.ts.map

package/dist/commands/GetVersionCommand.js

@@ -0,0 +1,69 @@
+"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 __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 chalk_1 = __importDefault(require("chalk"));
+const BaseCommand_1 = __importDefault(require("../BaseCommand"));
+const core_1 = require("@memlab/core");
+const api_1 = require("@memlab/api");
+const core_2 = require("@memlab/core");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+const e2e_1 = require("@memlab/e2e");
+class GetVersionCommand extends BaseCommand_1.default {
+    getCommandName() {
+        return 'version';
+    }
+    getDescription() {
+        return 'Show the versions of all memlab packages installed';
+    }
+    loadDepencyPackageInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // require all sub-packages to register package information
+            // memlab and cli packages already registered in the bin file
+            // the following sub-packages are registered here lazily to
+            // avoid too many file operations
+            return Promise.all([
+                (0, api_1.registerPackage)(),
+                (0, core_2.registerPackage)(),
+                (0, heap_analysis_1.registerPackage)(),
+                (0, e2e_1.registerPackage)(),
+            ]);
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    run(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadDepencyPackageInfo();
+            const packages = core_1.config.packageInfo;
+            core_1.info.topLevel('');
+            for (const pkg of packages) {
+                const version = chalk_1.default.grey(`@${pkg.version}`);
+                core_1.info.topLevel(` ${pkg.name}${version}`);
+                if (core_1.config.verbose && pkg.packageLocation) {
+                    core_1.info.lowLevel(`  ${pkg.packageLocation}`);
+                }
+            }
+            core_1.info.topLevel('');
+        });
+    }
+}
+exports.default = GetVersionCommand;

package/dist/commands/RunMeasureCommand.js

@@ -40,6 +40,7 @@ const ScenarioFileOption_1 = __importDefault(require("../options/ScenarioFileOpt
 const SetDeviceOption_1 = __importDefault(require("../options/SetDeviceOption"));
 const DisableXvfbOption_1 = __importDefault(require("../options/DisableXvfbOption"));
 const NumberOfRunsOption_1 = __importDefault(require("../options/NumberOfRunsOption"));
+const HeadfulBrowserOption_1 = __importDefault(require("../options/HeadfulBrowserOption"));
 class RunMeasureCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'measure';
@@ -59,6 +60,7 @@ class RunMeasureCommand extends BaseCommand_1.default {
     }
     getOptions() {
         return [
+            new HeadfulBrowserOption_1.default(),
             new NumberOfRunsOption_1.default(),
             new AppOption_1.default(),
             new InteractionOption_1.default(),

package/dist/commands/WarmupAppCommand.js

@@ -33,6 +33,7 @@ const SetDeviceOption_1 = __importDefault(require("../options/SetDeviceOption"))
 const DisableXvfbOption_1 = __importDefault(require("../options/DisableXvfbOption"));
 const SkipWarmupOption_1 = __importDefault(require("../options/SkipWarmupOption"));
 const CheckXvfbSupportCommand_1 = __importDefault(require("./snapshot/CheckXvfbSupportCommand"));
+const HeadfulBrowserOption_1 = __importDefault(require("../options/HeadfulBrowserOption"));
 class FBWarmupAppCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'warmup';
@@ -51,6 +52,7 @@ class FBWarmupAppCommand extends BaseCommand_1.default {
     }
     getOptions() {
         return [
+            new HeadfulBrowserOption_1.default(),
             new AppOption_1.default(),
             new InteractionOption_1.default(),
             new RunningModeOption_1.default(),

package/dist/commands/heap/CheckLeakCommand.js

@@ -58,6 +58,8 @@ const LogTraceAsClusterOption_1 = __importDefault(require("../../options/heap/Lo
 const CleanLoggerDataCommand_1 = __importDefault(require("../CleanLoggerDataCommand"));
 const LeakFilterFileOption_1 = __importDefault(require("../../options/heap/leak-filter/LeakFilterFileOption"));
 const LeakClusterSizeThresholdOption_1 = __importDefault(require("../../options/heap/LeakClusterSizeThresholdOption"));
+const MLClusteringOption_1 = __importDefault(require("../../options/MLClusteringOption"));
+const MLClusteringLinkageMaxDistanceOption_1 = __importDefault(require("../../options/MLClusteringLinkageMaxDistanceOption"));
 class CheckLeakCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'find-leaks';
@@ -83,6 +85,8 @@ class CheckLeakCommand extends BaseCommand_1.default {
             new LeakClusterSizeThresholdOption_1.default(),
             new TraceAllObjectsOption_1.default(),
             new LogTraceAsClusterOption_1.default(),
+            new MLClusteringOption_1.default(),
+            new MLClusteringLinkageMaxDistanceOption_1.default(),
         ];
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/dist/commands/snapshot/TakeSnapshotCommand.js

@@ -39,6 +39,7 @@ const SetDeviceOption_1 = __importDefault(require("../../options/SetDeviceOption
 const DisableXvfbOption_1 = __importDefault(require("../../options/DisableXvfbOption"));
 const InitDirectoryCommand_1 = __importDefault(require("../InitDirectoryCommand"));
 const CheckXvfbSupportCommand_1 = __importDefault(require("./CheckXvfbSupportCommand"));
+const HeadfulBrowserOption_1 = __importDefault(require("../../options/HeadfulBrowserOption"));
 class TakeSnapshotCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'snapshot';
@@ -62,6 +63,7 @@ class TakeSnapshotCommand extends BaseCommand_1.default {
     }
     getOptions() {
         return [
+            new HeadfulBrowserOption_1.default(),
             new AppOption_1.default(),
             new InteractionOption_1.default(),
             new FullExecutionOption_1.default(),

package/dist/index.d.ts

@@ -7,5 +7,7 @@
  * @emails oncall+ws_labs
  * @format
  */
+/** @internal */
+export declare function registerPackage(): Promise<void>;
 export * from './runner';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -22,5 +22,27 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+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 });
+exports.registerPackage = void 0;
+const path_1 = __importDefault(require("path"));
+const core_1 = require("@memlab/core");
+/** @internal */
+function registerPackage() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return core_1.PackageInfoLoader.registerPackage(path_1.default.join(__dirname, '..'));
+    });
+}
+exports.registerPackage = registerPackage;
 __exportStar(require("./runner"), exports);

package/dist/options/HeadfulBrowserOption.d.ts

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

package/dist/options/HeadfulBrowserOption.js

@@ -0,0 +1,37 @@
+"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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+class HeadfulBrowserOption extends core_1.BaseOption {
+    getOptionName() {
+        return 'headful';
+    }
+    getDescription() {
+        return 'start the browser in headful mode, but default it is headless';
+    }
+    parse(config, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args[this.getOptionName()]) {
+                config.isHeadfulBrowser = true;
+            }
+        });
+    }
+}
+exports.default = HeadfulBrowserOption;

package/dist/options/MLClusteringLinkageMaxDistanceOption.d.ts

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

package/dist/options/MLClusteringLinkageMaxDistanceOption.js

@@ -0,0 +1,47 @@
+"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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const core_2 = require("@memlab/core");
+class MLClusteringLinkageMaxDistanceOption extends core_2.BaseOption {
+    getOptionName() {
+        return 'ml-linkage-max-dist';
+    }
+    getDescription() {
+        return 'set linkage max distance value for clustering. The value should be between [0, 1] inclusive.';
+    }
+    parse(config, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args['ml-linkage-max-dist']) {
+                const linkageMaxDist = args['ml-linkage-max-dist'];
+                const linkageMaxDistNum = parseFloat(linkageMaxDist);
+                if (!isNaN(linkageMaxDistNum) &&
+                    linkageMaxDistNum >= 0 &&
+                    linkageMaxDistNum <= 1) {
+                    config.mlClusteringLinkageMaxDistance = linkageMaxDistNum;
+                }
+                else {
+                    core_1.utils.haltOrThrow(`ml-linkage-max-dist is not number between [0, 1]. ml-linkage-max-dist=${linkageMaxDist}`);
+                }
+            }
+        });
+    }
+}
+exports.default = MLClusteringLinkageMaxDistanceOption;

package/dist/options/MLClusteringOption.d.ts

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

package/dist/options/MLClusteringOption.js

@@ -0,0 +1,37 @@
+"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 __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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+class MLClusteringOption extends core_1.BaseOption {
+    getOptionName() {
+        return 'ml-clustering';
+    }
+    getDescription() {
+        return 'use machine learning algorithms for clustering leak traces (by default, traces are clustered by heuristics)';
+    }
+    parse(config, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (args['ml-clustering']) {
+                config.isMLClustering = true;
+            }
+        });
+    }
+}
+exports.default = MLClusteringOption;

package/dist/options/heap/JSEngineOption.js

@@ -24,10 +24,10 @@ class JSEngineOption extends core_1.BaseOption {
         return 'engine';
     }
     getDescription() {
-        return 'set the JavaScript engine (default to v8)';
+        return 'set the JavaScript engine (default to V8)';
     }
     getExampleValues() {
-        return ['v8', 'hermes'];
+        return ['V8', 'hermes'];
     }
     parse(config, args) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/options/heap/leak-filter/examples/large-object-as-leak.example.js

@@ -5,7 +5,6 @@
  * 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
  * @oncall ws_labs
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/cli",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "license": "MIT",
   "description": "command line interface for memlab",
   "author": "Liang Gong <lgong@fb.com>",
@@ -24,10 +24,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@memlab/api": "^1.0.0",
-    "@memlab/core": "^1.0.0",
-    "@memlab/e2e": "^1.0.0",
-    "@memlab/heap-analysis": "^1.0.0",
+    "@memlab/api": "^1.0.6",
+    "@memlab/core": "^1.1.6",
+    "@memlab/e2e": "^1.0.7",
+    "@memlab/heap-analysis": "^1.0.5",
     "ansi": "^0.3.1",
     "babar": "^0.2.0",
     "chalk": "^4.0.0",