[Bug]: A WebSub policy's executionCondition is dropped on deploy, so the policy runs on every message

Open
#4,296 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
72/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
go

Research direction

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.

Written by the indexing model from the issue text.

Description

Area/EventGateway Area/Platform-API Aspect/API Severity/Major Type/Bug
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 only Name, Version and Params, so allChannels and 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 as executioncondition instead of executionCondition, even where the value survives (the receiver section).

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 main currently 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.

  1. Create the API with a conditional policy:
    POST /api/v0.9/websub-apis with {"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":{}}}. The 201 response returns the executionCondition.
  2. Deploy it to the event gateway (POST /api/v0.9/websub-apis/b01-ws/deployments, base: current). Wait for DEPLOYED.
  3. Read the stored artifact (SELECT content FROM deployments WHERE uuid='<deploymentId>'). The policies look as shown above.
  4. GET /api/management/v1/websub-apis/b01-ws on the event gateway controller lists log-message with no condition.
  5. Subscribe a callback to topic orders (POST http://<event-gateway>:8080/b01ws/v1/hub, form hub.mode=subscribe&hub.topic=orders&hub.callback=<listener>), then publish without an x-run header: POST http://<event-gateway>:8080/b01ws/v1/webhook-receiver?topic=orders with {"msg":"msg-1"}.
  6. 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: main at f5c93849.
  • platform-api built from source with -tags experimental (SQLite).
  • Event gateway images 0.10.0-SNAPSHOT built from that commit; Kafka bitnamilegacy/kafka:4.0.0-debian-12-r10.
  • macOS with Rancher Desktop.
Dominant language
Go
Stars
85
Forks
137
Avg merge
1d 12h
Merged PRs (30d)
247

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/api-platform

All issues in wso2/api-platform

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.