@memlab/core 1.1.4 → 1.1.5

package/dist/index.d.ts

@@ -7,6 +7,8 @@
  * @emails oncall+ws_labs
  * @format
  */
+/** @internal */
+export declare function registerPackage(): Promise<void>;
 export * from './lib/Types';
 /** @internal */
 export { default as config } from './lib/Config';
@@ -42,5 +44,7 @@ export { default as leakClusterLogger } from './logger/LeakClusterLogger';
 export { default as NormalizedTrace } from './trace-cluster/TraceBucket';
 /** @internal */
 export { default as EvaluationMetric } from './trace-cluster/EvalutationMetric';
+/** @internal */
+export * from './lib/PackageInfoLoader';
 export * from './lib/NodeHeap';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -22,11 +22,29 @@ 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.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 = void 0;
+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 */
+function registerPackage() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return PackageInfoLoader_1.PackageInfoLoader.registerPackage(path_1.default.join(__dirname, '..'));
+    });
+}
+exports.registerPackage = registerPackage;
 __exportStar(require("./lib/Types"), exports);
 /** @internal */
 var Config_1 = require("./lib/Config");
@@ -76,4 +94,6 @@ Object.defineProperty(exports, "NormalizedTrace", { enumerable: true, get: funct
 /** @internal */
 var EvalutationMetric_1 = require("./trace-cluster/EvalutationMetric");
 Object.defineProperty(exports, "EvaluationMetric", { enumerable: true, get: function () { return __importDefault(EvalutationMetric_1).default; } });
+/** @internal */
+__exportStar(require("./lib/PackageInfoLoader"), exports);
 __exportStar(require("./lib/NodeHeap"), exports);

package/dist/lib/Config.d.ts

@@ -8,7 +8,7 @@
  * @format
  */
 import type { LaunchOptions, Permission } from 'puppeteer';
-import type { AnyFunction, AnyValue, IClusterStrategy, IRunningMode, IScenario, Nullable, Optional, QuickExperiment, ILeakFilter } from './Types';
+import type { AnyFunction, AnyValue, IClusterStrategy, IRunningMode, IScenario, Nullable, Optional, QuickExperiment, ILeakFilter, IPackageInfo } from './Types';
 interface BrowserLaunchArgumentOptions {
     headless?: boolean;
     userDataDir?: string;
@@ -44,14 +44,19 @@ export declare enum ErrorHandling {
 }
 /** @internal */
 export declare class MemLabConfig {
-    snapshotHasDetachedness: boolean;
-    specifiedEngine: boolean;
-    verbose: boolean;
-    jsEngine: string;
     _reportLeaksInTimers: boolean;
     _deviceManualOverridden: boolean;
     _timerNodes: string[];
     _timerEdges: string[];
+    _isFullRun: boolean;
+    _scenario: Optional<IScenario>;
+    _isHeadfulBrowser: boolean;
+    _browser: string;
+    _packageInfo: IPackageInfo[];
+    snapshotHasDetachedness: boolean;
+    specifiedEngine: boolean;
+    verbose: boolean;
+    jsEngine: string;
     targetApp: string;
     targetTab: string;
     analysisMode: string;
@@ -94,7 +99,6 @@ export declare class MemLabConfig {
     puppeteerConfig: LaunchOptions & BrowserLaunchArgumentOptions & BrowserConnectOptions;
     openDevtoolsConsole: boolean;
     emulateDevice: Nullable<Device>;
-    _browser: string;
     addEnableGK: Set<string>;
     addDisableGK: Set<string>;
     qes: QuickExperiment[];
@@ -169,9 +173,6 @@ export declare class MemLabConfig {
     oversizeObjectAsLeak: boolean;
     oversizeThreshold: number;
     clusterRetainedSizeThreshold: number;
-    _isFullRun: boolean;
-    _scenario: Optional<IScenario>;
-    _isHeadfulBrowser: boolean;
     externalLeakFilter?: Optional<ILeakFilter>;
     monoRepoDir: string;
     muteConsole: boolean;

package/dist/lib/Config.js

@@ -97,6 +97,8 @@ class MemLabConfig {
         this.jsEngine = Constant_1.default.defaultEngine;
         // the default browser (Chromium)
         this._browser = 'chrome';
+        // a list of package information
+        this._packageInfo = [];
         // a set of additional GKs to be enabled
         this.addEnableGK = new Set();
         // a set of additional GKs to be disabled

package/dist/lib/PackageInfoLoader.d.ts

@@ -0,0 +1,7 @@
+/** @internal */
+export declare class PackageInfoLoader {
+    private static registeredPackages;
+    private static loadFrom;
+    static registerPackage(packageDirectory: string): Promise<void>;
+}
+//# sourceMappingURL=PackageInfoLoader.d.ts.map

package/dist/lib/PackageInfoLoader.js

@@ -0,0 +1,66 @@
+"use strict";
+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.PackageInfoLoader = void 0;
+/**
+ * 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
+ */
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const Config_1 = __importDefault(require("./Config"));
+const Utils_1 = __importDefault(require("./Utils"));
+/** @internal */
+class PackageInfoLoader {
+    static loadFrom(packageDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let exists = yield fs_extra_1.default.pathExists(packageDirectory);
+            if (!exists) {
+                throw Utils_1.default.haltOrThrow(`package directory doesn't exist: ${packageDirectory}`);
+            }
+            let packageJSONFile = path_1.default.join(packageDirectory, 'package-oss.json');
+            exists = yield fs_extra_1.default.pathExists(packageJSONFile);
+            if (!exists) {
+                packageJSONFile = path_1.default.join(packageDirectory, 'package.json');
+            }
+            exists = yield fs_extra_1.default.pathExists(packageJSONFile);
+            if (!exists) {
+                throw Utils_1.default.haltOrThrow(`package.json doesn't exist: ${packageJSONFile}`);
+            }
+            try {
+                const metaData = yield fs_extra_1.default.readJSON(packageJSONFile, 'UTF-8');
+                return Object.assign(Object.assign({}, metaData), { packageLocation: packageDirectory });
+            }
+            catch (ex) {
+                throw Utils_1.default.haltOrThrow(Utils_1.default.getError(ex));
+            }
+        });
+    }
+    static registerPackage(packageDirectory) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!PackageInfoLoader.registeredPackages.has(packageDirectory)) {
+                PackageInfoLoader.registeredPackages.add(packageDirectory);
+                const packageInfo = yield PackageInfoLoader.loadFrom(packageDirectory);
+                Config_1.default._packageInfo.push(packageInfo);
+            }
+        });
+    }
+}
+exports.PackageInfoLoader = PackageInfoLoader;
+PackageInfoLoader.registeredPackages = new Set();

package/dist/lib/Types.d.ts

@@ -120,6 +120,12 @@ export interface E2EScenarioSynthesizerConstructor {
     new (config: Config): IE2EScenarioSynthesizer;
 }
 /** @internal */
+export interface IPackageInfo {
+    name: string;
+    version: string;
+    packageLocation?: string;
+}
+/** @internal */
 export interface IRunningMode {
     setConfig(config: Config): void;
     beforeRunning(visitPlan: IE2EScenarioVisitPlan): void;
@@ -451,6 +457,10 @@ export interface IScenario {
      * `back` is the callback function that specifies how memlab should
      * back/revert the `action` callback. Think of it as an undo action.
      *
+     * * **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 = {
@@ -675,6 +685,10 @@ export interface IDataBuilder {
 /**
  * Callback function to provide if the page is loaded.
  * @param page - puppeteer's [Page](https://pptr.dev/api/puppeteer.page/) object.
+ * @returns a boolean value, if it returns `true`, memlab will consider
+ * the navigation completes, if it returns `false`, memlab will keep calling
+ * this callback until it returns `true`. This is an async callback, you can
+ * also `await` and returns `true` until some async logic is resolved.
  */
 export declare type CheckPageLoadCallback = (page: Page) => Promise<boolean>;
 /** @internal */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/core",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "license": "MIT",
   "description": "memlab core libraries",
   "author": "Liang Gong <lgong@fb.com>",