Deleting an API can leave a listing on an API Portal when a publish records its row after the last unpublish pass

Đang mở
#4,357 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
48/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, sql
Lĩnh vực
api, backend

Hướng nghiên cứu

Start by reading the UnpublishEverywhere, Publish, and withdrawIfArtifactDeleted paths from PR #4317, then trace the artifact schema and migrations for each SQL dialect. Add a regression test for the stated ordering and check that a publish during deletion is refused or withdrawn and that a failed delete clears the marker. Done means the deleted API's portal listing is withdrawn and the API can be published again after a failed delete.

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

Mô tả

Type/Bug

Problem

Deleting an API first unpublishes it from every API Portal it is live on (UnpublishEverywhere, #4317), and only then removes the artifact, which cascades its api_publications rows away. Publish takes no lock shared with the delete: it pushes the listing to the portal, then records its row.

#4317 covers two orderings:

  • a publish whose row lands while the delete is unpublishing is caught by a later pass (up to 3 passes);
  • a publish that cannot record its row because the API is already gone withdraws its own listing (withdrawIfArtifactDeleted).

One ordering is still open:

  1. The delete's last pass reads the publications.
  2. A concurrent Publish pushes to a portal and records its row.
  3. The delete removes the artifact, and the cascade removes that new row.

The portal keeps serving the deleted API, and no row is left to unpublish it from. CodeRabbit raised this on #4317 (thread).

Proposed fix

Mark the API as being deleted before the unpublish passes, and make Publish's record step fail atomically when the API is marked. For example, promote the draft only while the artifact is not marked, in the same statement.

  • A publish recorded before the mark exists when the passes run, so it is unpublished.
  • A publish that tries to record after the mark fails, and withdrawIfArtifactDeleted (extended to the marked state) withdraws its listing.
  • A failed delete clears the mark.

This needs a nullable or defaulted marker on the artifact. It is an additive schema change, applied to every dialect with its ALTER TABLE. Holding a row lock across the portal HTTP calls instead would keep a database lock open during network I/O, so it is not preferred.

Done when

  • A test reproduces the ordering above (delete's last read, then publish records, then artifact removal) and the listing is withdrawn.
  • A publish attempted while the API is being deleted is refused or withdrawn, and a delete that fails leaves the API publishable again.
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.