Merge pull request #7413 from Shopify/04-28-skip_manifest_generation_when_bundle_dir_matches_local_output

Skip manifest generation when bundle dir matches local output

Author: isaacroldan

packages/app/src/cli/services/build/steps/bundle-ui-step.test.ts

@@ -1,4 +1,5 @@
 import {executeBundleUIStep} from './bundle-ui-step.js'
+import * as generateManifest from './include-assets/generate-manifest.js'
 import * as buildExtension from '../extension.js'
 import {BundleUIStep, BuildContext} from '../client-steps.js'
 import {ExtensionInstance} from '../../../models/extensions/extension-instance.js'
@@ -7,6 +8,7 @@ import * as fs from '@shopify/cli-kit/node/fs'
 
 vi.mock('@shopify/cli-kit/node/fs')
 vi.mock('../extension.js')
+vi.mock('./include-assets/generate-manifest.js')
 
 describe('executeBundleUIStep', () => {
   let mockContext: BuildContext
@@ -55,4 +57,25 @@ describe('executeBundleUIStep', () => {
 
     expect(fs.copyFile).not.toHaveBeenCalled()
   })
+
+  test('skips manifest generation when local and bundle output directories resolve to the same path', async () => {
+    const stepWithManifest: BundleUIStep = {
+      id: 'bundle-ui',
+      name: 'Bundle UI Extension',
+      type: 'bundle_ui',
+      config: {generatesAssetsManifest: true},
+    }
+    mockContext.extension.outputPath = '/test/./extension/dist/handle.js'
+    mockContext.extension.configuration = {
+      extension_points: [
+        {target: 'admin.product-details.action.render', build_manifest: {assets: {main: {filepath: 'main.js'}}}},
+      ],
+    } as ExtensionInstance['configuration']
+    vi.mocked(buildExtension.buildUIExtension).mockResolvedValue('/test/extension/dist/handle.js')
+
+    await executeBundleUIStep(stepWithManifest, mockContext)
+
+    expect(fs.copyFile).not.toHaveBeenCalled()
+    expect(generateManifest.createOrUpdateManifestFile).not.toHaveBeenCalled()
+  })
 })

packages/app/src/cli/services/build/steps/bundle-ui-step.ts

@@ -26,9 +26,11 @@ export async function executeBundleUIStep(step: BundleUIStep, context: BuildCont
   const bundleOutputDir = step.config?.bundleFolder
     ? joinPath(dirname(context.extension.outputPath), step.config.bundleFolder)
     : dirname(context.extension.outputPath)
-  if (resolvePath(localOutputDir) !== resolvePath(bundleOutputDir)) {
-    await copyFile(localOutputDir, bundleOutputDir)
-  }
+
+  // If the final output path is the same as the local one: don't copy the results and don't generate manifests.
+  if (resolvePath(localOutputDir) === resolvePath(bundleOutputDir)) return
+
+  await copyFile(localOutputDir, bundleOutputDir)
 
   if (!step.config?.generatesAssetsManifest) return