Update various files to use environment methods, rename sentry env var

Author: webstackdev

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

@@ -1,4 +1,5 @@
 # Runs build, unit tests, and E2E tests - gates deployment
+# @TODO: Push to a preview branch on Vercel, and run the E2E tests on that preview instead of from a dev server
 name: CI - Build & Test
 
 on:
@@ -19,14 +20,14 @@ jobs:
 
     # Define environment variables once at the job level
     # These will be available to ALL steps in this job
-    # @TODO: These are real keys set on GitHub. But the production build only occurs on Vercel, and it's the only place that needs real keys. Once we set up a test framework using Docker containers for Suprabase, Upstash, etc., we should replace these keys with test keys.
+    # @TODO: Same issue with type-check.yml. These are real keys set on GitHub. But the production build only occurs on Vercel, and it's the only place that needs real keys. Once we set up a test framework using Docker containers for Suprabase, Upstash, etc., we should replace these keys with test keys.
     env:
       CONVERTKIT_API_KEY: ${{ secrets.CONVERTKIT_API_KEY }}
       CONVERTKIT_FORM_ID: ${{ secrets.CONVERTKIT_FORM_ID }}
       CRON_SECRET: ${{ secrets.CRON_SECRET }}
       RESEND_API_KEY: ${{ secrets.RESEND_API_KEY }}
       SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
