Feat: unnecessary to compile routes config for server render (#6856)

* fix: unnecessary to compile routes config for server render * chore: format ejs template * feat: support build fallback entry * chore: add test case for fallback entry * chore: update lock * chore: changeset * chore: lint * chore: lint * chore: remove console log * fix: merge conflict * fix: undefined assign
alibaba · Jun 17, 2024 · 15c8200 · 15c8200
1 parent d073ee5
commit 15c8200
Show file tree

Hide file tree

Showing 45 changed files with 429 additions and 504 deletions.
diff --git a/.changeset/green-files-watch.md b/.changeset/green-files-watch.md
@@ -0,0 +1,7 @@
+---
+'@ice/shared-config': patch
+'@ice/runtime': patch
+'@ice/app': patch
+---
+
+feat: support build additional server entry for fallback
diff --git a/examples/basic-project/tsconfig.json b/examples/basic-project/tsconfig.json
@@ -29,4 +29,4 @@
   },
   "include": ["src", ".ice", "ice.config.*"],
   "exclude": ["build", "public"]
-}
+}
diff --git a/examples/with-entry-type/ice.config.mts b/examples/with-entry-type/ice.config.mts
diff --git a/examples/with-entry-type/src/document.tsx b/examples/with-entry-type/src/document.tsx
diff --git a/examples/with-entry-type/src/pages/Custom/index.tsx b/examples/with-entry-type/src/pages/Custom/index.tsx
diff --git a/examples/with-entry-type/src/pages/about.tsx b/examples/with-entry-type/src/pages/about.tsx
diff --git a/examples/with-entry-type/src/pages/blog.tsx b/examples/with-entry-type/src/pages/blog.tsx
diff --git a/examples/with-entry-type/src/pages/home.tsx b/examples/with-entry-type/src/pages/home.tsx
diff --git a/examples/with-entry-type/src/pages/index.module.css b/examples/with-entry-type/src/pages/index.module.css
diff --git a/examples/with-entry-type/src/pages/layout.tsx b/examples/with-entry-type/src/pages/layout.tsx
diff --git a/examples/with-entry-type/.browserslistrc → examples/with-fallback-entry/.browserslistrc b/examples/with-entry-type/.browserslistrc → examples/with-fallback-entry/.browserslistrc
diff --git a/examples/with-fallback-entry/ice.config.mts b/examples/with-fallback-entry/ice.config.mts
@@ -0,0 +1,10 @@
+import { defineConfig } from '@ice/app';
+import plugin from './plugin';
+
+export default defineConfig(() => ({
+  plugins: [plugin()],
+  ssr: true,
+  server: {
+    format: 'cjs',
+  }
+}));
diff --git a/examples/with-entry-type/package.json → examples/with-fallback-entry/package.json b/examples/with-entry-type/package.json → examples/with-fallback-entry/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@examples/with-entry-type",
-  "private": true,
+  "name": "@examples/with-fallback-entry",
   "version": "1.0.0",
