feat: Add more logging to Sentry init

[YuvalBubnovsky]

User description

Added input range validation for Sentry env vars

Description

Give a summary of the change that you have made

Fixes #145

Dependencies

No new deps introduced.

Future Improvements

None at the moment.

Mentions

@rajdip-b

Screenshots of relevant screens

N/A

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:

• [x] I have followed the coding guidelines
• [x] 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
• [x] 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, bug_fix

---

Description

• Added URL validation for SENTRY_DSN and range validation for SENTRY_TRACES_SAMPLE_RATE and SENTRY_PROFILES_SAMPLE_RATE in environment schema.
• Enhanced Sentry initialization with detailed logging of configuration parameters.
• Implemented error handling during Sentry initialization to capture exceptions.
• Changed import for ProfilingIntegration to nodeProfilingIntegration.

---

Changes walkthrough 📝

Relevant files

Enhancement

env.schema.ts Add validation for Sentry environment variables                    apps/api/src/common/env/env.schema.ts Added URL validation for SENTRY_DSN. Implemented range validation for SENTRY_TRACES_SAMPLE_RATE and SENTRY_PROFILES_SAMPLE_RATE. Updated validation messages for Sentry environment variables. +56/-6    main.ts Enhance Sentry initialization with logging and error handling apps/api/src/main.ts Changed import for ProfilingIntegration. Added detailed logging for Sentry initialization. Implemented error handling for Sentry initialization. +23/-8

---

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

[codiumai-pr-agent-free[bot]]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Validation Improvement The validation for SENTRY_TRACES_SAMPLE_RATE and SENTRY_PROFILES_SAMPLE_RATE could be simplified by using z.coerce.number() instead of parsing the string manually. Error Handling The error caught during Sentry initialization is logged and captured, but the application continues to run. Consider whether this is the desired behavior or if the application should exit on Sentry initialization failure.

