Merge pull request #6305 from Shopify/08-22-move_buildmode_to_specification

Move buildMode to specification

Author: isaacroldan

packages/app/src/cli/models/extensions/extension-instance.ts

@@ -45,8 +45,6 @@ export const CONFIG_EXTENSION_IDS: string[] = [
   WebhooksSpecIdentifier,
 ]
 
-type BuildMode = 'theme' | 'function' | 'ui' | 'flow' | 'tax_calculation' | 'none'
-
 /**
  * Class that represents an instance of a local extension
  * Before creating this class we've validated that:
@@ -342,7 +340,7 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
   }
 
   async build(options: ExtensionBuildOptions): Promise<void> {
-    const mode = this.buildMode(options.environment)
+    const mode = this.specification.buildConfig.mode
 
     switch (mode) {
       case 'theme':
@@ -379,7 +377,7 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
 
     this.outputPath = this.getOutputPathForDirectory(bundleDirectory, extensionUuid)
 
-    const buildMode = this.buildMode(options.environment)
+    const buildMode = this.specification.buildConfig.mode
 
     if (this.isThemeExtension) {
       await bundleThemeExtension(this, options)
@@ -459,25 +457,6 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
     await this.specification.contributeToSharedTypeFile?.(this, typeDefinitionsByFile)
   }
 
-  buildMode(environment: 'production' | 'development'): BuildMode {
-    if (this.isThemeExtension) {
-      return 'theme'
-    } else if (this.isFunctionExtension) {
-      return 'function'
-    } else if (this.features.includes('esbuild')) {
-      return 'ui'
-    } else if (this.specification.identifier === 'flow_template' && environment === 'production') {
-      return 'flow'
-    }
-
-    // Workaround for tax_calculations because they remote spec NEEDS a valid js file to be included.
-    if (this.type === 'tax_calculation') {
-      return 'tax_calculation'
-    }
-
-    return 'none'
-  }
-
   private buildHandle() {
     switch (this.specification.uidStrategy) {
       case 'single':

packages/app/src/cli/models/extensions/specification.ts

@@ -46,6 +46,9 @@ export interface Asset {
   content: string
 }
 
+interface BuildConfig {
+  mode: 'ui' | 'theme' | 'flow' | 'function' | 'tax_calculation' | 'none'
+}
 /**
  * Extension specification with all the needed properties and methods to load an extension.
  */
@@ -59,6 +62,7 @@ export interface ExtensionSpecification<TConfiguration extends BaseConfigType =
   surface: string
   registrationLimit: number
   experience: ExtensionExperience
+  buildConfig: BuildConfig
   dependency?: string
   graphQLType?: string
   getBundleExtensionStdinContent?: (config: TConfiguration) => {main: string; assets?: Asset[]}
@@ -186,6 +190,7 @@ export function createExtensionSpecification<TConfiguration extends BaseConfigTy
     experience: spec.experience ?? 'extension',
     uidStrategy: spec.uidStrategy ?? (spec.experience === 'configuration' ? 'single' : 'uuid'),
     getDevSessionUpdateMessages: spec.getDevSessionUpdateMessages,
+    buildConfig: spec.buildConfig ?? {mode: 'none'},
   }
   const merged = {...defaults, ...spec}
 

packages/app/src/cli/models/extensions/specifications/checkout_post_purchase.ts

@@ -14,6 +14,7 @@ const checkoutPostPurchaseSpec = createExtensionSpecification({
   partnersWebIdentifier: 'post_purchase',
   schema: CheckoutPostPurchaseSchema,
   appModuleFeatures: (_) => ['ui_preview', 'cart_url', 'esbuild', 'single_js_entry_path'],
+  buildConfig: {mode: 'ui'},
   deployConfig: async (config, _) => {
     return {metafields: config.metafields ?? []}
   },

packages/app/src/cli/models/extensions/specifications/checkout_ui_extension.ts

@@ -21,6 +21,7 @@ const checkoutSpec = createExtensionSpecification({
   dependency,
   schema: CheckoutSchema,
   appModuleFeatures: (_) => ['ui_preview', 'cart_url', 'esbuild', 'single_js_entry_path', 'generates_source_maps'],
+  buildConfig: {mode: 'ui'},
   deployConfig: async (config, directory) => {
     return {
       extension_points: config.extension_points,

packages/app/src/cli/models/extensions/specifications/flow_template.ts

@@ -49,6 +49,7 @@ const flowTemplateSpec = createExtensionSpecification({
   identifier: 'flow_template',
   schema: FlowTemplateExtensionSchema,
   appModuleFeatures: (_) => ['ui_preview'],
+  buildConfig: {mode: 'flow'},
   deployConfig: async (config, extensionPath) => {
     return {
       template_handle: config.handle,

packages/app/src/cli/models/extensions/specifications/function.ts

@@ -81,6 +81,7 @@ const functionSpec = createExtensionSpecification({
   ],
   schema: FunctionExtensionSchema,
   appModuleFeatures: (_) => ['function'],
+  buildConfig: {mode: 'function'},
   deployConfig: async (config, directory, apiKey) => {
     let inputQuery: string | undefined
     const moduleId = randomUUID()

packages/app/src/cli/models/extensions/specifications/pos_ui_extension.ts

@@ -11,6 +11,7 @@ const posUISpec = createExtensionSpecification({
   dependency,
   schema: BaseSchema.extend({name: zod.string()}),
   appModuleFeatures: (_) => ['ui_preview', 'esbuild', 'single_js_entry_path'],
+  buildConfig: {mode: 'ui'},
   deployConfig: async (config, directory) => {
     const result = await getDependencyVersion(dependency, directory)
     if (result === 'not_found') throw new BugError(`Dependency ${dependency} not found`)

packages/app/src/cli/models/extensions/specifications/product_subscription.ts

@@ -12,6 +12,7 @@ const productSubscriptionSpec = createExtensionSpecification({
   graphQLType: 'subscription_management',
   schema: BaseSchema,
   appModuleFeatures: (_) => ['ui_preview', 'esbuild', 'single_js_entry_path'],
+  buildConfig: {mode: 'ui'},
   deployConfig: async (_, directory) => {
     const result = await getDependencyVersion(dependency, directory)
     if (result === 'not_found') throw new BugError(`Dependency ${dependency} not found`)

packages/app/src/cli/models/extensions/specifications/tax_calculation.ts

@@ -23,6 +23,7 @@ const spec = createExtensionSpecification({
   identifier: 'tax_calculation',
   schema: TaxCalculationsSchema,
   appModuleFeatures: (_) => [],
+  buildConfig: {mode: 'tax_calculation'},
   deployConfig: async (config, _) => {
     return {
       production_api_base_url: config.production_api_base_url,

packages/app/src/cli/models/extensions/specifications/theme.ts

@@ -12,6 +12,7 @@ const themeSpec = createExtensionSpecification({
   schema: BaseSchema,
   partnersWebIdentifier: 'theme_app_extension',
   graphQLType: 'theme_app_extension',
+  buildConfig: {mode: 'theme'},
   appModuleFeatures: (_) => {
     return ['theme']
   },