fix: update deployment files and sentry config

ReidyT · ReidyT · commit 6c360e5e649d · 2024-01-25T15:00:11.000+01:00
diff --git a/.github/workflows/deploy-dev.yml b/.github/workflows/deploy-dev.yml
@@ -25,9 +25,11 @@ jobs:
       - name: Yarn build
         # Set environment variables required to perform the build. These are only available to this step
         env:
-          VITE_API_HOST: ${{ secrets.REACT_APP_API_HOST_DEV }}
-          VITE_GRAASP_APP_KEY: ${{ secrets.APP_KEY }}
+          VITE_API_HOST: ${{ vars.VITE_API_HOST }}
+          VITE_GRAASP_APP_KEY: ${{ secrets.VITE_GRAASP_APP_KEY }}
+          VITE_SENTRY_ENV: development
           VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+          VITE_VERSION: ${{ github.sha }}
         run: yarn build
         shell: bash
 
diff --git a/.github/workflows/deploy-prod.yml b/.github/workflows/deploy-prod.yml
@@ -24,9 +24,11 @@ jobs:
       - name: Yarn build
         # Set environment variables required to perform the build. These are only available to this step
         env:
-          VITE_API_HOST: ${{ secrets.REACT_APP_API_HOST_PROD }}
-          VITE_GRAASP_APP_KEY: ${{ secrets.APP_KEY }}
+          VITE_API_HOST: ${{ vars.VITE_API_HOST }}
+          VITE_GRAASP_APP_KEY: ${{ secrets.VITE_GRAASP_APP_KEY }}
+          VITE_SENTRY_ENV: production
           VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+          VITE_VERSION: ${{ github.event.client_payload.tag }}
         run: yarn build
         shell: bash
 
diff --git a/.github/workflows/deploy-stage.yml b/.github/workflows/deploy-stage.yml
@@ -24,9 +24,11 @@ jobs:
       - name: Yarn build
         # Set environment variables required to perform the build. These are only available to this step
         env:
-          VITE_API_HOST: ${{ secrets.REACT_APP_API_HOST_STAGE }}
-          VITE_GRAASP_APP_KEY: ${{ secrets.APP_KEY }}
+          VITE_API_HOST: ${{ vars.VITE_API_HOST }}
+          VITE_GRAASP_APP_KEY: ${{ secrets.VITE_GRAASP_APP_KEY }}
+          VITE_SENTRY_ENV: staging
           VITE_SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+          VITE_VERSION: ${{ github.event.client_payload.tag }}
         run: yarn build
         shell: bash
 
diff --git a/README.md b/README.md
@@ -6,7 +6,6 @@
   PORT=3005
   VITE_GRAASP_APP_KEY=<app KEY>
   VITE_ENABLE_MOCK_API=true
