feat(remix-dev/vite): remove unstable prefix from serverBundles (#8596)

remix-run · Jan 25, 2024 · 656aa29 · 656aa29
1 parent ec21f5d
commit 656aa29
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 13 deletions.
diff --git a/integration/vite-adapter-test.ts b/integration/vite-adapter-test.ts
@@ -32,9 +32,9 @@ test.describe(async () => {
         pluginOptions: `
           {
             adapter: async ({ remixConfig }) => ({
-              unstable_serverBundles(...args) {
+              serverBundles(...args) {
                 // This lets us assert that user options are passed to adapter options hook
-                return remixConfig.unstable_serverBundles?.(...args) + "--adapter-options";
+                return remixConfig.serverBundles?.(...args) + "--adapter-options";
               },
               async buildEnd(args) {
                 let fs = await import("node:fs/promises");
@@ -53,7 +53,7 @@ test.describe(async () => {
               }
             }),
             
-            unstable_serverBundles() {
+            serverBundles() {
               return "user-options";
             }
           },
@@ -64,7 +64,7 @@ test.describe(async () => {
   });
   test.afterAll(() => stop());
 
-  test("Vite / adapter / unstable_serverBundles and buildEnd hooks", async () => {
+  test("Vite / adapter / serverBundles and buildEnd hooks", async () => {
     let { status } = viteBuild({ cwd });
     expect(status).toBe(0);
 

diff --git a/integration/vite-server-bundles-test.ts b/integration/vite-server-bundles-test.ts
@@ -122,7 +122,7 @@ test.describe(() => {
         port: devPort,
         pluginOptions: `{
           manifest: true,
-          unstable_serverBundles: async ({ branch }) => {
+          serverBundles: async ({ branch }) => {
             // Smoke test to ensure we can read the route files via 'route.file'
             await Promise.all(branch.map(async (route) => {
               const fs = await import("node:fs/promises");

diff --git a/packages/remix-dev/vite/build.ts b/packages/remix-dev/vite/build.ts
@@ -153,9 +153,7 @@ async function getServerBuilds(ctx: RemixPluginContext): Promise<{
         ),
       });
       if (typeof serverBundleId !== "string") {
-        throw new Error(
-          `The "unstable_serverBundles" function must return a string`
-        );
+        throw new Error(`The "serverBundles" function must return a string`);
       }
       buildManifest.routeIdToServerBundleId[route.id] = serverBundleId;
 

diff --git a/packages/remix-dev/vite/plugin.ts b/packages/remix-dev/vite/plugin.ts
@@ -112,7 +112,7 @@ export type ServerBundlesBuildManifest = BaseBuildManifest & {
 export type BuildManifest = DefaultBuildManifest | ServerBundlesBuildManifest;
 
 const adapterRemixConfigOverrideKeys = [
-  "unstable_serverBundles",
+  "serverBundles",
 ] as const satisfies ReadonlyArray<keyof VitePluginConfig>;
 
 type AdapterRemixConfigOverrideKey =
@@ -164,7 +164,7 @@ export type VitePluginConfig = RemixEsbuildUserConfigJsdocOverrides &
      * function should return a server bundle ID which will be used as the
      * bundle's directory name within the server build directory.
      */
-    unstable_serverBundles?: ServerBundlesFunction;
+    serverBundles?: ServerBundlesFunction;
     /**
      * Enable server-side rendering for your application. Disable to use Remix in
      * "SPA Mode", which will request the `/` path at build-time and save it as
@@ -492,15 +492,14 @@ export const remixVitePlugin: RemixVitePlugin = (remixUserConfig = {}) => {
       resolvedRemixUserConfig.buildDirectory
     );
 
-    let { serverBuildFile, unstable_serverBundles: serverBundles } =
-      resolvedRemixUserConfig;
+    let { serverBuildFile, serverBundles } = resolvedRemixUserConfig;
 
     // Log warning for incompatible vite config flags
     if (isSpaMode && serverBundles) {
       console.warn(
         colors.yellow(
           colors.bold("⚠️  SPA Mode: ") +
-            "the `unstable_serverBundles` config is invalid with " +
+            "the `serverBundles` config is invalid with " +
             "`unstable_ssr:false` and will be ignored`"
         )
       );