Function delayRenderInternal

packages/core/src/delay-render.ts:53–112

({
	scope,
	environment,
	label,
	options,
}: {
	scope: DelayRenderScope;
	environment: RemotionEnvironment;
	label: string | null;
	options: DelayRenderOptions;
})

 * @private
 */
export const delayRenderInternal = ({
	scope,
	environment,
	label,
	options,
}: {
	scope: DelayRenderScope;
	environment: RemotionEnvironment;
	label: string | null;
	options: DelayRenderOptions;
}): number => {
	if (typeof label !== 'string' && label !== null) {
		throw new Error(
			'The label parameter of delayRender() must be a string or undefined, got: ' +
				JSON.stringify(label),
		);
	}

	const handle = Math.random();
	scope.remotion_delayRenderHandles.push(handle);
	const called = Error().stack?.replace(/^Error/g, '') ?? '';

	if (environment.isRendering) {
		const timeoutToUse =
			(options?.timeoutInMilliseconds ??
				scope.remotion_puppeteerTimeout ??
				defaultTimeout) - 2000;
		const retriesLeft = (options?.retries ?? 0) - (scope.remotion_attempt - 1);
		scope.remotion_delayRenderTimeouts[handle] = {
			label: label ?? null,
			startTime: Date.now(),
			timeout: setTimeout(() => {
				const message = [
					`A delayRender()`,
					label ? `"${label}"` : null,
					`was called but not cleared after ${timeoutToUse}ms. See https://remotion.dev/docs/timeout for help.`,
					retriesLeft > 0 ? DELAY_RENDER_RETRIES_LEFT + retriesLeft : null,
					retriesLeft > 0 ? DELAY_RENDER_RETRY_TOKEN : null,
					DELAY_RENDER_CALLSTACK_TOKEN,
					called,
				]
					.filter(truthy)
					.join(' ');

				// in client-side rendering, don't throw (would be uncaught from setTimeout)
				if (environment.isClientSideRendering) {
					scope.remotion_cancelledError = getErrorStackWithMessage(
						Error(message),
					);
				} else {
					cancelRenderInternal(scope, Error(message));
				}
			}, timeoutToUse),
		};
	}

	scope.remotion_renderReady = false;