@memlab/cli 1.0.7 → 1.0.11

package/dist/commands/heap/interactive/ui-components/ListComponent.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { Widgets } from 'blessed';
+export declare type ListComponentOption = {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+    label?: string;
+};
+export declare type ListItemSelectInfo = {
+    keyName: string;
+};
+export declare type ListCallbacks = {
+    selectCallback?: (componentId: number, index: number, content: string[], selectInfo: ListItemSelectInfo) => void;
+    updateContent?: (oldContent: string[], newContent: string[]) => void;
+    getFocus?: () => void;
+    render?: () => void;
+};
+/**
+ * A ListComponent is an UI list component in CLI.
+ * It managers all the UI events related to the
+ * list component (e.g., scroll up, down, left, right, and other key strokes)
+ */
+export default class ListComponent {
+    element: Widgets.ListElement;
+    id: number;
+    private listIndex;
+    private content;
+    private callbacks;
+    private horizonScrollPositionMap;
+    private displayedItems;
+    private moreEntryIndex;
+    private focusKey;
+    private static readonly ListContentLimit;
+    private static readonly loadMore;
+    private static nextComponentId;
+    private static nextId;
+    constructor(content: string[], callbacks: ListCallbacks, options: ListComponentOption);
+    private render;
+    private static createEntryForMore;
+    protected registerKeys(): void;
+    private scrollLeft;
+    private scrollRight;
+    focus(): void;
+    loseFocus(): void;
+    selectIndex(index: number): void;
+    setFocusKey(key: string): void;
+    setLabel(label: string): void;
+    setContent(content: string[]): void;
+    loadMoreContent(): void;
+    private removeDisplayMoreEntry;
+    private insertDisplayMoreEntry;
+    updateContent(oldContent: string[], newContent: string[]): void;
+    getFocus(): void;
+    selectUpdate(index: number, content: string[], selectInfo: ListItemSelectInfo): void;
+}
+//# sourceMappingURL=ListComponent.d.ts.map

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