[codiumai-pr-agent-free[bot]]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Best practice	Validate parsed sample rates before using them in configuration ___ **Consider adding a check to ensure that the parsed sample rates are within the valid range (0 to 1) before using them in the Sentry configuration.** [apps/api/src/main.ts [35-48]](https://github.com/keyshade-xyz/keyshade/pull/470/files#diff-32c5294dd7ca131397ef57a87c3e0cf38ea5c2e4ca0061c602e73f7f00514c1aR35-R48) ```diff -const tracesSampleRate = +const validateSampleRate = (rate: number): number => { + return rate >= 0 && rate <= 1 ? rate : 1.0 +} + +const tracesSampleRate = validateSampleRate( parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE) || 1.0 -const profilesSampleRate = +) +const profilesSampleRate = validateSampleRate( parseFloat(process.env.SENTRY_PROFILES_SAMPLE_RATE) || 1.0 +) Sentry.init({ dsn: process.env.SENTRY_DSN, enabled: sentryEnv !== 'test' && sentryEnv !== 'e2e', environment: sentryEnv, tracesSampleRate, profilesSampleRate, integrations: [nodeProfilingIntegration()], debug: sentryEnv.startsWith('dev') }) ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 9 Why: Ensuring that parsed sample rates are within the valid range before using them in configuration is crucial for maintaining the integrity of the Sentry setup, preventing potential misconfigurations.	9
Maintainability	Extract common validation logic into a separate function ___ **Consider extracting the common validation logic for SENTRY_TRACES_SAMPLE_RATE and SENTRY_PROFILES_SAMPLE_RATE into a separate function to reduce code duplication and improve maintainability.** [apps/api/src/common/env/env.schema.ts [53-80]](https://github.com/keyshade-xyz/keyshade/pull/470/files#diff-3ac6831dfb43e9b21b1351465f5eebdf99c9e929c9abacb059cbf16f3d0b8c1dR53-R80) ```diff +const validateSampleRate = (val: string | undefined) => { + if (val === undefined) return true + const num = parseFloat(val) + return !isNaN(num) && num >= 0 && num <= 1 +} + SENTRY_TRACES_SAMPLE_RATE: z .string() .optional() - .refine( - (val) => { - if (val === undefined) return true - const num = parseFloat(val) - return !isNaN(num) && num >= 0 && num <= 1 - }, - { - message: - 'SENTRY_TRACES_SAMPLE_RATE must be a string representing a number between 0 and 1' - } - ), + .refine(validateSampleRate, { + message: 'SENTRY_TRACES_SAMPLE_RATE must be a string representing a number between 0 and 1' + }), SENTRY_PROFILES_SAMPLE_RATE: z .string() .optional() - .refine( - (val) => { - if (val === undefined) return true - const num = parseFloat(val) - return !isNaN(num) && num >= 0 && num <= 1 - }, - { - message: - 'SENTRY_PROFILES_SAMPLE_RATE must be a string representing a number between 0 and 1' - } - ), + .refine(validateSampleRate, { + message: 'SENTRY_PROFILES_SAMPLE_RATE must be a string representing a number between 0 and 1' + }), ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8 Why: Extracting common validation logic into a separate function reduces code duplication and improves maintainability, making the codebase easier to manage and extend in the future.	8
Enhancement	Add a custom error message for URL validation ___ **Consider using a custom error message for the URL validation of SENTRY_DSN. This will provide more specific feedback if an invalid URL is provided.** [apps/api/src/common/env/env.schema.ts [50]](https://github.com/keyshade-xyz/keyshade/pull/470/files#diff-3ac6831dfb43e9b21b1351465f5eebdf99c9e929c9abacb059cbf16f3d0b8c1dR50-R50) ```diff -SENTRY_DSN: z.string().url().optional(), +SENTRY_DSN: z.string().url({ message: "SENTRY_DSN must be a valid URL" }).optional(), ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 7 Why: Adding a custom error message for URL validation enhances user feedback by providing specific guidance when an invalid URL is provided, improving the usability of the validation schema.	7
Error handling	Add error handling for parsing sample rates ___ **Consider using a try-catch block when parsing the sample rates to handle potential parsing errors gracefully.** [apps/api/src/main.ts [35-38]](https://github.com/keyshade-xyz/keyshade/pull/470/files#diff-32c5294dd7ca131397ef57a87c3e0cf38ea5c2e4ca0061c602e73f7f00514c1aR35-R38) ```diff -const tracesSampleRate = - parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE) || 1.0 -const profilesSampleRate = - parseFloat(process.env.SENTRY_PROFILES_SAMPLE_RATE) || 1.0 +let tracesSampleRate = 1.0 +let profilesSampleRate = 1.0 +try { + tracesSampleRate = parseFloat(process.env.SENTRY_TRACES_SAMPLE_RATE) || 1.0 + profilesSampleRate = parseFloat(process.env.SENTRY_PROFILES_SAMPLE_RATE) || 1.0 +} catch (error) { + logger.warn(`Error parsing sample rates: ${error.message}. Using default values.`) +} ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 6 Why: Adding a try-catch block for parsing sample rates introduces error handling, which can prevent unexpected crashes due to parsing errors, although the likelihood of such errors is low given the context.	6

💡 Need additional feedback ? start a PR chat

[YuvalBubnovsky]

PR Code Suggestions ✨

Explore these optional code suggestions: Category Suggestion Score Best practice
Validate parsed sample rates before using them in configuration

9 Maintainability
Extract common validation logic into a separate function

8 Enhancement
Add a custom error message for URL validation

7 Error handling
Add error handling for parsing sample rates

6

💡 Need additional feedback ? start a PR chat

I fixed number 2 & 3 here, the other remarks the bot makes are irrelevant and are handles by us having the input validation inside the env.schema file and having the validation logic in a separate function.

[rajdip-b]

:tada: This PR is included in version 2.6.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: