Merge pull request #289 from ente-io/rename-sentry-variables

Rename sentry variables

configUtil.js

@@ -1,5 +1,5 @@
 const cp = require('child_process');
-const { isSentryEnabled } = require('./sentryConfigUtil');
+const { getIsSentryEnabled } = require('./sentryConfigUtil');
 
 module.exports = {
     COOP_COEP_HEADERS: {
@@ -51,5 +51,5 @@ module.exports = {
             cwd: __dirname,
             encoding: 'utf8',
         }),
-    isSentryEnabled: isSentryEnabled,
+    getIsSentryEnabled: getIsSentryEnabled,
 };

next.config.js

@@ -4,6 +4,7 @@ const withBundleAnalyzer = require('@next/bundle-analyzer')({
 const withWorkbox = require('@ente-io/next-with-workbox');
 
 const { withSentryConfig } = require('@sentry/nextjs');
+const { PHASE_DEVELOPMENT_SERVER } = require('next/constants');
 
 const {
     getGitSha,
@@ -14,42 +15,46 @@ const {
     CSP_DIRECTIVES,
     WORKBOX_CONFIG,
     ALL_ROUTES,
-    isSentryEnabled,
+    getIsSentryEnabled,
 } = require('./configUtil');
 
 const GIT_SHA = getGitSha();
 
-const SENTRY_ENABLED = isSentryEnabled();
+const IS_SENTRY_ENABLED = getIsSentryEnabled();
 
-module.exports = withSentryConfig(
+module.exports = (phase) =>
-    withWorkbox(
+    withSentryConfig(
-        withBundleAnalyzer({
+        withWorkbox(
-            env: {
+            withBundleAnalyzer({
-                SENTRY_RELEASE: GIT_SHA,
+                env: {
-            },
+                    SENTRY_RELEASE: GIT_SHA,
-            workbox: WORKBOX_CONFIG,
+                },
+                workbox: WORKBOX_CONFIG,
 
-            headers() {
+                headers() {
-                return [
+                    return [
-                    {
+                        {
-                        // Apply these headers to all routes in your application....
+                            // Apply these headers to all routes in your application....
-                        source: ALL_ROUTES,
+                            source: ALL_ROUTES,
-                        headers: convertToNextHeaderFormat({
+                            headers: convertToNextHeaderFormat({
-                            ...COOP_COEP_HEADERS,
+                                ...COOP_COEP_HEADERS,
-                            ...WEB_SECURITY_HEADERS,
+                                ...WEB_SECURITY_HEADERS,
-                            ...buildCSPHeader(CSP_DIRECTIVES),
+                                ...buildCSPHeader(CSP_DIRECTIVES),
-                        }),
+                            }),
-                    },
+                        },
-                ];
+                    ];
-            },
+                },
-            // https://dev.to/marcinwosinek/how-to-add-resolve-fallback-to-webpack-5-in-nextjs-10-i6j
+                // https://dev.to/marcinwosinek/how-to-add-resolve-fallback-to-webpack-5-in-nextjs-10-i6j
-            webpack: (config, { isServer }) => {
+                webpack: (config, { isServer }) => {
-                if (!isServer) {
+                    if (!isServer) {
-                    config.resolve.fallback.fs = false;
+                        config.resolve.fallback.fs = false;
-                }
+                    }
-                return config;
+                    return config;
-            },
+                },
-        })
+            })
-    ),
+        ),
-    { release: GIT_SHA, dryRun: !SENTRY_ENABLED }
+        {
-);
+            release: GIT_SHA,
+            dryRun: phase === PHASE_DEVELOPMENT_SERVER || !IS_SENTRY_ENABLED,
+        }
+    );

sentry.client.config.js

@@ -5,18 +5,18 @@ import {
     getSentryDSN,
     getSentryENV,
     getSentryRelease,
-    isSentryEnabled,
+    getIsSentryEnabled,
 } from 'constants/sentry';
 
 const SENTRY_DSN = getSentryDSN();
 const SENTRY_ENV = getSentryENV();
 const SENTRY_RELEASE = getSentryRelease();
-const ENABLED = isSentryEnabled();
+const IS_ENABLED = getIsSentryEnabled();
 
 Sentry.setUser({ id: getUserAnonymizedID() });
 Sentry.init({
     dsn: SENTRY_DSN,
-    enabled: ENABLED,
+    enabled: IS_ENABLED,
     environment: SENTRY_ENV,
     release: SENTRY_RELEASE,
     attachStacktrace: true,

sentry.server.config.js

@@ -3,17 +3,17 @@ import {
     getSentryDSN,
     getSentryENV,
     getSentryRelease,
-    isSentryEnabled,
+    getIsSentryEnabled,
 } from 'constants/sentry';
 
 const SENTRY_DSN = getSentryDSN();
 const SENTRY_ENV = getSentryENV();
 const SENTRY_RELEASE = getSentryRelease();
-const ENABLED = isSentryEnabled();
+const IS_ENABLED = getIsSentryEnabled();
 
 Sentry.init({
     dsn: SENTRY_DSN,
-    enabled: ENABLED,
+    enabled: IS_ENABLED,
     environment: SENTRY_ENV,
     release: SENTRY_RELEASE,
     autoSessionTracking: false,

sentryConfigUtil.js

@@ -1,6 +1,6 @@
-module.exports.isSentryEnabled = () => {
+module.exports.getIsSentryEnabled = () => {
-    if (process.env.SENTRY_ENABLED) {
+    if (process.env.NEXT_PUBLIC_IS_SENTRY_ENABLED) {
-        return process.env.SENTRY_ENABLED === 'yes';
+        return process.env.NEXT_PUBLIC_IS_SENTRY_ENABLED === 'yes';
     } else {
         if (process.env.NEXT_PUBLIC_SENTRY_ENV) {
             return process.env.NEXT_PUBLIC_SENTRY_ENV !== 'development';

src/constants/sentry/index.ts

@@ -7,4 +7,4 @@ export const getSentryENV = () =>
 
 export const getSentryRelease = () => process.env.SENTRY_RELEASE;
 
-export { isSentryEnabled } from '../../../sentryConfigUtil';
+export { getIsSentryEnabled } from '../../../sentryConfigUtil';