-
Notifications
You must be signed in to change notification settings - Fork 78
fix: to support @react-email/render exports across versions in templates #863
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Shubhdeep12
wants to merge
4
commits into
resend:canary
Choose a base branch
from
Shubhdeep12:fix/templates-renderasync
base: canary
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+91
−29
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
baf2cb6
fix(templates): improve error handling and mock render function for a…
Shubhdeep12 d098113
refactor(templates): replace async render function with synchronous r…
Shubhdeep12 c9b64a8
Merge branch 'canary' into fix/templates-renderasync
Shubhdeep12 b05636e
refactor(render): enhance render function to support both synchronous…
Shubhdeep12 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| import type * as React from 'react'; | ||
| import { vi } from 'vitest'; | ||
| import { render } from './render'; | ||
|
|
||
| const mockRenderFn = vi.fn(); | ||
| const mockRenderAsyncFn = vi.fn(); | ||
|
|
||
| let packageExports: 'both' | 'renderOnly' | 'renderAsyncOnly' = 'both'; | ||
|
|
||
| vi.mock('@react-email/render', () => ({ | ||
| get render() { | ||
| return packageExports === 'renderAsyncOnly' ? undefined : mockRenderFn; | ||
| }, | ||
| get renderAsync() { | ||
| return packageExports === 'renderOnly' ? undefined : mockRenderAsyncFn; | ||
| }, | ||
| })); | ||
|
|
||
| describe('render', () => { | ||
| const mockReactNode = { | ||
| type: 'div', | ||
| props: { children: 'Hello' }, | ||
| } as React.ReactElement; | ||
|
|
||
| beforeEach(() => { | ||
| packageExports = 'both'; | ||
| mockRenderFn.mockReset().mockResolvedValue('<html>Hello</html>'); | ||
| mockRenderAsyncFn.mockReset().mockResolvedValue('<html>Hello</html>'); | ||
| }); | ||
|
|
||
| it('calls render when @react-email/render exports render', async () => { | ||
| const html = await render(mockReactNode); | ||
|
|
||
| expect(html).toBe('<html>Hello</html>'); | ||
| expect(mockRenderFn).toHaveBeenCalledTimes(1); | ||
| expect(mockRenderFn).toHaveBeenCalledWith(mockReactNode); | ||
| expect(mockRenderAsyncFn).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('falls back to renderAsync when package only exports renderAsync', async () => { | ||
| packageExports = 'renderAsyncOnly'; | ||
| mockRenderAsyncFn.mockResolvedValue( | ||
| '<html>Rendered via renderAsync</html>', | ||
| ); | ||
|
|
||
| const html = await render(mockReactNode); | ||
|
|
||
| expect(html).toBe('<html>Rendered via renderAsync</html>'); | ||
| expect(mockRenderAsyncFn).toHaveBeenCalledTimes(1); | ||
| expect(mockRenderAsyncFn).toHaveBeenCalledWith(mockReactNode); | ||
| expect(mockRenderFn).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('prefers render over renderAsync when both are present', async () => { | ||
| mockRenderFn.mockResolvedValue('<html>From render</html>'); | ||
| mockRenderAsyncFn.mockResolvedValue('<html>From renderAsync</html>'); | ||
|
|
||
| const html = await render(mockReactNode); | ||
|
|
||
| expect(html).toBe('<html>From render</html>'); | ||
| expect(mockRenderFn).toHaveBeenCalled(); | ||
| expect(mockRenderAsyncFn).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,24 @@ | ||
| export async function render(node: React.ReactNode) { | ||
| let render: typeof import('@react-email/render').render; | ||
| import type * as React from 'react'; | ||
|
|
||
| export async function render(node: React.ReactNode): Promise<string> { | ||
| let mod: { | ||
| render?: (node: React.ReactNode) => Promise<string>; | ||
| renderAsync?: (node: React.ReactNode) => Promise<string>; | ||
| }; | ||
| try { | ||
| ({ render } = await import('@react-email/render')); | ||
| mod = await import('@react-email/render'); | ||
| } catch { | ||
| throw new Error( | ||
| 'Failed to render React component. Make sure to install `@react-email/render` or `@react-email/components`.', | ||
| ); | ||
| } | ||
|
|
||
| return render(node); | ||
| const renderFn = mod.render ?? mod.renderAsync; | ||
| if (typeof renderFn !== 'function') { | ||
| throw new Error( | ||
| 'Failed to render React component. Make sure to install `@react-email/render` (or an older version with renderAsync).', | ||
| ); | ||
| } | ||
|
|
||
| return renderFn(node); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.