Tweaks to environment checks, isDev() failing on GH Action run

Author: webstackdev

src/actions/utils/errors/actionsFunctionHandler.ts

@@ -1,7 +1,7 @@
 import { ActionError, type ActionErrorCode } from 'astro:actions'
 import { captureException, withScope } from '@sentry/astro'
 import { ensureActionSentry } from '@actions/utils/sentry'
-import { isDev, isProd, isTest, isUnitTest } from '@actions/utils/environment/environmentActions'
+import { isDev, isProd, isUnitTest } from '@actions/utils/environment/environmentActions'
 import { ActionsFunctionError, type ActionsFunctionErrorParams } from './ActionsFunctionError'
 
 ensureActionSentry()
@@ -136,13 +136,9 @@ export function formatActionsErrorLogEntry(
 }
 
 /**
- * Writes the formatted actions error JSON to stderr. No-ops during tests to keep output clean.
+ * Writes the formatted actions error JSON to stderr.
  */
 function logActionsError(error: ActionsFunctionError, context: ActionsFunctionContext): void {
-  if (isTest() || isUnitTest()) {
-    return
-  }
-
   const entry = formatActionsErrorLogEntry(error, context)
   console.error(JSON.stringify(entry))
 }

src/actions/utils/sentry/index.ts

@@ -2,7 +2,6 @@ import { init as sentryInit } from '@sentry/astro'
 import {
   getPackageRelease,
   getSentryDsn,
-  isDev,
   isProd,
 } from '@actions/utils/environment/environmentActions'
 
@@ -26,9 +25,7 @@ export function ensureActionSentry(): void {
     attachStacktrace: true,
     maxBreadcrumbs: 100,
     beforeSend(event) {
-      if (isDev()) {
-        return null
-      }
+      // any logic to modify the event before sending to Sentry
       return event
     },
   })

src/components/Analytics/index.astro

@@ -1,10 +1,8 @@
 ---
 import VercelAnalytics from '@vercel/analytics/astro'
-import { isProd } from '@components/scripts/utils/environmentClient'
+import { isDev, isProd } from '@components/scripts/utils/environmentClient'
 
-const prod = isProd()
-const mode = prod ? 'production' : 'development'
-const debug = !prod
+const mode = isProd() ? 'production' : 'development'
 ---
 
 <script>
@@ -16,4 +14,4 @@ const debug = !prod
     return event
   }
 </script>
-<VercelAnalytics debug={debug} mode={mode} />
+<VercelAnalytics debug={isDev()} mode={mode} />

src/components/Pwa/ServiceWorker/client/index.ts

@@ -35,10 +35,9 @@ export const registerServiceWorker = () => {
     return
   }
 
-  const devMode = isDev()
-  const allowDevServiceWorker = devMode && isE2eTest()
+  const allowDevServiceWorker = isDev() && isE2eTest()
 
-  if (devMode && !allowDevServiceWorker) {
+  if (isDev() && !allowDevServiceWorker) {
     void navigator.serviceWorker.getRegistrations().then(registrations => {
       registrations.forEach(registration => {
         console.info('[pwa] unregistering dev service worker', { scope: registration.scope })

src/components/scripts/utils/__tests__/environmentClient.spec.ts

@@ -15,15 +15,15 @@ describe('Environment detection utilities', () => {
     expect(isE2eTest()).toBe(false)
   })
 
-  it('isTest should return true when ran in unit test', () => {
+  it('isTest() should return true when running in Vitest', () => {
     expect(isTest()).toBe(true)
   })
 
-  it('isDev should return true when ran in unit test', () => {
+  it('isDev() should return true when running in Vitest', () => {
     expect(isDev()).toBe(true)
   })
 
-  it('isProd should return false when ran in unit test', () => {
+  it('isProd() should return false when running in Vitest', () => {
     expect(isProd()).toBe(false)
   })
 })

src/components/scripts/utils/environmentClient.ts

@@ -48,11 +48,11 @@ export const isTest = () => {
  */
 
 export const isDev = () => {
-  return import.meta.env.MODE === 'development'
+  return import.meta.env.DEV
 }
 
 export const isProd = () => {
-  return import.meta.env.MODE === 'production'
+  return import.meta.env.PROD
 }
 
 /**

src/lib/config/__tests__/environmentServer.spec.ts

@@ -14,15 +14,15 @@ describe('Build-time environment handling utilities', () => {
     expect(isE2eTest()).toBeFalsy()
   })
 
-  it('should report isTest is true when running in Vitest', () => {
+  it('isTest() should return true when running in Vitest', () => {
     expect(isTest()).toBeTruthy()
   })
 
-  it('should report running in development environment when running in Vitest', () => {
+  it('isDev() should return true when running in Vitest', () => {
     expect(isDev()).toBeTruthy()
   })
 
-  it('should report not running in production environment when running in Vitest', () => {
+  it('isProd() should return false when running in Vitest', () => {
     expect(isProd()).toBeFalsy()
   })
 })

src/lib/config/environmentServer.ts

@@ -31,7 +31,7 @@ export const isCI = () => {
 }
 
 export const isDev = () => {
-  return !isVercel() && !isGitHub()
+  return !isVercel() && !isGitHub() && process.env['NODE_ENV'] !== 'production'
 }
 
 export const isProd = () => {

src/pages/api/_utils/errors/apiFunctionHandler.ts

@@ -1,7 +1,7 @@
 import { createHash } from 'node:crypto'
 import { captureException, withScope } from '@sentry/astro'
 import { ensureApiSentry } from '@pages/api/_utils/sentry'
-import { isDev, isProd, isTest } from '@pages/api/_utils/environment'
+import { isDev, isProd } from '@pages/api/_utils/environment'
 import { ApiFunctionError, type ApiFunctionErrorParams } from './ApiFunctionError'
 
 ensureApiSentry()
@@ -108,7 +108,7 @@ export function handleApiFunctionError(
     requestMeta: sanitizedMetadata,
   })
 
-  if (isProd() && !isTest()) {
+  if (isProd()) {
     withScope(scope => {
       scope.setTags({
         route: context.route,
@@ -228,10 +228,6 @@ type LogMetadata = {
 }
 
 function logApiError(error: ApiFunctionError, metadata: LogMetadata) {
-  if (isTest()) {
-    return
-  }
-
   const entry = formatApiErrorLogEntry(error, metadata)
   console.error(JSON.stringify(entry))
 }