[Bug]: An artifact removed from an immutable gateway's files still shows as deployed in the control plane

未关闭
#4,161 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
57/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
go, sqlite
领域
api, backend

调研方向

Read gateway/gateway-controller/cmd/controller/main.go around line 168, pkg/immutable/loader.go, and pkg/controlplane/sync.go around line 695 to trace startup loading and deployment sync. Reproduce with immutable mode, deployment sync enabled, and two annotated REST API files; remove one and restart the controller. Done when the control plane reports that API as UNDEPLOYED after restart.

由索引模型根据 Issue 内容生成。

描述

Area/Gateway Aspect/Other Severity/Minor Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/Other (Anything else which does not match above categories)

Description

An immutable gateway pushes the artifacts it loads from files to the control plane, and they show as deployed there. When a file is removed and the gateway restarts, the gateway no longer serves that artifact, but it never tells the control plane. The control plane keeps showing the deployment as DEPLOYED with no undeploy.

Observed (deployment sync enabled)

  • Two REST API files, a and b, each with the gateway.api-platform.wso2.com/project-id annotation. After a restart, both appear in the control plane, and b's deployment is DEPLOYED.
  • I changed a's display name, removed b's file, and restarted gateway-controller.
    • The control plane received a's new display name, so the push after the restart did happen.
    • The gateway's GET /rest-apis/b answers 404.
    • The control plane's GET /api/v0.9/rest-apis/b/deployments still lists DEPLOYED and no UNDEPLOYED.

Expected
After the restart, the control plane shows b's deployment on that gateway as undeployed.

Cause

  • Immutable mode deletes the SQLite database on every boot (gateway/gateway-controller/cmd/controller/main.go:168), so the gateway has no record of what it served before.
  • The loader only creates what is in the files (pkg/immutable/loader.go). The connect-time push sends only the artifacts the gateway still has (pkg/controlplane/sync.go:695), so nothing reports b as undeployed.
Steps to Reproduce
  1. Start an immutable gateway (SQLite, [immutable_gateway] enabled = true) connected to platform-api with deployment sync on. Give it two REST API files with the project-id annotation of an existing project.
  2. Check that both APIs show a DEPLOYED deployment in the control plane.
  3. Remove one file and restart gateway-controller.
  4. The control plane still shows that API's deployment as DEPLOYED.
Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)

Current main (0ee943ff4). Platform-api and gateway built from source and run by the IT suite (tests/framework), with the gateway on SQLite, on macOS with Rancher Desktop.

主要语言
Go
星标
85
派生
137
平均合并
1 天 12 小时
30 天内合并 PR
247

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

wso2/api-platform 的其他 Issue

查看 wso2/api-platform 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。