@memlab/api 1.0.3 → 1.0.4

package/dist/API.d.ts

@@ -17,7 +17,10 @@ import BrowserInteractionResultReader from './result-reader/BrowserInteractionRe
  * Options for configuring browser interaction run, all fields are optional
  */
 export declare type RunOptions = {
-    /** test scenario definition */
+    /**
+     * test scenario specifying how to interact with browser
+     * (for more details view {@link IScenario})
+     */
     scenario?: IScenario;
     /** the absolute path of cookies file */
     cookiesFile?: string;

package/dist/__tests__/heap/examples/example-1.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-1.d.ts.map

package/dist/__tests__/heap/examples/example-1.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+class TestObject {
+    constructor() {
+        this.arr1 = [1, 2, 3];
+        this.arr2 = ['1', '2', '3'];
+    }
+}
+(function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const obj = new TestObject();
+        // get a heap snapshot of the current program state
+        const heap = yield (0, core_1.getNodeInnocentHeap)();
+        const node = heap.getAnyObjectWithClassName('TestObject');
+        console.log(node === null || node === void 0 ? void 0 : node.name);
+    });
+})();

package/dist/__tests__/heap/examples/example-2.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-2.d.ts.map

package/dist/__tests__/heap/examples/example-2.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+(function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        const heapFile = (0, core_1.dumpNodeHeapSnapshot)();
+        const heap = yield (0, heap_analysis_1.getHeapFromFile)(heapFile);
+        // get the total number of heap objects
+        heap.nodes.length;
+        heap.nodes.forEach((node) => {
+            console.log(node.name);
+        });
+    });
+})();

package/dist/__tests__/heap/examples/example-3.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-3.d.ts.map

package/dist/__tests__/heap/examples/example-3.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+(function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        const heapFile = (0, core_1.dumpNodeHeapSnapshot)();
+        const heap = yield (0, heap_analysis_1.getHeapFromFile)(heapFile);
+        // get the total number of heap references
+        heap.edges.length;
+        heap.edges.forEach((edge) => {
+            console.log(edge.name_or_index);
+        });
+    });
+})();

package/dist/__tests__/heap/examples/example-4.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-4.d.ts.map

package/dist/__tests__/heap/examples/example-4.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+(function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        const heapFile = (0, core_1.dumpNodeHeapSnapshot)();
+        const heap = yield (0, heap_analysis_1.getHeapFromFile)(heapFile);
+        const node = heap.getNodeById(1);
+        if (node) {
+            console.log(node.id);
+        }
+    });
+})();

package/dist/__tests__/heap/examples/example-5.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-5.test.d.ts.map

package/dist/__tests__/heap/examples/example-5.test.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+class TestObject {
+    constructor() {
+        this.arr1 = [1, 2, 3];
+        this.arr2 = ['1', '2', '3'];
+    }
+}
+test('memory test', () => __awaiter(void 0, void 0, void 0, function* () {
+    core_1.config.muteConsole = true;
+    let obj = new TestObject();
+    // get a heap snapshot of the current program state
+    let heap = yield (0, core_1.getNodeInnocentHeap)();
+    // call some function that may add references to obj
+    // rabbitHole()
+    expect(heap.hasObjectWithClassName('TestObject')).toBe(true);
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    obj = null;
+    heap = yield (0, core_1.getNodeInnocentHeap)();
+    // if rabbitHole does not add new references, the obj can be GCed
+    expect(heap.hasObjectWithClassName('TestObject')).toBe(false);
+}), 30000);

package/dist/__tests__/heap/examples/example-6.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-6.d.ts.map

package/dist/__tests__/heap/examples/example-6.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const heap_analysis_1 = require("@memlab/heap-analysis");
+(function () {
+    return __awaiter(this, void 0, void 0, function* () {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const object = { 'memlab-test-heap-property': 'memlab-test-heap-value' };
+        const heapFile = (0, core_1.dumpNodeHeapSnapshot)();
+        const heap = yield (0, heap_analysis_1.getHeapFromFile)(heapFile);
+        // should be true
+        console.log(heap.hasObjectWithPropertyName('memlab-test-heap-property'));
+    });
+})();

package/dist/__tests__/heap/examples/example-7.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+export {};
+//# sourceMappingURL=example-7.test.d.ts.map

package/dist/__tests__/heap/examples/example-7.test.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * 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
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+test('memory test', () => __awaiter(void 0, void 0, void 0, function* () {
+    core_1.config.muteConsole = true;
+    const o1 = {};
+    let o2 = {};
+    // tag o1 with marker: "memlab-mark-1"
+    (0, core_1.tagObject)(o1, 'memlab-mark-1');
+    // tag o2 with marker: "memlab-mark-2"
+    (0, core_1.tagObject)(o2, 'memlab-mark-2');
+    o2 = null;
+    const heap = yield (0, core_1.getNodeInnocentHeap)();
+    // expect object with marker "memlab-mark-1" exists
+    expect(heap.hasObjectWithTag('memlab-mark-1')).toBe(true);
+    // expect object with marker "memlab-mark-2" can be GCed
+    expect(heap.hasObjectWithTag('memlab-mark-2')).toBe(false);
+}), 30000);

package/dist/index.d.ts

@@ -10,7 +10,7 @@
 export * from './API';
 export * from '@memlab/heap-analysis';
 export { default as BrowserInteractionResultReader } from './result-reader/BrowserInteractionResultReader';
-export { dumpNodeHeapSnapshot, getCurrentNodeHeap } from '@memlab/core';
+export { dumpNodeHeapSnapshot, getNodeInnocentHeap } from '@memlab/core';
 /** @internal */
 export { config } from '@memlab/core';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -26,14 +26,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = exports.getCurrentNodeHeap = exports.dumpNodeHeapSnapshot = exports.BrowserInteractionResultReader = void 0;
+exports.config = exports.getNodeInnocentHeap = exports.dumpNodeHeapSnapshot = exports.BrowserInteractionResultReader = void 0;
 __exportStar(require("./API"), exports);
 __exportStar(require("@memlab/heap-analysis"), exports);
 var BrowserInteractionResultReader_1 = require("./result-reader/BrowserInteractionResultReader");
 Object.defineProperty(exports, "BrowserInteractionResultReader", { enumerable: true, get: function () { return __importDefault(BrowserInteractionResultReader_1).default; } });
 var core_1 = require("@memlab/core");
 Object.defineProperty(exports, "dumpNodeHeapSnapshot", { enumerable: true, get: function () { return core_1.dumpNodeHeapSnapshot; } });
-Object.defineProperty(exports, "getCurrentNodeHeap", { enumerable: true, get: function () { return core_1.getCurrentNodeHeap; } });
+Object.defineProperty(exports, "getNodeInnocentHeap", { enumerable: true, get: function () { return core_1.getNodeInnocentHeap; } });
 /** @internal */
 var core_2 = require("@memlab/core");
 Object.defineProperty(exports, "config", { enumerable: true, get: function () { return core_2.config; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memlab/api",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "license": "MIT",
   "description": "memlab API",
   "author": "Liang Gong <lgong@fb.com>",
@@ -57,6 +57,7 @@
   "scripts": {
     "build-pkg": "tsc",
     "test-pkg": "jest .",
+    "publish-patch": "npm version patch --force && npm publish",
     "clean-pkg": "rm -rf ./dist && rm -rf ./node_modules && rm -f ./tsconfig.tsbuildinfo"
   },
   "bugs": {