feat(rest): create new endpoint for bulk delete function #2416
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KoukiHama
added
needs code review
needs general test
heliocastro
requested review from
heliocastro,
GMishx,
KoukiHama,
arunazhakesan and
ag4ums
as code owners
Signed-off-by: Shi Qiu <[email protected]>
shi9qiu
force-pushed
the
bulk-delete-api
branch
from
edc37b2
to
92af64d
Compare
|
Dear all, @GMishx @KoukiHama @heliocastro @arunazhakesan @smrutis1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: #2415, #1649
Create new endpoint for bulk delete function (#1468).
How To Test?
Preparations
Exclusion Behavior Confirmation
After starting the system, sign in as an Admin user and register a Release with the following structure.
Open the detail screen of each Release in a web browser and confirm the ID of the Release.
Use any RestAPI client tool to execute the RestAPI.
HTTP Method: DELETE
URL：http://{your-host}/resource/api/releases/{release-id}/bulkDelete
Response Confirmation
{ "id": "0cc9b2190acc4a9684220c5fae3bb8d1", "name": "DeleteLibrary001", "version": "", "type": "COMPONENT", "childList": [ { "id": "7ba3519c75a44dbb8001b9abf204aabe", "name": "DeleteLibrary001", "version": "1.00", "type": "RELEASE", "parentId": "0cc9b2190acc4a9684220c5fae3bb8d1", "childList": [ { "id": "f44b32501fce45cf83210eb87e1a0f38", "name": "DeleteLibrary002", "version": "", "type": "COMPONENT", "parentId": "7ba3519c75a44dbb8001b9abf204aabe", "childList": [ { "id": "81e2a98043754c16ae0e1f0b813f12e8", "name": "DeleteLibrary002", "version": "1.00", "type": "RELEASE", "parentId": "f44b32501fce45cf83210eb87e1a0f38", "childList": [ { "id": "559eef9ea058403bb573bf1d9877e578", "name": "DeleteLibrary003", "version": "", "type": "COMPONENT", "parentId": "81e2a98043754c16ae0e1f0b813f12e8", "childList": [ { "id": "aac86784f95146929646009a6ee6a6f9", "name": "DeleteLibrary003", "version": "1.00", "type": "RELEASE", "parentId": "559eef9ea058403bb573bf1d9877e578", "childList": [], "state": "EXCLUDED" } ], "state": "EXCLUDED" } ], "state": "EXCLUDED" } ], "state": "EXCLUDED" } ], "state": "EXCLUDED" } ], "state": "EXCLUDED" }Confirm that the following records have not been deleted.
[Release]
DeleteLibrary001 1.00
DeleteLibrary002 1.00
DeleteLibrary003 1.00
[Component]
DeleteLibrary001
DeleteLibrary002
DeleteLibrary003
Confirmation of Preview Mode Operation
After starting the system, sign in as an Admin user and register a Release with the following structure.
Open the detail screen of each Release in a web browser and confirm the ID of the Release.
Use any RestAPI client tool to execute the RestAPI.
HTTP Method: DELETE
URL: http://{your-host}/resource/api/releases/{release-id}/bulkDelete?isPreview=true
Response Confirmation
{ "id": "8bfed94283b044eea64d26ba3ddc82ad", "name": "DeleteLibrary004", "version": "", "type": "COMPONENT", "childList": [ { "id": "24db41e44aa64090a6fdad642d7d94b1", "name": "DeleteLibrary004", "version": "1.00", "type": "RELEASE", "parentId": "8bfed94283b044eea64d26ba3ddc82ad", "childList": [ { "id": "056543ab37dc404f8b322409d7697bc4", "name": "RemainLibrary001", "version": "", "type": "COMPONENT", "parentId": "24db41e44aa64090a6fdad642d7d94b1", "childList": [ { "id": "dbd29dbba48e4c0f809897a4695d0248", "name": "RemainLibrary001", "version": "1.00", "type": "RELEASE", "parentId": "056543ab37dc404f8b322409d7697bc4", "childList": [], "state": "EXCLUDED" } ], "state": "EXCLUDED" }, { "id": "44b339a428b1470a8232944a0efa012e", "name": "DeleteLibrary005", "version": "", "type": "COMPONENT", "parentId": "24db41e44aa64090a6fdad642d7d94b1", "childList": [ { "id": "8a12abad6bfe4d63b3cf2738f6d87f37", "name": "DeleteLibrary005", "version": "1.00", "type": "RELEASE", "parentId": "44b339a428b1470a8232944a0efa012e", "childList": [ { "id": "1c14c0b323754a98835ef8f06ef05ce9", "name": "DeleteLibrary006", "version": "", "type": "COMPONENT", "parentId": "8a12abad6bfe4d63b3cf2738f6d87f37", "childList": [ { "id": "6ff70c8569c541adbc04667624d9a2f1", "name": "DeleteLibrary006", "version": "1.00", "type": "RELEASE", "parentId": "1c14c0b323754a98835ef8f06ef05ce9", "childList": [], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" }Confirm that the following records have not been deleted.
[Release]
ExcludeLibrary001 1.00
RemainLibrary001 1.00
DeleteLibrary004 1.00
DeleteLibrary005 1.00
DeleteLibrary006 1.00
[Component]
ExcludeLibrary001
RemainLibrary001
DeleteLibrary004
DeleteLibrary005
DeleteLibrary006
Bulk Deletion Confirmation
After starting the system, sign in as an Admin user and register a Release with the following structure.
Open the detail screen of each Release in a web browser and confirm the ID of the Release.
Use any RestAPI client tool to execute the RestAPI.
HTTP Method: DELETE
URL: http://{your-host}/resource/api/releases/{release-id}/bulkDelete
Response Confirmation
{ "id": "8bfed94283b044eea64d26ba3ddc82ad", "name": "DeleteLibrary004", "version": "", "type": "COMPONENT", "childList": [ { "id": "24db41e44aa64090a6fdad642d7d94b1", "name": "DeleteLibrary004", "version": "1.00", "type": "RELEASE", "parentId": "8bfed94283b044eea64d26ba3ddc82ad", "childList": [ { "id": "056543ab37dc404f8b322409d7697bc4", "name": "RemainLibrary001", "version": "", "type": "COMPONENT", "parentId": "24db41e44aa64090a6fdad642d7d94b1", "childList": [ { "id": "dbd29dbba48e4c0f809897a4695d0248", "name": "RemainLibrary001", "version": "1.00", "type": "RELEASE", "parentId": "056543ab37dc404f8b322409d7697bc4", "childList": [], "state": "EXCLUDED" } ], "state": "EXCLUDED" }, { "id": "44b339a428b1470a8232944a0efa012e", "name": "DeleteLibrary005", "version": "", "type": "COMPONENT", "parentId": "24db41e44aa64090a6fdad642d7d94b1", "childList": [ { "id": "8a12abad6bfe4d63b3cf2738f6d87f37", "name": "DeleteLibrary005", "version": "1.00", "type": "RELEASE", "parentId": "44b339a428b1470a8232944a0efa012e", "childList": [ { "id": "1c14c0b323754a98835ef8f06ef05ce9", "name": "DeleteLibrary006", "version": "", "type": "COMPONENT", "parentId": "8a12abad6bfe4d63b3cf2738f6d87f37", "childList": [ { "id": "6ff70c8569c541adbc04667624d9a2f1", "name": "DeleteLibrary006", "version": "1.00", "type": "RELEASE", "parentId": "1c14c0b323754a98835ef8f06ef05ce9", "childList": [], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" }Replace the ID of the release according to the test data.
Confirm that the following records have not been deleted.
[Release]
ExcludeLibrary001 1.00
RemainLibrary001 1.00
[Component]
ExcludeLibrary001
RemainLibrary001
Confirm that the following records have been deleted.
[Release]
DeleteLibrary004 1.00
DeleteLibrary005 1.00
DeleteLibrary006 1.00
[Component]
DeleteLibrary004
DeleteLibrary005
DeleteLibrary006
Operation by a User without Admin Privileges
Open the detail screen of any Release in a web browser and confirm the ID of the Release.
Use any RestAPI client tool to execute the RestAPI.
HTTP method: DELETE
URL: http://{your-host}/resource/api/releases/{release-id}/bulkDelete
Response Confirmation
Checklist
Must:
Overview of improvements
Purpose
The bulk delete function is a feature that allows for the deletion of a group of Releases and unused Components that are linked together, starting from a specified Release.
The purpose of this change is to enable the execution of the bulk delete function from the RestAPI, in anticipation of transitioning the frontend to Next.js.
The operating conditions and limitations are the same as the UI version of the bulk delete function.
To enable the bulk delete function, it is necessary to enable the Admin’s Private access function.
Add the following entries to sw360.properties:
Summary of Function Changes
Addition of Endpoint
The following endpoint has been added to the SW360 RestAPI.
true: Only perform operation check without deleting data on the DB. (For preview screen)
false: Delete data on the DB.
Sample URL:
Key Points of Code Changes
Addition of endpoint for bulk delete function
ReleaseController
rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/release/ReleaseController.java
bulkDeleteReleases method
Added a Java method corresponding to the endpoint “/{id}/bulkDelete” for the bulk delete function.
Sw360ReleaseService
rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/release/Sw360ReleaseService.java
deleteBulkRelease method
Added common RestAPI processing to call the backend processing of the bulk delete function.
JacksonCustomizations
rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/core/JacksonCustomizations.java
BulkOperationNodeMixin class
Added a Mixin class containing instructions to the serializer during response JSON generation.
Bug fixes
Modified backend logic to fix bugs discovered in testing.
BulkDeleteUtil
backend/src-common/src/main/java/org/eclipse/sw360/datahandler/db/BulkDeleteUtil.java
deleteBulkRelease method
Fixed a bug where the links of subordinate Releases were deleted when a Release referenced from an external project was bulk deleted.
BulkDeleteUtilTest
backend/src/src-components/src/test/java/org/eclipse/sw360/components/db/BulkDeleteUtilTest.java
Added Maven tests to address the aforementioned bug.
Data Structure
DB Records
The bulk delete function analyzes the dependency tree of existing data each time and deletes the data. Therefore, the bulk delete function does not hold any tree information in the database.
Response JSON
The API of the bulk delete function returns JSON data in the following format after execution. The structure of the JSON data is based on the assumption that it will be displayed on the bulk delete screen of the UI, and the format is such that Components and Releases appear alternately.
{ "id": "8bfed94283b044eea64d26ba3ddc82ad", "name": "DeleteLibrary004", "version": "", "type": "COMPONENT", "childList": [ { "id": "24db41e44aa64090a6fdad642d7d94b1", "name": "DeleteLibrary004", "version": "1.00", "type": "RELEASE", "parentId": "8bfed94283b044eea64d26ba3ddc82ad", "childList": [ { "id": "056543ab37dc404f8b322409d7697bc4", "name": "RemainLibrary001", "version": "", "type": "COMPONENT", "parentId": "24db41e44aa64090a6fdad642d7d94b1", "childList": [ { "id": "dbd29dbba48e4c0f809897a4695d0248", "name": "RemainLibrary001", "version": "1.00", "type": "RELEASE", "parentId": "056543ab37dc404f8b322409d7697bc4", "childList": [], "state": "EXCLUDED" } ], "state": "EXCLUDED" }, { "id": "44b339a428b1470a8232944a0efa012e", "name": "DeleteLibrary005", "version": "", "type": "COMPONENT", "parentId": "24db41e44aa64090a6fdad642d7d94b1", "childList": [ { "id": "8a12abad6bfe4d63b3cf2738f6d87f37", "name": "DeleteLibrary005", "version": "1.00", "type": "RELEASE", "parentId": "44b339a428b1470a8232944a0efa012e", "childList": [ { "id": "1c14c0b323754a98835ef8f06ef05ce9", "name": "DeleteLibrary006", "version": "", "type": "COMPONENT", "parentId": "8a12abad6bfe4d63b3cf2738f6d87f37", "childList": [ { "id": "6ff70c8569c541adbc04667624d9a2f1", "name": "DeleteLibrary006", "version": "1.00", "type": "RELEASE", "parentId": "1c14c0b323754a98835ef8f06ef05ce9", "childList": [], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" } ], "state": "SUCCEEDED" }Data class corresponding to the response data:
org.eclipse.sw360.datahandler.thrift.components.BulkOperationNode
DB Migration
There are no changes to the DB structure due to this modification.
Limitations