JacksonGL
commented
1 year ago @unlikelyzero Sure, the integration may consists of two steps:
Get heap snapshot dumped onto disk with certain directory structure and meta files
For your existing playwright/test framework, I would suggest implementing an API that takes JS heap snapshots from the browser. It seems playwright supports connecting with the Browser's DevTools via the Chrome DevTools Protocol (link). So you can leverage this to take JS heap snapshots from Chromium. Here is the code pointer of how memlab uses puppeteer to collect the heap snapshots from Chromium.
The API could look like this (as an example):
await takeJSHeapSnapshot(page, tag);tag is one of the tags: baseline, target, final, these three snapshots is equivalent to SBP, STP, SBP' respectively.
Your takeJSHeapSnapshot API should dump files in certain format on disk. Here is a complete list of files and directory structure required by MemLab core API for finding memory leaks.
/path/to/dump/
└── data
└── cur
├── run-meta.json # meta data of memlab run and browser configuration
├── s1.heapsnapshot # heap snapshot after the url callback (initial page load)
├── s2.heapsnapshot # heap snapshot after the action callback (after target interaction)
├── s3.heapsnapshot # heap snapshot after the back callback (after reverting target interaction)
└── snap-seq.json # meta data about each browser interaction stepTo get examples of those meta files, run a random MemLab test scenario and view those files under this directory: $(memlab get-default-work-dir)/data/cur.
In your Playwright test code, you can insert those takeJSHeapSnapshot API calls in your playwright test code to collect the three snapshots and get file dumped onto disk.
Find memory leaks based on heap snapshot dumps and meta files
Once you have the takeJSHeapSnapshot implementation dumped heap snapshots and meta files onto disk, you can find memory leaks with this memlab core API:
const {findLeaks, BrowserInteractionResultReader} = require('@memlab/api');
(async function () {
const reader = BrowserInteractionResultReader.from('/path/to/dump/');
const leaks = await findLeaks(reader);
})();
ajayjaggi97
unlikelyzero
Tallyb
Hello! This project looks amazing and is something our team at NASA Open MCT would love to used within our nascent performance testing suite.
I've seen a few requests for integration https://github.com/facebookincubator/memlab/issues/15 and https://github.com/facebookincubator/memlab/issues/14.
We're leveraging the playwright/test package which is nearly identical to jest+puppeteer in terms of capabilities. The only missing API from puppeteer is https://github.com/microsoft/playwright/issues/14134 , but otherwise has API parity and should be interchangeable.
I was wondering if you could provide a guide on how to integrate memlab into our existing playwright/test framework. I could help keep it up to date by integrating these two projects as part of our CI pipeline. I'd just like to know about how we should go about getting started using some of your core APIs. Thanks!