@memlab/cli 1.0.13 → 1.0.15

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/bin/preinstall

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+/**
+ * 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 ws_labs
+ */
+
+const path = require("path");
+const fs = require("fs");
+if (process.platform !== "win32") {
+  const memlabFile = path.join(__dirname, "../bin/memlab.js");
+  const content = fs.readFileSync(memlabFile, "UTF-8");
+  fs.writeFileSync(
+    memlabFile,
+    content.replace("#!/usr/bin/env node", "#!/usr/bin/env -S node"),
+    "UTF-8"
+  );
+}

package/dist/commands/MemLabRunCommand.js

@@ -52,10 +52,10 @@ const CheckLeakCommand_1 = __importDefault(require("./heap/CheckLeakCommand"));
 const InitDirectoryCommand_1 = __importDefault(require("./InitDirectoryCommand"));
 const TakeSnapshotCommand_1 = __importDefault(require("./snapshot/TakeSnapshotCommand"));
 const SetWorkingDirectoryOption_1 = __importDefault(require("../options/SetWorkingDirectoryOption"));
-const AppOption_1 = __importDefault(require("../options/AppOption"));
-const InteractionOption_1 = __importDefault(require("../options/InteractionOption"));
-const SkipSnapshotOption_1 = __importDefault(require("../options/SkipSnapshotOption"));
-const RunningModeOption_1 = __importDefault(require("../options/RunningModeOption"));
+const AppOption_1 = __importDefault(require("../options/e2e/AppOption"));
+const InteractionOption_1 = __importDefault(require("../options/e2e/InteractionOption"));
+const SkipSnapshotOption_1 = __importDefault(require("../options/e2e/SkipSnapshotOption"));
+const RunningModeOption_1 = __importDefault(require("../options/e2e/RunningModeOption"));
 const BaselineFileOption_1 = __importDefault(require("../options/heap/BaselineFileOption"));
 const TargetFileOption_1 = __importDefault(require("../options/heap/TargetFileOption"));
 const FinalFileOption_1 = __importDefault(require("../options/heap/FinalFileOption"));

package/dist/commands/RunMeasureCommand.js

@@ -26,21 +26,22 @@ const InitDirectoryCommand_1 = __importDefault(require("./InitDirectoryCommand")
 const core_1 = require("@memlab/core");
 const CleanRunDataCommand_1 = __importDefault(require("./CleanRunDataCommand"));
 const Snapshot_1 = require("./snapshot/Snapshot");
-const AppOption_1 = __importDefault(require("../options/AppOption"));
-const FullExecutionOption_1 = __importDefault(require("../options/FullExecutionOption"));
-const InteractionOption_1 = __importDefault(require("../options/InteractionOption"));
-const SkipScreenshotOption_1 = __importDefault(require("../options/SkipScreenshotOption"));
-const SkipSnapshotOption_1 = __importDefault(require("../options/SkipSnapshotOption"));
-const SkipGCOption_1 = __importDefault(require("../options/SkipGCOption"));
-const SkipScrollOption_1 = __importDefault(require("../options/SkipScrollOption"));
-const SkipExtraOperationOption_1 = __importDefault(require("../options/SkipExtraOperationOption"));
-const RunningModeOption_1 = __importDefault(require("../options/RunningModeOption"));
-const RemoteBrowserDebugOption_1 = __importDefault(require("../options/RemoteBrowserDebugOption"));
-const ScenarioFileOption_1 = __importDefault(require("../options/ScenarioFileOption"));
-const SetDeviceOption_1 = __importDefault(require("../options/SetDeviceOption"));
-const DisableXvfbOption_1 = __importDefault(require("../options/DisableXvfbOption"));
+const AppOption_1 = __importDefault(require("../options/e2e/AppOption"));
+const FullExecutionOption_1 = __importDefault(require("../options/e2e/FullExecutionOption"));
+const InteractionOption_1 = __importDefault(require("../options/e2e/InteractionOption"));
+const SkipScreenshotOption_1 = __importDefault(require("../options/e2e/SkipScreenshotOption"));
+const SkipSnapshotOption_1 = __importDefault(require("../options/e2e/SkipSnapshotOption"));
+const SkipGCOption_1 = __importDefault(require("../options/e2e/SkipGCOption"));
+const SkipScrollOption_1 = __importDefault(require("../options/e2e/SkipScrollOption"));
+const SkipExtraOperationOption_1 = __importDefault(require("../options/e2e/SkipExtraOperationOption"));
+const RunningModeOption_1 = __importDefault(require("../options/e2e/RunningModeOption"));
+const RemoteBrowserDebugOption_1 = __importDefault(require("../options/e2e/RemoteBrowserDebugOption"));
+const ScenarioFileOption_1 = __importDefault(require("../options/e2e/ScenarioFileOption"));
+const SetDeviceOption_1 = __importDefault(require("../options/e2e/SetDeviceOption"));
+const SetUserAgentOption_1 = __importDefault(require("../options/e2e/SetUserAgentOption"));
+const DisableXvfbOption_1 = __importDefault(require("../options/e2e/DisableXvfbOption"));
 const NumberOfRunsOption_1 = __importDefault(require("../options/NumberOfRunsOption"));
-const HeadfulBrowserOption_1 = __importDefault(require("../options/HeadfulBrowserOption"));
+const HeadfulBrowserOption_1 = __importDefault(require("../options/e2e/HeadfulBrowserOption"));
 class RunMeasureCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'measure';
@@ -74,6 +75,7 @@ class RunMeasureCommand extends BaseCommand_1.default {
             new RemoteBrowserDebugOption_1.default(),
             new ScenarioFileOption_1.default(),
             new SetDeviceOption_1.default(),
+            new SetUserAgentOption_1.default(),
             new DisableXvfbOption_1.default(),
         ];
     }

