[Content]: Middleware examples use the pre-3.0 `(request, next)` shape; start mode now calls `(event, next)` and `next(request)` throws
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 82/100
- Issue-Typ
- Dokumentation
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- typescript
- Bereich
- documentation
Rechercherichtung
Beginne mit den Middleware-Beispielen auf den aufgeführten Seiten: building-apps/middleware-and-api-routes, guides/protected-routes, building-apps/sessions-and-auth, reference/vite-plugin-solid/start und reference/filesystem-routing/api. Vergleiche ihre Signaturen mit solid-v2/fullstack-Vorlage src/middleware.ts und dem gemeldeten Typ für 3.0.1. Aktualisiere veraltete Beispiele und Anleitungen, damit sie der aktuellen API entsprechen; fertig ist die Arbeit, wenn die aufgeführten Beispiele nicht mehr die request-first-Form oder next(request) verwenden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
📚 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:
- https://docs.solidjs.com/building-apps/middleware-and-api-routes ("Add a middleware": the
Middlewaretype,requireHttps,securityHeaders, and "Pass aRequesttonext(request)to replace the request") - https://docs.solidjs.com/guides/protected-routes ("Middleware for whole sections":
requireAccountSessionreadsrequest.url)
Works at runtime, but the type annotation is the old shape:
- https://docs.solidjs.com/building-apps/sessions-and-auth ("Authenticate once in middleware":
attachCustomer(_request: Request, next)) - https://docs.solidjs.com/reference/vite-plugin-solid/start (
### middleware: theMiddlewaretype)
Signature from an older release:
- https://docs.solidjs.com/reference/filesystem-routing/api (written from
v0.2.1; in 0.5.0createAPIHandlerreturns(input: Request | { request: Request }, next) => Promise<Response>)
📋 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 /.
- Vorherrschende Sprache
- MDX
- Sterne
- 291
- Forks
- 369
- Ø Merge
- 1 T. 1 Std.
- Gemergte PRs (30 T.)
- 39
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus solidjs/solid-docs
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
solidjs/solid-docs#1713 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
solidjs/solid-docs#1635 ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Content]: Cloudflare WorkersEvtl. vergeben @Janani-bn hat das vor 52 Tagen übernommen. Offengood first issue solid solidstart
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
solidjs/solid-docs#1522 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Content]: v2 Store documentation is unclear on class instancesEvtl. vergeben @LadyBluenotes hat das vor 14 Tagen übernommen. Offenpending review
solidjs/solid-docs#1687 · 1 Kommentar · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
-
[Content]: Add a concrete DOM-binding example to fine-grained reactivityEvtl. wieder frei @LadyBluenotes hat das vor 85 Tagen übernommen, und es ist kein Pull Request offen. Offenpending review
solidjs/solid-docs#1637 · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in solidjs/solid-docs
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
Maintainer antworten meist innerhalb von 1 Tag
-
needs discussion
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
openfga/openfga.dev#1436 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 2 Tagen
-
documentation
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 86/100
Awesome-Embedded-Learning-Studio/Tutorial_AwesomeModernCPP#335 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 75/100
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 84/100