Unstable Vite: support for custom servers

[pcattori]

Expanded createRequestHandler to accept a function for build that acts as a dynamic way to get the latest build during dev. Then added APIs for custom server to delegate asset handling and SSR to Vite in dev:

import { createViteServer, loadViteServerBuild } from "@remix-run/dev"

// util to setup a Vite dev server in middleware mode
let vite = createViteServer()
//  ^? import("vite").ViteDevServer

// serve assets via built-in Vite middleware
app.use(vite.middlewares)

// serve SSR via Remix's request handler
app.use('*', createRequestHandler(() => loadViteServerBuild(vite)))

Names prefixed with unstable_ for now

Example usage

// server.mjs
import {
  unstable_createViteServer,
  unstable_loadViteServerBuild,
} from "@remix-run/dev";
import { createRequestHandler } from "@remix-run/express";
import { installGlobals } from "@remix-run/node";
import compression from "compression";
import express from "express";
import morgan from "morgan";
import sourceMapSupport from "source-map-support";

sourceMapSupport.install();
installGlobals();

let vite =
  process.env.NODE_ENV === "production"
    ? undefined
    : await unstable_createViteServer();

const app = express();
app.disable("x-powered-by");

if (vite) {
  app.use(vite.middlewares);
} else {
  app.use(compression());
  app.use(
    "/build",
    express.static("public/build", { immutable: true, maxAge: "1y" })
  );
}
app.use(express.static("public", { maxAge: "1h" }));
app.use(morgan("tiny"));

app.all(
  "*",
  createRequestHandler({
    build: vite
      ? () => unstable_loadViteServerBuild(vite)
      : await import("./build/index.js"),
  })
);

const port = process.env.PORT || 3000;
app.listen(port, async () => console.log(`Express server listening on port ${port}`));

Testing Strategy

Integration tests

TODO

• switch to using .ts for vite config

[changeset-bot]

⚠️ No Changeset found

Latest commit: c91dde0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[pcattori]

@markdalgleish maybe we just want to unset all server options for child compiler since we don't want to use it as a server at all?

[pcattori]

purposefully placing the await within requestHandler so that createRequestHandler doesn't need to change to async which would be breaking change.

[pcattori]

note: duplicated "server-entry" literal from plugin.ts since creating an abstraction on our virtual modules seemed unnecessary so far. might revisit this.

[pcattori]

Windows CI is failing. Going to investigate/resolve this with a Windows VM next week.

[github-actions]

🤖 Hello there,

We just published version 2.2.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!

[github-actions]

🤖 Hello there,

We just published version 2.2.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!