Heap snapshot diffs for accurate memtest leak detection (#1372)

Author: enisdenjo

.github/workflows/memtest.yml

@@ -57,11 +57,12 @@ jobs:
         with:
           key: docker-images-${{ runner.os }}-${{ steps.hash-docker-images.outputs.result }}
       - name: Test
-        uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3
         env:
           E2E_GATEWAY_RUNNER: ${{matrix.e2e_runner}}
+        run: yarn test:mem ${{matrix.test_name}}
+      - name: Upload heap snapshots
+        if: failure()
+        uses: actions/upload-artifact@v4
         with:
-          timeout_minutes: 30
-          max_attempts: 5
-          command: yarn test:mem ${{matrix.test_name}}
-          # TODO: publish heap allocation sampling profile to artifact
+          name: ${{matrix.test_name}}-heap-snapshots
+          path: e2e/${{matrix.test_name}}/*.heapsnapshot

.gitignore

@@ -1,6 +1,7 @@
 node_modules/
 .DS_Store
 dist/
+!/internal/heapsnapshot/dist/
 bundle/
 .yarn/*
 !.yarn/patches

.prettierignore

@@ -13,3 +13,4 @@ __generated__
 /e2e/config-syntax-error/gateway.config.ts
 /e2e/config-syntax-error/custom-resolvers.ts
 CHANGELOG.md
+/internal/heapsnapshot/dist/

DEPS_RESOLUTIONS_NOTES.md

@@ -14,8 +14,3 @@ Here we collect reasons and write explanations about why some resolutions or pat
 ### vitest-tsconfig-paths
 
 1. Resolve tsconfig paths in modules that have been [inlined](https://vitest.dev/config/#server-deps-inline).
-
-### @memlab/core
-
-1. Define package.json#export for `@memlab/core/Types`
-1. Define package.json#export for `@memlab/core/Utils`

e2e/auto-type-merging/auto-type-merging.memtest.ts

@@ -28,10 +28,6 @@ memtest(
         }
       }
     `,
-    expectedHeavyFrame: (frame) =>
-      // allocates a lot but all is freed confirmed through heap snapshot
-      frame.name === 'set' &&
-      frame.callstack.some((frame) => frame.name === 'subschemaExecutor'),
   },
   async () =>
     gateway({

e2e/federation-subscriptions-passthrough/federation-subscriptions-passthrough.memtest.ts

@@ -23,14 +23,6 @@ describe('upstream subscriptions via websockets', () => {
           }
         }
       `,
-      expectedHeavyFrame: (frame) =>
-        // allocates a lot but all is freed confirmed through heap snapshot
-        frame.name === 'set' &&
-        frame.callstack.some(
-          (frame) =>
-            frame.name.includes('stitchingInfo') ||
-            frame.name.includes('batch'),
-        ),
     },
     async () =>
       gateway({

e2e/interface-additional-resolvers/interface-additional-resolvers.memtest.ts

@@ -24,10 +24,6 @@ memtest(
         }
       }
     `,
-    expectedHeavyFrame: (frame) =>
-      // allocates a lot but all is freed confirmed through heap snapshot
-      frame.name === 'set' &&
-      frame.callstack.some((frame) => frame.name === 'createBatchingExecutor'),
   },
   async () =>
     await gateway({

internal/heapsnapshot/README.md

@@ -0,0 +1,5 @@
+Fork of [ChromeDevTools/devtools-frontend/[...]/heap_snapshot_worker](https://github.com/ChromeDevTools/devtools-frontend/blob/dd60dc9c8add93357dcffcfc3e2a9e5a31864413/front_end/entrypoints/heap_snapshot_worker) without the browser requirements, adapted for Node, with utilities for quick setup, parsing and analysis.
+
+Please make sure to build and commit any changes done inside this package to allow for "buildless" testing.
+
+This is the only package in the project that is used built (it's not listed in `tsconfig.json#paths`) because it uses worker threads and they need Node-ready JavaScript.