@memlab/core 1.1.10 → 1.1.12

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/dist/index.d.ts

@@ -49,4 +49,6 @@ export { default as EvaluationMetric } from './trace-cluster/EvalutationMetric';
 export * from './lib/PackageInfoLoader';
 /** @internal */
 export { default as SequentialClustering } from './trace-cluster/SequentialClustering';
+/** @internal */
+export { default as TraceFinder } from './paths/TraceFinder';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SequentialClustering = exports.EvaluationMetric = exports.NormalizedTrace = exports.leakClusterLogger = exports.ProcessManager = exports.modes = exports.constant = exports.analysis = exports.browserInfo = exports.serializer = exports.fileManager = exports.utils = exports.BaseOption = exports.info = exports.config = exports.registerPackage = void 0;
+exports.TraceFinder = exports.SequentialClustering = exports.EvaluationMetric = exports.NormalizedTrace = exports.leakClusterLogger = exports.ProcessManager = exports.modes = exports.constant = exports.analysis = exports.browserInfo = exports.serializer = exports.fileManager = exports.utils = exports.BaseOption = exports.info = exports.config = exports.registerPackage = void 0;
 const path_1 = __importDefault(require("path"));
 const PackageInfoLoader_1 = require("./lib/PackageInfoLoader");
 /** @internal */
@@ -100,3 +100,6 @@ __exportStar(require("./lib/PackageInfoLoader"), exports);
 /** @internal */
 var SequentialClustering_1 = require("./trace-cluster/SequentialClustering");
 Object.defineProperty(exports, "SequentialClustering", { enumerable: true, get: function () { return __importDefault(SequentialClustering_1).default; } });
+/** @internal */
+var TraceFinder_1 = require("./paths/TraceFinder");
+Object.defineProperty(exports, "TraceFinder", { enumerable: true, get: function () { return __importDefault(TraceFinder_1).default; } });

package/dist/lib/Constant.js

