You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Sentry initialization could fail silently if DSN is missing. Consider adding explicit validation and error handling.
try{Sentry.init({dsn: process.env.SENTRY_DSN,tracesSampleRate: 1.0,environment: 'CLI',integrations: [nodeProfilingIntegration()],beforeSend(event){if(event.exception){Logger.log('A detailed error report has been sent to the Keyshade team.')}returnevent}})returnSentry}catch(error){Logger.error('Failed to initialize error reporting.')Sentry.captureException(error)returnnull}}
Ensure the correct directory path is used when creating parent directories for configuration files
The ensureDirectoryExists function should be called with the directory path, not the file path. Extract the directory path using dirname to ensure the parent directory exists before creating the file.
Why: This is a critical bug fix. Using the file path instead of directory path with ensureDirectoryExists could cause file creation failures, as the parent directory must exist before creating a file.
9
Add proper error handling for network requests to prevent unhandled promise rejections
Add error handling for the fetch request to prevent unhandled promise rejections. Wrap the fetch call in a try-catch block and handle network errors explicitly.
await Sentry.startSpan(
{
name: 'Example Frontend Span',
op: 'test'
},
async () => {
- const res = await fetch('/api/sentry-example-api')- if (!res.ok) {- throw new Error('Sentry Example Frontend Error')+ try {+ const res = await fetch('/api/sentry-example-api')+ if (!res.ok) {+ throw new Error('Sentry Example Frontend Error')+ }+ } catch (error) {+ Sentry.captureException(error)+ throw error
}
}
)
Apply this suggestion
Suggestion importance[1-10]: 8
Why: The suggestion adds important error handling for network requests, capturing and properly handling fetch errors with Sentry. This improves error tracking and prevents unhandled promise rejections in production.
8
Security
Implement safe error object serialization to prevent exposure of sensitive data and handle circular references
Avoid directly stringifying the error object as it may contain sensitive information or circular references. Instead, extract and log only necessary error properties like statusCode, name, and message.
if (this.metricsEnabled && error?.statusCode === 500) {
- Logger.report('Failed to update roles.\n' + JSON.stringify(error))+ Logger.report('Failed to update roles.\n' + JSON.stringify({+ statusCode: error.statusCode,+ message: error.message,+ name: error.name+ }))
}
Apply this suggestion
Suggestion importance[1-10]: 8
Why: This is an important security enhancement that prevents potential exposure of sensitive information and handles JSON serialization issues with circular references in error objects.
8
General
Remove unreachable code that follows a throw statement
The unreachable code after throwing an error should be removed as it will never be executed.
export function GET() {
throw new Error('Sentry Example API Route Error')
- return NextResponse.json({ data: 'Testing Sentry Error...' })
}
Apply this suggestion
Suggestion importance[1-10]: 5
Why: The suggestion removes dead code that can never be executed after the throw statement. While this is a valid improvement for code cleanliness, it's a relatively minor issue since the code would never execute anyway.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Description
CLI:
Fixes #529
Developer's checklist
If changes are made in the code:
Documentation Update
PR Type
Enhancement, Bug fix, Documentation, Other
Description
Integrated Sentry logging and error monitoring across CLI, platform, and API.
Added new commands and improved existing ones in CLI for secrets and variables management.
Enhanced error handling and logging with Sentry integration in CLI and platform.
Updated environment schemas and configurations to support Sentry.
Added example pages, API routes, and utilities for testing Sentry integration.
Updated documentation and example environment files with Sentry configurations.
Refactored and improved application setup, logging, and instrumentation for better error tracking.
Updated dependencies and build configurations to include Sentry-related packages.
Added Sentry release management to CI workflow.
Changes walkthrough 📝
12 files
page.tsx
Add Sentry example page for testing integration.apps/platform/src/app/sentry-example-page/page.tsx
documentation.
startSpanfor error monitoring.main.ts
Refactor Sentry initialization and app setup.apps/api/src/main.ts
variables.
DOMAINandisHttpin application setup.get.secret.ts
Update `get` command for secrets with environment support.apps/cli/src/commands/secret/get.secret.ts
getcommand to include environment slug as an argument.list.secret.ts
Enhance `list` command for secrets with decryption.apps/cli/src/commands/secret/list.secret.ts
listcommand for secrets.get.variable.ts
Add `get` command for variables with environment support.apps/cli/src/commands/variable/get.variable.ts
getcommand for variables under a project andenvironment.
base.command.ts
Add Sentry integration to base command logic.apps/cli/src/commands/base.command.ts
commands.
sentry.ts
Introduce Sentry utility for CLI error reporting.apps/cli/src/util/sentry.ts
global-error.tsx
Add global error handling with Sentry integration.apps/platform/src/app/global-error.tsx
platform.
variable.command.ts
Register `get` command for variables in CLI.apps/cli/src/commands/variable.command.ts
getcommand for variables in the CLI.logger.ts
Enhance logger with Sentry error reporting.apps/cli/src/util/logger.ts
reportmethod to log errors to Sentry.instrumentation.ts
Add Sentry instrumentation for platform.apps/platform/src/instrumentation.ts
route.ts
Add Sentry example API route for testing.apps/platform/src/app/api/sentry-example-api/route.ts
9 files
env.schema.ts
Update environment schema with Sentry and defaults.apps/api/src/common/env/env.schema.ts
API_PORTandDOMAIN.env.ts
Add Sentry environment variables for platform.apps/platform/src/env.ts
sentry.client.config.ts
Add Sentry client configuration for platform.apps/platform/sentry.client.config.ts
sentry.edge.config.ts
Add Sentry edge configuration for platform.apps/platform/sentry.edge.config.ts
sentry.server.config.ts
Add Sentry server configuration for platform.apps/platform/sentry.server.config.ts
index.ts
Add dotenv configuration to CLI entry point.apps/cli/src/index.ts
next.config.js
Integrate Sentry into Next.js configuration.apps/platform/next.config.js
esbuild.config.js
Add esbuild configuration for CLI with Sentry.apps/cli/esbuild.config.js
integration.
release.yml
Add Sentry release management to CI workflow..github/workflows/release.yml
1 files
create.environment.ts
Enhance error reporting for environment creation.apps/cli/src/commands/environment/create.environment.ts
failures.
2 files
.env.example
Update example environment variables with Sentry settings..env.example
configurations.
.env.example
Add example environment file for CLI.apps/cli/.env.example
3 files
package.json
Update CLI package.json with Sentry dependencies.apps/cli/package.json
package.json
Update platform package.json with Sentry dependency.apps/platform/package.json
package-lock.json
Added Sentry dependencies and updated package metadata.apps/cli/package-lock.json
@sentry/esbuild-plugin,@sentry/node, and@sentry/profiling-node.Sentry integration and other functionalities.
devflags from some existing dependencies, indicating they arenow required in production.
engines, and funding information.
2 files
package.json
Update API package.json with namespace.apps/api/package.json
package.json
Update web package.json with namespace.apps/web/package.json
55 files