-  VITE_GRAASP_DOMAIN=localhost
   VITE_API_HOST=<request address for the backend>
 ```
 
diff --git a/docs/Setup_Intructions.md b/docs/Setup_Intructions.md
@@ -360,7 +360,6 @@ jobs:
         uses: cypress-io/github-action@v2
         env:
           VITE_API_HOST: http://localhost:3636
-          VITE_GRAASP_DOMAIN: localhost
           VITE_GRAASP_APP_KEY: id-1234567890
           VITE_ENABLE_MOCK_API: true
           NODE_ENV: test
diff --git a/index.html b/index.html
@@ -10,7 +10,7 @@
       name="Text Analysis"
       content="A Graasp App created using a template."
     />
-    <meta name="version-info" content="%APP_VERSION%" />
+    <meta name="version-info" content="%VITE_VERSION%" />
     <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
     <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
     <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
@@ -48,6 +48,6 @@
       To begin the development, run `npm start` or `yarn start`.
       To create a production bundle, use `npm run build` or `yarn build`.
     -->
-    <script type="module" src="./src/index.tsx"></script>
+    <script type="module" src="src/index.tsx"></script>
   </body>
 </html>
diff --git a/src/config/env.ts b/src/config/env.ts
@@ -1,7 +1,7 @@
 export const GRAASP_APP_KEY = import.meta.env.VITE_GRAASP_APP_KEY;
-export const APP_VERSION = import.meta.env.VITE_VERSION;
-export const GOOGLE_ANALYTICS_ID = import.meta.env.VITE_GOOGLE_ANALYTICS_ID;
-export const ENABLE_MOCK_API =
-  import.meta.env.VITE_ENABLE_MOCK_API === 'true' || false;
+export const APP_VERSION = import.meta.env.VITE_VERSION || 'latest';
+export const ENABLE_MOCK_API = import.meta.env.VITE_ENABLE_MOCK_API === 'true';
 export const GRAASP_API_HOST =
   import.meta.env.VITE_API_HOST || 'http://localhost:3000';
+export const SENTRY_DSN = import.meta.env.VITE_SENTRY_DSN;
+export const SENTRY_ENV = import.meta.env.VITE_SENTRY_ENV;
diff --git a/src/config/sentry.ts b/src/config/sentry.ts
@@ -1,31 +1,37 @@
+import { APP_VERSION, SENTRY_DSN, SENTRY_ENV } from './env';
+
 type SentryConfigType = {
   dsn: string;
   environment: string;
   tracesSampleRate: number;
   release: string;
+  replaysSessionSampleRate: number;
+  replaysOnErrorSampleRate: number;
 };
 
 export const generateSentryConfig = (): SentryConfigType => {
-  let SENTRY_ENVIRONMENT = 'development';
-  let SENTRY_TRACE_SAMPLE_RATE = 1.0;
-  switch (import.meta.env.MODE) {
-    case 'production':
-      SENTRY_ENVIRONMENT = 'production';
-      SENTRY_TRACE_SAMPLE_RATE = 0.1;
-      break;
-    case 'test':
-      SENTRY_TRACE_SAMPLE_RATE = 0.0;
-      break;
-    case 'development':
-      SENTRY_TRACE_SAMPLE_RATE = 0.0;
-      break;
-    default:
-  }
+  // This sets the sample rate to be 10%. You may want this to be 100% while
+  // in development and sample at a lower rate in production
+  const DEV_TRACE_SAMPLE_RATE = 1.0;
+  const DEV_REPLAY_SAMPLE_RATE = 0.1;
+  const PROD_TRACE_SAMPLE_RATE = 0.1;
+  const PROD_REPLAY_SAMPLE_RATE = 0.1;
 
   return {
-    dsn: (!window.Cypress && import.meta.env.SENTRY_DSN) || '',
-    environment: SENTRY_ENVIRONMENT,
-    tracesSampleRate: SENTRY_TRACE_SAMPLE_RATE,
-    release: import.meta.env.APP_VERSION || '',
+    // dsn is set only when not running inside cypress
+    dsn: (!window.Cypress && SENTRY_DSN) || '',
+    environment: SENTRY_ENV,
+    tracesSampleRate: import.meta.env.PROD
+      ? PROD_TRACE_SAMPLE_RATE
+      : DEV_TRACE_SAMPLE_RATE,
+    // release is set only when building for production
+    release: APP_VERSION,
+
+    replaysSessionSampleRate: import.meta.env.PROD
+      ? PROD_REPLAY_SAMPLE_RATE
+      : DEV_REPLAY_SAMPLE_RATE,
+    // If the entire session is not sampled, use the below sample rate to sample
+    // sessions when an error occurs.
+    replaysOnErrorSampleRate: 1.0,
   };
 };
diff --git a/src/env.d.ts b/src/env.d.ts
@@ -4,7 +4,6 @@ interface ImportMetaEnv {
   readonly VITE_PORT: number;
   readonly VITE_VERSION: string;
   readonly VITE_GRAASP_APP_KEY: string;
-  readonly VITE_GOOGLE_ANALYTICS_ID?: string;
   readonly VITE_ENABLE_MOCK_API: string;
   readonly VITE_API_HOST?: string;
 }
diff --git a/vite.config.ts b/vite.config.ts
@@ -12,7 +12,7 @@ const config = ({ mode }: { mode: string }): UserConfigExport => {
   process.env = { ...process.env, ...loadEnv(mode, process.cwd()) };
 
   return defineConfig({
-    base: '/',
+    base: '',
     server: {
       port: parseInt(process.env.VITE_PORT || '3001', 10),
       // only auto open the app when in dev mode

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ interface ImportMetaEnv {`
`4`	`4`	`readonly VITE_PORT: number;`
`5`	`5`	`readonly VITE_VERSION: string;`
`6`	`6`	`readonly VITE_GRAASP_APP_KEY: string;`
`7`		`- readonly VITE_GOOGLE_ANALYTICS_ID?: string;`
`8`	`7`	`readonly VITE_ENABLE_MOCK_API: string;`
`9`	`8`	`readonly VITE_API_HOST?: string;`
`10`	`9`	`}`