fix(sdk): evict compiled manifest modules from require cache in dev mode (#22129)

## Problem `yarn twenty dev` crashes after running for a while with: ``` FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory ``` The crash happens during the **Manifest Build** phase, after the process has been up for a long time (~35 min in the reported case) — the signature of a slow memory leak in the long-running watch process, not a single oversized operation. Fixes the issue described in `core-team-issues#2560`. ## Root cause `manifest-extract-config-from-file.ts``loadModule()` compiles each entity file with esbuild (`bundle: true`, so the whole dependency graph is inlined), writes it to a unique `mkdtemp` directory, and loads it with `appRequire(tempFile)`. `createRequire` shares Node's global module cache (`Module._cache`), so **every loaded temp module is retained in the require cache forever**. Two things made this unbounded: 1. `mkdtemp` generates a fresh random directory each call, so cache keys never collide — entries purely accumulate. 2. The `finally` block removed the temp dir **from disk** but never evicted the `require.cache` entry, so the evaluated, fully-bundled module object stayed pinned in the JS heap. In dev mode the orchestrator re-runs `buildManifest` on **every** file change and watcher rebuild (`scheduleSync()`), and each rebuild compiles & `require()`s ~one module per entity file (53 in the reported case). Over a session of editing, thousands of large bundled module objects pile up in `require.cache` until V8's heap is exhausted → FATAL OOM. ## Fix Delete the temp module from the require cache after loading it, so memory stays bounded to a single rebuild. Because `bundle: true` inlines the whole graph, the temp module is the only cache entry per load, so deleting it lets the bundled object be GC'd. ```ts } finally { delete appRequire.cache[tempFile]; await remove(tempDir); } ``` ## Test Adds a regression test (`manifest-extract-config-from-file.spec.ts`) that runs `extractManifestFromFile` repeatedly and asserts no `twenty-manifest` temp modules accumulate in the require cache. https://claude.ai/code/session_0168hN9yEYvjZbqdz7PckKn8 --- _Generated by [Claude Code](https://claude.ai/code/session_0168hN9yEYvjZbqdz7PckKn8)_  <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22129?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
2026-06-25 11:21:51 +02:00
parent db687c7407
commit 6a36fc3ba8
2 changed files with 68 additions and 11 deletions
@@ -0,0 +1,43 @@
+import { createRequire } from 'module';
+import { join } from 'path';
+
+import { MINIMAL_APP_PATH } from '@/cli/__tests__/apps/fixture-paths';
+import { extractManifestFromFile } from '@/cli/utilities/build/manifest/manifest-extract-config-from-file';
+import { type ApplicationConfig } from '@/sdk/define';
+
+describe('extractManifestFromFile', () => {
+  const filePath = join(MINIMAL_APP_PATH, 'application.config.ts');
+
+  it('extracts the default-exported config from a bundled entity file', async () => {
+    const result = await extractManifestFromFile<ApplicationConfig>({
+      filePath,
+      appPath: MINIMAL_APP_PATH,
+    });
+
+    expect(result.config.displayName).toBe('Root App');
+  }, 60000);
+
+  // Regression test for the dev-mode OOM crash: bundled entity modules used to be
+  // written to disk and required, leaking one fully-bundled module per file into
+  // the require cache on every rebuild. Evaluating in memory keeps it bounded.
+  it('does not grow the require cache across rebuilds', async () => {
+    const requireCache = createRequire(import.meta.url).cache;
+
+    // Warm up so first-time dependency loads don't count against the assertion.
+    await extractManifestFromFile<ApplicationConfig>({
+      filePath,
+      appPath: MINIMAL_APP_PATH,
+    });
+
+    const before = Object.keys(requireCache).length;
+
+    for (let index = 0; index < 5; index++) {
+      await extractManifestFromFile<ApplicationConfig>({
+        filePath,
+        appPath: MINIMAL_APP_PATH,
+      });
+    }
+
+    expect(Object.keys(requireCache).length).toBe(before);
+  }, 60000);
+});
@@ -1,13 +1,20 @@
 import { conditionalAvailabilityTransformPlugin } from '@/cli/utilities/build/common/conditional-availability/conditional-availability-transform-plugin';
-import { pathExists, remove } from '@/cli/utilities/file/fs-utils';
+import { pathExists } from '@/cli/utilities/file/fs-utils';
 import { type ValidationResult } from '@/sdk/define';
 import * as esbuild from 'esbuild';
 import { createRequire } from 'module';
-import { mkdtemp, writeFile } from 'node:fs/promises';
-import os from 'os';
+import vm from 'node:vm';
 import path from 'path';
 import { isDefined, isPlainObject } from 'twenty-shared/utils';

+type CompiledModuleWrapper = (
+  exports: Record<string, unknown>,
+  require: NodeRequire,
+  module: { exports: Record<string, unknown> },
+  filename: string,
+  dirname: string,
+) => void;
+
 const MANIFEST_MOCK_MODULES = [
  'twenty-sdk/ui',
  'twenty-client-sdk/core',
@@ -86,16 +93,23 @@ const loadModule = async ({

  const code = result.outputFiles[0].text;

-  const tempDir = await mkdtemp(path.join(os.tmpdir(), 'twenty-manifest-'));
-  const tempFile = path.join(tempDir, 'module.cjs');
+  const compiledWrapper = vm.compileFunction(
+    code,
+    ['exports', 'require', 'module', '__filename', '__dirname'],
+    { filename: filePath },
+  ) as unknown as CompiledModuleWrapper;

-  try {
-    await writeFile(tempFile, code);
+  const moduleShim: { exports: Record<string, unknown> } = { exports: {} };

-    return appRequire(tempFile) as Record<string, unknown>;
-  } finally {
-    await remove(tempDir);
-  }
+  compiledWrapper(
+    moduleShim.exports,
+    appRequire,
+    moduleShim,
+    filePath,
+    path.dirname(filePath),
+  );
+
+  return moduleShim.exports;
 };

 const extractDefaultConfigFromModuleOrThrow = <T>(