3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-30 17:37:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(core): expose opt-in env variable for SSG thread recycling (#11166)

Browse source
This commit is contained in:
Sébastien Lorber 2025-05-09 17:40:58 +02:00 • committed by GitHub
parent b7cd1061fd
commit 8061f2267b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 26 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
packages/docusaurus/src/ssg/ssgEnv.ts
View file

@ -27,3 +27,14 @@ export const SSGWorkerThreadTaskSize: number = process.env
.DOCUSAURUS_SSG_WORKER_THREAD_TASK_SIZE
? parseInt(process.env.DOCUSAURUS_SSG_WORKER_THREAD_TASK_SIZE, 10)
: 10; // TODO need fine-tuning
// Controls worker thread recycling behavior (maxMemoryLimitBeforeRecycle)
// See https://github.com/facebook/docusaurus/pull/11166
// See https://github.com/facebook/docusaurus/issues/11161
export const SSGWorkerThreadRecyclerMaxMemory: number | undefined = process.env
.DOCUSAURUS_SSG_WORKER_THREAD_RECYCLER_MAX_MEMORY
? parseInt(process.env.DOCUSAURUS_SSG_WORKER_THREAD_RECYCLER_MAX_MEMORY, 10)
: // TODO we should probably provide a default value here
// 2gb is a quite reasonable max that should work well even for large sites
// we'd rather ask community feedback first
undefined;

16
packages/docusaurus/src/ssg/ssgExecutor.ts
View file

@ -12,7 +12,11 @@ import _ from 'lodash';
import logger, {PerfLogger} from '@docusaurus/logger';
import {createSSGParams} from './ssgParams';
import {renderHashRouterTemplate} from './ssgTemplate';
import {SSGWorkerThreadCount, SSGWorkerThreadTaskSize} from './ssgEnv';
import {
SSGWorkerThreadCount,
SSGWorkerThreadRecyclerMaxMemory,
SSGWorkerThreadTaskSize,
} from './ssgEnv';
import {generateHashRouterEntrypoint} from './ssgUtils';
import {createGlobalSSGResult} from './ssgGlobalResult';
import {executeSSGInlineTask} from './ssgWorkerInline';
@ -124,6 +128,16 @@ const createPooledSSGExecutor: CreateSSGExecutor = async ({
runtime: 'worker_threads',
isolateWorkers: false,
workerData: {params},
// WORKER MEMORY MANAGEMENT
// Allows containing SSG memory leaks with a thread recycling workaround
// See https://github.com/facebook/docusaurus/pull/11166
// See https://github.com/facebook/docusaurus/issues/11161
maxMemoryLimitBeforeRecycle: SSGWorkerThreadRecyclerMaxMemory,
resourceLimits: {
// For some reason I can't figure out how to limit memory on a worker
// See https://x.com/sebastienlorber/status/1920781195618513143
},
});
},
);