feat(api): Create endpoint for fetching all revisions of a secret #303

anudeeps352 · 2024-06-27T20:15:26Z

User description

Description

Create endpoint for fetching all revisions of a secret

GET /api/secret/:secretId/revisions/:environmentId

Fixes #272

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

My PR follows the style guidelines of this project
I have performed a self-check on my work

If changes are made in the code:

I have followed the coding guidelines
My changes in code generate no new warnings
My changes are breaking another fix/feature of the project
I have added test cases to show that my feature works
I have added relevant screenshots in my PR
There are no UI/UX issues

Documentation Update

This PR requires an update to the documentation at docs.keyshade.xyz
I have made the necessary updates to the documentation, or no documentation changes are required.

PR Type

Enhancement, Tests

Description

Added a new endpoint GET /api/secret/:secretId/revisions/:environmentId to fetch all revisions of a secret.
Implemented the getRevisionsOfSecret method in the SecretController class.
Added getRevisionsOfSecret method to the SecretService class, including authority checks and retrieval logic.
Added end-to-end tests for the new endpoint, covering multiple scenarios including fetching multiple revisions, no revisions, non-existent secret, non-existent environment, and unauthorized access.

Changes walkthrough 📝

Relevant files

Enhancement

secret.controller.ts `Add endpoint to fetch all revisions of a secret` apps/api/src/secret/controller/secret.controller.ts Added a new endpoint `GET` `/api/secret/:secretId/revisions/:environmentId` to fetch all revisions of a secret. Implemented the `getRevisionsOfSecret` method in the `SecretController` class.	+14/-0
secret.service.ts `Implement service method to fetch secret revisions` apps/api/src/secret/service/secret.service.ts Added `getRevisionsOfSecret` method to the `SecretService` class. Implemented authority checks and retrieval of secret revisions.	+29/-0

Tests

secret.e2e.spec.ts `Add tests for fetching all revisions of a secret endpoint` apps/api/src/secret/secret.e2e.spec.ts Added end-to-end tests for the new endpoint to fetch all revisions of a secret. Included tests for various scenarios: fetching multiple revisions, no revisions, non-existent secret, non-existent environment, and unauthorized access.	+104/-0

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

codiumai-pr-agent-free · 2024-06-27T20:15:49Z

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	3
🧪 Relevant tests	Yes
🔒 Security concerns	No
⚡ Key issues to review	Possible Bug: Ensure that the `getRevisionsOfSecret` method in `SecretService` handles the case where the secret or environment does not exist before making database queries. This could prevent unnecessary database calls and improve error handling.
⚡ Key issues to review	Error Handling: Verify that the error messages returned are consistent and informative across different failure scenarios in the endpoint.

codiumai-pr-agent-free · 2024-06-27T20:16:32Z

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Add error handling to improve method robustness and error reporting Implement error handling for the `getRevisionsOfSecret` method to manage cases where the authority checks fail or the database operations throw an exception. This will improve the robustness of the method and provide clearer error messages to the client. apps/api/src/secret/service/secret.service.ts [499-511] -await this.authorityCheckerService.checkAuthorityOverSecret({ - userId: user.id, - entity: { id: secretId }, - authority: Authority.READ_SECRET, - prisma: this.prisma -}) -await this.authorityCheckerService.checkAuthorityOverEnvironment({ - userId: user.id, - entity: { id: environmentId }, - authority: Authority.READ_ENVIRONMENT, - prisma: this.prisma -}) +try { + await this.authorityCheckerService.checkAuthorityOverSecret({ + userId: user.id, + entity: { id: secretId }, + authority: Authority.READ_SECRET, + prisma: this.prisma + }) + await this.authorityCheckerService.checkAuthorityOverEnvironment({ + userId: user.id, + entity: { id: environmentId }, + authority: Authority.READ_ENVIRONMENT, + prisma: this.prisma + }) +} catch (error) { + throw new HttpException('Failed to verify authorities or fetch data', HttpStatus.INTERNAL_SERVER_ERROR); +} Apply this suggestion Suggestion importance[1-10]: 10 Why: Implementing error handling for authority checks and database operations enhances the robustness of the method and provides clearer error messages to the client, which is crucial for reliability and user experience.	10
Enhancement	Add parameter validation for `secretId` and `environmentId` to ensure they are well-formed UUIDs Consider validating the parameters `secretId` and `environmentId` to ensure they are not empty or malformed before proceeding with the database operations. This can help prevent unnecessary database queries and potential errors when invalid IDs are provided. apps/api/src/secret/controller/secret.controller.ts [110-111] -@Param('secretId') secretId: string, -@Param('environmentId') environmentId: string +@Param('secretId', ParseUUIDPipe) secretId: string, +@Param('environmentId', ParseUUIDPipe) environmentId: string Apply this suggestion Suggestion importance[1-10]: 9 Why: Adding validation for `secretId` and `environmentId` ensures that only well-formed UUIDs are processed, preventing unnecessary database queries and potential errors. This is a significant improvement for robustness and security.	9
Performance	Suggest adding a database index on `secretId` and `environmentId` to improve query performance To optimize the database query when fetching secret revisions, consider including an index on the `secretId` and `environmentId` fields in the `secretVersion` table. This can significantly improve the performance of the query, especially when dealing with a large number of records. apps/api/src/secret/service/secret.service.ts [514-517] +const revisions = await this.prisma.secretVersion.findMany({ + where: { + secretId: secretId, + environmentId: environmentId + } +}) - Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding an index on `secretId` and `environmentId` can significantly improve the performance of database queries, especially with large datasets. This is a valuable optimization for performance.	8
Security	Implement a middleware to check API key authorities to centralize security checks To ensure that the API key provided has the necessary authorities, consider implementing a middleware that checks the API key before reaching the controller method. This can help centralize security checks and reduce redundancy across different endpoints. apps/api/src/secret/controller/secret.controller.ts [106-111] -@RequiredApiKeyAuthorities(Authority.READ_SECRET) +@UseGuards(ApiKeyAuthGuard) async getRevisionsOfSecret( @CurrentUser() user: User, @Param('secretId') secretId: string, @Param('environmentId') environmentId: string ) Apply this suggestion Suggestion importance[1-10]: 7 Why: Using a middleware to check API key authorities can centralize security checks and reduce redundancy, improving maintainability. However, the current decorator approach is also valid, so this is more of a structural improvement.	7

