@brillout/vite-plugin-server-entry

• What is this?
• Manual import
• How it works

 

What is this?

@brillout/vite-plugin-server-entry does two things:

• Generates the server production entry dist/server/entry.js.
• Automatically loads it.

Vike and Telefunc automatically use and configure this plugin on your behalf: there is nothing for you to do and you can usually ignore this plugin.

^{⇧ TOP ⇧}

Manual import

Normally, the dist/server/entry.js file is automatically imported.

But this automatic importing doesn't work with Yarn PnP and certain Docker configurations, and you'll keep getting the following error:

[@brillout/vite-plugin-server-entry][Wrong Usage] The server production entry is missing
or wasn't imported. (Re-)build your app and try again. If you still get this error,
then you need to manually import the server production entry.

The workaround is to manually import dist/server/entry.js in your server code.

// server.js

// Add this import at the begining of your server code
import './path/to/dist/server/entry.js'

// Your server code (Express.js, Hono, Vercel Serverless/Edge Function, Cloudflare Worker, ...)
// ...

Make sure to import dist/server/entry.js only in production, see Conditional manual import.

[!NOTE] The file extension may be different than .js (e.g. dist/server/entry.mjs), and the build directory location is determined by vite.config.js > build.outDir which may be different than dist/ (e.g. build/server/entry.js). Adjust your import accordingly:

- import './path/to/dist/server/entry.js
+ import './path/to/build/server/entry.mjs

[!NOTE] If you aren't using Yarn PnP nor Docker and you keep getting this error, then it's most likely a bug and please file a bug report.

[!NOTE] Technically, the automatic importing doesn't work when your node_modules/ directory is immutable or if you remove/reset node_modules/ after you build your app for production. If you want to know more, see How it works.

^{⇧ TOP ⇧}

How it works

[!NOTE] You usually don't need to read this. If you have a problem, reading the section Manual import is usually enough.

@brillout/vite-plugin-server-entry does two things:

• Generates a "server production entry" file dist/server/entry.js.
• Generates a "auto importer" file node_modules/@brillout/vite-plugin-server-entry/dist/importServerEntry/autoImporter.js.

The server production entry, which is located at dist/server/entry.js, enables tools such as Vike and Telefunc to consolidate their production entry into a single file. It loads the user files built for production which are located at dist/** (e.g. the built .telefunc.js user files for Telefunc, and the built +Page.js user files for Vike).

The auto importer file, which is located at node_modules/@brillout/vite-plugin-server-entry/dist/importServerEntry/autoImporter.js, automatically imports dist/server/entry.js on your behalf, so that you don't have to manually import dist/server/entry.js yourself as shown in the following. That's the only purpose of the auto importer.

// server/index.js (*your* server entry)

// Without the auto importer, you would have to manually import dist/server/entry.js
// yourself, for example like this:
if (process.env.NODE_ENV === 'production') {
  await import('../dist/server/entry.js')
}

See How the auto importer works for more information.

^{⇧ TOP ⇧}

Changelog

0.4.13 (2024-10-08)

Bug Fixes

• improve manual import instructions (fab34c2)