Support custom entry.server file in Vercel Vite Preset

[TooTallNate]

Allows for a custom entry.server.jsx/entery.server.tsx file to exist in the project. The following heuristics are used to determine whether or not to copy in the Vercel-specific entry.server file:

• If there is no entry.server file, then we copy in the Vercel entry server
• If there is a entry.server file, then we hash the contents to try to determine if the file has been modified from a known default Remix template^[1].
  • If there's a hash match, we can safely copy in the Vercel entry server
  • If there's no match, then we run a RegExp on the contents to see if @vercel/remix is being used
    • If no RegExp match, we print a warning and link to docs, but allow the build to continue

[1]: There is a script to generate the JSON file containing the sha256sums of the all Remix templates' entry.server contents throughout the Git history. For now, I just ran the script manually. In the future, we can set up a GH Action to automate updating the JSON file.

To test this out

Install the @vercel/remix package from this URL: https://remix-git-tootallnate-zero-1664-allow-for-custom-entryse-6ab7cd.vercel.sh/vercel-remix.tgz

npm i https://remix-git-tootallnate-zero-1664-allow-for-custom-entryse-6ab7cd.vercel.sh/vercel-remix.tgz

Your customized entry.server file should be based on this starting point:

import { RemixServer } from "@remix-run/react";
import { handleRequest } from "@vercel/remix";

export default function (
  request,
  responseStatusCode,
  responseHeaders,
  remixContext
) {
  let remixServer = <RemixServer context={remixContext} url={request.url} />;
  return handleRequest(
    request,
    responseStatusCode,
    responseHeaders,
    remixServer
  );
}

After that you can deploy to Vercel as usual.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
remix	✅ Ready (Inspect)	Visit Preview	Mar 15, 2024 2:53am

[Gbuomprisco]

Hi @TooTallNate - this is working for me, thanks for that.

The only issue I encountered is that my index route (which is under the route _site._index.tsx) does not get compiled, resulting in a 404 error.

[TooTallNate]

@Gbuomprisco Could you share a repository demonstrating the 404 issue (ideally in a new issue)?

[Gbuomprisco]

It seems to work fine in a minimal starter but not with my (largeish) application :| I'll keep testing!

[EndangeredMassa]

Is there a test we can write for this?

[TooTallNate]

@EndangeredMassa Test will be added on the Remix builder side.