[Bug]: Redeploying a changed WebSub API deletes its Kafka topics, dropping all subscribers

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
56/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
go, kafka
Domain
backend, databases

Research direction

Start with event-gateway/gateway-runtime/internal/xdsclient/handler.go around line 213 and trace how an updated WebSub binding is removed and added again. Then read event-gateway/gateway-runtime/internal/runtime/runtime.go around line 1188, where binding removal deletes Kafka topics. Reproduce by redeploying after adding an unrelated channel; done when subscriptions and delivery on unchanged channels survive redeployment.

Written by the indexing model from the issue text.

Description

Area/EventGateway Aspect/API Severity/Major Type/Bug
Please select the area the issue is related to

Event Gateway

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)

Description

Deploying a changed WebSub API again deletes its Kafka topics, including the internal subscription topic. Every existing subscriber is dropped without notice, and messages published after the redeploy never reach subscribers that did not unsubscribe. They only receive messages again after they subscribe again.

Any change to the deployed configuration triggers it. In the reproduction below the only change is a new, unrelated channel. A redeploy with identical content is skipped and does not lose subscribers.

Expected: subscriptions and messages on channels that did not change survive a redeploy.
Actual: all subscriptions are lost and messages published after the redeploy are not delivered.

What the event-gateway runtime logged during the redeploy:

msg="Updating binding via xDS" name=b01-ws uuid=01a1e4e1-75dd-73ff-953a-b35a35364971 kind=WebSubApi
msg="Deleted topic" topic=0d308a66f246630dc7092f19f2dfcbe7d2194b38062b88f6ab8df798c09ab55a
msg="Deleted topic" topic=d51efd60b66b664b9102ea80abdfb964eff0c145285618302412924e045361cc
msg="Dynamically removed WebSubApi binding" name=b01-ws
msg="Created topic" topic=d51efd60b66b664b9102ea80abdfb964eff0c145285618302412924e045361cc
msg="Topic metadata" topic_hash=d51efd60b66b664b9102ea80abdfb964eff0c145285618302412924e045361cc apiName=b01-ws apiVersion=v1 channelName=orders

Where it comes from in the code:

  • event-gateway/gateway-runtime/internal/xdsclient/handler.go:213: an updated binding is removed, then added again.
  • event-gateway/gateway-runtime/internal/runtime/runtime.go:1188: RemoveWebSubApiBinding deletes the binding's Kafka topics, both the data topics and the internal subscription topic, before closing the broker driver.

Related: #1872.

Steps to Reproduce

Setup: platform-api built with -tags experimental (the WebSub plugin) and an event gateway connected to it, both built from main. A webhook listener that records what it receives (event-gateway/webhook-listener, GET /received-events) is reachable from the event gateway at http://wh-listener:8090.

Deployments from platform-api to an event gateway built from main currently fail because of #4288. To get past it, 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, not product behaviour.

  1. Create the API:
    POST /api/v0.9/websub-apis with {"id":"b01-ws","displayName":"b01-ws","version":"v1","projectId":"default","context":"/b01ws","channels":{"orders":{}}}.
  2. Deploy it to the event gateway: POST /api/v0.9/websub-apis/b01-ws/deployments with {"name":"d1","base":"current","gatewayId":"<event-gateway-id>"}. Wait until the deployment is DEPLOYED.
  3. Subscribe the listener: POST http://<event-gateway>:8080/b01ws/v1/hub (form-encoded) with hub.mode=subscribe&hub.topic=orders&hub.callback=http://wh-listener:8090/b01&hub.lease_seconds=3600. It returns 202, and the runtime logs Subscription verified and activated.
  4. Publish: POST http://<event-gateway>:8080/b01ws/v1/webhook-receiver?topic=orders with {"msg":"msg-1"}. It returns 202, and the listener receives {"msg":"msg-1"}.
  5. Add an unrelated channel: GET /api/v0.9/websub-apis/b01-ws, add "refunds":{} to channels, and PUT it back. It returns 200.
  6. Deploy again (same request as step 2). Wait for DEPLOYED. The runtime logs the lines shown above.
  7. Publish {"msg":"msg-2"} to orders (same request as step 4). It returns 202.
  8. Check the listener (GET /received-events) 35 seconds later. It still holds only msg-1; msg-2 never arrives.
  9. Subscribe again exactly as in step 3, then publish {"msg":"msg-3"}. The listener now receives msg-3, so delivery itself works; only the subscription was lost.
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: event-gateway-controller and event-gateway-runtime 0.10.0-SNAPSHOT, built from that commit; Kafka bitnamilegacy/kafka:4.0.0-debian-12-r10 (SASL_SSL, from event-gateway/docker-compose.dev.yaml).
  • 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.