breaking: no builtin middleware (#1670)

dai-shi · web-flow · commit a9b5085ca1e4 · 2025-09-12T08:30:09.000+09:00
This is the first part of changes for v0.27.0.
diff --git a/e2e/fixtures/broken-links/waku.config.ts b/e2e/fixtures/broken-links/waku.config.ts
@@ -1,10 +1,5 @@
 import { defineConfig } from 'waku/config';
 
 export default defineConfig({
-  middleware: [
-    'waku/middleware/context',
-    './src/redirects.js',
-    'waku/middleware/dev-server',
-    'waku/middleware/handler',
-  ],
+  middleware: ['./src/redirects.js'],
 });
diff --git a/e2e/fixtures/ssr-catch-error/src/pages/_layout.tsx b/e2e/fixtures/ssr-catch-error/src/pages/_layout.tsx
@@ -1,6 +1,6 @@
 import { Suspense } from 'react';
 import type { ReactNode } from 'react';
-import { getContextData } from 'waku/middleware/context';
+import { unstable_getContextData as getContextData } from 'waku/server';
 
 import { ClientLayout } from '../components/client-layout.js';
 
diff --git a/e2e/fixtures/ssr-catch-error/waku.config.ts b/e2e/fixtures/ssr-catch-error/waku.config.ts
@@ -1,12 +1,7 @@
 import { defineConfig } from 'waku/config';
 
 export default defineConfig({
-  middleware: [
-    'waku/middleware/context',
-    'waku/middleware/dev-server',
-    './src/middleware/validator.js',
-    'waku/middleware/handler',
-  ],
+  middleware: ['./src/middleware/validator.js'],
   /**
    * Base path for HTTP requests to indicate RSC requests.
    * Defaults to "RSC".
diff --git a/examples/07_cloudflare/waku.config.ts b/examples/07_cloudflare/waku.config.ts
@@ -3,12 +3,7 @@ import tailwindcss from '@tailwindcss/vite';
 
 export default defineConfig({
   unstable_honoEnhancer: './waku.hono-enhancer',
-  middleware: [
-    'waku/middleware/context',
-    'waku/middleware/dev-server',
-    './waku.cloudflare-middleware',
-    'waku/middleware/handler',
-  ],
+  middleware: ['./waku.cloudflare-middleware'],
   vite: {
     plugins: [tailwindcss()],
     optimizeDeps: {
diff --git a/examples/34_functions/src/components2/funcs2.ts b/examples/34_functions/src/components2/funcs2.ts
@@ -1,6 +1,6 @@
 'use server';
 
-import { getContext } from 'waku/middleware/context';
+import { unstable_getContext as getContext } from 'waku/server';
 
 export const greet = async (name: string) => {
   await Promise.resolve();
diff --git a/examples/38_cookies/src/components/App.tsx b/examples/38_cookies/src/components/App.tsx
@@ -1,5 +1,5 @@
 import { Suspense, cache } from 'react';
-import { getContextData } from 'waku/middleware/context';
+import { unstable_getContextData as getContextData } from 'waku/server';
 
 import { getHonoContext } from '../hono-enhancer';
 import { Counter } from './Counter';
diff --git a/examples/38_cookies/src/server-entry.tsx b/examples/38_cookies/src/server-entry.tsx
@@ -1,7 +1,7 @@
 import fsPromises from 'node:fs/promises';
 import { unstable_defineEntries as defineEntries } from 'waku/minimal/server';
 import { Slot } from 'waku/minimal/client';
-import { getContextData } from 'waku/middleware/context';
+import { unstable_getContextData as getContextData } from 'waku/server';
 import App from './components/App';
 
 export default defineEntries({
diff --git a/examples/38_cookies/waku.config.ts b/examples/38_cookies/waku.config.ts
@@ -2,11 +2,5 @@ import { defineConfig } from 'waku/config';
 
 export default defineConfig({
   unstable_honoEnhancer: './src/hono-enhancer',
-  middleware: [
-    'waku/middleware/context',
-    './src/middleware/cookie.js',
-    './src/middleware/noop.js',
-    'waku/middleware/dev-server',
-    'waku/middleware/handler',
-  ],
+  middleware: ['./src/middleware/cookie.js', './src/middleware/noop.js'],
 });
diff --git a/packages/waku/package.json b/packages/waku/package.json
@@ -26,10 +26,6 @@
       "types": "./dist/config.d.ts",
       "default": "./dist/config.js"
     },
-    "./middleware/*": {
-      "types": "./dist/middleware/*.d.ts",
-      "default": "./dist/middleware/*.js"
-    },
     "./client": {
       "types": "./dist/client.d.ts",
       "default": "./dist/client.js"
diff --git a/packages/waku/src/config.ts b/packages/waku/src/config.ts
@@ -1,8 +1,6 @@
 import type { UserConfig } from 'vite';
-import type { Middleware } from './lib/middleware/types.js';
-import type { BuiltinMiddleware } from './lib/config/types.js';
 
-export type { Middleware };
+export type { Middleware } from './lib/types.js';
 
 export interface Config {
   /**
@@ -50,14 +48,10 @@ export interface Config {
   rscBase?: string;
   /**
    * Middleware to use
-   * Defaults to:
-   * [
-   *   'waku/middleware/context',
-   *   'waku/middleware/dev-server',
-   *   'waku/middleware/handler',
-   * ]
+   * Defaults to: []
+   * @deprecated This will be removed soon.
    */
-  middleware?: (BuiltinMiddleware | (string & {}))[];
+  middleware?: (string & {})[];
   /**
    * Enhancer for Hono
    * Defaults to `undefined`
diff --git a/packages/waku/src/lib/config/types.ts b/packages/waku/src/lib/config/types.ts
@@ -1,10 +1,5 @@
 import type { Config } from '../../config.js';
 
-export type BuiltinMiddleware =
-  | 'waku/middleware/context'
-  | 'waku/middleware/dev-server'
-  | 'waku/middleware/handler';
-
 export type ConfigDev = Required<Config>;
 
 export type ConfigPrd = Pick<Required<Config>, 'basePath' | 'rscBase'>;
diff --git a/packages/waku/src/lib/context.ts b/packages/waku/src/lib/context.ts
@@ -8,7 +8,7 @@ type Context = {
 
 const contextStorage = new AsyncLocalStorage<Context>();
 
-export const context: Middleware = () => {
+export const contextMiddleware: Middleware = () => {
   return async (ctx, next) => {
     const context: Context = {
       req: ctx.req,
diff --git a/packages/waku/src/lib/middleware/types.ts b/packages/waku/src/lib/middleware/types.ts
diff --git a/packages/waku/src/lib/types.ts b/packages/waku/src/lib/types.ts
@@ -59,3 +59,25 @@ export type ServerEntries = {
     handleBuild: HandleBuild;
   };
 };
+
+/** @deprecated This will be removed soon. */
+export type HandlerContext = {
+  req: Request;
+  res?: Response;
+  readonly data: Record<string, unknown>;
+};
+
+/** @deprecated This will be removed soon. */
+type Handler = (
+  ctx: HandlerContext,
+  next: () => Promise<void>,
+) => Promise<void>;
+
+/** @deprecated This will be removed soon. */
+export type MiddlewareOptions = {
+  cmd: 'dev' | 'start';
+  env: Record<string, string>;
+};
+
+/** @deprecated This will be removed soon. */
+export type Middleware = (options: MiddlewareOptions) => Handler;
diff --git a/packages/waku/src/lib/utils/request.ts b/packages/waku/src/lib/utils/request.ts
@@ -1,8 +1,7 @@
 import type { ReactFormState } from 'react-dom/client';
 import { decodeFuncId, decodeRscPath } from '../renderers/utils.js';
-import type { HandlerContext } from '../middleware/types.js';
 import type { ConfigDev } from '../config/types.js';
-import type { HandleRequest } from '../types.js';
+import type { HandleRequest, HandlerContext } from '../types.js';
 
 type HandleRequestInput = Parameters<HandleRequest>[0];
 
diff --git a/packages/waku/src/lib/vite-rsc/engine.ts b/packages/waku/src/lib/vite-rsc/engine.ts
@@ -1,7 +1,9 @@
-import type { HandlerContext, MiddlewareOptions } from '../middleware/types.js';
-import { middlewares } from 'virtual:vite-rsc-waku/middlewares';
 import type { MiddlewareHandler } from 'hono';
+import { middlewares } from 'virtual:vite-rsc-waku/middlewares';
 import { isBuild } from 'virtual:vite-rsc-waku/config';
+import type { HandlerContext, MiddlewareOptions } from '../types.js';
+import { contextMiddleware } from '../context.js';
+import { handlerMiddleware } from './handler.js';
 
 // cf. packages/waku/src/lib/hono/engine.ts
 export function createHonoHandler(): MiddlewareHandler {
@@ -10,17 +12,17 @@ export function createHonoHandler(): MiddlewareHandler {
     middlwareOptions = {
       cmd: 'dev',
       env: {},
-      unstable_onError: new Set(),
     };
   } else {
     middlwareOptions = {
       cmd: 'start',
       env: {},
-      unstable_onError: new Set(),
     };
   }
 
-  const handlers = middlewares.map((m) => m(middlwareOptions));
+  const handlers = [contextMiddleware, ...middlewares, handlerMiddleware].map(
+    (m) => m(middlwareOptions),
+  );
 
   return async (c, next) => {
     const ctx: HandlerContext = {
diff --git a/packages/waku/src/lib/vite-rsc/handler.ts b/packages/waku/src/lib/vite-rsc/handler.ts
@@ -8,16 +8,15 @@ import {
 } from '@vitejs/plugin-rsc/rsc';
 import { stringToStream } from '../utils/stream.js';
 import { getErrorInfo } from '../utils/custom-errors.js';
-import type { HandlerContext } from '../middleware/types.js';
 import { config } from 'virtual:vite-rsc-waku/config';
-import type { HandleRequest } from '../types.js';
+import type { HandleRequest, HandlerContext, Middleware } from '../types.js';
 import serverEntry from 'virtual:vite-rsc-waku/server-entry';
 import { getInput } from '../utils/request.js';
 import { createRenderUtils } from '../utils/render.js';
 
 type HandleRequestOutput = Awaited<ReturnType<HandleRequest>>;
 
-export async function handleRequest(ctx: HandlerContext) {
+async function handleRequest(ctx: HandlerContext) {
   await import('virtual:vite-rsc-waku/set-platform-data');
 
   const { input, temporaryReferences } = await getInput(
@@ -76,3 +75,5 @@ function loadSsrEntryModule() {
     'index',
   );
 }
+
+export const handlerMiddleware: Middleware = () => handleRequest;
diff --git a/packages/waku/src/lib/vite-rsc/middleware/handler.ts b/packages/waku/src/lib/vite-rsc/middleware/handler.ts
diff --git a/packages/waku/src/lib/vite-rsc/plugin.ts b/packages/waku/src/lib/vite-rsc/plugin.ts
@@ -66,11 +66,7 @@ export function rscPlugin(rscPluginOptions?: RscPluginOptions): PluginOption {
     slicesDir: '_slices',
     privateDir: 'private',
     rscBase: 'RSC',
-    middleware: [
-      'waku/middleware/context',
-      'waku/middleware/dev-server',
-      'waku/middleware/handler',
-    ],
+    middleware: [],
     unstable_honoEnhancer: undefined,
     vite: undefined,
     ...rscPluginOptions?.config,
@@ -281,17 +277,6 @@ if (import.meta.hot) {
     createVirtualPlugin('vite-rsc-waku/middlewares', async function () {
       const ids: string[] = [];
       for (const file of config.middleware) {
-        // dev-server logic is all handled by `@vitejs/plugin-rsc`, so skipped.
-        if (file === 'waku/middleware/dev-server') {
-          continue;
-        }
-
-        // new `handler` is exported from `waku/vite-rsc/middleware/handler.js`
-        if (file === 'waku/middleware/handler') {
-          ids.push(path.join(__dirname, 'middleware/handler.js'));
-          continue;
-        }
-
         // resolve local files
         let id = file;
         if (file[0] === '.') {
diff --git a/packages/waku/src/middleware/context.ts b/packages/waku/src/middleware/context.ts
diff --git a/packages/waku/src/router/define-router.ts b/packages/waku/src/router/define-router.ts
@@ -5,6 +5,7 @@ import {
   unstable_getPlatformData,
   unstable_setPlatformData,
   unstable_createAsyncIterable as createAsyncIterable,
+  unstable_getContext as getContext,
 } from '../server.js';
 import { unstable_defineEntries as defineEntries } from '../minimal/server.js';
 import {
@@ -20,7 +21,6 @@ import {
 import { getPathMapping, path2regexp } from '../lib/utils/path.js';
 import type { PathSpec } from '../lib/utils/path.js';
 import { INTERNAL_ServerRouter } from './client.js';
-import { getContext } from '../middleware/context.js';
 import { stringToStream } from '../lib/utils/stream.js';
 import { createCustomError, getErrorInfo } from '../lib/utils/custom-errors.js';
 
diff --git a/packages/waku/src/server.ts b/packages/waku/src/server.ts
@@ -1,4 +1,8 @@
-import { getContext } from './middleware/context.js';
+import { getContext } from './lib/context.js';
+export {
+  getContext as unstable_getContext,
+  getContextData as unstable_getContextData,
+} from './lib/context.js';
 
 export * as unstable_builderConstants from './lib/builder/constants.js';
 
