[Bug]: route.fulfill({ json }) replaces a Content-Type set in headers and sets none for null, false, 0 and ''

Aperta Adatta ai principianti
  • Qualcosa non va?
#44,109 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
javascript, typescript
Ambito
api, testing

Direzione di ricerca

Il bug si trova nel ramo json di _innerFulfill in packages/playwright-core/src/client/network.ts, che imposta il Content-Type senza controllare gli header esistenti e verifica la truthiness di options.json. Leggi il blocco subito sopra, dove il body viene creato con options.json !== undefined, e confronta le due condizioni. Il lavoro è completato quando json mantiene il valore di un Content-Type preimpostato e null, false, 0 e '' inviano application/json. Verificalo con il test di riproduzione tests/fulfill-json.spec.ts su Chromium, Firefox e WebKit.

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

Descrizione

Version

1.65.1

Steps to reproduce
  1. Clone https://github.com/ondraulehla/playwright-repro-fulfill-json-content-type
  2. npm install
  3. npx playwright install
  4. npx playwright test

The repro is one spec file, tests/fulfill-json.spec.ts. Every request is routed, so it needs no server. Each test does this with a different set of options:

await page.route('http://repro.test/data', route => route.fulfill(options));
const result = await page.evaluate(async () => {
  const response = await fetch('/data');
  return { contentType: response.headers.get('content-type'), body: await response.text() };
});
Expected behavior

The docs for the json option say: "JSON response. This method will set the content type to application/json if not set."

So I'd expect two things:

  1. route.fulfill({ json: { a: 1 }, headers: { 'Content-Type': 'application/problem+json' } }) keeps application/problem+json, because the content type is already set.
  2. route.fulfill({ json: null }) responds with application/json, and so do false, 0 and '', the same way json: 1 does. Playwright already serializes the body for them (null, false, 0, "").
Actual behavior

18 of the 30 tests fail, the same 6 in Chromium, Firefox and WebKit. The 4 control tests pass in all three.

fulfill options Expected Chromium Firefox WebKit
json: { a: 1 }, headers: { 'content-type': 'application/problem+json' } application/problem+json application/json application/json application/json
json: { a: 1 }, headers: { 'Content-Type': 'application/problem+json' } application/problem+json application/json application/json application/json
json: null application/json no header no header text/plain
json: false application/json no header no header text/plain
json: 0 application/json no header no header text/plain
json: '' application/json no header no header text/plain

"no header" means response.headers.get('content-type') is null in the page.

I get the same table on macOS and on Linux (Ubuntu 24.04 in Docker).

Additional context

I found this while looking at how the clients pick the content type after #43205, which was the Python side of the second case (json=[] and json={}).

Both cases come from the same block in _innerFulfill in packages/playwright-core/src/client/network.ts:

if (options.contentType)
  headers['content-type'] = String(options.contentType);
else if (options.json)
  headers['content-type'] = 'application/json';

The json branch doesn't check whether headers already has a content type, and it tests options.json for truthiness. A few lines above, the body is built with options.json !== undefined, which is why the falsy values get a serialized body but no header.

I tried this change against the installed 1.65.1 bundle and all 30 tests pass with it:

else if (options.json !== undefined && !('content-type' in headers))

I'd like to send a PR with the fix and tests if this is approved for a community contribution.

Environment
System:
  OS: macOS 26.6.2
  CPU: (8) arm64 Apple M1 Pro
Binaries:
  Node: 26.5.0 - /opt/homebrew/bin/node
  npm: 11.17.0 - /opt/homebrew/bin/npm
npmPackages:
  @playwright/test: 1.65.1 => 1.65.1
Lingua principale
TypeScript
Stelle
99.7k
Fork
6.8k
Merge medio
16h 10m
PR unite (30g)
301

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 microsoft/playwright

Tutte le issue di microsoft/playwright

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.