@memlab/core 1.1.10 → 1.1.11

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

@@ -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[];

package/package.json

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