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

Vite: client references to .server code result in build-time error #8184

Merged
merged 2 commits into from Nov 30, 2023

Conversation

pcattori
Copy link
Contributor

@pcattori pcattori commented Nov 30, 2023

Remix already ensures that all code from .server files (and now also .server directories) gets replaced with an empty module, so there's no way for .server code to end up in the client. Ideally, all references to .server code get stripped in the client anyway, but replacing them with empty modules is a failsafe. In the case that there are still imports for .server files in the client, those will correctly result in errors.

However, those errors could sometimes happen at runtime, meaning that it was possible for your CI/CD pipeline to pass and for you to deploy your app only for your users to hit a "cannot reference .server code within the client" error. This is already much better than leaking server data in the client, but still not ideal. Specifically, this could happen when using default exports within a .server file/directory.

This PR adds test to ensure that named imports, namespace imports, and default imports from .server files/directories all fail at build time. That ensures that your CI/CD pipeline fails before you ever deploy any references to (empty) .server modules that could result in ugly errors for your users.

To get default exports to fail at build time, we needed to switch our empty module stub from export default {} to export {}. So this PR also makes that change.

Copy link

changeset-bot bot commented Nov 30, 2023

🦋 Changeset detected

Latest commit: 4401926

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 16 packages
Name Type
@remix-run/dev Patch
create-remix Patch
remix Patch
@remix-run/architect Patch
@remix-run/cloudflare Patch
@remix-run/cloudflare-pages Patch
@remix-run/cloudflare-workers Patch
@remix-run/css-bundle Patch
@remix-run/deno Patch
@remix-run/eslint-config Patch
@remix-run/express Patch
@remix-run/node Patch
@remix-run/react Patch
@remix-run/serve Patch
@remix-run/server-runtime Patch
@remix-run/testing Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@pcattori pcattori changed the title Pedro/vite empty modules Vite: client references to .server code result in build-time error Nov 30, 2023
@pcattori pcattori merged commit 3205687 into dev Nov 30, 2023
9 checks passed
@pcattori pcattori deleted the pedro/vite-empty-modules branch November 30, 2023 17:48
@github-actions github-actions bot added the awaiting release This issue has been fixed and will be released soon label Nov 30, 2023
Copy link
Contributor

github-actions bot commented Dec 5, 2023

🤖 Hello there,

We just published version 2.4.0-pre.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

Copy link
Contributor

🤖 Hello there,

We just published version 2.4.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

@github-actions github-actions bot removed the awaiting release This issue has been fixed and will be released soon label Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant