Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/honest-ducks-film.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@react-email/preview-server": patch
---

Buffer logs written to console.log,info,warn,error until spinner is done
67 changes: 66 additions & 1 deletion packages/preview-server/src/actions/render-email-by-path.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
'use server';

import { log } from 'node:console';
import fs from 'node:fs';
import path from 'node:path';
import logSymbols from 'log-symbols';
import ora, { type Ora } from 'ora';
import type React from 'react';
import {
isBuilding,
isPreviewDevelopment,
Expand Down Expand Up @@ -40,6 +42,51 @@ export type EmailRenderingResult =

const cache = new Map<string, EmailRenderingResult>();

const createLogBufferer = (
originalLogger: (...args: any[]) => void,
overwriteLogger: (logger: (...args: any[]) => void) => void,
) => {
let logs: Array<any[]> = [];

let timesCorked = 0;

return {
buffer: () => {
timesCorked += 1;
overwriteLogger((...args: any[]) => logs.push(args));
},
flush: () => {
timesCorked = Math.max(timesCorked - 1, 0);
// This ensures that, only once flushing has been called as many times as
// buffering, that the logs are actually flushed.
if (timesCorked === 0) {
for (const logArgs of logs) {
originalLogger(...logArgs);
}
logs = [];
overwriteLogger(originalLogger);
}
},
};
};

const logBufferer = createLogBufferer(
console.log,
(logger) => (console.log = logger),
);
const errorBufferer = createLogBufferer(
console.error,
(logger) => (console.error = logger),
);
const infoBufferer = createLogBufferer(
console.info,
(logger) => (console.info = logger),
);
const warnBufferer = createLogBufferer(
console.warn,
(logger) => (console.warn = logger),
);

export const renderEmailByPath = async (
emailPath: string,
invalidatingCache = false,
Expand All @@ -52,12 +99,18 @@ export const renderEmailByPath = async (
return cache.get(emailPath)!;
}

logBufferer.buffer();
errorBufferer.buffer();
infoBufferer.buffer();
warnBufferer.buffer();

const emailFilename = path.basename(emailPath);
let spinner: Ora | undefined;
if (!isBuilding && !isPreviewDevelopment) {
spinner = ora({
text: `Rendering email template ${emailFilename}\n`,
prefixText: ' ',
stream: process.stderr,
}).start();
registerSpinnerAutostopping(spinner);
}
Expand All @@ -79,6 +132,10 @@ export const renderEmailByPath = async (
symbol: logSymbols.error,
text: `Failed while rendering ${emailFilename}`,
});
logBufferer.flush();
errorBufferer.flush();
infoBufferer.flush();
warnBufferer.flush();
return { error: componentResult.error };
}

Expand All @@ -91,7 +148,7 @@ export const renderEmailByPath = async (
} = componentResult;

const previewProps = Email.PreviewProps || {};
const EmailComponent = Email as React.FC;
const EmailComponent = Email as React.FunctionComponent;
try {
const timeBeforeEmailRendered = performance.now();
const element = createElement(EmailComponent, previewProps);
Expand Down Expand Up @@ -123,6 +180,10 @@ export const renderEmailByPath = async (
symbol: logSymbols.success,
text: `Successfully rendered ${emailFilename} in ${timeForConsole} (bundled in ${millisecondsToBundled.toFixed(0)}ms)`,
});
logBufferer.flush();
errorBufferer.flush();
infoBufferer.flush();
warnBufferer.flush();

const renderingResult: RenderedEmailMetadata = {
prettyMarkup,
Expand All @@ -148,6 +209,10 @@ export const renderEmailByPath = async (
symbol: logSymbols.error,
text: `Failed while rendering ${emailFilename}`,
});
logBufferer.flush();
errorBufferer.flush();
infoBufferer.flush();
warnBufferer.flush();

if (exception instanceof SyntaxError) {
interface SpanPosition {
Expand Down
Loading