fix: detect canary status from main branch only

Author: danielroe

config/env.ts

@@ -3,7 +3,9 @@
 import Git from 'simple-git'
 import * as process from 'node:process'
 
-export { version } from '../package.json'
+import { version as packageVersion } from '../package.json'
+
+export { packageVersion as version }
 
 /**
  * Environment variable `PULL_REQUEST` provided by Netlify.
@@ -41,22 +43,24 @@ export const gitBranch = process.env.BRANCH || process.env.VERCEL_GIT_COMMIT_REF
 /**
  * Whether this is the canary environment (main.npmx.dev).
  *
- * Detected via the custom Vercel environment (`VERCEL_ENV === 'canary'`),
- * or as a fallback, a production deploy from the `main` branch.
+ * Detected as any non-PR Vercel deploy from the `main` branch
+ * (which may receive `VERCEL_ENV === 'production'` or `'preview'`
+ * depending on the project's production branch configuration).
  *
  * @see {@link https://vercel.com/docs/environment-variables/system-environment-variables#VERCEL_ENV}
  */
 export const isCanary =
-  process.env.VERCEL_ENV === 'canary' ||
-  (process.env.VERCEL_ENV === 'production' && gitBranch === 'main')
+  (process.env.VERCEL_ENV === 'production' || process.env.VERCEL_ENV === 'preview') &&
+  gitBranch === 'main' &&
+  !isPR
 
 /**
  * Environment variable `CONTEXT` provided by Netlify.
  * `dev`, `production`, `deploy-preview`, `branch-deploy`, `preview-server`, or a branch name
  * @see {@link https://docs.netlify.com/build/configure-builds/environment-variables/#build-metadata}
  *
  * Environment variable `VERCEL_ENV` provided by Vercel.
- * `production`, `preview`, `development`, or a custom environment name (e.g. `canary`).
+ * `production`, `preview`, or `development`.
  * @see {@link https://vercel.com/docs/environment-variables/system-environment-variables#VERCEL_ENV}
  *
  * Whether this is some sort of preview environment.
@@ -152,12 +156,28 @@ export async function getFileLastUpdated(path: string) {
   }
 }
 
+/**
+ * Resolves the current version from git tags, falling back to `package.json`.
+ *
+ * Uses `git describe --tags --abbrev=0 --match 'v*'` to find the most recent
+ * reachable release tag (e.g. `v0.1.0` -> `0.1.0`).
+ */
+export async function getVersion() {
+  try {
+    const tag = (await git.raw(['describe', '--tags', '--abbrev=0', '--match', 'v*'])).trim()
+    return tag.replace(/^v/, '')
+  } catch {
+    return packageVersion
+  }
+}
+
 export async function getEnv(isDevelopment: boolean) {
-  const { commit, shortCommit, branch } = await getGitInfo()
+  const [{ commit, shortCommit, branch }, version] = await Promise.all([getGitInfo(), getVersion()])
   const env = isDevelopment ? 'dev' : isCanary ? 'canary' : isPreview ? 'preview' : 'release'
   const previewUrl = getPreviewUrl()
   const productionUrl = getProductionUrl()
   return {
+    version,
     commit,
     shortCommit,
     branch,

modules/build-env.ts

@@ -1,7 +1,7 @@
 import type { BuildInfo, EnvType } from '../shared/types'
 import { createResolver, defineNuxtModule } from 'nuxt/kit'
 import { isCI } from 'std-env'
-import { getEnv, getFileLastUpdated, version } from '../config/env'
+import { getEnv, getFileLastUpdated } from '../config/env'
 
 const { resolve } = createResolver(import.meta.url)
 
@@ -26,7 +26,7 @@ export default defineNuxtModule({
         prNumber: null,
       } satisfies BuildInfo
     } else {
-      const [{ env: useEnv, commit, shortCommit, branch, prNumber }, privacyPolicyDate] =
+      const [{ env: useEnv, version, commit, shortCommit, branch, prNumber }, privacyPolicyDate] =
         await Promise.all([getEnv(nuxt.options.dev), getFileLastUpdated('app/pages/privacy.vue')])
       env = useEnv
       nuxt.options.appConfig.env = useEnv

test/unit/config/env.spec.ts

@@ -27,24 +27,34 @@ describe('isCanary', () => {
     vi.unstubAllEnvs()
   })
 
-  it('returns true when VERCEL_ENV is "canary"', async () => {
-    vi.stubEnv('VERCEL_ENV', 'canary')
+  it('returns true when VERCEL_ENV is "production" and branch is "main"', async () => {
+    vi.stubEnv('VERCEL_ENV', 'production')
+    vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
     const { isCanary } = await import('../../../config/env')
 
     expect(isCanary).toBe(true)
   })
 
-  it('returns true when VERCEL_ENV is "production" and branch is "main"', async () => {
-    vi.stubEnv('VERCEL_ENV', 'production')
+  it('returns true when VERCEL_ENV is "preview" and branch is "main" (non-PR)', async () => {
+    vi.stubEnv('VERCEL_ENV', 'preview')
     vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
     const { isCanary } = await import('../../../config/env')
 
     expect(isCanary).toBe(true)
   })
 
+  it('returns false when VERCEL_ENV is "preview", branch is "main", but is a PR', async () => {
+    vi.stubEnv('VERCEL_ENV', 'preview')
+    vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
+    vi.stubEnv('VERCEL_GIT_PULL_REQUEST_ID', '123')
+    const { isCanary } = await import('../../../config/env')
+
+    expect(isCanary).toBe(false)
+  })
+
   it.each([
     ['production (non-main branch)', 'production', 'v1.0.0'],
-    ['preview', 'preview', undefined],
+    ['preview (non-main branch)', 'preview', 'feat/foo'],
     ['development', 'development', undefined],
     ['unset', undefined, undefined],
   ])('returns false when VERCEL_ENV is %s', async (_label, value, branch) => {
@@ -78,19 +88,19 @@ describe('getEnv', () => {
     expect(result.env).toBe('dev')
   })
 
-  it('returns "canary" when VERCEL_ENV is "canary"', async () => {
-    vi.stubEnv('VERCEL_ENV', 'canary')
+  it('returns "canary" for Vercel preview deploys from main branch (non-PR)', async () => {
+    vi.stubEnv('VERCEL_ENV', 'preview')
     vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
     const { getEnv } = await import('../../../config/env')
     const result = await getEnv(false)
 
     expect(result.env).toBe('canary')
   })
 
-  it('returns "preview" for Vercel preview deploys', async () => {
+  it('returns "preview" for Vercel preview PR deploys', async () => {
     vi.stubEnv('VERCEL_ENV', 'preview')
     vi.stubEnv('VERCEL_GIT_PULL_REQUEST_ID', '123')
-    vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
+    vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'feat/foo')
     const { getEnv } = await import('../../../config/env')
     const result = await getEnv(false)
 
@@ -125,18 +135,9 @@ describe('getEnv', () => {
     expect(result.env).toBe('release')
   })
 
-  it('prioritises "canary" over "preview" when VERCEL_ENV is "canary" and PR is open', async () => {
-    vi.stubEnv('VERCEL_ENV', 'canary')
-    vi.stubEnv('VERCEL_GIT_PULL_REQUEST_ID', '789')
-    vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
-    const { getEnv } = await import('../../../config/env')
-    const result = await getEnv(false)
-
-    expect(result.env).toBe('canary')
-  })
-
   it('prioritises "dev" over "canary" in development mode', async () => {
-    vi.stubEnv('VERCEL_ENV', 'canary')
+    vi.stubEnv('VERCEL_ENV', 'preview')
+    vi.stubEnv('VERCEL_GIT_COMMIT_REF', 'main')
     const { getEnv } = await import('../../../config/env')
     const result = await getEnv(true)
 
@@ -169,7 +170,6 @@ describe('getPreviewUrl', () => {
   it.each([
     ['Netlify production', { CONTEXT: 'production', URL: 'https://prod.example.com' }],
     ['Vercel production', { VERCEL_ENV: 'production', NUXT_ENV_VERCEL_URL: 'prod.example.com' }],
-    ['Vercel canary', { VERCEL_ENV: 'canary', NUXT_ENV_VERCEL_URL: 'main.example.com' }],
   ])('%s environment returns `undefined`', async (_name, envVars) => {
     for (const [key, value] of Object.entries(envVars)) {
       vi.stubEnv(key, value)
@@ -308,3 +308,20 @@ describe('getProductionUrl', () => {
     expect(getProductionUrl()).toBe(expectedUrl)
   })
 })
+
+describe('getVersion', () => {
+  it('returns package.json version when no git tags are reachable', async () => {
+    const { getVersion, version } = await import('../../../config/env')
+    const result = await getVersion()
+
+    // In test environments without reachable tags, falls back to package.json
+    expect(result).toBe(version)
+  })
+
+  it('strips the leading "v" prefix from the tag', async () => {
+    const { getVersion } = await import('../../../config/env')
+    const result = await getVersion()
+
+    expect(result).not.toMatch(/^v/)
+  })
+})