Refactor extension build process to use modular build steps #6867
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| import spec from './channel.js' | ||
| import {ExtensionInstance} from '../extension-instance.js' | ||
| import {ExtensionBuildOptions} from '../../../services/build/extension.js' | ||
| import {describe, expect, test} from 'vitest' | ||
| import {inTemporaryDirectory, writeFile, fileExists, mkdir} from '@shopify/cli-kit/node/fs' | ||
| import {joinPath} from '@shopify/cli-kit/node/path' | ||
| import {Writable} from 'stream' | ||
|
|
||
| const SUBDIRECTORY = 'specifications' | ||
|
|
||
| describe('channel_config', () => { | ||
| describe('clientSteps', () => { | ||
| test('uses copy_files mode', () => { | ||
| expect(spec.buildConfig.mode).toBe('copy_files') | ||
| }) | ||
|
|
||
| test('has a single copy-files step scoped to the specifications subdirectory', () => { | ||
| expect(spec.clientSteps[0]!.steps).toHaveLength(1) | ||
| expect(spec.clientSteps[0]!.steps[0]).toMatchObject({ | ||
| id: 'copy-files', | ||
| type: 'include_assets', | ||
| config: { | ||
| inclusions: [{type: 'pattern', baseDir: SUBDIRECTORY, destination: SUBDIRECTORY}], | ||
| }, | ||
| }) | ||
|
|
||
| const {include} = ( | ||
| spec.clientSteps[0]!.steps[0]!.config as {inclusions: [{include: string[]}]} | ||
| ).inclusions[0]! | ||
|
|
||
| expect(include).toEqual(expect.arrayContaining(['**/*.json', '**/*.toml', '**/*.yaml', '**/*.yml', '**/*.svg'])) | ||
| }) | ||
|
|
||
| test('config is serializable to JSON', () => { | ||
| const serialized = JSON.stringify(spec.clientSteps) | ||
| const deserialized = JSON.parse(serialized) | ||
|
|
||
| expect(deserialized[0].steps).toHaveLength(1) | ||
| expect(deserialized[0].steps[0].config.inclusions[0].type).toBe('pattern') | ||
| }) | ||
| }) | ||
|
|
||
| describe('build integration', () => { | ||
| test('copies specification files to output, preserving subdirectory structure', async () => { | ||
| await inTemporaryDirectory(async (tmpDir) => { | ||
| // Given | ||
| const extensionDir = joinPath(tmpDir, 'extension') | ||
| const specsDir = joinPath(extensionDir, SUBDIRECTORY) | ||
| const outputDir = joinPath(tmpDir, 'output') | ||
|
|
||
| await mkdir(specsDir) | ||
| await mkdir(outputDir) | ||
|
|
||
| await writeFile(joinPath(specsDir, 'product.json'), '{}') | ||
| await writeFile(joinPath(specsDir, 'order.toml'), '[spec]') | ||
| await writeFile(joinPath(specsDir, 'logo.svg'), '<svg/>') | ||
| // Root-level files should NOT be copied | ||
| await writeFile(joinPath(extensionDir, 'README.md'), '# readme') | ||
| await writeFile(joinPath(extensionDir, 'index.js'), 'ignored') | ||
|
|
||
| const extension = new ExtensionInstance({ | ||
| configuration: {name: 'my-channel', type: 'channel'}, | ||
| configurationPath: '', | ||
| directory: extensionDir, | ||
| specification: spec, | ||
| }) | ||
| extension.outputPath = outputDir | ||
|
|
||
| const buildOptions: ExtensionBuildOptions = { | ||
| stdout: new Writable({ | ||
| write(chunk, enc, cb) { | ||
| cb() | ||
| }, | ||
| }), | ||
| stderr: new Writable({ | ||
| write(chunk, enc, cb) { | ||
| cb() | ||
| }, | ||
| }), | ||
| app: {} as any, | ||
| environment: 'production', | ||
| } | ||
|
|
||
| // When | ||
| await extension.build(buildOptions) | ||
|
|
||
| // Then — specification files copied with path preserved | ||
| await expect(fileExists(joinPath(outputDir, SUBDIRECTORY, 'product.json'))).resolves.toBe(true) | ||
| await expect(fileExists(joinPath(outputDir, SUBDIRECTORY, 'order.toml'))).resolves.toBe(true) | ||
| await expect(fileExists(joinPath(outputDir, SUBDIRECTORY, 'logo.svg'))).resolves.toBe(true) | ||
|
|
||
| // Root-level files not in specifications/ are not copied | ||
| await expect(fileExists(joinPath(outputDir, 'README.md'))).resolves.toBe(false) | ||
| await expect(fileExists(joinPath(outputDir, 'index.js'))).resolves.toBe(false) | ||
| }) | ||
| }) | ||
|
|
||
| test('does not copy files with non-matching extensions inside specifications/', async () => { | ||
| await inTemporaryDirectory(async (tmpDir) => { | ||
| // Given | ||
| const extensionDir = joinPath(tmpDir, 'extension') | ||
| const specsDir = joinPath(extensionDir, SUBDIRECTORY) | ||
| const outputDir = joinPath(tmpDir, 'output') | ||
|
|
||
| await mkdir(specsDir) | ||
| await mkdir(outputDir) | ||
|
|
||
| await writeFile(joinPath(specsDir, 'spec.json'), '{}') | ||
| await writeFile(joinPath(specsDir, 'ignored.ts'), 'const x = 1') | ||
| await writeFile(joinPath(specsDir, 'ignored.js'), 'const x = 1') | ||
|
|
||
| const extension = new ExtensionInstance({ | ||
| configuration: {name: 'my-channel', type: 'channel'}, | ||
| configurationPath: '', | ||
| directory: extensionDir, | ||
| specification: spec, | ||
| }) | ||
| extension.outputPath = outputDir | ||
|
|
||
| const buildOptions: ExtensionBuildOptions = { | ||
| stdout: new Writable({ | ||
| write(chunk, enc, cb) { | ||
| cb() | ||
| }, | ||
| }), | ||
| stderr: new Writable({ | ||
| write(chunk, enc, cb) { | ||
| cb() | ||
| }, | ||
| }), | ||
| app: {} as any, | ||
| environment: 'production', | ||
| } | ||
|
|
||
| // When | ||
| await extension.build(buildOptions) | ||
|
|
||
| // Then | ||
| await expect(fileExists(joinPath(outputDir, SUBDIRECTORY, 'spec.json'))).resolves.toBe(true) | ||
| await expect(fileExists(joinPath(outputDir, SUBDIRECTORY, 'ignored.ts'))).resolves.toBe(false) | ||
| await expect(fileExists(joinPath(outputDir, SUBDIRECTORY, 'ignored.js'))).resolves.toBe(false) | ||
| }) | ||
| }) | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Duplicate/double-wrapped error handling in ExtensionInstance.build()
executeStep()already throws when a step fails andcontinueOnErroris false:But
ExtensionInstance.build()then checks:That condition is effectively unreachable because
executeStep()won’t return{success:false}unlesscontinueOnErroris true. This is dead logic and also risks producing a worse error message (e.g.,undefined) if behavior changes later.Impact: