fix(Platform) consolidate to one env variable for Sentry DSN (#15010)

* Remove `SENTRY_DSN` env variable
* Fix errors for `yarn lint`
* Update docs for framework convensions

Author: sergical

.env.example

@@ -5,3 +5,4 @@
 
 NEXT_PUBLIC_ALGOLIA_APP_ID=
 NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=
+NEXT_PUBLIC_SENTRY_DSN=

.gitignore

@@ -50,9 +50,10 @@ typings/
 # Output of 'npm pack'
 *.tgz
 
-# dotenv environment variables file
+# dotenv environment variables files
 .env
-.env.development
+.env.*
+!.env.example
 
 # gatsby files
 .cache/

next.config.ts

@@ -1,8 +1,8 @@
 import {codecovNextJSWebpackPlugin} from '@codecov/nextjs-webpack-plugin';
 import {withSentryConfig} from '@sentry/nextjs';
 
-import {redirects} from './redirects.js';
 import {REMOTE_IMAGE_PATTERNS} from './src/config/images';
+import {redirects} from './redirects.js';
 
 const outputFileTracingExcludes = process.env.NEXT_PUBLIC_DEVELOPER_DOCS
   ? {
@@ -40,12 +40,9 @@ const outputFileTracingExcludes = process.env.NEXT_PUBLIC_DEVELOPER_DOCS
       ],
     };
 
-if (
-  process.env.NODE_ENV !== 'development' &&
-  (!process.env.NEXT_PUBLIC_SENTRY_DSN || !process.env.SENTRY_DSN)
-) {
+if (process.env.NODE_ENV !== 'development' && !process.env.NEXT_PUBLIC_SENTRY_DSN) {
   throw new Error(
-    'Missing required environment variables: NEXT_PUBLIC_SENTRY_DSN and SENTRY_DSN must be set in production'
+    'Missing required environment variable: NEXT_PUBLIC_SENTRY_DSN must be set in production'
   );
 }
 

platform-includes/getting-started-complete/javascript.nuxt.mdx

@@ -110,7 +110,7 @@ export default defineNuxtConfig({
   runtimeConfig: {
     public: {
       sentry: {
-        dsn: process.env.SENTRY_DSN_PUBLIC, // Use a public environment variable for the DSN
+        dsn: process.env.NUXT_PUBLIC_SENTRY_DSN, // Use a public environment variable for the DSN
       },
     },
   },

src/hotReloadWatcher.mjs

@@ -1,4 +1,5 @@
 import path from 'path';
+
 import {watch} from 'node:fs/promises';
 import {WebSocketServer} from 'ws';
 
@@ -9,7 +10,7 @@ export const throttle = (fn, delay) => {
   return (...args) => {
     const now = Date.now();
     if (now - last < delay) {
-      return;
+      return undefined;
     }
     last = now;
     return fn(...args);

src/instrumentation.ts

@@ -3,7 +3,7 @@ import * as Sentry from '@sentry/nextjs';
 export function register() {
   if (process.env.NEXT_RUNTIME === 'nodejs') {
     Sentry.init({
-      dsn: process.env.SENTRY_DSN,
+      dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
       tracesSampleRate: 1,
       enableLogs: true,
       debug: false,
@@ -15,7 +15,7 @@ export function register() {
 
   if (process.env.NEXT_RUNTIME === 'edge') {
     Sentry.init({
-      dsn: process.env.SENTRY_DSN,
+      dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
       tracesSampleRate: 1,
       enableLogs: true,
       debug: false,