feat: enable sentry init only when the enable flag is set

Author: kneerose

.github/workflows/build-and-deploy-test-stack.yml

@@ -61,7 +61,7 @@ jobs:
             cd $DEST_DIR/tests/test-infrastructure
             ./build-and-deploy.sh update-images
             yes | docker system prune -f || echo "Ignoring system prune eror"
-          envs: GOVTOOL_TAG, GRAFANA_ADMIN_PASSWORD, GRAFANA_SLACK_RECIPIENT, GRAFANA_SLACK_OAUTH_TOKEN, SENTRY_DSN_BACKEND, GTM_ID, NPMRC_TOKEN, SENTRY_DSN_FRONTEND, PIPELINE_URL, USERSNAP_SPACE_API_KEY, APP_ENV, PDF_API_URL, KUBER_API_KEY, IPFS_GATEWAY, IPFS_PROJECT_ID
+          envs: GOVTOOL_TAG, GRAFANA_ADMIN_PASSWORD, GRAFANA_SLACK_RECIPIENT, GRAFANA_SLACK_OAUTH_TOKEN, SENTRY_DSN_BACKEND, GTM_ID, NPMRC_TOKEN, SENTRY_DSN_FRONTEND, PIPELINE_URL, USERSNAP_SPACE_API_KEY, APP_ENV, PDF_API_URL, KUBER_API_KEY, IPFS_GATEWAY, IPFS_PROJECT_ID, IS_SENTRY_ENABLED
         env:
           GOVTOOL_TAG: ${{ github.sha }}
           GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}

govtool/frontend/.env.example

@@ -9,4 +9,5 @@ VITE_USERSNAP_SPACE_API_KEY=""
 VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED='true'
 VITE_PDF_API_URL=""
 VITE_IPFS_GATEWAY=""
-VITE_IPFS_PROJECT_ID=""
+VITE_IPFS_PROJECT_ID=""
+VITE_IS_SENTRY_ENABLED=false

govtool/frontend/Dockerfile.qovery

@@ -1,6 +1,7 @@
 FROM node:20.18.1-alpine as builder
 
 ARG VITE_APP_ENV='beta'
+ARG VITE_IS_SENTRY_ENABLED='false'
 ARG VITE_BASE_URL
 ARG VITE_METADATA_API_URL
 ARG VITE_GTM_ID

govtool/frontend/src/main.tsx

@@ -24,28 +24,30 @@ const tagManagerArgs = {
 
 TagManager.initialize(tagManagerArgs);
 
-Sentry.init({
-  dsn: import.meta.env.VITE_SENTRY_DSN,
-  environment: import.meta.env.VITE_APP_ENV,
-  release: version,
-  integrations: [
-    Sentry.browserTracingIntegration(),
-    Sentry.replayIntegration(),
-  ],
-  tracesSampleRate: 1.0,
-  replaysSessionSampleRate: 0.1,
-  replaysOnErrorSampleRate: 1.0,
-  beforeSend(event) {
-    window.dataLayer = window.dataLayer || [];
-    window.dataLayer.push({
-      event: "sentryEvent",
-      sentryEventId: event?.event_id || "default_event_id",
-      sentryErrorMessage:
-        event?.exception?.values?.[0]?.value || "Unknown Error",
-    });
-    return event;
-  },
-});
+if (import.meta.env.VITE_IS_SENTRY_ENABLED) {
+  Sentry.init({
+    dsn: import.meta.env.VITE_SENTRY_DSN,
+    environment: import.meta.env.VITE_APP_ENV,
+    release: version,
+    integrations: [
+      Sentry.browserTracingIntegration(),
+      Sentry.replayIntegration(),
+    ],
+    tracesSampleRate: 1.0,
+    replaysSessionSampleRate: 0.1,
+    replaysOnErrorSampleRate: 1.0,
+    beforeSend(event) {
+      window.dataLayer = window.dataLayer || [];
+      window.dataLayer.push({
+        event: "sentryEvent",
+        sentryEventId: event?.event_id || "default_event_id",
+        sentryErrorMessage:
+          event?.exception?.values?.[0]?.value || "Unknown Error",
+      });
+      return event;
+    },
+  });
+}
 
 ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
   <React.StrictMode>

tests/test-infrastructure/.env.example

@@ -9,4 +9,5 @@ APP_ENV=test
 PDF_API_URL= 
 KUBER_API_KEY=
 IPFS_GATEWAY=""
-IPFS_PROJECT_ID=""
+IPFS_PROJECT_ID=""
+IS_SENTRY_ENABLED=false