apps/api/src/secret/service/secret.service.ts

anudeeps352 · 2024-07-23T15:10:12Z

Hey btw since this pr won't be considered in foss hack,can this be merged ??

rajdip-b · 2024-07-23T17:28:17Z

I'm totally fine if you are!

apps/api/src/secret/service/secret.service.ts

rajdip-b

The code looks good. Just fix the tests and we can merge it.

anudeeps352 · 2024-07-27T20:06:49Z

Hey I think this one would work fine

rajdip-b

Looks so clean! LGTM.

Updated sort param

## [2.3.0](v2.2.0...v2.3.0) (2024-07-29) ### 🚀 Features * **api:** Add pagination metadata to Environment module ([#382](#382)) ([9baa344](9baa344)) * **api:** Add pagination metadata to Event module ([#394](#394)) ([60010b4](60010b4)) * **api:** Add pagination metadata to Integration module ([#391](#391)) ([0372e36](0372e36)) * **api:** Add pagination metadata to Project module ([#393](#393)) ([bc274fd](bc274fd)) * **api:** Add pagination metadata to Secret module ([#389](#389)) ([c4cc667](c4cc667)) * **api:** Add pagination metadata to Variable module ([#390](#390)) ([be6aabf](be6aabf)) * **api:** Add pagination metadata to Workspace module ([#387](#387)) ([a08c924](a08c924)) * **api:** Add pagination metadata to Workspace Role module ([#388](#388)) ([d8e8f49](d8e8f49)) * **api:** Create a paginate method ([#379](#379)) ([09576f1](09576f1)) * **api:** Create endpoint for fetching all revisions of a [secure] ([#303](#303)) ([de2b602](de2b602)) * **api:** Create endpoint for fetching all revisions of a variable ([#304](#304)) ([9abddc1](9abddc1)) * **cli:** Improved the DX for list profile ([#334](#334)) ([6bff496](6bff496)) * **platform:** Add warning sonner toast for invalid otp ([#335](#335)) ([21513f5](21513f5)) ### 🐛 Bug Fixes * **cli:** Added parent directory check ([#359](#359)) ([538ea7f](538ea7f)) * **platform:** Platform types fixes ([#374](#374)) ([8e9d9ff](8e9d9ff)) ### 📚 Documentation * Added docker details in setting-things-up.md ([#358](#358)) ([ed5093a](ed5093a)) * Update postman workspace link ([d6aba27](d6aba27)) * Updated env and cli docs ([1213d2a](1213d2a)) ### 🔧 Miscellaneous Chores * Added next backend url in .env.example ([5695254](5695254)) * **api-client:** Added pagination structure ([a70e957](a70e957)) * **api-client:** Fixed test script ([ad70819](ad70819)) * **api-client:** Removed try-catch from tests in environment ([a64e48c](a64e48c)) * **api:** Add user cache for optimization ([#386](#386)) ([8d730b5](8d730b5)) * **api:** Alter cache rehydration interval ([f5f9eec](f5f9eec)) * **api:** Fixed naming error in variable controller ([0c5a380](0c5a380)) * **api:** Improve handling of edge cases for paginate module ([#402](#402)) ([8591487](8591487)) * **api:** Minor updates to user service ([249d778](249d778)) * **api:** Skip workspace creation when user is admin ([#376](#376)) ([13f6c59](13f6c59)) * **ci:** Add docker check ([#383](#383)) ([3119001](3119001)) * **ci:** Add names to CI files ([1a7e5f6](1a7e5f6)) * **ci:** Add validate CLI pipeline ([#373](#373)) ([a91df6c](a91df6c)) * **ci:** Adding validate pipeline ([#372](#372)) ([23cf3b3](23cf3b3)) * **ci:** Disabled platform and api deployments ([74d601a](74d601a)) * **ci:** Fixed deployment scripts ([12e35db](12e35db)) * **ci:** Fixed platform script ([d783f2a](d783f2a)) * **CI:** Include migration deployment in API deploy pipeline ([dbd5222](dbd5222)) * **CI:** Separated deployment and docker build jobs ([090e193](090e193)) * **CI:** Setup inter-job dependency ([1756727](1756727)) * **ci:** Update auto-assign.yaml ([#375](#375)) ([91e0ec1](91e0ec1)) * **cli:** Changed objects to classes ([#306](#306)) ([c83f2db](c83f2db)) * Removed Minio config ([8feb83a](8feb83a)) * Updated deployment scripts and added health check in platform ([fcc1c3f](fcc1c3f)) ### 🔨 Code Refactoring * **api:** Updated path of some endpoints in project controller ([9502678](9502678)) * **api:** Updated Redis provider ([33491a1](33491a1))

