Skip to content
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

Fix instance where renderToStringAsync returns a promise of a promise #378

Merged
merged 14 commits into from
Jul 17, 2024
5 changes: 5 additions & 0 deletions .changeset/famous-experts-decide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'preact-render-to-string': patch
---

Fix issue where preactRenderToString returns a promise of a promise
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export async function renderToStringAsync(vnode, context) {
parent[CHILDREN] = [vnode];

try {
const rendered = _renderToString(
const rendered = await _renderToString(
vnode,
context || EMPTY_OBJ,
false,
Expand Down
83 changes: 67 additions & 16 deletions test/compat/async.test.jsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { renderToStringAsync } from '../../src/index.js';
import { h } from 'preact';
import { Suspense, useId } from 'preact/compat';
import { h, Fragment } from 'preact';
import { Suspense, useId, lazy, createContext } from 'preact/compat';
import { expect } from 'chai';
import { createSuspender } from '../utils.jsx';

Expand All @@ -26,10 +26,14 @@ describe('Async renderToString', () => {
});

it('should render JSX with nested suspended components', async () => {
const { Suspender: SuspenderOne, suspended: suspendedOne } =
createSuspender();
const { Suspender: SuspenderTwo, suspended: suspendedTwo } =
createSuspender();
const {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The git commit formatter hook makes these changes. Let me know if you want me to keep them as is.

Suspender: SuspenderOne,
suspended: suspendedOne
} = createSuspender();
const {
Suspender: SuspenderTwo,
suspended: suspendedTwo
} = createSuspender();

const promise = renderToStringAsync(
<ul>
Expand All @@ -56,10 +60,14 @@ describe('Async renderToString', () => {
});

it('should render JSX with nested suspense boundaries', async () => {
const { Suspender: SuspenderOne, suspended: suspendedOne } =
createSuspender();
const { Suspender: SuspenderTwo, suspended: suspendedTwo } =
createSuspender();
const {
Suspender: SuspenderOne,
suspended: suspendedOne
} = createSuspender();
const {
Suspender: SuspenderTwo,
suspended: suspendedTwo
} = createSuspender();

const promise = renderToStringAsync(
<ul>
Expand Down Expand Up @@ -88,12 +96,18 @@ describe('Async renderToString', () => {
});

it('should render JSX with multiple suspended direct children within a single suspense boundary', async () => {
const { Suspender: SuspenderOne, suspended: suspendedOne } =
createSuspender();
const { Suspender: SuspenderTwo, suspended: suspendedTwo } =
createSuspender();
const { Suspender: SuspenderThree, suspended: suspendedThree } =
createSuspender();
const {
Suspender: SuspenderOne,
suspended: suspendedOne
} = createSuspender();
const {
Suspender: SuspenderTwo,
suspended: suspendedTwo
} = createSuspender();
const {
Suspender: SuspenderThree,
suspended: suspendedThree
} = createSuspender();

const promise = renderToStringAsync(
<ul>
Expand Down Expand Up @@ -175,4 +189,41 @@ describe('Async renderToString', () => {
const rendered = await promise;
expect(rendered).to.equal('<p>ok</p>');
});

it('should work with an in-render suspension', async () => {
const Context = createContext();

let c = 0;

const Fetcher = ({ children }) => {
c++;
if (c === 1) {
throw Promise.resolve();
}
return <Fragment>{children}</Fragment>;
};

const LazyComponent = lazy(
async () =>
function ImportedComponent() {
return <div>2</div>;
}
);

const LoadableComponent = ({}) => (
<Suspense fallback={'...loading'}>
<LazyComponent />
</Suspense>
);

const rendered = await renderToStringAsync(
<Context.Provider>
<Fetcher>
<LoadableComponent />
</Fetcher>
</Context.Provider>
);

expect(rendered).to.equal(`<div>2</div>`);
});
});