package/dist/commands/WarmupAppCommand.js

@@ -24,16 +24,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const BaseCommand_1 = __importDefault(require("../BaseCommand"));
 const api_1 = require("@memlab/api");
 const InitDirectoryCommand_1 = __importDefault(require("./InitDirectoryCommand"));
-const AppOption_1 = __importDefault(require("../options/AppOption"));
-const InteractionOption_1 = __importDefault(require("../options/InteractionOption"));
-const RunningModeOption_1 = __importDefault(require("../options/RunningModeOption"));
-const RemoteBrowserDebugOption_1 = __importDefault(require("../options/RemoteBrowserDebugOption"));
-const ScenarioFileOption_1 = __importDefault(require("../options/ScenarioFileOption"));
-const SetDeviceOption_1 = __importDefault(require("../options/SetDeviceOption"));
-const DisableXvfbOption_1 = __importDefault(require("../options/DisableXvfbOption"));
-const SkipWarmupOption_1 = __importDefault(require("../options/SkipWarmupOption"));
+const AppOption_1 = __importDefault(require("../options/e2e/AppOption"));
+const InteractionOption_1 = __importDefault(require("../options/e2e/InteractionOption"));
+const RunningModeOption_1 = __importDefault(require("../options/e2e/RunningModeOption"));
+const RemoteBrowserDebugOption_1 = __importDefault(require("../options/e2e/RemoteBrowserDebugOption"));
+const ScenarioFileOption_1 = __importDefault(require("../options/e2e/ScenarioFileOption"));
+const SetDeviceOption_1 = __importDefault(require("../options/e2e/SetDeviceOption"));
+const SetUserAgentOption_1 = __importDefault(require("../options/e2e/SetUserAgentOption"));
+const DisableXvfbOption_1 = __importDefault(require("../options/e2e/DisableXvfbOption"));
+const SkipWarmupOption_1 = __importDefault(require("../options/e2e/SkipWarmupOption"));
 const CheckXvfbSupportCommand_1 = __importDefault(require("./snapshot/CheckXvfbSupportCommand"));
-const HeadfulBrowserOption_1 = __importDefault(require("../options/HeadfulBrowserOption"));
+const HeadfulBrowserOption_1 = __importDefault(require("../options/e2e/HeadfulBrowserOption"));
 class FBWarmupAppCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'warmup';
@@ -59,6 +60,7 @@ class FBWarmupAppCommand extends BaseCommand_1.default {
             new RemoteBrowserDebugOption_1.default(),
             new ScenarioFileOption_1.default(),
             new SetDeviceOption_1.default(),
+            new SetUserAgentOption_1.default(),
             new DisableXvfbOption_1.default(),
             new SkipWarmupOption_1.default(),
         ];

package/dist/commands/heap/GetRetainerTraceCommand.js

@@ -49,7 +49,7 @@ const BaseCommand_1 = __importStar(require("../../BaseCommand"));
 const core_1 = require("@memlab/core");
 const SnapshotFileOption_1 = __importDefault(require("../../options/heap/SnapshotFileOption"));
 const JSEngineOption_1 = __importDefault(require("../../options/heap/JSEngineOption"));
