fix: Error messages fixed in api-key service

[Nil2000]

User description

Description

Error messages updated in keyshade/apps/api/src/api-key/service/api-key.service.ts file

Fixes #417

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

Bug fix

---

Description

• Updated error messages in the ApiKeyService to provide clearer and more accurate information by using apiKeySlug instead of apiKeyId.
• Ensured consistency in error handling across methods in the ApiKeyService.

---

Changes walkthrough 📝

	Relevant files
Bug fix	api-key.service.ts Fix error messages in API key service                                        apps/api/src/api-key/service/api-key.service.ts Updated error messages for NotFoundException. Changed error message to use apiKeySlug instead of apiKeyId. +3/-3

---

💡 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: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Inconsistent Error Handling The error message in the catch block (line 140) throws a NotFoundException, which may not be appropriate for all types of errors that could occur during the delete operation.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible bug	✅ Reorder code to prevent potential null reference errors Consider moving the apiKey check before accessing apiKey.id to avoid potential runtime errors if apiKey is null. apps/api/src/api-key/service/api-key.service.ts [88-97] const apiKey = await this.prisma.apiKey.findUnique({ where: { slug: apiKeySlug } }) -const apiKeyId = apiKey.id if (!apiKey) { throw new NotFoundException(`API key ${apiKeySlug} not found`) } +const apiKeyId = apiKey.id + [Suggestion has been applied] Suggestion importance[1-10]: 9 Why: This suggestion addresses a potential bug where accessing apiKey.id could result in a runtime error if apiKey is null. Reordering the code to check for null before accessing properties is a crucial fix.	9
Error handling	Improve error handling to distinguish between different types of errors Consider adding more specific error handling in the deleteApiKey method to distinguish between "not found" errors and other potential issues. apps/api/src/api-key/service/api-key.service.ts [132-141] try { await this.prisma.apiKey.delete({ where: { slug: apiKeySlug, userId: user.id } }) } catch (error) { - throw new NotFoundException(`API key ${apiKeySlug} not found`) + if (error instanceof Prisma.PrismaClientKnownRequestError && error.code === 'P2025') { + throw new NotFoundException(`API key ${apiKeySlug} not found`) + } + throw error } Apply this suggestion Suggestion importance[1-10]: 8 Why: This suggestion improves error handling by distinguishing between different types of errors, which enhances the robustness and clarity of the code.	8
Consistency	Standardize error handling approach across different methods Consider using a consistent approach for error handling across all methods. The getApiKeyBySlug method doesn't use a try-catch block, unlike deleteApiKey. apps/api/src/api-key/service/api-key.service.ts [155-167] -const apiKey = await this.prisma.apiKey.findUnique({ - where: { - slug: apiKeySlug, - userId: user.id - }, - select: this.apiKeySelect -}) +try { + const apiKey = await this.prisma.apiKey.findUnique({ + where: { + slug: apiKeySlug, + userId: user.id + }, + select: this.apiKeySelect + }) -if (!apiKey) { - throw new NotFoundException(`API key ${apiKeySlug} not found`) + if (!apiKey) { + throw new NotFoundException(`API key ${apiKeySlug} not found`) + } + + return apiKey +} catch (error) { + if (error instanceof NotFoundException) { + throw error + } + throw new InternalServerErrorException('An error occurred while fetching the API key') } Apply this suggestion Suggestion importance[1-10]: 7 Why: Standardizing error handling across methods can improve code consistency and maintainability, though it may not be as critical as addressing potential runtime errors.	7

[rajdip-b]

🎉 This PR is included in version 2.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