@@ -0,0 +1,237 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const blessed_1 = __importDefault(require("blessed"));
+const chalk_1 = __importDefault(require("chalk"));
+const string_width_1 = __importDefault(require("string-width"));
+const HeapViewUtils_1 = require("./HeapViewUtils");
+/**
+ * A ListComponent is an UI list component in CLI.
+ * It managers all the UI events related to the
+ * list component (e.g., scroll up, down, left, right, and other key strokes)
+ */
+class ListComponent {
+    constructor(content, callbacks, options) {
+        this.listIndex = 0;
+        this.content = [];
+        this.moreEntryIndex = -1;
+        this.focusKey = '';
+        this.id = ListComponent.nextId();
+        this.horizonScrollPositionMap = new Map();
+        this.callbacks = callbacks;
+        // init list element
+        this.element = blessed_1.default.list(Object.assign(Object.assign({}, options), { tags: false, scrollable: true, keys: true, border: {
+                fg: 'grey',
+                type: 'line',
+            }, style: {
+                item: {
+                    fg: 'white',
+                    bg: 'default',
+                },
+                selected: {
+                    bg: 'grey',
+                    bold: true,
+                },
+            } }));
+        this.setContent(content);
+        this.registerKeys();
+    }
+    static nextId() {
+        return ListComponent.nextComponentId++;
+    }
+    // render the whole screen
+    render() {
+        if (this.callbacks.render) {
+            this.callbacks.render();
+        }
+    }
+    static createEntryForMore(more) {
+        const key = chalk_1.default.inverse('enter');
+        return chalk_1.default.grey(` ${more} more ... (select and ${key} to load)`);
+    }
+    registerKeys() {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const self = this;
+        this.element.on('keypress', (char, key) => {
+            const content = self.content;
+            // if selecting "More"
+            if (key.name === 'enter' &&
+                content.length > 0 &&
+                self.listIndex >= 0 &&
+                self.listIndex === self.moreEntryIndex) {
+                self.loadMoreContent();
+                return;
+            }
+            // move selection down
+            if (key.name === 'down' && self.listIndex < self.displayedItems - 1) {
+                self.element.select(++self.listIndex);
+                self.selectUpdate(self.listIndex, content, {
+                    keyName: key.name,
+                });
+                // move selection up
+            }
+            else if (key.name === 'up' && self.listIndex > 0) {
+                self.element.select(--self.listIndex);
+                self.selectUpdate(self.listIndex, content, {
+                    keyName: key.name,
+                });
+                // hit enter to select the current heap object
+            }
+            else if (key.name === 'enter') {
+                self.selectUpdate(self.listIndex, content, {
+                    keyName: key.name,
+                });
+                // scroll left
+            }
+            else if (key.name === 'left') {
+                self.scrollLeft();
+                // scroll right
+            }
+            else if (key.name === 'right') {
+                self.scrollRight();
+            }
+        });
+    }
+    scrollLeft() {
+        var _a;
+        const selectedContent = this.content[this.listIndex];
+        if (!selectedContent) {
+            return;
+        }
+        let offset = 0;
+        if (this.horizonScrollPositionMap.has(this.listIndex)) {
+            offset = (_a = this.horizonScrollPositionMap.get(this.listIndex)) !== null && _a !== void 0 ? _a : 0;
+        }
+        if (offset === 0) {
+            return;
+        }
+        this.horizonScrollPositionMap.set(this.listIndex, --offset);
+        let newContent = (0, HeapViewUtils_1.substringWithColor)(selectedContent, offset);
+        if (offset > 0) {
+            newContent = chalk_1.default.grey('...') + newContent;
+        }
+        this.element.spliceItem(this.listIndex, 1, newContent);
+        this.element.select(this.listIndex);
+    }
+    scrollRight() {
+        var _a;
+        const selectedContent = this.content[this.listIndex];
+        if (!selectedContent || (0, string_width_1.default)(selectedContent) <= 5) {
+            return;
+        }
+        let offset = 0;
+        if (this.horizonScrollPositionMap.has(this.listIndex)) {
+            offset = (_a = this.horizonScrollPositionMap.get(this.listIndex)) !== null && _a !== void 0 ? _a : 0;
+        }
+        this.horizonScrollPositionMap.set(this.listIndex, ++offset);
+        let newContent = (0, HeapViewUtils_1.substringWithColor)(selectedContent, offset);
+        if (offset > 0) {
+            newContent = chalk_1.default.grey('...') + newContent;
+        }
+        this.element.spliceItem(this.listIndex, 1, newContent);
+        this.element.select(this.listIndex);
+    }
+    focus() {
+        this.element.focus();
+        this.element.style.border.fg = 'white';
+        this.element.style.selected = {
+            bg: 'grey',
+            bold: true,
+        };
+        this.getFocus();
+    }
+    loseFocus() {
+        this.element.style.border.fg = 'grey';
+        this.element.style.selected = {
+            bg: 'black',
+            bold: false,
+        };
+    }
+    selectIndex(index) {
+        while (this.displayedItems <= index &&
+            this.displayedItems < this.content.length) {
+            this.loadMoreContent();
+        }
+        this.listIndex = index;
+        this.element.select(index);
+    }
+    setFocusKey(key) {
+        this.focusKey = key;
+    }
+    setLabel(label) {
+        const componentLabel = label + chalk_1.default.grey(` (press ${chalk_1.default.inverse(this.focusKey)} to focus)`);
+        this.element.setLabel(componentLabel);
+    }
+    setContent(content) {
+        const oldContent = this.content;
+        this.element.clearItems();
+        this.displayedItems = 0;
+        this.moreEntryIndex = -1;
+        this.listIndex = 0;
+        // push list items into the list
+        for (let i = 0; i < content.length; ++i) {
+            if (this.displayedItems >= ListComponent.ListContentLimit) {
+                break;
+            }
+            this.element.pushItem(content[i]);
+            ++this.displayedItems;
+        }
+        this.content = content;
+        this.horizonScrollPositionMap.clear();
+        this.insertDisplayMoreEntry();
+        this.updateContent(oldContent, this.content);
+    }
+    loadMoreContent() {
+        if (this.moreEntryIndex < 0) {
+            return;
+        }
+        const curIndex = this.listIndex;
+        this.removeDisplayMoreEntry();
+        let idx = this.displayedItems;
+        const limit = Math.min(this.displayedItems + ListComponent.loadMore, this.content.length);
+        while (idx < limit) {
+            this.element.pushItem(this.content[idx++]);
+        }
+        this.displayedItems = limit;
+        this.insertDisplayMoreEntry();
+        this.selectIndex(curIndex);
+        this.render();
+    }
+    removeDisplayMoreEntry() {
+        this.element.spliceItem(this.displayedItems - 1, 1);
+        this.moreEntryIndex = -1;
+        --this.displayedItems;
+        --this.listIndex;
+    }
+    // insert the display more entry
+    insertDisplayMoreEntry() {
+        if (this.displayedItems < this.content.length) {
+            this.element.pushItem(ListComponent.createEntryForMore(this.content.length - this.displayedItems));
+            ++this.displayedItems;
+            this.moreEntryIndex = this.displayedItems - 1;
+        }
+    }
+    // function to be overridden
+    updateContent(oldContent, newContent) {
+        if (this.callbacks.updateContent) {
+            this.callbacks.updateContent(oldContent, newContent);
+        }
+    }
+    // function to be overridden
+    getFocus() {
+        if (this.callbacks.getFocus) {
+            this.callbacks.getFocus();
+        }
+    }
+    selectUpdate(index, content, selectInfo) {
+        if (this.callbacks.selectCallback) {
+            this.callbacks.selectCallback(this.id, index, content, selectInfo);
+        }
+    }
+}
+exports.default = ListComponent;
+ListComponent.ListContentLimit = 100;
+ListComponent.loadMore = 100;
+ListComponent.nextComponentId = 0;

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