-const HeapNodeIdOption_1 = __importDefault(require("../../options/HeapNodeIdOption"));
+const HeapNodeIdOption_1 = __importDefault(require("../../options/heap/HeapNodeIdOption"));
 const SnapshotDirectoryOption_1 = __importDefault(require("../../options/heap/SnapshotDirectoryOption"));
 const core_2 = require("@memlab/core");
 function calculateRetainerTrace() {

package/dist/commands/heap/interactive/InteractiveHeapExploreCommand.js

@@ -51,7 +51,7 @@ const BaseCommand_1 = __importStar(require("../../../BaseCommand"));
 const SnapshotFileOption_1 = __importDefault(require("../../../options/heap/SnapshotFileOption"));
 const JSEngineOption_1 = __importDefault(require("../../../options/heap/JSEngineOption"));
 const CliScreen_1 = __importDefault(require("./ui-components/CliScreen"));
-const HeapNodeIdOption_1 = __importDefault(require("../../../options/HeapNodeIdOption"));
+const HeapNodeIdOption_1 = __importDefault(require("../../../options/heap/HeapNodeIdOption"));
 const MLClusteringOption_1 = __importDefault(require("../../../options/MLClusteringOption"));
 class InteractiveHeapViewCommand extends BaseCommand_1.default {
     getCommandName() {

package/dist/commands/heap/interactive/ui-components/CliScreen.js

@@ -63,11 +63,16 @@ class CliScreen {
         if (keys.length === 0) {
             return;
         }
-        const nodes = objectCategory.get(keys[0]);
-        if (!nodes || nodes.length === 0) {
-            return;
+        let nodes;
+        for (const key of keys) {
+            nodes = objectCategory.get(key);
+            if (nodes && nodes.length > 0) {
+                break;
+            }
+        }
+        if (nodes && nodes.length > 0) {
+            this.heapController.setCurrentHeapObject((0, HeapViewUtils_1.getHeapObjectAt)(nodes, 0));
         }
-        this.heapController.setCurrentHeapObject((0, HeapViewUtils_1.getHeapObjectAt)(nodes, 0));
     }
     initScreen(title) {
         return blessed_1.default.screen({

package/dist/commands/helper/HelperCommand.d.ts

@@ -28,6 +28,7 @@ export default class HelperCommand extends BaseCommand {
     private printCategory;
     private getCommandOptionsSummary;
     private printOptions;
+    private formatOptionText;
     private printCommand;
     private printHelperTextForCommand;
     private printFullHelperTextForCommand;

package/dist/commands/helper/HelperCommand.js

@@ -171,12 +171,27 @@ class HelperCommand extends BaseCommand_1.default {
         }
         const headerLength = optionsText.reduce((acc, cur) => Math.max(acc, cur.header.length), 0);
         for (const optionText of optionsText) {
-            const header = chalk_1.default.green(optionText.header);
-            const prefix = core_1.utils.repeat(' ', headerLength - optionText.header.length);
-            const msg = `${indent}${prefix}${header}  ${optionText.desc}`;
+            const msg = this.formatOptionText(optionText, indent, headerLength);
             core_1.info.topLevel(`\n${msg}`);
         }
     }
+    formatOptionText(optionText, indent, headerLength) {
+        const header = chalk_1.default.green(optionText.header);
+        const prefix = core_1.utils.repeat(' ', headerLength - optionText.header.length);
+        const headerString = `${indent}${prefix}${header} `;
+        const headerStringWidth = (0, string_width_1.default)(headerString);
+        const maxWidth = Math.min(process.stdout.columns, 150);
+        const descMaxWidth = maxWidth - headerStringWidth;
+        let descString = optionText.desc.substring(0, descMaxWidth);
+        let descStringRemain = optionText.desc.substring(descMaxWidth);
+        while (descStringRemain.length > 0) {
+            descString += '\n';
+            descString += core_1.utils.repeat(' ', headerStringWidth);
+            descString += descStringRemain.substring(0, descMaxWidth);
+            descStringRemain = descStringRemain.substring(descMaxWidth);
+        }
+        return `${headerString}${descString}`;
+    }
     printCommand(command, extraIndent = '', printOptions = false) {
         const indent = '  ' + extraIndent;
         const name = command.getFullCommand();

package/dist/commands/snapshot/TakeSnapshotCommand.js

@@ -24,22 +24,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const BaseCommand_1 = __importDefault(require("../../BaseCommand"));
 const Snapshot_1 = require("./Snapshot");
 const CleanRunDataCommand_1 = __importDefault(require("../CleanRunDataCommand"));
-const FullExecutionOption_1 = __importDefault(require("../../options/FullExecutionOption"));
-const AppOption_1 = __importDefault(require("../../options/AppOption"));
-const InteractionOption_1 = __importDefault(require("../../options/InteractionOption"));
-const SkipSnapshotOption_1 = __importDefault(require("../../options/SkipSnapshotOption"));
-const SkipScreenshotOption_1 = __importDefault(require("../../options/SkipScreenshotOption"));
-const SkipGCOption_1 = __importDefault(require("../../options/SkipGCOption"));
-const SkipScrollOption_1 = __importDefault(require("../../options/SkipScrollOption"));
-const SkipExtraOperationOption_1 = __importDefault(require("../../options/SkipExtraOperationOption"));
-const RunningModeOption_1 = __importDefault(require("../../options/RunningModeOption"));
-const RemoteBrowserDebugOption_1 = __importDefault(require("../../options/RemoteBrowserDebugOption"));
-const ScenarioFileOption_1 = __importDefault(require("../../options/ScenarioFileOption"));
-const SetDeviceOption_1 = __importDefault(require("../../options/SetDeviceOption"));
-const DisableXvfbOption_1 = __importDefault(require("../../options/DisableXvfbOption"));
+const FullExecutionOption_1 = __importDefault(require("../../options/e2e/FullExecutionOption"));
+const AppOption_1 = __importDefault(require("../../options/e2e/AppOption"));
+const InteractionOption_1 = __importDefault(require("../../options/e2e/InteractionOption"));
+const SkipSnapshotOption_1 = __importDefault(require("../../options/e2e/SkipSnapshotOption"));
+const SkipScreenshotOption_1 = __importDefault(require("../../options/e2e/SkipScreenshotOption"));
+const SkipGCOption_1 = __importDefault(require("../../options/e2e/SkipGCOption"));
+const SkipScrollOption_1 = __importDefault(require("../../options/e2e/SkipScrollOption"));
+const SkipExtraOperationOption_1 = __importDefault(require("../../options/e2e/SkipExtraOperationOption"));
+const RunningModeOption_1 = __importDefault(require("../../options/e2e/RunningModeOption"));
+const RemoteBrowserDebugOption_1 = __importDefault(require("../../options/e2e/RemoteBrowserDebugOption"));
+const ScenarioFileOption_1 = __importDefault(require("../../options/e2e/ScenarioFileOption"));
+const SetDeviceOption_1 = __importDefault(require("../../options/e2e/SetDeviceOption"));
+const DisableXvfbOption_1 = __importDefault(require("../../options/e2e/DisableXvfbOption"));
 const InitDirectoryCommand_1 = __importDefault(require("../InitDirectoryCommand"));
 const CheckXvfbSupportCommand_1 = __importDefault(require("./CheckXvfbSupportCommand"));
-const HeadfulBrowserOption_1 = __importDefault(require("../../options/HeadfulBrowserOption"));
+const HeadfulBrowserOption_1 = __importDefault(require("../../options/e2e/HeadfulBrowserOption"));
+const SetUserAgentOption_1 = __importDefault(require("../../options/e2e/SetUserAgentOption"));
 class TakeSnapshotCommand extends BaseCommand_1.default {
     getCommandName() {
         return 'snapshot';
@@ -76,6 +77,7 @@ class TakeSnapshotCommand extends BaseCommand_1.default {
             new RemoteBrowserDebugOption_1.default(),
             new ScenarioFileOption_1.default(),
             new SetDeviceOption_1.default(),
+            new SetUserAgentOption_1.default(),
             new DisableXvfbOption_1.default(),
         ];
     }

package/dist/options/e2e/SetUserAgentOption.d.ts

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

package/dist/options/e2e/SetUserAgentOption.js

@@ -0,0 +1,42 @@
+"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 ws_labs
+ */
+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 SetUserAgentOption extends core_1.BaseOption {
+    getOptionName() {
+        return 'user-agent';
+    }
+    getDescription() {
+        return ('set the UserAgent string in browser (for E2E interaction), ' +
+            'otherwise it uses the default UserAgent from Chromium');
+    }
+    getExampleValues() {
+        return ['"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2)"'];
+    }
+    parse(config, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const optionName = this.getOptionName();
+            if (args[optionName]) {
+                config.defaultUserAgent = args[optionName];
+            }
+        });
+    }
+}
+exports.default = SetUserAgentOption;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/cli",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "license": "MIT",
   "description": "command line interface for memlab",
   "author": "Liang Gong <lgong@fb.com>",
@@ -15,7 +15,9 @@
   ],
   "main": "dist/index.js",
   "files": [
-    "dist"
+    "dist",
+    "bin",
+    "LICENSE"
   ],
   "bin": {
     "memlab": "bin/memlab.js"