[Bug]: A WebSub policy's executionCondition is dropped on deploy, so the policy runs on every message
Maintainer thường phản hồi trong vòng 1 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 72/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- go
- Lĩnh vực
- backend-api-design
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Go
- Star
- 85
- Fork
- 137
- Merge trung bình
- 1 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 247
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Không có hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
wso2/api-platform#4369 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsĐang mởArea/Policies Aspect/Other Severity/Trivial Type/Bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 91/100
wso2/api-platform#4355 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Area/Gateway Aspect/API Severity/Minor Type/Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
wso2/api-platform#4348 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Aspect/AI Aspect/API. Severity/Major
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
wso2/api-platform#4343 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[Bug]: content-length-guardrail policy accepts a non-string streamingJsonPath at API creationĐang mởArea/Policies Aspect/Configuration Severity/Minor Type/Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
wso2/api-platform#4330 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của wso2/api-platform
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
needs discussion
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
openfga/openfga.dev#1436 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 2 ngày
-
都道府県を指定すると区名から始まる住所に市名を補わないĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
digital-go-jp/abr-geocoder#457 ·
Maintainer thường phản hồi trong vòng 3 ngày
-
benchmark
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
mozilla-ai/cq#601 ·
Maintainer thường phản hồi trong vòng 1 ngày