Let global middleware declare the paths it runs on

Aberta
  • Algo errado?
#808 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.
Linguagem predominante
TypeScript
Estrelas
684
Forks
83
Merge médio
15h 22min
PRs com merge (30d)
219

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de voidzero-dev/void

Todas as issues de voidzero-dev/void

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.