@@ -4,8 +4,8 @@
  * 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
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../../BaseCommand';

package/dist/commands/helper/GenerateCLIDocCommand.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

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

@@ -4,8 +4,8 @@
  * 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
  */
 import type { BaseOption, CLIOptions } from '@memlab/core';
 import BaseCommand from '../../BaseCommand';

package/dist/commands/helper/HelperCommand.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -51,6 +51,7 @@ const core_1 = require("@memlab/core");
 const CommandOrder_1 = __importDefault(require("./lib/CommandOrder"));
 const BaseCommand_1 = __importStar(require("../../BaseCommand"));
 const UniversalOptions_1 = __importDefault(require("../../options/lib/UniversalOptions"));
+const heap_analysis_1 = require("@memlab/heap-analysis");
 class HelperCommand extends BaseCommand_1.default {
     constructor() {
         super(...arguments);
@@ -81,7 +82,11 @@ class HelperCommand extends BaseCommand_1.default {
     printCommandCategories(options) {
         for (const category in BaseCommand_1.CommandCategory) {
             const item = CommandOrder_1.default.find(item => item.category === category);
-            const commandsToPrintFirst = item ? item.commands : [];
+            const commandsToPrintFirst = heap_analysis_1.heapConfig.isCliInteractiveMode
+                ? []
+                : item
+                    ? item.commands
+                    : [];
             this.printCategory(category, commandsToPrintFirst, options);
         }
     }
@@ -93,13 +98,13 @@ class HelperCommand extends BaseCommand_1.default {
         core_1.info.topLevel('');
     }
     printCategory(category, commandsToPrintFirst, options) {
-        this.printCategoryHeader(category, options);
+        const commandsToPrint = [];
         for (const command of commandsToPrintFirst) {
             const name = command.getCommandName();
             if (this.printedCommand.has(name)) {
                 continue;
             }
-            this.printCommand(command, options.indent);
+            commandsToPrint.push(command);
             this.printedCommand.add(name);
         }
         // print other commands in this category
@@ -115,9 +120,16 @@ class HelperCommand extends BaseCommand_1.default {
             if (this.printedCommand.has(name)) {
                 continue;
             }
-            this.printCommand(command, options.indent);
+            commandsToPrint.push(command);
             this.printedCommand.add(name);
         }
+        if (commandsToPrint.length === 0) {
+            return;
+        }
+        this.printCategoryHeader(category, options);
+        for (const command of commandsToPrint) {
+            this.printCommand(command, options.indent);
+        }
         core_1.info.topLevel('');
     }
     getCommandOptionsSummary(command, indent = '') {

package/dist/commands/helper/lib/CommandOrder.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { CommandOrder } from './Types';
 declare const _default: CommandOrder;

package/dist/commands/helper/lib/CommandOrder.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/commands/helper/lib/Types.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import BaseCommand, { CommandCategory } from '../../../BaseCommand';
 export declare type CommandOrderItem = {

package/dist/commands/helper/lib/Types.js

@@ -5,7 +5,7 @@
  * 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
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commands/query/QueryDefaultWorkDirCommand.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import { CLIOptions } from '@memlab/core';
 import BaseCommand, { CommandCategory } from '../../BaseCommand';

package/dist/commands/query/QueryDefaultWorkDirCommand.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/dist/commands/snapshot/CheckXvfbSupportCommand.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../../BaseCommand';

package/dist/commands/snapshot/CheckXvfbSupportCommand.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/snapshot/Snapshot.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 export declare function runPageInteractionFromCLI(): Promise<void>;
 //# sourceMappingURL=Snapshot.d.ts.map

package/dist/commands/snapshot/Snapshot.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/snapshot/TakeSnapshotCommand.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../../BaseCommand';

package/dist/commands/snapshot/TakeSnapshotCommand.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/commands/snapshot/WarmupAndSnapshotCommand.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { CLIOptions } from '@memlab/core';
 import BaseCommand from '../../BaseCommand';

package/dist/commands/snapshot/WarmupAndSnapshotCommand.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/index.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 /** @internal */
 export declare function registerPackage(): Promise<void>;

package/dist/index.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/dist/options/AppOption.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { ParsedArgs } from 'minimist';
 import type { MemLabConfig } from '@memlab/core';

package/dist/options/AppOption.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/options/DebugOption.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { ParsedArgs } from 'minimist';
 import type { MemLabConfig } from '@memlab/core';

package/dist/options/DebugOption.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/options/DisableXvfbOption.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { ParsedArgs } from 'minimist';
 import type { MemLabConfig } from '@memlab/core';

package/dist/options/DisableXvfbOption.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/dist/options/FullExecutionOption.d.ts

@@ -4,8 +4,8 @@
  * 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
  */
 import type { ParsedArgs } from 'minimist';
 import type { MemLabConfig } from '@memlab/core';

package/dist/options/FullExecutionOption.js

@@ -5,8 +5,8 @@
  * 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
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }