[Bug]: WebSub deployments to an event gateway built from main fail: platform-api sends a v1alpha1 artifact

オープン
#4,288 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
66/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
go

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

Area/EventGateway Area/Platform-API Aspect/API Severity/Blocker 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 deployed from platform-api to an event gateway built from the same main commit always fails with GATEWAY_PROCESSING_ERROR.

The cause:

  1. The event gateway reports its own product version, 0.10.0-SNAPSHOT, and platform-api stores that as the gateway's version.
  2. 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's apiVersion to gateway.api-platform.wso2.com/v1alpha1 (platform-api/internal/gatewaytranslator/translate/run.go:42).
  3. 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
  1. Build platform-api from main with -tags experimental (this enables the WebSub/WebBroker plugin) and start it.
  2. Build the event gateway from main (make build in event-gateway/).
  3. Register a gateway in platform-api: POST /api/v0.9/gateways with {"id":"gw-event","displayName":"Event gateway","functionalityType":"event","version":"1.0","endpoints":["http://localhost"]}. Mint a token with POST /api/v0.9/gateways/gw-event/tokens.
  4. Start the event gateway stack (event-gateway/docker-compose.dev.yaml) with that token and platform-api as its control plane.
  5. Once it connects, call GET /api/v0.9/gateways/gw-event. It returns "version":"0.10.0-SNAPSHOT".
  6. Create a WebSub API: POST /api/v0.9/websub-apis with {"id":"b01-ws","displayName":"b01-ws","version":"v1","projectId":"default","context":"/b01ws","channels":{"orders":{}}}.
  7. Deploy it: POST /api/v0.9/websub-apis/b01-ws/deployments with {"name":"d1","base":"current","gatewayId":"gw-event"}.
  8. The deployment ends FAILED with GATEWAY_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: main at f5c93849; 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.
主要言語
Go
スター
85
フォーク
137
平均マージ
1日 12時間
マージ済み PR(30日)
247

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

wso2/api-platform のほかの issue

wso2/api-platform の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。