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

Clean redundant ?client-route=1 usage in dev #9395

Merged
merged 1 commit into from
May 9, 2024
Merged

Clean redundant ?client-route=1 usage in dev #9395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/slimy-shrimps-roll.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@remix-run/dev": patch
---

Clean up redundant `?client-route=1` imports in development
47 changes: 20 additions & 27 deletions packages/remix-dev/vite/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,11 @@ const CLIENT_ROUTE_EXPORTS = [
"shouldRevalidate",
];

// The "=1" suffix ensures client route requests can be processed before hitting
// the Vite plugin since "?client-route" can be serialized as "?client-route="
const CLIENT_ROUTE_QUERY_STRING = "?client-route=1";
/** This is used to manage a build optimization to remove unused route exports
from the client build output. This is important in cases where custom route
exports are only ever used on the server. Without this optimization we can't
tree-shake any unused custom exports because routes are entry points. */
const BUILD_CLIENT_ROUTE_QUERY_STRING = "?__remix-build-client-route";
Copy link
Member Author

Choose a reason for hiding this comment

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

Since this query string is no longer visible in the browser's network tab, I'm not trying to make this look pretty anymore and instead I'm aiming for it to be more explicit.

Copy link
Member Author

@markdalgleish markdalgleish May 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Also the =1 suffix is no longer needed since that was to solve an issue when proxying during development. In production builds this query string never goes over the network.


// Only expose a subset of route properties to the "serverBundles" function
const branchRouteProperties = [
Expand Down Expand Up @@ -318,10 +320,6 @@ const getHash = (source: BinaryLike, maxLength?: number): string => {
return typeof maxLength === "number" ? hash.slice(0, maxLength) : hash;
};

const isClientRoute = (id: string): boolean => {
return id.endsWith(CLIENT_ROUTE_QUERY_STRING);
};

const resolveChunk = (
ctx: RemixPluginContext,
viteManifest: Vite.Manifest,
Expand All @@ -332,7 +330,7 @@ const resolveChunk = (
path.relative(ctx.rootDirectory, absoluteFilePath)
);
let entryChunk =
viteManifest[rootRelativeFilePath + CLIENT_ROUTE_QUERY_STRING] ??
viteManifest[rootRelativeFilePath + BUILD_CLIENT_ROUTE_QUERY_STRING] ??
viteManifest[rootRelativeFilePath];

if (!entryChunk) {
Expand Down Expand Up @@ -966,7 +964,7 @@ export const remixVitePlugin: RemixVitePlugin = (remixUserConfig = {}) => {
`${resolveFileUrl(
ctx,
resolveRelativeRouteFilePath(route, ctx.remixConfig)
)}${CLIENT_ROUTE_QUERY_STRING}`
)}`
),
hasAction: sourceExports.includes("action"),
hasLoader: sourceExports.includes("loader"),
Expand Down Expand Up @@ -1142,7 +1140,7 @@ export const remixVitePlugin: RemixVitePlugin = (remixUserConfig = {}) => {
`${path.resolve(
ctx.remixConfig.appDirectory,
route.file
)}${CLIENT_ROUTE_QUERY_STRING}`
)}${BUILD_CLIENT_ROUTE_QUERY_STRING}`
),
],
},
Expand Down Expand Up @@ -1271,8 +1269,8 @@ export const remixVitePlugin: RemixVitePlugin = (remixUserConfig = {}) => {
cssModulesManifest[id] = code;
}

if (isClientRoute(id)) {
let routeModuleId = id.replace(CLIENT_ROUTE_QUERY_STRING, "");
if (id.endsWith(BUILD_CLIENT_ROUTE_QUERY_STRING)) {
Copy link
Member Author

Choose a reason for hiding this comment

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

Inlined isClientRoute here since it's now the only usage.

let routeModuleId = id.replace(BUILD_CLIENT_ROUTE_QUERY_STRING, "");
let sourceExports = await getRouteModuleExports(
viteChildCompiler,
ctx,
Expand Down Expand Up @@ -1695,10 +1693,6 @@ export const remixVitePlugin: RemixVitePlugin = (remixUserConfig = {}) => {
let useFastRefresh = !ssr && (isJSX || code.includes(devRuntime));
if (!useFastRefresh) return;

if (isClientRoute(id)) {
return { code: addRefreshWrapper(ctx.remixConfig, code, id) };
}

Comment on lines -1698 to -1701
Copy link
Member Author

Choose a reason for hiding this comment

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

This code path is only used in dev, so no longer needed.

let result = await babel.transformAsync(code, {
configFile: false,
babelrc: false,
Expand Down Expand Up @@ -1789,17 +1783,16 @@ function addRefreshWrapper(
id: string
): string {
let route = getRoute(remixConfig, id);
let acceptExports =
route || isClientRoute(id)
Copy link
Member Author

@markdalgleish markdalgleish May 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

HMR is no longer needed for these virtual modules since they're only used during build.

? [
"clientAction",
"clientLoader",
"handle",
"meta",
"links",
"shouldRevalidate",
]
: [];
let acceptExports = route
? [
"clientAction",
"clientLoader",
"handle",
"meta",
"links",
"shouldRevalidate",
]
: [];
return (
REACT_REFRESH_HEADER.replaceAll("__SOURCE__", JSON.stringify(id)) +
code +
Expand Down