Update reportService API endpoint for marking reports as read #112
Conversation
This file contains hidden or 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
- Changed the API endpoint for marking a report as read from `/api/reports/${reportId}` to `/api/reports/${reportId}/status` in both the reportService and its corresponding test file.
- This change improves clarity in the API structure.
- Modified the UpdateItemCommand in ReportsService to use both userId and id as keys for report updates. This change ensures that the report belongs to the correct user, enhancing data integrity.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the API endpoint for marking a report as read to improve clarity, and accordingly updates both the frontend service and its tests. Additionally, the backend service is refactored to use a composite key when updating report status.
- Updated API endpoint in reportService.ts to include "/status".
- Updated the corresponding test file to match the new endpoint.
- Refactored the backend update command to use a composite key including userId and id.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| frontend/src/common/api/reportService.ts | Updated the endpoint for marking a report as read in the frontend. |
| frontend/src/common/api/tests/reportService.test.ts | Updated the API endpoint in tests to match the new structure. |
| backend/src/reports/reports.service.ts | Modified the update command to use a composite key (userId and id). |
Comments suppressed due to low confidence (1)
backend/src/reports/reports.service.ts:247
- The update command now expects a composite key including 'userId', but it is unclear if 'userId' is properly defined and scoped in this context. Please ensure that 'userId' is initialized and accessible when constructing the key.
userId, // Partition key
GuidoBR
approved these changes
Apr 25, 2025
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.
Change
This pull request includes updates to the
ReportsServicein the backend and changes to the API endpoints and their usage in the frontend. The most important changes involve modifying the DynamoDB key structure in the backend and updating the API endpoint for marking reports as read in the frontend.Backend changes:
ReportsServiceinreports.service.tsto use a composite key (userIdas the partition key andidas the sort key) for DynamoDB operations, ensuring better data organization and query flexibility.Frontend changes:
/statusto the URL inreportService.test.tsandreportService.ts, aligning it with the new backend API structure. [1] [2]Does this PR introduce a breaking change?
{...}
What needs to be documented once your changes are merged?
{...}
Additional Comments
{...}