[Content]: Middleware examples use the pre-3.0 `(request, next)` shape; start mode now calls `(event, next)` and `next(request)` throws

オープン 初心者向け
#1,716 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript
領域
documentation

調査の方向性

指定されたページのミドルウェアの例から始めます。building-apps/middleware-and-api-routes、guides/protected-routes、building-apps/sessions-and-auth、reference/vite-plugin-solid/start、reference/filesystem-routing/api の例を確認してください。シグネチャを solid-v2/fullstack テンプレートの src/middleware.ts および報告された 3.0.1 の型と比較します。古くなった例と説明を現在の API に合わせて更新します。完了条件は、指定された例で request-first 形式や next(request) が使われなくなることです。

索引モデルが issue の本文から書いたものです。

説明

📚 Subject area/topic

Building apps (Middleware and API routes), Guides, Reference (@solidjs/vite-plugin, filesystem-routing)

📋 Page(s) affected (or suggested, for new content)

Examples break when copied:

Works at runtime, but the type annotation is the old shape:

Signature from an older release:

📋 Description of content that is out-of-date or incorrect

Since @solidjs/vite-plugin 3.0.0-next.48 (CHANGELOG 1702a19, marked BREAKING), start-mode middleware is event-first:

// @solidjs/vite-plugin 3.0.1, dist/types/src/request-event.d.ts
export type StartMiddleware = (
	event: StartRequestEvent,
	next: () => Promise<Response>
) => Response | Promise<Response>;

The request is event.request, and next() takes no arguments. To substitute the request, assign event.request before calling next(). The solid-v2/fullstack template's src/middleware.ts uses this shape (satisfies StartMiddleware[]).

The pages above still document the request-first shape, (request: Request, next: (request?: Request) => …), and say to call next(request). Copying them breaks the app.

Checked in dev with solid-js / @solidjs/web 2.0.3, @solidjs/vite-plugin 3.0.1, vite 8.3.8. I wrote a middleware exactly to the documented type and registered it with start.middleware:

export default async (request: Request, next: (request?: Request) => Response | Promise<Response>) => {
	console.log("[mw] request.url =", (request as any).url);
	return next(request);
};

The first argument is the event (request.url logs undefined), and every page answers 500 with:

[@solidjs/vite-plugin] start.middleware: next() takes no arguments. Middleware receives the request event — (event, next) — so to substitute the request, assign event.request = newRequest before calling next().

The guide's requireHttps and the protected-routes requireAccountSession would also fail at new URL(request.url) before they reach next().

Proposed fix: switch these examples to (event, next) with event.request, type the middleware module as StartMiddleware[] like the template does, and replace the next(request) paragraph with "assign event.request before calling next()". I'm happy to send a PR, one page or all of them, whichever you prefer.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

Local steps: pnpm create solid@latest -t basic --solid --ts --ssr (rename the generated start: { node: true } to nodeServer: true), add middleware: './src/middleware.ts' to start, put the middleware above in src/middleware.ts, run pnpm dev, and open /.

主要言語
MDX
スター
291
フォーク
369
平均マージ
1日 1時間
マージ済み PR(30日)
39

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

solidjs/solid-docs のほかの issue

solidjs/solid-docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。