anudeeps352 requested a review from rajdip-b as a code owner June 27, 2024 20:15

codiumai-pr-agent-free bot added enhancement Tests Review effort [1-5]: 3 labels Jun 27, 2024

rajdip-b requested changes Jun 28, 2024

View reviewed changes

apps/api/src/secret/service/secret.service.ts Show resolved Hide resolved

rajdip-b added the foss hack Clustering all the curated issues for Foss Hack 2024 label Jun 28, 2024

rajdip-b force-pushed the getAllRevisionsOfSecrets branch from 52cb6ab to b5a0637 Compare June 28, 2024 13:37

rajdip-b requested changes Jun 28, 2024

View reviewed changes

apps/api/src/secret/service/secret.service.ts Outdated Show resolved Hide resolved

rajdip-b force-pushed the getAllRevisionsOfSecrets branch from 2a4de25 to 5adf2ce Compare July 23, 2024 17:28

rajdip-b approved these changes Jul 23, 2024

View reviewed changes

apps/api/src/secret/service/secret.service.ts Outdated Show resolved Hide resolved

apps/api/src/secret/service/secret.service.ts Outdated Show resolved Hide resolved

apps/api/src/secret/service/secret.service.ts Outdated Show resolved Hide resolved

rajdip-b reviewed Jul 26, 2024

View reviewed changes

anudeeps352 force-pushed the getAllRevisionsOfSecrets branch from 99ce8da to 50ea093 Compare July 26, 2024 17:09

rajdip-b force-pushed the getAllRevisionsOfSecrets branch from a9b846a to 41d33a5 Compare July 27, 2024 06:31

rajdip-b approved these changes Jul 28, 2024

View reviewed changes

anudeeps352 and others added 5 commits July 29, 2024 19:13

API: Create endpoint for fetching all revisions of a secret

751bbe5

added pagination to getRevisionsOfSecret

2670240

removed order and search query params

52b1e75

Update secret.service.ts

8093f0d

Updated sort param

added order param and removed sort param

85668fe

rajdip-b force-pushed the getAllRevisionsOfSecrets branch from f054806 to 85668fe Compare July 29, 2024 13:43

rajdip-b merged commit 1df4469 into keyshade-xyz:develop Jul 29, 2024
4 checks passed

rajdip-b pushed a commit that referenced this pull request Jul 29, 2024

feat(api): Create endpoint for fetching all revisions of a secret (#303)

de2b602

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): Create endpoint for fetching all revisions of a secret #303

feat(api): Create endpoint for fetching all revisions of a secret #303

anudeeps352 commented Jun 27, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Jun 27, 2024

codiumai-pr-agent-free bot commented Jun 27, 2024 •

edited

Loading

anudeeps352 commented Jul 23, 2024

rajdip-b commented Jul 23, 2024

rajdip-b left a comment

anudeeps352 commented Jul 27, 2024

rajdip-b left a comment

feat(api): Create endpoint for fetching all revisions of a secret #303

feat(api): Create endpoint for fetching all revisions of a secret #303

Conversation

anudeeps352 commented Jun 27, 2024 • edited by codiumai-pr-agent-free bot Loading

User description

Description

Dependencies

Future Improvements

Mentions

Screenshots of relevant screens

Developer's checklist

Documentation Update

PR Type

Description

Changes walkthrough 📝

codiumai-pr-agent-free bot commented Jun 27, 2024

PR Reviewer Guide 🔍

codiumai-pr-agent-free bot commented Jun 27, 2024 • edited Loading

PR Code Suggestions ✨

anudeeps352 commented Jul 23, 2024

rajdip-b commented Jul 23, 2024

rajdip-b left a comment

Choose a reason for hiding this comment

anudeeps352 commented Jul 27, 2024

rajdip-b left a comment

Choose a reason for hiding this comment

anudeeps352 commented Jun 27, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Jun 27, 2024 •

edited

Loading