Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

`rel="next"` from the legacy `/query` aliases points at `/api/query`, silently moving clients off the path they requested

Aperta
  • Qualcosa non va?
#319 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
50/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
api, backend

Direzione di ricerca

Start with routes/compatability.js, controllers/utils.js, and routes/tests/query.test.js, then inspect how req.originalUrl differs from req.baseUrl + req.path for the three aliases. Confirm the chosen link behavior with a POST test, update public/API.html, and ensure the decision is explicit and covered by the test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Summary

/v1/api/getByProperties, /v1/api/query.action, and /v1/api/getByProperties.action are URL rewrites onto /v1/api/query (routes/compatability.js:8-10). Now that #312 gives /query a rel="next" Link, a response to any of those aliases carries a next link naming /v1/api/query rather than the path the client actually requested. A client that walks its pages leaves the legacy path after page 1 and is never told.

Verified on production 2026-09-24, read-only:

POST /v1/api/getByProperties?limit=1         {"type":"Annotation"}
POST /v1/api/query.action?limit=1            {"type":"Annotation"}
POST /v1/api/getByProperties.action?limit=1  {"type":"Annotation"}

-> 200, all three:
Link: <https://store.rerum.io/v1/api/query?limit=1&skip=1>; rel="next"

Why this matters

setNextPageLink() builds the path from req.baseUrl + req.path (controllers/utils.js:155). express-urlrewrite replaces req.url before the router matches, so by the time the /query controller runs those two describe the rewritten route. req.originalUrl is untouched and still holds what the client sent, so the alias is recoverable either way.

Pointing at the canonical path is a defensible thing for rel="next" to do. The problem is that it is currently a side effect of how the rewrite works rather than a decision we made, and it happens silently:

  • Nothing in the response says the path changed. There is no Content-Location, so a client cannot know page 2 lives elsewhere without diffing URLs it did not construct.
  • The aliases exist because old clients still call them. Those are the clients least likely to survive being handed a path their stack was never set up for — fixed base paths, proxy rules, allowlists.
  • Page 1 and page 2 of one walk arrive from two different endpoints, so anything that caches, logs, or rate limits per path sees one walk as two.

Scope is narrow: only paged endpoints are affected, which is /query through its three aliases. The /batch_create -> /bulkCreate rewrite does not page.

Neither the behavior nor the aliases are covered anywhere. routes/__tests__/query.test.js never exercises a rewritten path — __tests__/core_provider_contract.test.js:14 only asserts that compatability.js is mounted — and public/API.html does not mention getByProperties at all.

Proposed change

Decide which of these we mean, then make it explicit in code and in public/API.html.

  1. Keep the canonical link and announce it. Serve Content-Location: /v1/api/query on responses that arrived through a rewrite, so the move from alias to canonical path is stated rather than inferred. One header, and the current behavior stops being accidental.

  2. Keep the client on the path it asked for. Build the link from the pathname of req.originalUrl instead of req.baseUrl + req.path. For every non-rewritten route the two are identical, so nothing else changes. This keeps a legacy walk entirely on the legacy path, at the cost of advertising a deprecated URL in a header we control.

Recommend option 1. The canonical path is the better destination, and the only real complaint is that we currently arrive there without saying so.

Either way, add a case to routes/__tests__/query.test.js that POSTs to /v1/api/getByProperties and asserts the rel="next" path, so the choice cannot drift, and give the aliases a line in public/API.html noting that they are rewrites onto /query and what their next links point at.

Lingua principale
JavaScript
Stelle
3
Fork
6
Merge medio
4g 9h
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CenterForDigitalHumanities/rerum_server_nodejs

Tutte le issue di CenterForDigitalHumanities/rerum_server_nodejs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.