Skip to content

refactor: remove buildConfig from specifications in favor of clientSteps #7334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isaacroldan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: remove buildConfig from specifications in favor of clientSteps #7334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions packages/app/src/cli/models/extensions/extension-instance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,12 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi
return this.specification.identifier === 'editor_extension_collection'
}

get hasDeploySteps(): boolean {
return (
this.specification.clientSteps?.some((group) => group.lifecycle === 'deploy' && group.steps.length > 0) ?? false
)
}

get features(): ExtensionFeature[] {
return this.specification.appModuleFeatures(this.configuration)
}
Expand Down Expand Up @@ -340,16 +346,14 @@ export class ExtensionInstance<TConfiguration extends BaseConfigType = BaseConfi

this.outputPath = this.getOutputPathForDirectory(bundleDirectory, extensionUuid)

const buildMode = this.specification.buildConfig.mode

if (this.isThemeExtension) {
await bundleThemeExtension(this, options)
} else if (buildMode !== 'none') {
} else if (this.hasDeploySteps) {
outputDebug(`Will copy pre-built file from ${defaultOutputPath} to ${this.outputPath}`)
if (await fileExists(defaultOutputPath)) {
await copyFile(defaultOutputPath, this.outputPath)

if (buildMode === 'function') {
if (this.isFunctionExtension) {
await bundleFunctionExtension(this.outputPath, this.outputPath)
Comment on lines 349 to 357
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyIntoBundle assumes a single file output and uses copyFile(defaultOutputPath, this.outputPath). For extensions whose outputPath is a directory (e.g., specs that only run include_assets and don't define getOutputRelativePath), fileExists(defaultOutputPath) will be true and copyFile will throw (EISDIR). It also won't include any additional files placed alongside the main output (e.g., static assets copied into the output directory). Consider handling directory outputs (recursive copy) and/or executing the relevant non-build client steps (like include_assets/copy_static_assets) even when skipBuild is enabled.

Copilot uses AI. Check for mistakes.
}
}
Expand Down
10 changes: 0 additions & 10 deletions packages/app/src/cli/models/extensions/specification.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,6 @@ export interface BuildAsset {
static?: boolean
}

type BuildConfig =
| {mode: 'ui' | 'theme' | 'function' | 'tax_calculation' | 'none' | 'hosted_app_home'}
| {mode: 'copy_files'; filePatterns: string[]; ignoredFilePatterns?: string[]}

/**
* Extension specification with all the needed properties and methods to load an extension.
*/
Expand All @@ -74,7 +70,6 @@ export interface ExtensionSpecification<TConfiguration extends BaseConfigType =
registrationLimit: number
experience: ExtensionExperience
clientSteps?: ClientSteps
buildConfig: BuildConfig
dependency?: string
graphQLType?: string
getOutputRelativePath?: (extension: ExtensionInstance<TConfiguration>) => string
Expand Down Expand Up @@ -224,7 +219,6 @@ export function createExtensionSpecification<TConfiguration extends BaseConfigTy
uidStrategy: spec.uidStrategy ?? (spec.experience === 'configuration' ? 'single' : 'uuid'),
getDevSessionUpdateMessages: spec.getDevSessionUpdateMessages,
clientSteps: spec.clientSteps,
buildConfig: spec.buildConfig ?? {mode: 'none'},
}
const merged = {...defaults, ...spec}

Expand Down Expand Up @@ -273,7 +267,6 @@ export function createConfigExtensionSpecification<TConfiguration extends BaseCo
identifier: string
schema: ZodSchemaType<TConfiguration>
clientSteps?: ClientSteps
buildConfig?: BuildConfig
appModuleFeatures?: (config?: TConfiguration) => ExtensionFeature[]
transformConfig: TransformationConfig | CustomTransformationConfig
uidStrategy?: UidStrategy
Expand All @@ -292,7 +285,6 @@ export function createConfigExtensionSpecification<TConfiguration extends BaseCo
experience: 'configuration',
uidStrategy: spec.uidStrategy ?? 'single',
clientSteps: spec.clientSteps,
buildConfig: spec.buildConfig ?? {mode: 'none'},
getDevSessionUpdateMessages: spec.getDevSessionUpdateMessages,
patchWithAppDevURLs: spec.patchWithAppDevURLs,
})
Expand All @@ -303,7 +295,6 @@ export function createContractBasedModuleSpecification<TConfiguration extends Ba
CreateExtensionSpecType<TConfiguration>,
| 'identifier'
| 'appModuleFeatures'
| 'buildConfig'
| 'uidStrategy'
| 'clientSteps'
| 'experience'
Expand All @@ -316,7 +307,6 @@ export function createContractBasedModuleSpecification<TConfiguration extends Ba
schema: zod.any({}) as unknown as ZodSchemaType<TConfiguration>,
appModuleFeatures: spec.appModuleFeatures,
experience: spec.experience,
buildConfig: spec.buildConfig ?? {mode: 'none'},
clientSteps: spec.clientSteps,
uidStrategy: spec.uidStrategy,
transformRemoteToLocal: spec.transformRemoteToLocal,
Expand Down
4 changes: 0 additions & 4 deletions packages/app/src/cli/models/extensions/specifications/admin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,6 @@ const adminSpecificationSpec = createExtensionSpecification<AdminConfigType>({
},
}
},
buildConfig: {
mode: 'copy_files',
filePatterns: [],
},
clientSteps: [
{
lifecycle: 'deploy',
Expand Down
5 changes: 0 additions & 5 deletions packages/app/src/cli/models/extensions/specifications/channel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {createContractBasedModuleSpecification} from '../specification.js'
import {joinPath} from '@shopify/cli-kit/node/path'

const SUBDIRECTORY_NAME = 'specifications'
const FILE_EXTENSIONS = ['json', 'toml', 'yaml', 'yml', 'svg']
Expand All @@ -8,10 +7,6 @@ const channelSpecificationSpec = createContractBasedModuleSpecification({
identifier: 'channel_config',
uidStrategy: 'single',
experience: 'extension',
buildConfig: {
mode: 'copy_files',
filePatterns: FILE_EXTENSIONS.map((ext) => joinPath(SUBDIRECTORY_NAME, '**', `*.${ext}`)),
},
clientSteps: [
{
lifecycle: 'deploy',
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/checkout_post_purchase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ const checkoutPostPurchaseSpec = createExtensionSpecification({
partnersWebIdentifier: 'post_purchase',
schema: CheckoutPostPurchaseSchema,
appModuleFeatures: (_) => ['ui_preview', 'cart_url', 'esbuild', 'single_js_entry_path'],
buildConfig: {mode: 'ui'},
getOutputRelativePath: (extension: ExtensionInstance<CheckoutPostPurchaseConfigType>) =>
`dist/${extension.handle}.js`,
clientSteps: [
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/checkout_ui_extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ const checkoutSpec = createExtensionSpecification({
dependency,
schema: CheckoutSchema,
appModuleFeatures: (_) => ['ui_preview', 'cart_url', 'esbuild', 'single_js_entry_path', 'generates_source_maps'],
buildConfig: {mode: 'ui'},
getOutputRelativePath: (extension: ExtensionInstance<CheckoutConfigType>) => `dist/${extension.handle}.js`,
clientSteps: [
{
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/flow_template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ const flowTemplateSpec = createExtensionSpecification({
identifier: 'flow_template',
schema: FlowTemplateExtensionSchema,
appModuleFeatures: (_) => ['ui_preview'],
buildConfig: {mode: 'copy_files', filePatterns: ['**/*.flow', '**/*.json', '**/*.toml']},
clientSteps: [
{
lifecycle: 'deploy',
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/function.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ const functionSpec = createExtensionSpecification({
],
schema: FunctionExtensionSchema,
appModuleFeatures: (_) => ['function'],
buildConfig: {mode: 'function'},
getOutputRelativePath: (_extension: ExtensionInstance<FunctionConfigType>) => joinPath('dist', 'index.wasm'),
devSessionWatchConfig: (extension: ExtensionInstance<FunctionConfigType>) => {
const config = extension.configuration
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/pos_ui_extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ const posUISpec = createExtensionSpecification({
dependency,
schema: PosUISchema,
appModuleFeatures: (_) => ['ui_preview', 'esbuild', 'single_js_entry_path'],
buildConfig: {mode: 'ui'},
getOutputRelativePath: (extension: ExtensionInstance<PosUIConfigType>) => `dist/${extension.handle}.js`,
clientSteps: [
{
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/product_subscription.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ const productSubscriptionSpec = createExtensionSpecification({
graphQLType: 'subscription_management',
schema: BaseSchema,
appModuleFeatures: (_) => ['ui_preview', 'esbuild', 'single_js_entry_path'],
buildConfig: {mode: 'ui'},
getOutputRelativePath: (extension: ExtensionInstance<ProductSubscriptionConfigType>) => `dist/${extension.handle}.js`,
clientSteps: [
{
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/tax_calculation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ const spec = createExtensionSpecification({
identifier: 'tax_calculation',
schema: TaxCalculationsSchema,
appModuleFeatures: (_) => [],
buildConfig: {mode: 'tax_calculation'},
getOutputRelativePath: (extension: ExtensionInstance<TaxCalculationsConfigType>) =>
joinPath('dist', `${extension.handle}.js`),
clientSteps: [
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/theme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ const themeSpec = createExtensionSpecification({
schema: BaseSchema,
partnersWebIdentifier: 'theme_app_extension',
graphQLType: 'theme_app_extension',
buildConfig: {mode: 'theme'},
clientSteps: [
{
lifecycle: 'deploy',
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/ui_extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ const uiExtensionSpec = createExtensionSpecification({
identifier: 'ui_extension',
dependency,
schema: UIExtensionSchema,
buildConfig: {mode: 'ui'},
getOutputRelativePath: (extension: ExtensionInstance<UIExtensionConfigType>) => `dist/${extension.handle}.js`,
clientSteps: [
{
Expand Down
1 change: 0 additions & 1 deletion packages/app/src/cli/models/extensions/specifications/web_pixel_extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ const webPixelSpec = createExtensionSpecification({
partnersWebIdentifier: 'web_pixel',
schema: WebPixelSchema,
appModuleFeatures: (_) => ['esbuild', 'single_js_entry_path'],
buildConfig: {mode: 'ui'},
getOutputRelativePath: (extension: ExtensionInstance<WebPixelConfigType>) => `dist/${extension.handle}.js`,
clientSteps: [
{
Expand Down
17 changes: 8 additions & 9 deletions packages/app/src/cli/services/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,20 +213,19 @@ export async function deploy(options: DeployOptions) {
let uploadExtensionsBundleResult!: UploadExtensionsBundleOutput

try {
const bundle = app.allExtensions.some((ext) => ext.specification.buildConfig.mode !== 'none')
let bundlePath: string | undefined

if (bundle) {
bundlePath = joinPath(options.app.directory, '.shopify', `deploy-bundle.${developerPlatformClient.bundleFormat}`)
await mkdir(dirname(bundlePath))
}
const candidateBundlePath = joinPath(
options.app.directory,
'.shopify',
`deploy-bundle.${developerPlatformClient.bundleFormat}`,
)
await mkdir(dirname(candidateBundlePath))

const appManifest = await app.manifest(identifiers)

await bundleAndBuildExtensions({
const bundlePath = await bundleAndBuildExtensions({
app,
appManifest,
bundlePath,
bundlePath: candidateBundlePath,
identifiers,
skipBuild: options.skipBuild,
isDevDashboardApp: developerPlatformClient.supportsAtomicDeployments,
Expand Down
16 changes: 13 additions & 3 deletions packages/app/src/cli/services/deploy/bundle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,18 @@ import {Writable} from 'stream'
interface BundleOptions {
app: AppInterface
appManifest: AppManifest
bundlePath?: string
bundlePath: string
identifiers?: Identifiers
skipBuild: boolean
isDevDashboardApp: boolean
}

export async function bundleAndBuildExtensions(options: BundleOptions) {
/**
* Builds all extensions into a bundle directory and compresses it if any
* extension produced output. Returns the bundlePath if a bundle was created,
* or undefined if only the manifest was present (nothing to upload).
*/
export async function bundleAndBuildExtensions(options: BundleOptions): Promise<string | undefined> {
Comment on lines +21 to +26
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring says this returns undefined when “only the manifest was present (nothing to upload)”, but the decision is currently based on ext.hasDeploySteps, not on whether any files beyond manifest.json were actually written into the bundle directory. This can lead to returning a bundle path (and uploading) even when deploy steps copied 0 files. Consider basing this on bundle directory contents (excluding manifest.json) or tracking whether any step produced output.

Copilot uses AI. Check for mistakes.
const bundleDirectory = joinPath(options.app.directory, '.shopify', 'deploy-bundle')
await rmdir(bundleDirectory, {force: true})
await mkdir(bundleDirectory)
Expand Down Expand Up @@ -73,7 +78,12 @@ export async function bundleAndBuildExtensions(options: BundleOptions) {
showTimestamps: false,
})

if (options.bundlePath) {
const hasExtensionOutput = options.app.allExtensions.some((ext) => ext.hasDeploySteps)

if (hasExtensionOutput) {
await compressBundle(bundleDirectory, options.bundlePath)
return options.bundlePath
}

return undefined
Comment on lines +81 to +88
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bundleAndBuildExtensions now returns string | undefined and can skip compression when hasExtensionOutput is false. There are existing tests for bundling with UI/function/theme extensions, but no test covering the new “no deploy steps / manifest-only” branch to assert that the function returns undefined and does not create the bundle file.

Copilot uses AI. Check for mistakes.
}
Loading