[Bug]: content-length-guardrail policy counts SSE events without content as their whole JSON text
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 57/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- go
- Ambito
- backend-api-design
Direzione di ricerca
Start by locating the content-length-guardrail policy implementation and its tests for streaming JSONPath extraction. Reproduce the report with an SSE stream containing a content event followed by an empty delta finish event, then check how the policy handles a valid JSON event with no value at the configured path. Done means the event contributes zero bytes and the stream passes when its actual content is within the configured limits.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Please select the area the issue is related to
Gateway
Please select the aspect the issue is related to
Aspect/AI (AI/LLM integration, MCP, AI readiness)
Description
The content-length-guardrail policy counts an SSE event with no content as content. When an event has no value at streamingJsonPath, the policy adds the event's whole JSON text to the response length. It should add zero bytes.
Real providers send such events in every stream. OpenAI ends each stream with a finish event whose delta is empty:
data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}
With the default path, $.choices[0].delta.content, this event adds 59 bytes. A stream with usage reporting adds a usage event as well. Some providers also send a first event that holds only the role.
The extra bytes change the policy's decisions:
- A reply within
maxis blocked when the extra bytes take it over. - A reply shorter than
minpasses when the extra bytes take it overmin. - The policy releases a held-back stream earlier than the content alone would.
The doc says the policy uses the JSONPath "to extract the incremental token text" from each event. An event with no token text should add nothing.
A fix could count zero bytes for an event that is valid JSON but has no value at streamingJsonPath. Whether a data line that is not JSON should still count as content is a separate choice.
The integration suite in wso2/gateway-controllers#415 asserts the current behaviour.
Steps to Reproduce
- Create a REST API with the
content-length-guardrailpolicy on an operation:{"name":"content-length-guardrail","version":"v1","params":{"response":{"enabled":true,"min":1,"max":20}}} - Send a request whose upstream replies with this SSE stream. Its only content is
abc, 3 bytes:data: {"choices":[{"delta":{"content":"abc"}}]} data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}]} data: [DONE] - The stream ends with the guardrail's SSE error event, and
[DONE]never reaches the client. The policy counts 62 bytes: 3 forabcand 59 for the finish event. - Send the same stream without the finish event. It passes with
abcand[DONE].
Severity Level of the Issue
Severity/Major (Important functionality is broken. Should be prioritized. Doesn't need immediate attention)
Environment Details (with versions)
- Policy:
content-length-guardrailv1.1.0, wso2/gateway-controllers main (4f1520a8) - Gateway versions: 1.1.0 (patched), 1.2.0 and latest (
main-59dcd51) - macOS 27.0.1 (Apple silicon), Colima 0.10.3, Docker Engine 29.5.2
- Lingua principale
- Go
- Stelle
- 85
- Fork
- 137
- Merge medio
- 1g 12h
- PR unite (30g)
- 247
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Nessuna guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
wso2/api-platform#4369 ·
I maintainer di solito rispondono entro 1 giorno
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsApertaArea/Policies Aspect/Other Severity/Trivial Type/Bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 91/100
wso2/api-platform#4355 ·
I maintainer di solito rispondono entro 1 giorno
-
Area/Gateway Aspect/API Severity/Minor Type/Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
wso2/api-platform#4348 ·
I maintainer di solito rispondono entro 1 giorno
-
Aspect/AI Aspect/API. Severity/Major
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
wso2/api-platform#4343 ·
I maintainer di solito rispondono entro 1 giorno
-
[Bug]: content-length-guardrail policy accepts a non-string streamingJsonPath at API creationApertaArea/Policies Aspect/Configuration Severity/Minor Type/Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
wso2/api-platform#4330 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di wso2/api-platform
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
mozilla-ai/cq#601 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno