[Bug]: WebSub deployments to an event gateway built from main fail: platform-api sends a v1alpha1 artifact
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 66/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- go
- Domain
- api, backend-api-design
Research direction
Start with the version comparison in platform-api/internal/gatewaytranslator/gwversion/versions.go and the artifact rewrite in platform-api/internal/gatewaytranslator/translate/run.go. Trace how the event gateway's reported version reaches that comparison, then check the WebSub and WebBroker translation paths. Done means event gateway deployments from the same main commit use an API version the gateway accepts; verify with the WebSub reproduction steps in the issue.
Written by the indexing model from the issue text.
Description
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 deployed from platform-api to an event gateway built from the same main commit always fails with GATEWAY_PROCESSING_ERROR.
The cause:
- The event gateway reports its own product version,
0.10.0-SNAPSHOT, and platform-api stores that as the gateway's version. - platform-api compares that value with the API gateway's LTS boundary. Below
1.2.0(MinGatewayV1Version,platform-api/internal/gatewaytranslator/gwversion/versions.go:34), it rewrites every artifact'sapiVersiontogateway.api-platform.wso2.com/v1alpha1(platform-api/internal/gatewaytranslator/translate/run.go:42). - The event gateway accepts only
gateway.api-platform.wso2.com/v1, so it rejects the artifact.
What the event gateway controller logged:
level=WARN source=pkg/utils/api_deployment.go:550 msg="Validation error" field=version message="Unsupported API version (must be 'gateway.api-platform.wso2.com/v1')"
level=ERROR source=/build/pkg/controlplanehooks/hooks.go:106 msg="Failed to create WebSub API from YAML" ... error="failed to deploy API configuration from YAML: configuration validation failed with 1 errors"
level=INFO source=pkg/controlplane/client.go:804 msg="Deployment ack sent" ... resource_type=websub action=deploy status=failed
The first line of the artifact platform-api stored for that deployment: apiVersion: gateway.api-platform.wso2.com/v1alpha1.
After the stored gateway version was cleared in platform-api's database, so that no translation ran, the same API deployed and served traffic. That confirms the version comparison is the cause.
WebBroker deployments go through the same translation (platform-api/plugins/eventgateway/service/webbroker_api_deployment.go:210), so they are expected to fail the same way. I only ran the WebSub case.
Expected: an event gateway built from the same commit accepts the deployment. Event-gateway versions should not be compared with the API gateway's LTS release line, or the two should agree on one scheme.
Related: #1951.
Steps to Reproduce
- Build platform-api from
mainwith-tags experimental(this enables the WebSub/WebBroker plugin) and start it. - Build the event gateway from
main(make buildinevent-gateway/). - Register a gateway in platform-api:
POST /api/v0.9/gatewayswith{"id":"gw-event","displayName":"Event gateway","functionalityType":"event","version":"1.0","endpoints":["http://localhost"]}. Mint a token withPOST /api/v0.9/gateways/gw-event/tokens. - Start the event gateway stack (
event-gateway/docker-compose.dev.yaml) with that token and platform-api as its control plane. - Once it connects, call
GET /api/v0.9/gateways/gw-event. It returns"version":"0.10.0-SNAPSHOT". - Create a WebSub API:
POST /api/v0.9/websub-apiswith{"id":"b01-ws","displayName":"b01-ws","version":"v1","projectId":"default","context":"/b01ws","channels":{"orders":{}}}. - Deploy it:
POST /api/v0.9/websub-apis/b01-ws/deploymentswith{"name":"d1","base":"current","gatewayId":"gw-event"}. - The deployment ends
FAILEDwithGATEWAY_PROCESSING_ERROR, and the controller logs the lines shown above.
Severity Level of the Issue
Severity/Blocker (Core functionality is broken and consumer is blocked. Need immediate attention)
Environment Details (with versions)
- Source:
mainatf5c93849;event-gateway/VERSION=0.10.0-SNAPSHOT. - platform-api built from source with
-tags experimental(SQLite). - Event gateway images built from that commit, started 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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
wso2/api-platform#4369 ·
Maintainers usually reply within 1 day
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsOpenArea/Policies Aspect/Other Severity/Trivial Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
wso2/api-platform#4355 ·
Maintainers usually reply within 1 day
-
Area/Gateway Aspect/API Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
wso2/api-platform#4348 ·
Maintainers usually reply within 1 day
-
Aspect/AI Aspect/API. Severity/Major
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
wso2/api-platform#4343 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
wso2/api-platform#4330 ·
Maintainers usually reply within 1 day
All issues in wso2/api-platform
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Inconsistency between golang and cue in specPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
security
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Tencent/LoopForge#1087 · 1 comment ·
Maintainers usually reply within 1 day