feat(api): API-CLIENT: Create controller for User module

[anudeeps352]

User description

Description

API-CLIENT: Create controller for User module

Fixes #349

Dependencies

None

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

• Implemented a new UserController class to manage user-related operations such as retrieving, updating, and deleting user data.
• Defined TypeScript interfaces for user-related requests and responses, including operations for email change OTP validation and resending.
• Added comprehensive tests for the UserController methods to ensure correct functionality of user operations.

---

Changes walkthrough 📝

	Relevant files
Enhancement	user.ts Implement UserController for managing user operations        packages/api-client/src/controllers/user.ts Created UserController class with methods for user operations. Implemented methods for getting, updating, and deleting user data. Added methods for validating and resending email change OTP. +66/-0    user.types.d.ts Define user-related request and response types                      packages/api-client/src/types/user.types.d.ts Defined interfaces for user-related requests and responses. Included types for user data retrieval and update operations. Added types for email change OTP validation and resend operations. +34/-0
Tests	user.spec.ts Add tests for UserController methods                                          packages/api-client/tests/user.spec.ts Added tests for UserController methods. Tested user data retrieval, update, and deletion. Included tests for email change OTP validation and resend. +100/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 Security concerns Sensitive information exposure: The validateEmailChangeOTP method in the UserController class (packages/api-client/src/controllers/user.ts) includes the OTP in the URL query parameter (line 48). This could potentially expose sensitive information in server logs or browser history. It's recommended to send the OTP in the request body instead.

⚡ Recommended focus areas for review Possible Bug The updateSelf and deleteSelf methods use relative paths ('./api/user') which may cause issues. These should be absolute paths ('/api/user'). Code Smell The validateEmailChangeOTP method includes the OTP in the URL query parameter, which may expose sensitive information. Consider moving it to the request body. Incomplete Tests The test suite is missing tests for validateEmailChangeOTP and resendEmailChangeOTP methods. These should be implemented to ensure full coverage.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible bug	Correct the test for deleting the current user The test for deleting the current user is incorrectly named and implemented. It's currently calling updateSelf instead of deleteSelf. Correct the test name and implementation to properly test the delete functionality. packages/api-client/tests/user.spec.ts [89-96] -it('should update current user', async () => { - const deleteUser = await userController.updateSelf( - { name: 'Jane Doe', email: '[email protected]' }, +it('should delete current user', async () => { + const deleteUser = await userController.deleteSelf( { 'x-e2e-user-email': email } ) expect(deleteUser.success).toBe(true) }) Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion addresses a critical bug in the test suite by correcting the test for deleting a user, ensuring that the intended functionality is accurately tested.	9
Best practice	Implement error handling for API calls to improve robustness Consider adding error handling for API calls to manage potential network issues or unexpected server responses. You could wrap the API calls in try-catch blocks and provide more informative error messages. packages/api-client/src/controllers/user.ts [21-26] async getSelf( headers?: Record<string, string> ): Promise<ClientResponse<GetSelfResponse>> { - const response = await this.apiClient.get(`/api/user`, headers) - return await parseResponse<GetSelfResponse>(response) + try { + const response = await this.apiClient.get(`/api/user`, headers) + return await parseResponse<GetSelfResponse>(response) + } catch (error) { + throw new Error(`Failed to get user data: ${error.message}`) + } } Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding error handling for API calls is crucial for managing potential network issues or unexpected server responses, thereby improving the robustness and reliability of the application.	8
Enhancement	Use template literals for constructing API endpoint URLs Consider using template literals for URL construction in API calls to improve readability and reduce the risk of typos. For example, replace ./api/user with ${this.backendURL}/api/user. packages/api-client/src/controllers/user.ts [32] -const response = await this.apiClient.put(`./api/user`, request, headers) +const response = await this.apiClient.put(`${this.backendURL}/api/user`, request, headers) Apply this suggestion Suggestion importance[1-10]: 7 Why: Using template literals for URL construction enhances readability and reduces the risk of typos, improving code maintainability and clarity.	7
	Add tests for email change OTP validation and resend functionality Add tests for the validateEmailChangeOTP and resendEmailChangeOTP methods to ensure complete coverage of the UserController functionality. packages/api-client/tests/user.spec.ts [98-100] -// Validate email change OTP -// resend validate email OTP tests +it('should validate email change OTP', async () => { + const response = await userController.validateEmailChangeOTP( + { otp: '123456' }, + { 'x-e2e-user-email': email } + ) + expect(response.success).toBe(true) +}) +it('should resend email change OTP', async () => { + const response = await userController.resendEmailChangeOTP( + {}, + { 'x-e2e-user-email': email } + ) + expect(response.success).toBe(true) +}) + Apply this suggestion Suggestion importance[1-10]: 6 Why: Adding tests for the validateEmailChangeOTP and resendEmailChangeOTP methods increases test coverage and ensures that these functionalities are working as expected, enhancing the reliability of the codebase.	6

💡 Need additional feedback ? start a PR chat

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