-      PUBLIC_SENTRY_DSN: ${{ secrets.PUBLIC_SENTRY_DSN }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
       PUBLIC_SUPABASE_URL: ${{ secrets.PUBLIC_SUPABASE_URL }}
       PUBLIC_SUPABASE_KEY: ${{ secrets.PUBLIC_SUPABASE_KEY }}
       SUPABASE_SERVICE_ROLE_KEY: ${{ secrets.SUPABASE_SERVICE_ROLE_KEY }}

.github/workflows/type-check.yml

@@ -13,12 +13,13 @@ jobs:
 
     # Define environment variables once at the job level
     # These will be available to ALL steps in this job
+    # @TODO: Same issue with build-and-test.yml. These are real keys set on GitHub. But the production build only occurs on Vercel, and it's the only place that needs real keys. Once we set up a test framework using Docker containers for Suprabase, Upstash, etc., we should replace these keys with test keys.
     env:
       CONVERTKIT_API_KEY: ${{ secrets.CONVERTKIT_API_KEY }}
       CONVERTKIT_FORM_ID: ${{ secrets.CONVERTKIT_FORM_ID }}
       RESEND_API_KEY: ${{ secrets.RESEND_API_KEY }}
       SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
-      PUBLIC_SENTRY_DSN: ${{ secrets.PUBLIC_SENTRY_DSN }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
       WEBMENTION_IO_TOKEN: ${{ secrets.WEBMENTION_IO_TOKEN }}
 
     steps:

sentry.server.config.js

@@ -1,5 +1,5 @@
 import * as Sentry from "@sentry/astro"
-import { PUBLIC_SENTRY_DSN } from "astro:env/client"
+import { SENTRY_DSN } from "astro:env/client"
 
 /**
  * Server-side Sentry initialization
@@ -8,16 +8,16 @@ import { PUBLIC_SENTRY_DSN } from "astro:env/client"
  * It tracks server-side errors, API errors, and build-time issues.
  *
  * Note: SENTRY_AUTH_TOKEN is only needed for uploading source maps during build.
- * The server SDK only needs PUBLIC_SENTRY_DSN to report errors.
+ * The server SDK only needs SENTRY_DSN to report errors.
  */
 
 const isProd = import.meta.env.PROD
 const isDev = import.meta.env.DEV
 
 // Initialize Sentry in production if DSN is available
-if (isProd && PUBLIC_SENTRY_DSN) {
+if (isProd) {
   Sentry.init({
-    dsn: PUBLIC_SENTRY_DSN,
+    dsn: SENTRY_DSN,
 
     /** Release name to track regressions between releases */
     release: import.meta.env['npm_package_name'] + '@' + import.meta.env['npm_package_version'],

src/components/Avatar/__tests__/server.spec.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest'
-
+import { isDev } from '@components/scripts/utils'
 /**
  * Comprehensive unit tests for AvatarManager
  *
@@ -59,7 +59,7 @@ describe('AvatarManager', () => {
 
       // Constructor should only run once (if in development mode)
       // In production, console.log won't be called
-      if (import.meta.env.DEV) {
+      if (isDev()) {
         expect(consoleLogSpy).toHaveBeenCalledTimes(1)
       }
     })

src/components/Avatar/server.ts

@@ -15,6 +15,7 @@
  */
 
 import type { ImageMetadata } from 'astro'
+import { isDev } from '@components/scripts/utils'
 
 type AvatarMap = Record<string, ImageMetadata>
 
@@ -60,15 +61,15 @@ class AvatarManagerClass {
       if (filename && imageData) {
         // Deep freeze the image metadata to prevent modifications
         map[filename] = Object.freeze({ ...imageData })
-      } else if (import.meta.env.DEV) {
+      } else if (isDev()) {
         console.warn(`[AvatarManager] Failed to process avatar at path: ${path}`)
       }
     }
 
     // Freeze the map to prevent modifications
     this.avatarMap = Object.freeze(map)
 
-    if (import.meta.env.DEV) {
+    if (isDev()) {
       console.log(`[AvatarManager] Initialized with ${Object.keys(this.avatarMap).length} avatars`)
     }
   }

src/components/scripts/bootstrap/index.ts

@@ -10,15 +10,15 @@ import {
   initConsentSideEffects,
 } from '@components/scripts/store'
 import { SentryBootstrap } from '@components/scripts/sentry/client'
-import { PUBLIC_SENTRY_DSN } from 'astro:env/client'
+import { isProd } from "@components.scripts/utils"
 
 export class AppBootstrap {
   static init(): void {
     addScriptBreadcrumb({ scriptName: 'AppBootstrap', operation: 'init' })
 
     try {
       /* Be careful adding script here. It runs before any script tags in components. */
-      if (import.meta.env.PROD && PUBLIC_SENTRY_DSN) {
+      if (isProd()) {
         SentryBootstrap.init()
       } else {
         console.info('🔧 Sentry disabled in development mode')

src/components/scripts/errors/handler.ts

@@ -1,5 +1,6 @@
 import { captureException } from '@sentry/browser'
 import { ClientScriptError } from './ClientScriptError'
+import { isProd } from '@components/scripts/utils'
 
 export interface ScriptErrorContext {
   scriptName: string
@@ -31,7 +32,7 @@ export function handleScriptError(
 ): ClientScriptError {
   // Transform to ClientScriptError (normalizes message internally)
   const clientError = new ClientScriptError(error)
-  if (import.meta.env.PROD) {
+  if (isProd()) {
     captureException(clientError, {
       tags: {
         scriptName: context.scriptName,

src/components/scripts/sentry/client.ts

@@ -10,7 +10,7 @@ import {
   makeFetchTransport,
   linkedErrorsIntegration,
 } from '@sentry/browser'
-import { PUBLIC_SENTRY_DSN } from 'astro:env/client'
+import { SENTRY_DSN } from 'astro:env/client'
 import { $consent } from '@components/scripts/store/consent'
 
 /**
@@ -31,18 +31,12 @@ import { $consent } from '@components/scripts/store/consent'
 
 export class SentryBootstrap {
   static init(): void {
-    // Skip initialization if DSN is not configured
-    if (!PUBLIC_SENTRY_DSN) {
-      console.warn('⚠️ Sentry DSN not configured, skipping initialization')
-      return
-    }
-
     // Check analytics consent for PII handling
     const consentState = $consent.get()
     const hasAnalyticsConsent = consentState.analytics
 
     const client = new BrowserClient({
-      dsn: PUBLIC_SENTRY_DSN,
+      dsn: SENTRY_DSN,
 
       integrations: [
         // Core integrations

src/lib/config/environmentalVariableValidation.ts

@@ -116,7 +116,7 @@ export const environmentalVariablesConfig: AstroUserConfig['env'] = {
       context: 'server',
       optional: false, // Only required for uploading source maps during build
     }),
-    PUBLIC_SENTRY_DSN: envField.string({
+    SENTRY_DSN: envField.string({
       access: 'public',
       context: 'client',
       optional: false, // Optional - Sentry only enabled if provided