Deleting an API can leave a listing on an API Portal when a publish records its row after the last unpublish pass
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
Research direction
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.
Written by the indexing model from the issue text.
Description
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:
- The delete's last pass reads the publications.
- A concurrent
Publishpushes to a portal and records its row. - 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.
- Dominant language
- Go
- Stars
- 85
- Forks
- 137
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 247
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
wso2/api-platform#4369 ·
Maintainers usually reply within 1 day
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsOpenArea/Policies Aspect/Other Severity/Trivial Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
wso2/api-platform#4355 ·
Maintainers usually reply within 1 day
-
Area/Gateway Aspect/API Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
wso2/api-platform#4348 ·
Maintainers usually reply within 1 day
-
Aspect/AI Aspect/API. Severity/Major
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
wso2/api-platform#4343 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
wso2/api-platform#4330 ·
Maintainers usually reply within 1 day
All issues in wso2/api-platform
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Inconsistency between golang and cue in specPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
security
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Tencent/LoopForge#1087 · 1 comment ·
Maintainers usually reply within 1 day