fix: Disable sentry based on if in local development or not

README.md

@@ -98,14 +98,18 @@ AWS_ACCESS_KEY_ID = env.get("AWS_ACCESS_KEY_ID", "")
 AWS_SECRET_ACCESS_KEY = env.get("AWS_SECRET_ACCESS_KEY", "")
 ```
 
-### Database 
+### Database
 You can either develop using the dev database, or use the local database provided in the docker compose file
 
 Using the local database is detailed below, but both options will require the dev database password, so you will have to ask an RTP for this too
 
 ### Forcing evals/rtp or anything else
 All of the role checking is done in `conditional/utils/user_dict.py`, and you can change the various functions to `return True` for debugging
 
+### Using Sentry
+If you want to opt-into logging errors through Sentry then set the `CONDITIONAL_SENTRY_ENV` environment variable to anything other than `local-development`.
+Setting it to `local-development` or having the environment variable unset disables Sentry in both the frontend and backend (Re-building the container may be required).
+
 
 
 ## Dependencies

conditional/__init__.py

@@ -39,11 +39,12 @@
     )
 
 # Sentry setup
-sentry_sdk.init(
-    dsn=app.config['SENTRY_DSN'],
-    integrations=[FlaskIntegration(), SqlalchemyIntegration()],
-    environment=app.config['SENTRY_ENV'],
-)
+if app.config['SENTRY_ENV'] != "local-development":
+    sentry_sdk.init(
+        dsn=app.config['SENTRY_DSN'],
+        integrations=[FlaskIntegration(), SqlalchemyIntegration()],
+        environment=app.config['SENTRY_ENV'],
+    )
 
 ldap = CSHLDAP(app.config['LDAP_BIND_DN'],
                app.config['LDAP_BIND_PW'],

frontend/javascript/app.js

@@ -1,15 +1,18 @@
 // Install Sentry to send errors to Sentry
 import * as Sentry from '@sentry/browser';
-Sentry.init(
-  {
-    dsn: 'https://[email protected]/133175'
-  }
-);
 
-// Capture unhandled exceptions in promises
-window.addEventListener('unhandledrejection', err => {
-  Sentry.captureException(err.reason);
-});
+if (process.env.SENTRY_ENV !== "local-development") {
+    Sentry.init(
+        {
+            dsn: 'https://[email protected]/133175'
+        }
+    );
+
+    // Capture unhandled exceptions in promises
+    window.addEventListener('unhandledrejection', err => {
+        Sentry.captureException(err.reason);
+    });
+}
 
 // Load the rest of the modules
 import "jquery";

package.json

@@ -44,6 +44,7 @@
     "bootstrap-icons": "^1.13.1",
     "copy-webpack-plugin": "^14.0.0",
     "css-loader": "^7.1.4",
+    "dotenv": "^18.0.5",
     "eslint-config-google": "^0.14.0",
     "expose-loader": "^5.0.1",
     "imports-loader": "^5.0.0",

webpack.config.js

@@ -2,11 +2,14 @@ const webpack = require('webpack');
 const CopyPlugin = require('copy-webpack-plugin')
 const path = require('path');
 const sass = require('sass');
+const dotenv = require('dotenv');
 
 var jsSrc = path.resolve('./frontend');
 var jsDest = path.resolve('./conditional/static');
 var publicPath = 'static/js';
 
+dotenv.config();
+
 var babelQuery = {
   "presets": ["@babel/preset-env"],
   "plugins": []
@@ -25,7 +28,8 @@ var webpackConfig = {
   plugins: [
     new webpack.DefinePlugin({
       'process.env': {
-        'NODE_ENV': JSON.stringify('production')
+        'NODE_ENV': JSON.stringify('production'),
+        'SENTRY_ENV': JSON.stringify(process.env.CONDITIONAL_SENTRY_ENV ?? "local-development")
       }
     }),
     new CopyPlugin({