+  "private": true,
   "scripts": {
     "start": "ice start",
     "build": "ice build"
@@ -12,11 +12,10 @@
   "dependencies": {
     "@ice/app": "workspace:*",
     "@ice/runtime": "workspace:*",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "fs-extra": "^10.0.0",
     "@types/react": "^18.0.0",
     "@types/react-dom": "^18.0.2",
     "webpack": "^5.88.0"

diff --git a/examples/with-fallback-entry/plugin.ts b/examples/with-fallback-entry/plugin.ts
@@ -0,0 +1,12 @@
+export default function createPlugin() {
+  return {
+    name: 'custom-plugin',
+    setup({ onGetConfig }) {
+      onGetConfig((config) => {
+        config.server = {
+          fallbackEntry: true,
+        };
+      });
+    },
+  };
+}
diff --git a/examples/with-entry-type/public/favicon.ico → ...es/with-fallback-entry/public/favicon.ico b/examples/with-entry-type/public/favicon.ico → ...es/with-fallback-entry/public/favicon.ico
diff --git a/examples/with-entry-type/src/app.tsx → examples/with-fallback-entry/src/app.tsx b/examples/with-entry-type/src/app.tsx → examples/with-fallback-entry/src/app.tsx
diff --git a/examples/with-fallback-entry/src/document.tsx b/examples/with-fallback-entry/src/document.tsx
@@ -0,0 +1,22 @@
+import { Meta, Title, Links, Main, Scripts } from 'ice';
+
+function Document() {
+  return (
+    <html>
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="description" content="ICE Demo" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Title />
+        <Links />
+      </head>
+      <body>
+        <Main />
+        <Scripts />
+      </body>
+    </html>
+  );
+}
+
+export default Document;
diff --git a/examples/with-fallback-entry/src/global.css b/examples/with-fallback-entry/src/global.css
@@ -0,0 +1,3 @@
+body {
+  font-size: 14px;
+}
diff --git a/examples/with-fallback-entry/src/pages/index.tsx b/examples/with-fallback-entry/src/pages/index.tsx
@@ -0,0 +1,3 @@
+export default function Home() {
+  return <h1>home</h1>;
+}
diff --git a/examples/with-entry-type/src/typings.d.ts → ...ples/with-fallback-entry/src/typings.d.ts b/examples/with-entry-type/src/typings.d.ts → ...ples/with-fallback-entry/src/typings.d.ts
diff --git a/examples/with-entry-type/tsconfig.json → examples/with-fallback-entry/tsconfig.json b/examples/with-entry-type/tsconfig.json → examples/with-fallback-entry/tsconfig.json
diff --git a/packages/ice/src/bundler/config/plugins.ts b/packages/ice/src/bundler/config/plugins.ts
@@ -1,5 +1,7 @@
+import path from 'path';
+import type { CommandName } from 'build-scripts';
 import ServerRunnerPlugin from '../../webpack/ServerRunnerPlugin.js';
-import { IMPORT_META_RENDERER, IMPORT_META_TARGET, WEB } from '../../constant.js';
+import { IMPORT_META_RENDERER, IMPORT_META_TARGET, WEB, FALLBACK_ENTRY, RUNTIME_TMP_DIR } from '../../constant.js';
 import getServerCompilerPlugin from '../../utils/getServerCompilerPlugin.js';
 import ReCompilePlugin from '../../webpack/ReCompilePlugin.js';
 import getEntryPoints from '../../utils/getEntryPoints.js';
@@ -20,6 +22,18 @@ export const getSpinnerPlugin = (spinner, name?: string) => {
   };
 };
 
+export const getFallbackEntry = (options: {
+  rootDir: string;
+  command: CommandName;
+  fallbackEntry: boolean;
+}): string => {
+  const { command, fallbackEntry, rootDir } = options;
+  if (command === 'build' && fallbackEntry) {
+    return path.join(rootDir, RUNTIME_TMP_DIR, FALLBACK_ENTRY);
+  }
+  return '';
+};
+
 interface ServerPluginOptions {
   serverRunner?: ServerRunner;
   serverCompiler?: ServerCompiler;
@@ -30,6 +44,7 @@ interface ServerPluginOptions {
   serverEntry?: string;
   ensureRoutesConfig: () => Promise<void>;
   userConfig?: UserConfig;
+  fallbackEntry?: string;
   getFlattenRoutes?: () => string[];
   command?: string;
 }
@@ -43,6 +58,7 @@ export const getServerPlugin = ({
   outputDir,
   serverCompileTask,
   userConfig,
+  fallbackEntry,
   getFlattenRoutes,
   command,
 }: ServerPluginOptions) => {
@@ -53,6 +69,7 @@ export const getServerPlugin = ({
     return getServerCompilerPlugin(serverCompiler, {
       rootDir,
       serverEntry,
+      fallbackEntry,
       outputDir,
       serverCompileTask,
       userConfig,

diff --git a/packages/ice/src/bundler/rspack/getConfig.ts b/packages/ice/src/bundler/rspack/getConfig.ts
@@ -11,7 +11,7 @@ import {
   CSS_MODULES_LOCAL_IDENT_NAME,
   CSS_MODULES_LOCAL_IDENT_NAME_DEV,
 } from '../../constant.js';
-import { getReCompilePlugin, getServerPlugin, getSpinnerPlugin } from '../config/plugins.js';
+import { getFallbackEntry, getReCompilePlugin, getServerPlugin, getSpinnerPlugin } from '../config/plugins.js';
 import { getExpandedEnvs } from '../../utils/runtimeEnv.js';
 import type { BundlerOptions, Context } from '../types.js';
 import type { PluginData } from '../../types/plugin.js';
@@ -34,8 +34,8 @@ const getConfig: GetConfig = async (context, options, rspack) => {
   } = options;
   const {
     rootDir,
-    userConfig,
     command,
+    userConfig,
     extendsPluginAPI: {
       serverCompileTask,
       getRoutesFile,
@@ -50,6 +50,11 @@ const getConfig: GetConfig = async (context, options, rspack) => {
       getSpinnerPlugin(spinner),
       // Add Server runner plugin.
       getServerPlugin({
+        fallbackEntry: getFallbackEntry({
+          rootDir,
+          command,
+          fallbackEntry: server?.fallbackEntry,
+        }),
         serverRunner,
         ensureRoutesConfig,
         serverCompiler,
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,4 +29,4 @@ @@
       },
       "include": ["src", ".ice", "ice.config.*"],
       "exclude": ["build", "public"]
-    }
+    }