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

Đang mở
#4,161 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
57/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go, sqlite
Lĩnh vực
api, backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Go
Star
85
Fork
137
Merge trung bình
1 ngày 12 giờ
Pull request đã merge (30 ngày)
247

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của wso2/api-platform

Tất cả issue của wso2/api-platform

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.