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

Đang mở Phù hợp với người mới
#1,716 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với các ví dụ middleware trên những trang được liệt kê: building-apps/middleware-and-api-routes, guides/protected-routes, building-apps/sessions-and-auth, reference/vite-plugin-solid/start và reference/filesystem-routing/api. So sánh chữ ký của chúng với src/middleware.ts trong template solid-v2/fullstack và kiểu được báo cáo ở phiên bản 3.0.1. Cập nhật các ví dụ và hướng dẫn đã lỗi thời để khớp với API hiện tại; hoàn tất khi các ví dụ được liệt kê không còn dùng dạng request-first hoặc next(request).

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

📚 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 /.

Ngôn ngữ chính
MDX
Star
291
Fork
369
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
39

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của solidjs/solid-docs

Tất cả issue của solidjs/solid-docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.