Merge pull request #5818 from Shopify/shauns/05-16-remove_opt-out_for_improve_config_module_loading

Remove opt-out for improve config module loading

Author: gonzaloriestra

.changeset/funny-pumpkins-smash.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': minor
+---
+
+Opt-out removed for validation of unsupported app configuration sections

packages/app/src/cli/constants.ts

@@ -5,7 +5,6 @@ export const environmentVariableNames = {
   enableAppLogPolling: 'SHOPIFY_CLI_ENABLE_APP_LOG_POLLING',
   templatesJsonPath: 'SHOPIFY_CLI_APP_TEMPLATES_JSON_PATH',
   mkcertBinaryPath: 'SHOPIFY_CLI_MKCERT_BINARY',
-  disableUnsupportedConfigPropertyChecks: 'SHOPIFY_CLI_DISABLE_UNSUPPORTED_CONFIG_PROPERTY_CHECKS',
   disableMinificationOnDev: 'SHOPIFY_CLI_DISABLE_MINIFICATION_ON_DEV',
 }
 

packages/app/src/cli/models/app/loader.test.ts

@@ -2569,7 +2569,7 @@ wrong = "property"
     await expect(loadTestingApp()).rejects.toThrow(AbortError)
   })
 
-  test('loads the app with an unsupported config property, under failure mode (default)', async () => {
+  test('loads the app with an unsupported config property', async () => {
     const linkedAppConfigurationWithExtraConfig = `
     name = "for-testing"
     client_id = "1234567890"
@@ -2597,42 +2597,6 @@ wrong = "property"
       'Unsupported section(s) in app configuration: and_another, something_else',
     )
   })
-
-  test('loads the app with an unsupported config property, under passthrough mode', async () => {
-    vi.stubEnv('SHOPIFY_CLI_DISABLE_UNSUPPORTED_CONFIG_PROPERTY_CHECKS', '1')
-    const linkedAppConfigurationWithExtraConfig = `
-    name = "for-testing"
-    client_id = "1234567890"
-    application_url = "https://example.com/lala"
-    embedded = true
-
-    [build]
-    include_config_on_deploy = true
-
-    [webhooks]
-    api_version = "2023-07"
-
-    [auth]
-    redirect_urls = [ "https://example.com/api/auth" ]
-
-    [something_else]
-    not_valid = true
-
-    [and_another]
-    bad = true
-    `
-    await writeConfig(linkedAppConfigurationWithExtraConfig)
-
-    const app = await loadTestingApp()
-    expect(app.allExtensions.map((ext) => ext.specification.identifier).sort()).toEqual([
-      'app_access',
-      'app_home',
-      'branding',
-      'webhooks',
-    ])
-
-    vi.unstubAllEnvs()
-  })
 })
 
 describe('getAppConfigurationFileName', () => {

packages/app/src/cli/models/app/loader.ts

@@ -19,7 +19,7 @@ import {
   AppHiddenConfig,
   isLegacyAppSchema,
 } from './app.js'
-import {configurationFileNames, dotEnvFileNames, environmentVariableNames} from '../../constants.js'
+import {configurationFileNames, dotEnvFileNames} from '../../constants.js'
 import metadata from '../../metadata.js'
 import {ExtensionInstance} from '../extensions/extension-instance.js'
 import {ExtensionsArraySchema, UnifiedSchema} from '../extensions/schemas.js'
@@ -55,8 +55,6 @@ import {joinWithAnd, slugify} from '@shopify/cli-kit/common/string'
 import {getArrayRejectingUndefined} from '@shopify/cli-kit/common/array'
 import {showNotificationsIfNeeded} from '@shopify/cli-kit/node/notifications-system'
 import ignore from 'ignore'
-import {getEnvironmentVariables} from '@shopify/cli-kit/node/environment'
-import {isTruthy} from '@shopify/cli-kit/node/context/utilities'
 
 const defaultExtensionDirectory = 'extensions/*'
 
@@ -182,18 +180,6 @@ export function parseConfigurationObjectAgainstSpecification<TSchema extends zod
   }
 }
 
-/**
- * Returns true if we should fail if an unsupported app.toml config property is found.
- *
- * This is deactivated if SHOPIFY_CLI_DISABLE_UNSUPPORTED_CONFIG_PROPERTY_CHECKS is set
- */
-async function shouldFailIfUnsupportedConfigProperty(): Promise<boolean> {
-  const env = getEnvironmentVariables()
-  // devs can also opt-out
-  const disableUnsupportedConfigPropertyChecks = env[environmentVariableNames.disableUnsupportedConfigPropertyChecks]
-  return !isTruthy(disableUnsupportedConfigPropertyChecks)
-}
-
 export class AppErrors {
   private errors: {
     [key: string]: OutputMessage
@@ -656,8 +642,6 @@ class AppLoader<TConfig extends AppConfiguration, TModuleSpec extends ExtensionS
   }
 
   private async createConfigExtensionInstances(directory: string, appConfiguration: TConfig & CurrentAppConfiguration) {
-    const failIfUnsupportedConfigProperty = await shouldFailIfUnsupportedConfigProperty()
-
     const extensionInstancesWithKeys = await Promise.all(
       this.specifications
         .filter((specification) => specification.uidStrategy === 'single')
@@ -697,15 +681,11 @@ class AppLoader<TConfig extends AppConfiguration, TModuleSpec extends ExtensionS
       })
 
     if (unusedKeys.length > 0) {
-      if (failIfUnsupportedConfigProperty) {
-        this.abortOrReport(
-          outputContent`Unsupported section(s) in app configuration: ${unusedKeys.sort().join(', ')}`,
-          undefined,
-          appConfiguration.path,
-        )
-      } else {
-        outputDebug(outputContent`Unused keys in app configuration: ${outputToken.json(unusedKeys)}`)
-      }
+      this.abortOrReport(
+        outputContent`Unsupported section(s) in app configuration: ${unusedKeys.sort().join(', ')}`,
+        undefined,
+        appConfiguration.path,
+      )
     }
     return extensionInstancesWithKeys
       .filter(([instance]) => instance)