Delete related attachment & images when an entity is deleted #460
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #460 +/- ##
===========================================
- Coverage 97.91% 97.57% -0.34%
===========================================
Files 48 49 +1
Lines 1723 1772 +49
===========================================
+ Hits 1687 1729 +42
- Misses 36 43 +7 ☔ View full report in Codecov by Sentry. |
VKTB
commented
Feb 13, 2025
| @@ -43,6 +43,8 @@ async def __call__(self, request: Request) -> str: | |||
| if not self._is_jwt_access_token_valid(credentials.credentials): | |||
| raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Invalid token or expired token") | |||
|
|
|||
| request.state.token = credentials.credentials | |||
There was a problem hiding this comment.
Not sure if this is a nice thing to do as there are not many examples when I searched for it on GitHub. The alternative would be to do request.headers.get("Authorization").split("Bearer ")[1] in the endpoints.
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.
Description
This PR introduces two new config values for the API to connect to and interact with an Object Storage API instance. I opted for a boolean ENV VAR (
OBJECT_STORAGE__ENABLED) because this API can be run on its own without an Object Storage API instance. This was the simplest way to ensure the tests did not break as an Object Storage API instance will otherwise be required to make them pass. These new config values will need to be added to the Docker IMS deployment configurations.I implemented an
ObjectStorageAPIClientclass whose methods are used in the services layer by the catalogue item, item, and system modules to delete any attachments and images associated to the entity that is being deleted using the same JWT access token supplied in the request. The entities in the IMS API database get deleted after the attachments and images are successfully deleted from the object storage. Unfortunately, there is no way to restore these if the delete database operation is not successful. Because the JWT access tokens have an expiry time, there could be cases where they are valid when received by the IMS API but expire when they are received by the Object Storage API. In cases like these, the IMS API will just return403 Invalid token or expired tokenso the consumer will just need to retry their request with a valid access token. The IMS API will return500 Something went wrongfor any other errors that occur while communicating with the Object Storage API.Testing instructions
You will need an Object Storage API instance running with some attachments and images in S3.
204returned when there are no attachments and/or images associated with the entity that is being deleted.Agile board tracking
closes #399