[Bug]: WebSub deployments to an event gateway built from main fail: platform-api sends a v1alpha1 artifact
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
- 66/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- go
- Ambito
- api, backend-api-design
Direzione di ricerca
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.
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 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.
- 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
-
benchmark
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
mozilla-ai/cq#601 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation migration
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
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