|
| 1 | +import Publish from './publish.js' |
| 2 | +import {themePublishJsonOutputSchema} from '../../services/publish/types.js' |
| 3 | +import {findOrSelectTheme} from '../../utilities/theme-selector.js' |
| 4 | +import {Config} from '@oclif/core' |
| 5 | +import {ensureAuthenticatedThemes} from '@shopify/cli-kit/node/session' |
| 6 | +import {themePublish} from '@shopify/cli-kit/node/themes/api' |
| 7 | +import {withCapturedStandardStreams} from '@shopify/cli-kit/node/testing/output' |
| 8 | +import {runWithCommandEventsForCommand} from '@shopify/cli-kit/node/command-events' |
| 9 | +import {inTemporaryDirectory, writeFile} from '@shopify/cli-kit/node/fs' |
| 10 | +import {joinPath} from '@shopify/cli-kit/node/path' |
| 11 | +import {outputWarn} from '@shopify/cli-kit/node/output' |
| 12 | +import {describe, expect, test, vi} from 'vitest' |
| 13 | + |
| 14 | +vi.mock('@shopify/cli-kit/node/session') |
| 15 | +vi.mock('@shopify/cli-kit/node/themes/api') |
| 16 | +vi.mock('@shopify/cli-kit/node/metadata') |
| 17 | +vi.mock('../../utilities/theme-selector.js') |
| 18 | +vi.mock('../../utilities/theme-store.js', () => ({ensureThemeStore: ({store}: {store: string}) => store})) |
| 19 | + |
| 20 | +const originalTheme = {id: 1, name: 'Original', role: 'unpublished', processing: false, createdAtRuntime: false} |
| 21 | +const publishedTheme = {...originalTheme, role: 'live'} |
| 22 | +const store = 'test.myshopify.com' |
| 23 | + |
| 24 | +async function run(argv: string[]) { |
| 25 | + const config = new Config({root: __dirname}) |
| 26 | + await config.load() |
| 27 | + vi.mocked(ensureAuthenticatedThemes).mockImplementation(async (storeFqdn) => ({token: 'token', storeFqdn})) |
| 28 | + return runWithCommandEventsForCommand(argv, () => new Publish(argv, config).run()) |
| 29 | +} |
| 30 | + |
| 31 | +async function inEnvironments(run: () => Promise<void>) { |
| 32 | + await inTemporaryDirectory(async (directory) => { |
| 33 | + await writeFile( |
| 34 | + joinPath(directory, 'shopify.theme.toml'), |
| 35 | + ` |
| 36 | +[environments.first] |
| 37 | +store = "first.myshopify.com" |
| 38 | +password = "token" |
| 39 | +[environments.second] |
| 40 | +store = "second.myshopify.com" |
| 41 | +password = "token" |
| 42 | +`, |
| 43 | + ) |
| 44 | + const cwd = vi.spyOn(process, 'cwd').mockReturnValue(directory) |
| 45 | + try { |
| 46 | + await run() |
| 47 | + } finally { |
| 48 | + cwd.mockRestore() |
| 49 | + } |
| 50 | + }) |
| 51 | +} |
| 52 | + |
| 53 | +describe('theme publish JSON output', () => { |
| 54 | + test('exposes its schema and JSON flag in help', () => { |
| 55 | + expect(Publish.jsonOutputSchema).toBe(themePublishJsonOutputSchema) |
| 56 | + expect(Publish.flags.json).toBeDefined() |
| 57 | + expect(Publish.description).toContain('ThemePublishResult') |
| 58 | + }) |
| 59 | + |
| 60 | + test.each([undefined, '', 'https://example.com/theme.zip'])( |
| 61 | + 'returns the updated theme and omits missing src (%s)', |
| 62 | + async (src) => { |
| 63 | + vi.mocked(findOrSelectTheme).mockResolvedValue(originalTheme) |
| 64 | + vi.mocked(themePublish).mockResolvedValue({...publishedTheme, src}) |
| 65 | + await withCapturedStandardStreams(async ({stdout, stderr}) => { |
| 66 | + await run(['--store', store, '--theme', '1', '--force', '--json']) |
| 67 | + expect(JSON.parse(stdout())).toEqual({ |
| 68 | + status: 'success', |
| 69 | + theme: {...publishedTheme, ...(src === undefined ? {} : {src}), shop: store}, |
| 70 | + }) |
| 71 | + expect(stderr()).toBe('') |
| 72 | + }) |
| 73 | + }, |
| 74 | + ) |
| 75 | + |
| 76 | + test('routes diagnostics to stderr', async () => { |
| 77 | + vi.mocked(findOrSelectTheme).mockResolvedValue(originalTheme) |
| 78 | + vi.mocked(themePublish).mockImplementation(async () => { |
| 79 | + outputWarn('Retrying request') |
| 80 | + return publishedTheme |
| 81 | + }) |
| 82 | + await withCapturedStandardStreams(async ({stdout, stderr}) => { |
| 83 | + await run(['--store', store, '--theme', '1', '--force', '--json']) |
| 84 | + expect(JSON.parse(stdout()).theme.role).toBe('live') |
| 85 | + expect(JSON.parse(stderr())).toMatchObject({type: 'diagnostic', level: 'warning', message: 'Retrying request'}) |
| 86 | + }) |
| 87 | + }) |
| 88 | + |
| 89 | + test('leaves execution failures to the shared error handler without writing a result', async () => { |
| 90 | + vi.mocked(findOrSelectTheme).mockResolvedValue(originalTheme) |
| 91 | + vi.mocked(themePublish).mockRejectedValue(new Error('Publishing failed')) |
| 92 | + await withCapturedStandardStreams(async ({stdout}) => { |
| 93 | + await expect(run(['--store', store, '--theme', '1', '--force', '--json'])).rejects.toThrow('Publishing failed') |
| 94 | + expect(stdout()).toBe('') |
| 95 | + }) |
| 96 | + }) |
| 97 | + |
| 98 | + test.each(['none', 'partial', 'all'])('collects one document in configured order (%s failures)', async (failures) => { |
| 99 | + vi.mocked(findOrSelectTheme).mockResolvedValue(originalTheme) |
| 100 | + vi.mocked(themePublish).mockImplementation(async (_id, session) => { |
| 101 | + if (failures === 'all' || (failures === 'partial' && session.storeFqdn.startsWith('first.'))) { |
| 102 | + throw new Error('Publishing failed') |
| 103 | + } |
| 104 | + return publishedTheme |
| 105 | + }) |
| 106 | + const exitCode = process.exitCode |
| 107 | + await inEnvironments(async () => { |
| 108 | + await withCapturedStandardStreams(async ({stdout, stderr}) => { |
| 109 | + await run(['--environment', 'first', '--environment', 'second', '--theme', '1', '--force', '--json']) |
| 110 | + const environments: string[] = [] |
| 111 | + if (failures === 'none') environments.push('first') |
| 112 | + if (failures !== 'all') environments.push('second') |
| 113 | + expect(JSON.parse(stdout())).toEqual({ |
| 114 | + environments: environments.map((environment) => ({ |
| 115 | + environment, |
| 116 | + result: {status: 'success', theme: {...publishedTheme, shop: `${environment}.myshopify.com`}}, |
| 117 | + })), |
| 118 | + }) |
| 119 | + if (failures === 'none') { |
| 120 | + expect(stderr()).toBe('') |
| 121 | + } else { |
| 122 | + const errors = stderr() |
| 123 | + .trim() |
| 124 | + .split('\n') |
| 125 | + .map((line) => JSON.parse(line)) |
| 126 | + expect(errors).toHaveLength(failures === 'all' ? 2 : 1) |
| 127 | + expect(errors[0]).toMatchObject({type: 'diagnostic', level: 'error', code: 'theme-environment-failed'}) |
| 128 | + } |
| 129 | + expect(process.exitCode).toBe(exitCode) |
| 130 | + }) |
| 131 | + }) |
| 132 | + }) |
| 133 | + |
| 134 | + test.each([ |
| 135 | + {status: 'success', theme: {...publishedTheme, id: '1', shop: store}}, |
| 136 | + {status: 'success', theme: {...publishedTheme, shop: null}}, |
| 137 | + {status: 'success', theme: {...publishedTheme, src: false, shop: store}}, |
| 138 | + { |
| 139 | + environments: [ |
| 140 | + {environment: 'first', result: {status: 'success', theme: {...publishedTheme, role: null, shop: store}}}, |
| 141 | + ], |
| 142 | + }, |
| 143 | + ])('rejects malformed results %#', (result) => { |
| 144 | + expect(() => themePublishJsonOutputSchema.validate(result)).toThrow() |
| 145 | + }) |
| 146 | +}) |
0 commit comments