[Bug]: A WebSub policy's executionCondition is dropped on deploy, so the policy runs on every message
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
- 72/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- go
- Ambito
- backend-api-design
Direzione di ricerca
Start with generatePolicyList in platform-api/plugins/eventgateway/service/websub_api_deployment.go and model.Policy in platform-api/internal/model/api.go; trace how policy fields are copied into the deployment YAML and read by the gateway. Check the deployed artifact and the gateway's GET /api/management/v1/websub-apis/{id} output. Done when the condition is preserved in the artifact and the gateway runs the policy only when it holds.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Please select the area the issue is related to
Event Gateway, Platform API
Please select the aspect the issue is related to
Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)
Description
A WebSub API's policy executionCondition is lost when the API is deployed, so the policy runs on every message. platform-api stores the condition and returns it on GET, but the deployment artifact doesn't carry it in a form the gateway reads:
allChannels:
on_message_received:
policies:
- executioncondition: null
name: log-message
params: {}
version: v1
receiver:
policies:
- executioncondition: request.header.x-run == 'yes'
name: log-message
...
The event gateway's copy of the API (GET /api/management/v1/websub-apis/b01-ws) lists the policy with no condition at all. A message published without the x-run header, so with the condition false, still ran the policy:
level=DEBUG msg="[body] calling OnRequestBody" policy=log-message version=v1 route=SUB|/b01ws/v1/webhook-receiver|*
Where it comes from in the code:
generatePolicyList(platform-api/plugins/eventgateway/service/websub_api_deployment.go:721) copies onlyName,VersionandParams, soallChannelsand per-channel policies lose the condition.model.Policy(platform-api/internal/model/api.go:100) has JSON tags only. The YAML artifact therefore writes the field asexecutionconditioninstead ofexecutionCondition, even where the value survives (thereceiversection).
Expected: a policy with an executionCondition runs only when the condition holds.
Actual: the condition is dropped and the policy always runs.
Steps to Reproduce
Setup: platform-api built with -tags experimental and an event gateway connected to it, both built from main.
Deployments to an event gateway built from
maincurrently fail because of #4288. To reproduce this issue I cleared that gateway's stored version in platform-api's database (UPDATE gateways SET version='' WHERE handle='<event-gateway-id>'). That is a test workaround.
- Create the API with a conditional policy:
POST /api/v0.9/websub-apiswith{"id":"b01-ws","displayName":"b01-ws","version":"v1","projectId":"default","context":"/b01ws","allChannels":{"on_message_received":{"policies":[{"name":"log-message","version":"v1","params":{},"executionCondition":"request.header.x-run == 'yes'"}]}},"channels":{"orders":{}}}. The201response returns theexecutionCondition. - Deploy it to the event gateway (
POST /api/v0.9/websub-apis/b01-ws/deployments,base: current). Wait forDEPLOYED. - Read the stored artifact (
SELECT content FROM deployments WHERE uuid='<deploymentId>'). The policies look as shown above. GET /api/management/v1/websub-apis/b01-wson the event gateway controller listslog-messagewith no condition.- Subscribe a callback to topic
orders(POST http://<event-gateway>:8080/b01ws/v1/hub, formhub.mode=subscribe&hub.topic=orders&hub.callback=<listener>), then publish without anx-runheader:POST http://<event-gateway>:8080/b01ws/v1/webhook-receiver?topic=orderswith{"msg":"msg-1"}. - The event-gateway runtime logs
calling OnRequestBody policy=log-message, so the policy ran although its condition is false.
Severity Level of the Issue
Severity/Major (Important functionality is broken. Should be prioritized. Doesn't need immediate attention)
Environment Details (with versions)
- Source:
mainatf5c93849. - platform-api built from source with
-tags experimental(SQLite). - Event gateway images
0.10.0-SNAPSHOTbuilt from that commit; Kafkabitnamilegacy/kafka:4.0.0-debian-12-r10. - macOS with Rancher Desktop.
- 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