Let global middleware declare the paths it runs on

Ouverte
  • Quelque chose ne va pas ?
#808 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
typescript
Domaine
tooling

Piste de recherche

Start by reading packages/void/src/asset-worker-bypass.ts and the middleware loading and execution flow; the issue does not name those entry points or any tests. Trace how patternCanReachUnder() is used for route, page, and auth patterns. Done means middleware matchers skip nonmatching requests and the asset bypass remains enabled when no middleware matcher can reach assets, while files without a matcher retain current behavior.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Version

void 1.8.0, and main at 004624f

Problem

Every file in middleware/ runs on every request, so a middleware that only matters for one section has to test the path itself:

// middleware/04.admin.ts
const ADMIN_PATH = /^\/admin(\/|$)/;

export default defineMiddleware(async (c, next) => {
  if (!ADMIN_PATH.test(c.req.path)) return next();
  // …
});

Void's own dashboard does the same in platform/packages/dashboard/middleware/01.auth.ts, with PUBLIC_PATHS and PUBLIC_PREFIXES.

That's only boilerplate, but having middleware at all also costs every static file its free request. resolveAssetWorkerBypass() in packages/void/src/asset-worker-bypass.ts gives up the bypass as soon as there's any middleware:

facts.hasMiddleware ||

So in a build with middleware, every hashed JS, CSS and image file starts the Worker, and each middleware runs for it. Any middleware that reads a session, KV or D1 has to skip asset paths by hand, or every asset waits on that read. Void can't tell which middleware might touch /assets/, so it has to assume all of them do.

Proposal

Let a middleware file export the paths it runs on, in the same glob syntax as run_worker_first:

// middleware/04.admin.ts
export const matcher = ['/admin', '/admin/**'];

export default defineMiddleware(async (c, next) => {
  // runs only for /admin and below
});
  • A file without matcher runs on every request, as today, so existing apps see no change.
  • ! patterns exclude paths, as in run_worker_first, so a middleware that sets shared data for every page can still leave assets out with ['/**', '!/assets/**'].
  • Files still run in filename order; one that doesn't match is skipped.
  • hasMiddleware becomes "has middleware that can reach the assets folder": if every file has a matcher and none of them can reach it, checked with patternCanReachUnder() as the bypass already does for route, page and auth patterns, the bypass stays on.

Matching on the request path alone keeps it decidable at build time. A function form, like matcher: (c) => …, couldn't be checked against the assets folder, so it would have to keep the Worker in front.

Prior art
  • Next.js: export const config = { matcher: [...] } in middleware.ts, with path patterns and negative lookaheads, so _next/static can be left out.
  • TanStack Start: middleware attached to a route runs only for that route and below.
  • TanStack Router: beforeLoad on a layout route runs for its children only.
Langage dominant
TypeScript
Étoiles
684
Forks
83
Merge moyen
15 h 22 min
PR mergées (30 j)
219

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de voidzero-dev/void

Toutes les issues de voidzero-dev/void

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.