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(dev): serve any non-Remix assets from public/ #6279

Merged
merged 4 commits into from
May 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/ninety-flies-allow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@remix-run/dev": patch
---

- Fix public asset serving for non-Remix assets in the new dev server
- Add `--public-directory` / `unstable_dev.publicDirectory` option for configuring local directory for serving non-Remix assets like fonts
- Fix `svg` serving for new dev server
2 changes: 1 addition & 1 deletion integration/hmr-log-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ test("HMR", async ({ page }) => {
}
});

let portRange = makeRange(3080, 3099);
let portRange = makeRange(4080, 4099);
let appServerPort = await getPort({ port: portRange });
let httpPort = await getPort({ port: portRange });
let webSocketPort = await getPort({ port: portRange });
Expand Down
1 change: 1 addition & 0 deletions packages/remix-dev/__tests__/cli-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ describe("remix CLI", () => {
--http-host HTTP(S) host for the dev server. Default: localhost
--http-port HTTP(S) port for the dev server. Default: any open port
--no-restart Do not restart the app server when rebuilds occur.
--public-directory Path to public assets directory relative to Remix project root. Default: public
--websocket-port Websocket port for the dev server. Default: any open port
\`init\` Options:
--no-delete Skip deleting the \`remix.init\` script
Expand Down
9 changes: 9 additions & 0 deletions packages/remix-dev/cli/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ export async function dev(
httpHost?: string;
httpPort?: number;
restart?: boolean;
publicDirectory?: string;
websocketPort?: number;
} = {}
) {
Expand Down Expand Up @@ -515,6 +516,7 @@ let resolveDevBuild = async (

type DevServeFlags = DevBuildFlags & {
command: string;
publicDirectory: string;
restart: boolean;
};
let resolveDevServe = async (
Expand Down Expand Up @@ -552,6 +554,12 @@ let resolveDevServe = async (
process.exit(1);
}
}

let publicDirectory =
flags.publicDirectory ??
(dev === true ? undefined : dev.publicDirectory) ??
"public";

let restart =
flags.restart ?? (dev === true ? undefined : dev.restart) ?? true;

Expand All @@ -560,6 +568,7 @@ let resolveDevServe = async (
httpScheme,
httpHost,
httpPort,
publicDirectory,
websocketPort,
restart,
};
Expand Down
6 changes: 6 additions & 0 deletions packages/remix-dev/cli/run.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ ${colors.logoBlue("R")} ${colors.logoGreen("E")} ${colors.logoYellow(
--http-host HTTP(S) host for the dev server. Default: localhost
--http-port HTTP(S) port for the dev server. Default: any open port
--no-restart Do not restart the app server when rebuilds occur.
--public-directory Path to public assets directory relative to Remix project root. Default: public
--websocket-port Websocket port for the dev server. Default: any open port
\`init\` Options:
--no-delete Skip deleting the \`remix.init\` script
Expand Down Expand Up @@ -188,6 +189,7 @@ export async function run(argv: string[] = process.argv.slice(2)) {
"--http-host": String,
"--http-port": Number,
"--no-restart": Boolean,
"--public-directory": String,
"--websocket-port": Number,
},
{
Expand Down Expand Up @@ -225,6 +227,10 @@ export async function run(argv: string[] = process.argv.slice(2)) {
flags.httpPort = flags["http-port"];
delete flags["http-port"];
}
if (flags["public-directory"]) {
flags.publicDirectory = flags["public-directory"];
delete flags["public-directory"];
}
if (flags["websocket-port"]) {
flags.websocketPort = flags["websocket-port"];
delete flags["websocket-port"];
Expand Down
6 changes: 5 additions & 1 deletion packages/remix-dev/compiler/js/compiler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,11 @@ const createEsbuildConfig = (
platform: "browser",
format: "esm",
external: getExternals(ctx.config),
loader: loaders,
loader: {
...loaders,
// in development, use dataurls for svgs so that `<use href={mysvg} />` works across different origins
".svg": ctx.options.mode === "development" ? "dataurl" : loaders[".svg"],
},
bundle: true,
logLevel: "silent",
splitting: true,
Expand Down
1 change: 1 addition & 0 deletions packages/remix-dev/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ type Dev = {
httpPort?: number;
websocketPort?: number;
restart?: boolean;
publicDirectory?: string;
};

interface FutureConfig {
Expand Down
2 changes: 2 additions & 0 deletions packages/remix-dev/devServer_unstable/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ export let serve = async (
httpScheme: string;
httpHost: string;
httpPort: number;
publicDirectory: string;
websocketPort: number;
restart: boolean;
}
Expand Down Expand Up @@ -196,6 +197,7 @@ export let serve = async (
maxAge: "1y",
})
)
.use(express.static(options.publicDirectory, { maxAge: "1h" }))

// handle `broadcastDevReady` messages
.use(express.json())
Expand Down