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

feat(remix-dev,remix-serve): include publicPath in server build manifest #3349

Merged
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/remix-dev/__tests__/readConfig-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ describe("readConfig", () => {
devServerPort: expect.any(Number),
serverBuildPath: expect.any(String),
assetsBuildDirectory: expect.any(String),
relativeAssetsBuildDirectory: expect.any(String),
},
`
Object {
Expand All @@ -32,6 +33,7 @@ describe("readConfig", () => {
"entryServerFile": "entry.server.tsx",
"mdx": undefined,
"publicPath": "/build/",
"relativeAssetsBuildDirectory": Any<String>,
"rootDirectory": Any<String>,
"routes": Object {
"root": Object {
Expand Down
9 changes: 8 additions & 1 deletion packages/remix-dev/cli/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,14 @@ export async function dev(
purgeAppRequireCache(config.serverBuildPath);
next();
});
app.use(createApp(config.serverBuildPath, mode));
app.use(
createApp(
config.serverBuildPath,
mode,
config.publicPath,
config.assetsBuildDirectory
)
);

let server: Server | null = null;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ ${Object.keys(config.routes)
export { default as assets } from ${JSON.stringify(
assetsManifestVirtualModule.id
)};
export const assetsBuildDirectory = ${JSON.stringify(
config.relativeAssetsBuildDirectory
)};
export const publicPath = ${JSON.stringify(config.publicPath)};
export const entry = { module: entryServer };
export const routes = {
${Object.keys(config.routes)
Expand Down
19 changes: 14 additions & 5 deletions packages/remix-dev/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,11 @@ export interface RemixConfig {
*/
assetsBuildDirectory: string;

/**
* the original relative path to the assets build directory
*/
relativeAssetsBuildDirectory: string;

/**
* The URL prefix of the public build with a trailing slash.
*/
Expand Down Expand Up @@ -359,11 +364,14 @@ export async function readConfig(
serverBuildPath = path.resolve(rootDirectory, appConfig.serverBuildPath);
}

let assetsBuildDirectory = path.resolve(
rootDirectory,
let assetsBuildDirectory =
appConfig.assetsBuildDirectory ||
appConfig.browserBuildDirectory ||
path.join("public", "build")
appConfig.browserBuildDirectory ||
path.join("public", "build");

let absoluteAssetsBuildDirectory = path.resolve(
rootDirectory,
assetsBuildDirectory
);

let devServerPort =
Expand Down Expand Up @@ -435,7 +443,8 @@ export async function readConfig(
entryServerFile,
devServerPort,
devServerBroadcastDelay,
assetsBuildDirectory,
assetsBuildDirectory: absoluteAssetsBuildDirectory,
relativeAssetsBuildDirectory: assetsBuildDirectory,
publicPath,
rootDirectory,
routes,
Expand Down
15 changes: 10 additions & 5 deletions packages/remix-serve/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ import os from "os";

import { createApp } from "./index";

let port = Number.parseInt(process.env.PORT || "3000", 10);
if (Number.isNaN(port)) {
port = 3000;
}
let port = process.env.PORT ? Number(process.env.PORT) : 3000;
if (Number.isNaN(port)) port = 3000;

let buildPathArg = process.argv[2];

Expand Down Expand Up @@ -35,7 +33,14 @@ let onListen = () => {
}
};

let app = createApp(buildPath);
let build = require(buildPath);

let app = createApp(
buildPath,
process.env.NODE_ENV,
build.publicPath,
build.assetsBuildDirectory
);
let server = process.env.HOST
? app.listen(port, process.env.HOST, onListen)
: app.listen(port, onListen);
Expand Down
11 changes: 8 additions & 3 deletions packages/remix-serve/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,21 @@ import compression from "compression";
import morgan from "morgan";
import { createRequestHandler } from "@remix-run/express";

export function createApp(buildPath: string, mode = "production") {
export function createApp(
buildPath: string,
mode = "production",
publicPath = "/build/",
assetsBuildDirectory = "public/build/"
) {
let app = express();

app.disable("x-powered-by");

app.use(compression());

app.use(
"/build",
express.static("public/build", { immutable: true, maxAge: "1y" })
publicPath,
express.static(assetsBuildDirectory, { immutable: true, maxAge: "1y" })
);

app.use(express.static("public", { maxAge: "1h" }));
mcansh marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
2 changes: 2 additions & 0 deletions packages/remix-server-runtime/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ export interface ServerBuild {
};
routes: ServerRouteManifest;
assets: AssetsManifest;
publicPath: string;
assetsBuildDirectory: string;
}

export interface HandleDocumentRequestFunction {
Expand Down