feat(api): Create endpoint for fetching all revisions of a variable

[yogesh1801]

User description

Description

Adds a getRevisionsOfVariable method to get revisions of a variable

Fixes #271

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

• [ x] My PR follows the style guidelines of this project
• [x ] 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 getRevisionsOfVariable to fetch revisions of a variable with pagination support.
• Implemented the corresponding method in the service layer with necessary authority checks.
• Added end-to-end tests for the new endpoint covering multiple scenarios including no revisions, non-existent variable/environment, and access control.

---

Changes walkthrough 📝

	Relevant files
Enhancement	variable.controller.ts Add endpoint to fetch variable revisions with pagination  apps/api/src/variable/controller/variable.controller.ts Added getRevisionsOfVariable endpoint to fetch variable revisions. Implemented pagination for the new endpoint. +18/-0    variable.service.ts Implement method to retrieve variable revisions with authority checks apps/api/src/variable/service/variable.service.ts Added getRevisionsOfVariable method to retrieve variable revisions. Included authority checks for variable and environment access. +33/-0
Tests	variable.e2e.spec.ts Add tests for getRevisionsOfVariable endpoint                        apps/api/src/variable/variable.e2e.spec.ts Added tests for getRevisionsOfVariable endpoint. Included tests for various scenarios like no revisions, non-existent variable/environment, and access control. +105/-1

---

💡 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]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	3
🧪 Relevant tests	Yes
🔒 Security concerns	No
⚡ Key issues to review	None

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add validation for pagination parameters to ensure they are non-negative and within a reasonable range Consider validating the page and limit query parameters to ensure they are non-negative integers. This prevents potential issues with pagination logic where negative values could lead to unexpected behavior or errors. apps/api/src/variable/controller/variable.controller.ts [109-110] -@Query('page') page: number = 0, -@Query('limit') limit: number = 10 +@Query('page', new ParseIntPipe({ min: 0 })) page: number = 0, +@Query('limit', new ParseIntPipe({ min: 1, max: 100 })) limit: number = 10 Apply this suggestion Suggestion importance[1-10]: 9 Why: This suggestion improves the robustness of the API by ensuring that pagination parameters are within a valid range, preventing potential issues with negative values or excessively large limits.	9
Error handling	Handle the case where no revisions are found by throwing a NotFoundException Implement error handling for the scenario where no revisions are found for the given variable and environment IDs. This could involve returning a specific message or an empty array, depending on the desired API behavior. apps/api/src/variable/service/variable.service.ts [628-635] const revisions = await this.prisma.variableVersion.findMany({ where: { variableId: variableId, environmentId: environmentId }, skip: page * limit, take: limit }) +if (revisions.length === 0) { + throw new NotFoundException(`No revisions found for variable ID ${variableId} in environment ID ${environmentId}.`); +} Apply this suggestion Suggestion importance[1-10]: 8 Why: Implementing error handling for cases where no revisions are found improves the API's clarity and user experience by providing specific feedback when no data is available.	8
Performance	Suggest adding a database index to improve query performance for fetching variable revisions To optimize database queries, consider adding an index on the variableId and environmentId columns in the variableVersion table if not already present. This can significantly improve the performance of the query fetching variable revisions. apps/api/src/variable/service/variable.service.ts [628-635] +// Ensure your database has an index on `variableId` and `environmentId` for the `variableVersion` table. const revisions = await this.prisma.variableVersion.findMany({ where: { variableId: variableId, environmentId: environmentId }, skip: page * limit, take: limit }) Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding an index can significantly improve query performance, especially for large datasets. However, this suggestion is more of a general optimization tip and may not be directly applicable to the PR code diff.	7
Maintainability	Enhance method signature by adding explicit return type annotations Add explicit type annotations for the parameters in the getRevisionsOfVariable method to enhance code readability and maintainability. apps/api/src/variable/controller/variable.controller.ts [105-110] async getRevisionsOfVariable( @CurrentUser() user: User, @Param('variableId') variableId: string, @Param('environmentId') environmentId: string, @Query('page') page: number = 0, @Query('limit') limit: number = 10 -) +): Promise<VariableRevision[]> Apply this suggestion Suggestion importance[1-10]: 6 Why: Adding explicit return type annotations improves code readability and maintainability, but it is a minor enhancement compared to functional improvements or bug fixes.	6