Skip to content

Commit 609d0cc

Browse files
authored
Add new error message for awaiting the client export (#29853)
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please provide enough information so that others can review your pull request. The three fields below are mandatory. Before submitting a pull request, please make sure the following is done: 1. Fork [the repository](https://github.com/facebook/react) and create your branch from `main`. 2. Run `yarn` in the repository root. 3. If you've fixed a bug or added code that should be tested, add tests! 4. Ensure the test suite passes (`yarn test`). Tip: `yarn test --watch TestName` is helpful in development. 5. Run `yarn test --prod` to test in the production environment. It supports the same options as `yarn test`. 6. If you need a debugger, run `yarn test --debug --watch TestName`, open `chrome://inspect`, and press "Inspect". 7. Format your code with [prettier](https://github.com/prettier/prettier) (`yarn prettier`). 8. Make sure your code lints (`yarn lint`). Tip: `yarn linc` to only check changed files. 9. Run the [Flow](https://flowtype.org/) type checks (`yarn flow`). 10. If you haven't already, complete the CLA. Learn more about contributing: https://reactjs.org/docs/how-to-contribute.html --> ## Summary `Cannot access .then on server` is not an ideal message when you try to await or do promise chain to the properties of client reference. The below example will let `.then` get accessed by native code while handling the promise chain but the access is not clearly visible in user code. ``` import('./client-module').then((mod) => mod.Component) ``` This PR chnage the error message of module reference proxy '.then' property to show more kinds of usage, then it can be pretty clearly for helping users to avoid the bad usage <!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? --> ## How did you test this change? Unit test <!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes the user interface. How exactly did you verify that your PR solves the issue you wanted to solve? If you leave this empty, your PR will very likely be closed. -->
1 parent 349a99a commit 609d0cc

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

packages/react-server-dom-turbopack/src/ReactFlightTurbopackReferences.js

+5
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,11 @@ const deepProxyHandlers = {
133133
`Instead, you can export a Client Component wrapper ` +
134134
`that itself renders a Client Context Provider.`,
135135
);
136+
case 'then':
137+
throw new Error(
138+
`Cannot await or return from a thenable. ` +
139+
`You cannot await a client module from a server component.`,
140+
);
136141
}
137142
// eslint-disable-next-line react-internal/safe-string-coercion
138143
const expression = String(target.name) + '.' + String(name);

packages/react-server-dom-webpack/src/ReactFlightWebpackReferences.js

+5
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,11 @@ const deepProxyHandlers = {
141141
`Instead, you can export a Client Component wrapper ` +
142142
`that itself renders a Client Context Provider.`,
143143
);
144+
case 'then':
145+
throw new Error(
146+
`Cannot await or return from a thenable. ` +
147+
`You cannot await a client module from a server component.`,
148+
);
144149
}
145150
// eslint-disable-next-line react-internal/safe-string-coercion
146151
const expression = String(target.name) + '.' + String(name);

packages/react-server-dom-webpack/src/__tests__/ReactFlightDOM-test.js

+14
Original file line numberDiff line numberDiff line change
@@ -623,6 +623,20 @@ describe('ReactFlightDOM', () => {
623623
);
624624
});
625625

626+
it('throws when await a client module prop of client exports', async () => {
627+
const ClientModule = clientExports({
628+
Component: {deep: 'thing'},
629+
});
630+
async function awaitExport() {
631+
const mod = await ClientModule;
632+
return await Promise.resolve(mod.Component);
633+
}
634+
await expect(awaitExport()).rejects.toThrowError(
635+
`Cannot await or return from a thenable. ` +
636+
`You cannot await a client module from a server component.`,
637+
);
638+
});
639+
626640
it('throws when accessing a symbol prop from client exports', () => {
627641
const symbol = Symbol('test');
628642
const ClientModule = clientExports({

0 commit comments

Comments
 (0)