@@ -18,8 +18,7 @@ const constants = {
     supportedBrowsers: Object.create(null),
     internalDir: 'fb-internal',
     monoRepoDir: '',
-    defaultUserAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_2)' +
-        ' AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.0 Safari/537.36',
+    defaultUserAgent: 'default',
     V8SyntheticRoots: [
         '(GC roots)',
         '(Internalized strings)',

package/dist/lib/NodeHeap.js

@@ -93,7 +93,7 @@ exports.tagObject = tagObject;
  * ```
  */
 function dumpNodeHeapSnapshot() {
-    const randomID = `Math.random()`.replace('0.', '');
+    const randomID = `${Math.random()}`.replace('0.', '');
     const file = path_1.default.join(FileManager_1.default.generateTmpHeapDir(), `nodejs-${randomID}.heapsnapshot`);
     if (fs_extra_1.default.existsSync(file)) {
         fs_extra_1.default.removeSync(file);

package/dist/lib/Serializer.d.ts

@@ -28,6 +28,7 @@ declare type UnboundedObjectInfo = {
     node: IHeapNode;
     type: string;
     history: number[];
+    historyNumberFormatter?: (n: number) => string;
 };
 declare function summarizeUnboundedObjects(unboundedObjects: UnboundedObjectInfo[], options?: SummarizeOptions): string;
 declare function summarizeUnboundedObjectsToCSV(unboundedObjects: UnboundedObjectInfo[]): string;

package/dist/lib/Serializer.js

@@ -553,15 +553,17 @@ function summarizeNodeShape(node, options = {}) {
     return summarizeObjectShape(node, options);
 }
 function summarizeUnboundedObjects(unboundedObjects, options = {}) {
-    const sizeSep = options.color ? chalk_1.default.grey(' > ') : ' > ';
+    const historySeparator = options.color ? chalk_1.default.grey(' > ') : ' > ';
     const prefix = options.color ? chalk_1.default.grey('· ') : '· ';
     const opt = Object.assign({ compact: true }, options);
     return unboundedObjects
         .map(item => {
+        var _a;
         const id = options.color ? chalk_1.default.grey(`@${item.id}`) : `@${item.id}`;
         const name = summarizeNodeShape(item.node, opt);
+        const formatter = (_a = item.historyNumberFormatter) !== null && _a !== void 0 ? _a : Utils_1.default.getReadableBytes.bind(Utils_1.default);
         return (`${prefix}${name} [${item.type}](${id}):  ` +
-            item.history.map(v => Utils_1.default.getReadableBytes(v)).join(sizeSep));
+            item.history.map(v => formatter(v)).join(historySeparator));
     })
         .join('\n');
 }

package/dist/lib/Types.d.ts

@@ -361,7 +361,7 @@ export declare type InteractionsCallback = (page: Page, args?: OperationArgs) =>
  * ```
  *
  * The test scenario instance can also be passed to the
- * [`run` API](../modules/api_src#run) exported by `@memlab/api`.
+ * {@link run} API exported by `@memlab/api`.
  * ```typescript
  * const {run} = require('@memlab/api');
  *
@@ -431,6 +431,35 @@ export interface IScenario {
      * for memory leak filtering.
      */
     url: () => string;
+    /**
+     * `setup` is the callback function that will be called only once
+     * after the initial page load. This callback can be used to log in
+     * if you have to (we recommend using {@link cookies})
+     * or to prepare data before the {@link action} call.
+     *
+     * * **Parameters**:
+     *   * page: `Page` | the puppeteer [`Page`](https://pptr.dev/api/puppeteer.page)
+     *     object, which provides APIs to interact with the web browser
+     *
+     * * **Examples**:
+     * ```typescript
+     * const scenario = {
+     *   url: () => 'https://www.npmjs.com/',
+     *   setup: async (page) => {
+     *     // log in or prepare data for the interaction
+     *   },
+     *   action: async (page) => {
+     *     await page.click('a[href="/link"]');
+     *   },
+     *   back: async (page) => {
+     *     await page.click('a[href="/back"]');
+     *   },
+     * }
+     *
+     * module.exports = scenario;
+     * ```
+     */
+    setup?: InteractionsCallback;
     /**
      * `action` is the callback function that defines the interaction
      * where you want to trigger memory leaks after the initial page load.
@@ -473,7 +502,7 @@ export interface IScenario {
      * }
      *
      * module.exports = scenario;
-     ```
+     * ```
      */
     action?: InteractionsCallback;
     /**
@@ -728,10 +757,12 @@ export interface IE2EScenarioVisitPlan {
     numOfWarmup: number;
     dataBuilder: Optional<IDataBuilder>;
     isPageLoaded?: CheckPageLoadCallback;
+    scenario?: IScenario;
 }
 /** @internal */
 export declare type OperationArgs = {
     isPageLoaded?: CheckPageLoadCallback;
+    scenario?: Optional<IScenario>;
     showProgress?: boolean;
     failedURLs?: AnyRecord;
     pageHistoryLength?: number[];
@@ -893,7 +924,7 @@ export interface IHeapSnapshot {
     /**
      * Search for the heap and check if there is any JS object instance with
      * a specified constructor name.
-     * @param className The contructor name of the object instance
+     * @param className The constructor name of the object instance
      * @returns `true` if there is at least one such object in the heap
      *
      * * **Examples**: you can write a jest unit test with memory assertions:
@@ -932,7 +963,7 @@ export interface IHeapSnapshot {
     /**
      * Search for the heap and get one of the JS object instances with
      * a specified constructor name (if there is any).
-     * @param className The contructor name of the object instance
+     * @param className The constructor name of the object instance
      * @returns a handle pointing to any one of the object instances, returns
      *          `null` if no such object exists in the heap.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/core",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "license": "MIT",
   "description": "memlab core libraries",
   "author": "Liang Gong <lgong@fb.com>",
@@ -24,7 +24,8 @@
   },
   "files": [
     "dist",
-    "static"
+    "static",
+    "LICENSE"
   ],
   "engines": {
     "node": ">= 12.6.0"