search

r-sugi / nextjs-tdd-template

https://nextjs-tdd-templatestorybook-rsugis-projects.vercel.app
0 stars 0 forks source link

sentry 開発時にエラーログを送信しないようにする #174

Closed r-sugi closed 2 months ago

r-sugi commented 2 months ago

User description

173

PR Type

enhancement, configuration changes

Description

Changes walkthrough 📝

Relevant files
Enhancement
sentry.client.config.ts
Conditional Sentry initialization for client-side               
sentry.client.config.ts
  • Sentry initialization is now conditional on production environment.
  • DSN is retrieved from environment variables.
    		•  +21/-19 
    sentry.edge.config.ts
    Conditional Sentry initialization for edge features           
    sentry.edge.config.ts
  • Sentry initialization is now conditional on production environment.
  • DSN is retrieved from environment variables.
    		•  +9/-7     
    sentry.server.config.ts
    Conditional Sentry initialization for server-side               
    sentry.server.config.ts
  • Sentry initialization is now conditional on production environment.
  • DSN is retrieved from environment variables.
    		•  +11/-10 
    Configuration changes
    .env.sample
    Add Sentry DSN to environment sample file                               
    .env.sample - Added sample environment variable for Sentry DSN.
    		+3/-0     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    vercel[bot] commented 2 months ago

    The latest updates on your projects. Learn more about Vercel for Git ↗︎

    Name Status Preview Comments Updated (UTC)
    nextjs-tdd-template_storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 28, 2024 5:04pm
    github-actions[bot] commented 2 months ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Configuration Validation
    環境変数 `NEXT_PUBLIC_SENTRY_DSN` が未設定の場合、Sentryの初期化でエラーが発生する可能性があります。適切なエラーハンドリングまたはデフォルト値の設定が推奨されます。 Configuration Validation
    環境変数 `NEXT_PUBLIC_SENTRY_DSN` が未設定の場合、Sentryの初期化でエラーが発生する可能性があります。適切なエラーハンドリングまたはデフォルト値の設定が推奨されます。 Configuration Validation
    環境変数 `NEXT_PUBLIC_SENTRY_DSN` が未設定の場合、Sentryの初期化でエラーが発生する可能性があります。適切なエラーハンドリングまたはデフォルト値の設定が推奨されます。
    github-actions[bot] commented 2 months ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    開発環境と本番環境で replaysSessionSampleRate の値を区別する。 ___ **replaysSessionSampleRate
    の値が開発環境と本番環境で異なることを示唆していますが、現在のコードでは本番環境でのみ設定されています。開発環境でのサンプルレートも設定することを検討してください。** [sentry.client.config.ts [21]](https://github.com/r-sugi/nextjs-tdd-template/pull/174/files#diff-668b09e99b6037100b7526171c5b18292b5b22be0cf08b2a9dd55fbd64005dbaR21-R21) ```diff -replaysSessionSampleRate: 0.1, +replaysSessionSampleRate: process.env.NODE_ENV === "development" ? 1.0 : 0.1, ```
    Suggestion importance[1-10]: 8 Why: This suggestion improves the configuration by differentiating the `replaysSessionSampleRate` between development and production environments, which can be beneficial for testing purposes.
    		8
    開発環境でのデバッグオプションを有効にする。 ___ **debug オプションが false に設定されていますが、開発時にはデバッグ情報が役立つ可能性があります。環境変数を使用して、開発環境ではこのオプションを true
    に設定することを検討してください。** [sentry.client.config.ts [15]](https://github.com/r-sugi/nextjs-tdd-template/pull/174/files#diff-668b09e99b6037100b7526171c5b18292b5b22be0cf08b2a9dd55fbd64005dbaR15-R15) ```diff -debug: false, +debug: process.env.NODE_ENV === "development", ```
    Suggestion importance[1-10]: 8 Why: Enabling the debug option in the development environment can provide useful information during setup, improving the development process.
    		8
    開発環境で Sentry を有効にする。 ___ **Sentry.init の設定が本番環境に限定されていますが、開発環境でのエラー追跡も有用です。開発環境で Sentry
    を有効にするか、少なくとも開発環境での設定を追加することを検討してください。** [sentry.edge.config.ts [8]](https://github.com/r-sugi/nextjs-tdd-template/pull/174/files#diff-0579713d2867dd7b0b73196db50bf4197fd89375775158de6670415dff599032R8-R8) ```diff -if (process.env.NODE_ENV === "production") { +if (process.env.NODE_ENV !== "test") { ```
    Suggestion importance[1-10]: 7 Why: Allowing Sentry to be enabled in the development environment can help catch errors early, although it might not be necessary for all development workflows.
    		7
    開発環境で spotlight を有効にする。 ___ **`spotlight` オプションがコメントアウトされていますが、開発環境でのみ有効にすることを検討してください。これにより、開発中の問題解決が容易になります。** [sentry.server.config.ts [18]](https://github.com/r-sugi/nextjs-tdd-template/pull/174/files#diff-1ab87e7d17ff99375cf43fd08d1fe605cff6b415d719ba8cb725ebd06f181cecR18-R18) ```diff -// spotlight: process.env.NODE_ENV === 'development', +spotlight: process.env.NODE_ENV === 'development', ```
    Suggestion importance[1-10]: 7 Why: Enabling the `spotlight` option in the development environment can aid in problem-solving during development, though it is not crucial for all projects.
    		7