Exclude default values from multi-env flag requirements

Previously, default flag values were allowed to meet
mutli environment command run flag requirements. This
commit changes that to only allow requirements to
be met by user provided values

Author: dejmedus

packages/theme/src/cli/utilities/theme-command.test.ts

@@ -84,6 +84,9 @@ class TestThemeCommandWithUnionFlags extends TestThemeCommand {
     }),
   }
 }
+class TestThemeCommandWithPath extends TestThemeCommand {
+  static multiEnvironmentsFlags: RequiredFlags = ['store', 'path']
+}
 
 class TestUnauthenticatedThemeCommand extends ThemeCommand {
   static flags = {
@@ -390,6 +393,31 @@ describe('ThemeCommand', () => {
       expect(renderConcurrentProcesses?.map((process) => process.prefix)).toEqual(['development', 'production'])
     })
 
+    test('should not execute commands in environments that are missing required flags even if they have a default value', async () => {
+      // Given
+      vi.mocked(loadEnvironment)
+        .mockResolvedValueOnce({store: 'store1.myshopify.com', path: '/a/path'})
+        .mockResolvedValueOnce({})
+        .mockResolvedValueOnce({store: 'store3.myshopify.com'})
+
+      vi.mocked(renderConfirmationPrompt).mockResolvedValue(true)
+      vi.mocked(renderConcurrent).mockResolvedValue(undefined)
+
+      await CommandConfig.load()
+      const command = new TestThemeCommandWithPath(
+        ['--environment', 'development', '--environment', 'env-missing-store', '--environment', 'path-defaults-to-cwd'],
+        CommandConfig,
+      )
+
+      // When
+      await command.run()
+
+      // Then
+      const renderConcurrentProcesses = vi.mocked(renderConcurrent).mock.calls[0]?.[0]?.processes
+      expect(renderConcurrentProcesses).toHaveLength(1)
+      expect(renderConcurrentProcesses?.map((process) => process.prefix)).toEqual(['development'])
+    })
+
     test('should not execute commands in environments that are missing required "one of" flags', async () => {
       // Given
       vi.mocked(loadEnvironment)

packages/theme/src/cli/utilities/theme-command.ts

@@ -137,12 +137,8 @@ export default abstract class ThemeCommand extends Command {
    * @param flagsWithoutDefaults - Flags provided via the CLI
    * @returns The map of environments
    */
-  private async loadEnvironments(
-    environments: EnvironmentName[],
-    flags: FlagValues,
-    flagsWithoutDefaults: FlagValues,
-  ): Promise<Map<EnvironmentName, FlagValues>> {
-    const environmentMap = new Map<EnvironmentName, FlagValues>()
+  private async loadEnvironments(environments: EnvironmentName[], flags: FlagValues, flagsWithoutDefaults: FlagValues) {
+    const environmentMap = new Map<EnvironmentName, {flags: FlagValues; validationFlags: FlagValues}>()
 
     for (const environmentName of environments) {
       // eslint-disable-next-line no-await-in-loop
@@ -157,10 +153,13 @@ export default abstract class ThemeCommand extends Command {
       }
 
       environmentMap.set(environmentName, {
-        ...flags,
-        ...environmentFlags,
-        ...flagsWithoutDefaults,
-        environment: [environmentName],
+        flags: {
+          ...flags,
+          ...environmentFlags,
+          ...flagsWithoutDefaults,
+          environment: [environmentName],
+        },
+        validationFlags: {...environmentFlags, ...flagsWithoutDefaults} as FlagValues,
       })
     }
 
@@ -175,21 +174,21 @@ export default abstract class ThemeCommand extends Command {
    * @returns An object containing valid and invalid environment arrays
    */
   private async validateEnvironments(
-    environmentMap: Map<EnvironmentName, FlagValues>,
+    environmentMap: Map<EnvironmentName, {flags: FlagValues; validationFlags: FlagValues}>,
     requiredFlags: Exclude<RequiredFlags, null>,
     requiresAuth: boolean,
   ) {
     const valid: ValidEnvironment[] = []
     const invalid: {environment: EnvironmentName; reason: string}[] = []
 
-    for (const [environmentName, environmentFlags] of environmentMap) {
-      const validationResult = this.validConfig(environmentFlags, requiredFlags, environmentName)
+    for (const [environmentName, {flags, validationFlags}] of environmentMap) {
+      const validationResult = this.validConfig(validationFlags, requiredFlags, environmentName)
       if (validationResult !== true) {
         const missingFlagsText = validationResult.join(', ')
         invalid.push({environment: environmentName, reason: `Missing flags: ${missingFlagsText}`})
         continue
       }
-      valid.push({environment: environmentName, flags: environmentFlags, requiresAuth})
+      valid.push({environment: environmentName, flags, requiresAuth})
     }
 
     return {valid, invalid}