@memlab/core 1.1.12 → 1.1.14

package/dist/lib/Types.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import { ParsedArgs } from 'minimist';
 import type { LaunchOptions, Page } from 'puppeteer';
@@ -413,6 +413,34 @@ export interface IScenario {
      * ```
      */
     cookies?: () => Cookies;
+    /**
+     * `beforeInitialPageLoad` is the callback function that will be called only
+     * once before the initial page load. This callback can be used to set up
+     * the HTTP headers or to prepare data before loading the web page.
+     *
+     * * **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/',
+     *   beforeInitialPageLoad: async (page) => {
+     *     // before the initial page load
+     *   },
+     *   action: async (page) => {
+     *     await page.click('a[href="/link"]');
+     *   },
+     *   back: async (page) => {
+     *     await page.click('a[href="/back"]');
+     *   },
+     * }
+     *
+     * module.exports = scenario;
+     * ```
+     */
+    beforeInitialPageLoad?: InteractionsCallback;
     /**
      * String value of the initial url of the page.
      *
@@ -1092,6 +1120,10 @@ export interface IHeapLocation {
      * get the {@link IHeapSnapshot} containing this location instance
      */
     snapshot: IHeapSnapshot;
+    /**
+     * get the heap object this location this location represents
+     */
+    node: Nullable<IHeapNode>;
     /**
      * get the script ID of the source file
      */

package/dist/lib/Types.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/Utils.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { HaltOrThrowOptions } from './Types';
 import type { Browser, Page } from 'puppeteer';
@@ -121,6 +121,7 @@ declare function haltOrThrow(errorInfo: string | Error, options?: HaltOrThrowOpt
 declare function getError(maybeError: unknown): Error;
 declare function isNodeDominatedByDeletionsArray(node: IHeapNode): boolean;
 declare function getUniqueID(): string;
+declare function getClosureSourceUrl(node: IHeapNode): Nullable<string>;
 declare const _default: {
     applyToNodes: typeof applyToNodes;
     callAsync: typeof callAsync;
@@ -136,6 +137,7 @@ declare const _default: {
     extractHTMLElementNodeInfo: typeof extractHTMLElementNodeInfo;
     filterNodesInPlace: typeof filterNodesInPlace;
     getAllDominators: typeof getAllDominators;
+    getClosureSourceUrl: typeof getClosureSourceUrl;
     getConditionalDominatorIds: typeof getConditionalDominatorIds;
     getError: typeof getError;
     getEdgeByNameAndType: typeof getEdgeByNameAndType;

package/dist/lib/Utils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -484,7 +484,10 @@ function checkScenarioInstance(s) {
         (s.repeat && typeof s.repeat !== 'function') ||
         (s.isPageLoaded && typeof s.isPageLoaded !== 'function') ||
         (s.leakFilter && typeof s.leakFilter !== 'function') ||
-        (s.beforeLeakFilter && typeof s.beforeLeakFilter !== 'function')) {
+        (s.beforeLeakFilter && typeof s.beforeLeakFilter !== 'function') ||
+        (s.beforeInitialPageLoad &&
+            typeof s.beforeInitialPageLoad !== 'function') ||
+        (s.setup && typeof s.setup !== 'function')) {
         throw new Error('Invalid senario');
     }
     return s;
@@ -886,6 +889,11 @@ function isInterestingPath(p) {
     if (Config_1.default.hideBrowserLeak && styleEngineRetainsDetachedElement(p)) {
         return false;
     }
+    // if the path has pattern: Pending activitiies -> DetachedElement
+    if (Config_1.default.hideBrowserLeak &&
+        pendingActivitiesRetainsDetachedElementChain(p)) {
+        return false;
+    }
     return true;
 }
 // return true if the heap node represents JS object or closure
@@ -965,6 +973,29 @@ function styleEngineRetainsDetachedElement(path) {
     // check if the InternalNode is pointing to a detached element
     return !!p && isDetachedDOMNode(p.node);
 }
+function pendingActivitiesRetainsDetachedElementChain(path) {
+    let p = path;
+    // find the Pending activities
+    while (p && p.node && !isPendingActivityNode(p.node)) {
+        p = p.next;
+        if (!p) {
+            return false;
+        }
+    }
+    p = p.next;
+    if (!p || !p.node) {
+        return false;
+    }
+    // all the following reference chain is detached DOM elements
+    // pointing to other detached DOM elements
+    while (p && p.node) {
+        if (!isDetachedDOMNode(p.node)) {
+            return false;
+        }
+        p = p.next;
+    }
+    return true;
+}
 function pathHasDetachedHTMLNode(path) {
     if (!path) {
         return false;
@@ -1695,6 +1726,25 @@ let uindex = 1;
 function getUniqueID() {
     return `${process_1.default.pid}-${Date.now()}-${uindex++}`;
 }
+// try to get the url that defines the closure function
+// this is particular to heap snapshot taken from V8 in Chromium
+function getClosureSourceUrl(node) {
+    var _a, _b;
+    if (node.type !== 'closure') {
+        return null;
+    }
+    const shared = node.getReferenceNode('shared', 'internal');
+    if (!shared) {
+        return null;
+    }
+    const debug = shared.getReferenceNode('script_or_debug_info', 'internal');
+    if (!debug) {
+        return null;
+    }
+    const urlNode = debug.getReferenceNode('name', 'internal');
+    const url = (_b = (_a = urlNode === null || urlNode === void 0 ? void 0 : urlNode.toStringNode()) === null || _a === void 0 ? void 0 : _a.stringValue) !== null && _b !== void 0 ? _b : null;
+    return url;
+}
 exports.default = {
     applyToNodes,
     callAsync,
@@ -1710,6 +1760,7 @@ exports.default = {
     extractHTMLElementNodeInfo,
     filterNodesInPlace,
     getAllDominators,
+    getClosureSourceUrl,
     getConditionalDominatorIds,
     getError,
     getEdgeByNameAndType,

package/dist/lib/heap-data/HeapEdge.d.ts

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapEdge } from '../Types';
 import type HeapSnapshot from './HeapSnapshot';

package/dist/lib/heap-data/HeapEdge.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/dist/lib/heap-data/HeapLocation.d.ts

@@ -6,15 +6,16 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
-import type { IHeapLocation } from '../Types';
+import type { IHeapLocation, IHeapNode, Nullable } from '../Types';
 import type HeapSnapshot from './HeapSnapshot';
 export default class HeapLocation implements IHeapLocation {
     private heapSnapshot;
     private idx;
     constructor(heapSnapshot: HeapSnapshot, idx: number);
     get snapshot(): HeapSnapshot;
+    get node(): Nullable<IHeapNode>;
     get script_id(): number;
     get line(): number;
     get column(): number;

package/dist/lib/heap-data/HeapLocation.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -18,6 +18,13 @@ class HeapLocation {
     get snapshot() {
         return this.heapSnapshot;
     }
+    get node() {
+        const heapSnapshot = this.heapSnapshot;
+        const locations = heapSnapshot.snapshot.locations;
+        const locationFieldsCount = heapSnapshot._locationFieldsCount;
+        const objectIndex = locations[this.idx * locationFieldsCount + heapSnapshot._locationObjectIndexOffset];
+        return heapSnapshot.nodes.get(objectIndex);
+    }
     get script_id() {
         const heapSnapshot = this.heapSnapshot;
         const locations = heapSnapshot.snapshot.locations;

package/dist/lib/heap-data/HeapNode.d.ts

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapNode, IHeapEdge, Nullable, EdgeIterationCallback, Predicator, IHeapStringNode } from '../Types';
 import type HeapSnapshot from './HeapSnapshot';

package/dist/lib/heap-data/HeapNode.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __importDefault = (this && this.__importDefault) || function (mod) {
@@ -257,7 +257,7 @@ class HeapNode {
     get location() {
         const heapSnapshot = this.heapSnapshot;
         const locationIdx = heapSnapshot._nodeIdx2LocationIdx[this.idx];
-        if (locationIdx === undefined) {
+        if (locationIdx == null) {
             return null;
         }
         return new HeapLocation_1.default(heapSnapshot, locationIdx);

package/dist/lib/heap-data/HeapSnapshot.d.ts

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapNode, IHeapNodes, IHeapEdges, IHeapSnapshot, HeapNodeTypes, HeapEdgeTypes, HeapSnapshotMeta, RawHeapSnapshot, NumericDictionary, Nullable } from '../Types';
 import HeapNode from './HeapNode';

package/dist/lib/heap-data/HeapSnapshot.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/dist/lib/heap-data/HeapStringNode.d.ts

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapStringNode } from '../Types';
 import type HeapSnapshot from './HeapSnapshot';

package/dist/lib/heap-data/HeapStringNode.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/dist/lib/heap-data/HeapUtils.d.ts

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 export declare const NodeDetachState: {
     Unknown: number;

package/dist/lib/heap-data/HeapUtils.js

@@ -6,7 +6,7 @@
  *
  * @format
  * @lightSyntaxTransform
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/heap-data/MemLabTagStore.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { AnyValue, IHeapSnapshot } from '../Types';
 declare type AnyObject = Record<AnyValue, AnyValue>;

package/dist/lib/heap-data/MemLabTagStore.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const __1 = require("../..");

package/dist/lib/leak-filters/BaseLeakFilter.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../Config';
 import type { HeapNodeIdSet, IHeapNode, IHeapSnapshot } from '../Types';

package/dist/lib/leak-filters/BaseLeakFilter.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LeakDecision = void 0;

package/dist/lib/leak-filters/LeakFilterRuleList.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import { ILeakObjectFilterRule } from './BaseLeakFilter.rule';
 declare const _default: ILeakObjectFilterRule[];

package/dist/lib/leak-filters/LeakFilterRuleList.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/leak-filters/LeakObjectFilter.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../Config';
 import type { HeapNodeIdSet, IHeapNode, IHeapSnapshot } from '../Types';

package/dist/lib/leak-filters/LeakObjectFilter.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/leak-filters/rules/FilterByExternalFilter.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { HeapNodeIdSet, IHeapNode, IHeapSnapshot } from '../../Types';

package/dist/lib/leak-filters/rules/FilterByExternalFilter.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FilterByExternalFilterRule = void 0;

package/dist/lib/leak-filters/rules/FilterDetachedDOMElement.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { IHeapNode } from '../../Types';

package/dist/lib/leak-filters/rules/FilterDetachedDOMElement.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/leak-filters/rules/FilterHermesNode.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { IHeapNode } from '../../Types';

package/dist/lib/leak-filters/rules/FilterHermesNode.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/leak-filters/rules/FilterOverSizedNodeAsLeak.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { IHeapNode } from '../../Types';

package/dist/lib/leak-filters/rules/FilterOverSizedNodeAsLeak.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FilterOverSizedNodeAsLeakRule = void 0;

package/dist/lib/leak-filters/rules/FilterStackTraceFrame.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { IHeapNode } from '../../Types';

package/dist/lib/leak-filters/rules/FilterStackTraceFrame.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/leak-filters/rules/FilterTrivialNode.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { IHeapNode } from '../../Types';

package/dist/lib/leak-filters/rules/FilterTrivialNode.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/lib/leak-filters/rules/FilterUnmountedFiberNode.rule.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { MemLabConfig } from '../../Config';
 import type { IHeapNode } from '../../Types';

package/dist/lib/leak-filters/rules/FilterUnmountedFiberNode.rule.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/logger/LeakClusterLogger.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import { E2EStepInfo, TraceCluster, TraceClusterDiff, TraceClusterMetaInfo } from '../lib/Types';
 declare class LeakClusterLogger {

package/dist/logger/LeakClusterLogger.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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/logger/LeakTraceDetailsLogger.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { IHeapSnapshot, ISerializedInfo, LeakTracePathItem, Nullable } from '../lib/Types';
 declare class LeakTraceDetailsLogger {

package/dist/logger/LeakTraceDetailsLogger.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/modes/BaseMode.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import type { E2EStepInfo, Config, IE2EScenarioVisitPlan, Optional } from '../lib/Types';
 import type { Page } from 'puppeteer';

package/dist/modes/BaseMode.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 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/modes/InteractionTestMode.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import BaseMode from './BaseMode';
 declare class InteractionTestMode extends BaseMode {

package/dist/modes/InteractionTestMode.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/dist/modes/MeasureMode.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  *
  * @format
- * @oncall ws_labs
+ * @oncall web_perf_infra
  */
 import BaseMode from './BaseMode';
 import type { Page } from 'puppeteer';