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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
93c7a63
Fix issue where rendered is a promise
ccouzens Jul 15, 2024
b2287e2
Different syntax, but more success
ccouzens Jul 15, 2024
6dec254
Attempt to write a test for the case based on my app
ccouzens Jul 15, 2024
5795830
Add test that tests behaviour
ccouzens Jul 17, 2024
d882836
Further simplify test case
ccouzens Jul 17, 2024
61a31f1
Further simplify test case
ccouzens Jul 17, 2024
fdc2b1a
Create the test I want
ccouzens Jul 17, 2024
0f7f1d0
Revert unrelated change
ccouzens Jul 17, 2024
f161447
Add changeset
ccouzens Jul 17, 2024
58d7e01
Add missing imports
ccouzens Jul 17, 2024
8759b73
Reproduce without useClient
ccouzens Jul 17, 2024
3ba55d8
Avoid using urql
ccouzens Jul 17, 2024
0967404
Better description
ccouzens Jul 17, 2024
7bd6b29
Update test/compat/async.test.jsx
JoviDeCroock Jul 17, 2024
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/famous-experts-decide.md
View file
Open in desktop
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
49 changes: 47 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@
"@babel/register": "^7.12.10",
"@changesets/changelog-github": "^0.4.1",
"@changesets/cli": "^2.18.0",
"@urql/preact": "^4.1.0",
"baseline-rts": "npm:preact-render-to-string@latest",
"benchmarkjs-pretty": "^2.0.1",
"chai": "^4.2.0",
Expand Down Expand Up @@ -170,4 +171,4 @@
"publishConfig": {
"provenance": true
}
}
}
2 changes: 1 addition & 1 deletion src/index.js
View file
Open in desktop
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
42 changes: 42 additions & 0 deletions test/compat/async.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,46 @@ describe('Async renderToString', () => {
const rendered = await promise;
expect(rendered).to.equal('<p>ok</p>');
});

it('should render JSX after a urql component', async () => {
Copy link
Member

Choose a reason for hiding this comment

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

We might also want to try a test where it's triple-y nested as it might warrant a loop similar to the Array.isArray one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you think this would look like?

If I do something like:

		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 NestedLazyComponent = lazy(
			async () =>
				function ImportedComponent() {
					return (
						<Context.Provider>
							<Fetcher>
								<LoadableComponent />
							</Fetcher>
						</Context.Provider>
					);
				}
		);

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

		const NestedLoadableComponent = ({}) => (
			<Suspense fallback={'...loading'}>
				<NestedLazyComponent />
			</Suspense>
		);

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

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

Then the current solution continues to work

const client = urql.createClient({
url: 'http://localhost:1234',
exchanges: [urql.cacheExchange, urql.fetchExchange],
suspense: true,
fetch: () =>
Promise.resolve(
new Response('{ "data": { "foo": 4 } }', {
headers: { 'Content-Type': 'application/json' }
})
)
});

const Fetcher = ({ children }) => {
urql.useQuery({ query: 'query{ foo }' });
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(
<urql.Provider value={client}>
<Fetcher>
<LoadableComponent />
</Fetcher>
</urql.Provider>
);

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