chore: Implement memory leak detection in tests

[victor-yanev]

Description:

This PR introduces a method captureMemoryLeaks to detect and report potential memory leaks in test suites, enhancing the reliability and performance of applications by ensuring early detection and resolution of memory leaks.

It leverages the V8 engine's garbage collection (GC) profiling capabilities to monitor memory usage before and after test execution, identifying significant increases in totalHeapSize that may indicate a memory leak.

1. Initialization: The method begins by enabling the garbage collection (GC) through the setFlagsFromString('--expose_gc') command. This allows for manual triggering of garbage collection within the test environment.
2. Test Setup: Before each test case runs, profiler.start() is called to set up the GC profiler to monitor heap usage and other GC-related statistics during the test execution.
3. Test Teardown: After each test case completes, several critical actions are performed:
   • Garbage collection is manually triggered using await gc() to ensure that all unreferenced objects are cleared from memory. This step aims to capture the most accurate state of the heap after test execution.
   • The GC profiler is then stopped with profiler.stop(), and the method collects the GC statistics, including heap sizes before and after the GC.
   • The method calculates the total difference in heap size before and after the test execution. If this difference exceeds 500KB (defined as HEAP_SIZE_DIFF_MEMORY_LEAK_THRESHOLD), it indicates a potential memory leak.
   • For tests that potentially leak memory, detailed statistics about the memory usage and the specific areas of the heap that have grown are compiled into a report. This includes information such as the type of garbage collection event, the cost (in milliseconds) of the GC, and detailed heap statistics before and after the test.
   • A comment is generated with the memory leak report and is programmatically added or updated in a pull request (PR) associated with the test suite. This comment includes a header indicating a memory leak detection, a summary of the issue, detailed statistics, and recommendations for further investigation.
   • Optionally, if enabled through an environment variable (WRITE_SNAPSHOT_ON_MEMORY_LEAK), a heap snapshot is taken for leaks exceeding 1MB (defined as HEAP_SIZE_DIFF_SNAPSHOT_THRESHOLD). This snapshot can be used for a more in-depth analysis of the memory allocation and retention patterns. (this env is disabled everywhere by default and can be enabled locally by the person who is investigating the memory leak)

Related issue(s):

Fixes #2260

Notes for reviewer:

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

[github-actions]

Acceptance Tests

     33 files     353 suites   50m 21s ⏱️
   610 tests    588 ✔️ 4 💤 18 ❌
1 506 runs  1 462 ✔️ 4 💤 40 ❌

Results for commit 7ba48a4.

♻️ This comment has been updated with latest results.

[ebadiere]

Nice work! Once this is merged it will get picked up in CI. I'd like to discuss briefly some window of time during the first release when this is run, and you can be available if the CI breaks down. CI updates can make releases interesting.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.3% Duplication on New Code

See analysis details on SonarCloud

[quiet-node]

Wonderful work 🚀 🚀 !! Some qqs