Add function to handle glob pattern environments

Author: graygilmore

packages/cli-kit/src/public/node/environments.test.ts

@@ -176,3 +176,145 @@ describe('getEnvironmentNames', () => {
     })
   })
 })
+
+describe('expandEnvironmentPatterns', () => {
+  test('returns dedeuplicated environment names', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      const filePath = joinPath(tmpDir, fileName)
+      await writeFile(
+        filePath,
+        tomlEncode({
+          environments: {
+            'us-production': {store: 'us-store'},
+            'ca-production': {store: 'ca-store'},
+          },
+        }),
+      )
+
+      // When
+      const expanded = await environments.expandEnvironmentPatterns(['us-production', 'us-production'], fileName, {
+        from: tmpDir,
+      })
+
+      // Then
+      expect(expanded).toEqual(['us-production'])
+    })
+  })
+
+  describe('when the pattern contains glob characters', () => {
+    test('expands glob pattern to return multiple environments', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const filePath = joinPath(tmpDir, fileName)
+        await writeFile(
+          filePath,
+          tomlEncode({
+            environments: {
+              'us-production': {store: 'us-store'},
+              'ca-production': {store: 'ca-store'},
+              'de-production': {store: 'de-store'},
+              'us-staging': {store: 'us-staging-store'},
+            },
+          }),
+        )
+
+        // When
+        const expanded = await environments.expandEnvironmentPatterns(['*-production'], fileName, {from: tmpDir})
+
+        // Then
+        expect(expanded.sort()).toEqual(['ca-production', 'de-production', 'us-production'])
+      })
+    })
+
+    test('supports question mark glob patterns', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const filePath = joinPath(tmpDir, fileName)
+        await writeFile(
+          filePath,
+          tomlEncode({
+            environments: {
+              'us-production': {store: 'us-store'},
+              'uk-production': {store: 'uk-store'},
+              'usa-production': {store: 'usa-store'},
+            },
+          }),
+        )
+
+        // When
+        const expanded = await environments.expandEnvironmentPatterns(['u?-production'], fileName, {from: tmpDir})
+
+        // Then
+        expect(expanded.sort()).toEqual(['uk-production', 'us-production'])
+      })
+    })
+
+    test('supports square bracket glob patterns', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const filePath = joinPath(tmpDir, fileName)
+        await writeFile(
+          filePath,
+          tomlEncode({
+            environments: {
+              'us-production': {store: 'us-store'},
+              'uk-production': {store: 'uk-store'},
+              'usa-production': {store: 'usa-store'},
+            },
+          }),
+        )
+
+        // When
+        const expanded = await environments.expandEnvironmentPatterns(['u[a-z]-production'], fileName, {from: tmpDir})
+
+        // Then
+        expect(expanded.sort()).toEqual(['uk-production', 'us-production'])
+      })
+    })
+
+    test('supports curly bracket glob patterns', async () => {
+      await inTemporaryDirectory(async (tmpDir) => {
+        // Given
+        const filePath = joinPath(tmpDir, fileName)
+        await writeFile(
+          filePath,
+          tomlEncode({
+            environments: {
+              'us-production': {store: 'us-store'},
+              'uk-production': {store: 'uk-store'},
+              'usa-production': {store: 'usa-store'},
+            },
+          }),
+        )
+
+        // When
+        const expanded = await environments.expandEnvironmentPatterns(['{uk,us}-production'], fileName, {from: tmpDir})
+
+        // Then
+        expect(expanded.sort()).toEqual(['uk-production', 'us-production'])
+      })
+    })
+  })
+
+  test('returns exact pattern name even if no match found', async () => {
+    await inTemporaryDirectory(async (tmpDir) => {
+      // Given
+      const filePath = joinPath(tmpDir, fileName)
+      await writeFile(
+        filePath,
+        tomlEncode({
+          environments: {
+            'us-production': {store: 'us-store'},
+          },
+        }),
+      )
+
+      // When
+      const expanded = await environments.expandEnvironmentPatterns(['nonexistent'], fileName, {from: tmpDir})
+
+      // Then
+      expect(expanded).toEqual(['nonexistent'])
+    })
+  })
+})

packages/cli-kit/src/public/node/environments.ts

@@ -4,6 +4,7 @@ import {cwd} from './path.js'
 import * as metadata from './metadata.js'
 import {renderWarning} from './ui.js'
 import {JsonMap} from '../../private/common/json.js'
+import {minimatch} from 'minimatch'
 
 export interface Environments {
   [name: string]: JsonMap
@@ -111,3 +112,43 @@ export async function getEnvironmentNames(fileName: string, options?: LoadEnviro
 
   return Object.keys(environments)
 }
+
+export const ENVIRONMENT_ALLOWED_GLOB_PATTERN = /[*?[\]{}]/
+
+/**
+ * Expands environment patterns (including globs) to actual environment names.
+ * @param patterns - Array of environment names or glob patterns.
+ * @param fileName - The file name to load environments from.
+ * @param options - Optional configuration for loading.
+ * @returns Array of matched environment names.
+ */
+export async function expandEnvironmentPatterns(
+  patterns: string[],
+  fileName: string,
+  options?: LoadEnvironmentOptions,
+): Promise<string[]> {
+  const allEnvironments = await getEnvironmentNames(fileName, options)
+  const matchedEnvironments = new Set<string>()
+
+  for (const pattern of patterns) {
+    const isGlob = ENVIRONMENT_ALLOWED_GLOB_PATTERN.test(pattern)
+
+    if (isGlob) {
+      const matches = allEnvironments.filter((env) => minimatch(env, pattern))
+
+      if (matches.length === 0) {
+        renderWarningIfNeeded(
+          {
+            body: `Could not find any environments matching ${pattern}`,
+          },
+          options?.silent,
+        )
+      }
+      matches.forEach((match) => matchedEnvironments.add(match))
+    } else {
+      matchedEnvironments.add(pattern)
+    }
+  }
+
+  return Array.from(matchedEnvironments)
+}