chore: support IS_STAGING_OR_DEBUG in web based runtimes (#7981)

* nadro/adhoc/staging-debug-for-web

* chore: updating IS_STAGING_OR_DEBUG to support web browser runtimes, added unit test

* fix: typo

* fix: renaming from main/development to dev

* Update src/routes/utils.test.ts

Co-authored-by: Jace Browning <[email protected]>

* Update src/routes/utils.test.ts

Co-authored-by: Jace Browning <[email protected]>

---------

Co-authored-by: Jace Browning <[email protected]>

Author: nadr0

src/routes/utils.test.ts

@@ -1,4 +1,18 @@
-import { getRefFromVersion } from '@src/routes/utils'
+import { getAppVersion, getRefFromVersion } from '@src/routes/utils'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+beforeEach(() => {
+  const mockElectron = {
+    packageJson: {
+      version: 'mocked-version',
+    },
+  }
+  vi.stubGlobal('window', { electron: mockElectron })
+})
+
+afterEach(() => {
+  vi.unstubAllGlobals()
+})
 
 describe('Routes utility functions', () => {
   describe('getRefFromVersion', () => {
@@ -12,4 +26,70 @@ describe('Routes utility functions', () => {
       expect(getRefFromVersion('main')).toBeUndefined()
     })
   })
+
+  describe('getAppVersion', () => {
+    it('should return 0.0.0 for web testing', () => {
+      const expected = '0.0.0'
+      const actual = getAppVersion({
+        isTestEnvironment: true,
+        NODE_ENV: 'development',
+        isDesktop: false,
+      })
+      expect(actual).toBe(expected)
+    })
+    it('should return 0.0.0 for desktop testing', () => {
+      const expected = '0.0.0'
+      const actual = getAppVersion({
+        isTestEnvironment: true,
+        NODE_ENV: 'development',
+        isDesktop: true,
+      })
+      expect(actual).toBe(expected)
+    })
+    it('should return another mocked packageJson version', () => {
+      const expected = 'mocked-version'
+      const actual = getAppVersion({
+        isTestEnvironment: false,
+        NODE_ENV: 'development',
+        isDesktop: true,
+      })
+      expect(actual).toBe(expected)
+    })
+    it('should return another mocked packageJson version', () => {
+      const expected = 'mocked-version'
+      const actual = getAppVersion({
+        isTestEnvironment: true,
+        NODE_ENV: 'not-development',
+        isDesktop: true,
+      })
+      expect(actual).toBe(expected)
+    })
+    it('should return dev', () => {
+      const expected = 'dev'
+      const actual = getAppVersion({
+        isTestEnvironment: false,
+        NODE_ENV: 'development',
+        isDesktop: false,
+      })
+      expect(actual).toBe(expected)
+    })
+    it('should return main', () => {
+      const expected = 'main'
+      const actual = getAppVersion({
+        isTestEnvironment: false,
+        NODE_ENV: 'not-development',
+        isDesktop: false,
+      })
+      expect(actual).toBe(expected)
+    })
+    it('should return main because NODE_ENV is production', () => {
+      const expected = 'main'
+      const actual = getAppVersion({
+        isTestEnvironment: false,
+        NODE_ENV: 'production',
+        isDesktop: false,
+      })
+      expect(actual).toBe(expected)
+    })
+  })
 })

src/routes/utils.ts

@@ -9,21 +9,46 @@ import { withSiteBaseURL } from '@src/lib/withBaseURL'
 
 const isTestEnv = window?.localStorage.getItem(IS_PLAYWRIGHT_KEY) === 'true'
 
-export const APP_VERSION =
-  isTestEnv && env().NODE_ENV === 'development'
-    ? '0.0.0'
-    : isDesktop()
-      ? // @ts-ignore
-        window.electron.packageJson.version
-      : 'main'
+export function getAppVersion({
+  isTestEnvironment,
+  NODE_ENV,
+  isDesktop,
+}: {
+  isTestEnvironment: boolean
+  NODE_ENV: string | undefined
+  isDesktop: boolean
+}) {
+  if (isTestEnvironment && NODE_ENV === 'development') {
+    return '0.0.0'
+  }
+
+  if (isDesktop) {
+    // @ts-ignore
+    return window.electron.packageJson.version
+  }
+
+  // Web based runtimes
+  if (NODE_ENV === 'development') {
+    return 'dev'
+  }
+
+  return 'main'
+}
+
+export const APP_VERSION = getAppVersion({
+  isTestEnvironment: isTestEnv,
+  NODE_ENV: env().NODE_ENV,
+  isDesktop: isDesktop(),
+})
 
 export const PACKAGE_NAME = isDesktop()
   ? window.electron.packageJson.name
   : 'zoo-modeling-app'
 
 export const IS_STAGING = PACKAGE_NAME.indexOf('-staging') > -1
 
-export const IS_STAGING_OR_DEBUG = IS_STAGING || APP_VERSION === '0.0.0'
+export const IS_STAGING_OR_DEBUG =
+  IS_STAGING || APP_VERSION === '0.0.0' || APP_VERSION === 'dev'
 
 export function getRefFromVersion(version: string) {
   const hash = version.split('.').pop()