Skip to content

Fix flaky declarative-definitions test by mocking UI helpers #7435

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

Merged
gonzaloriestra merged 3 commits into from
Apr 30, 2026
Merged

Fix flaky declarative-definitions test by mocking UI helpers #7435

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86101a8
Fix flaky declarative-definitions test by mocking UI helpers
gonzaloriestra Apr 30, 2026
efa2bb7
Fix flaky declarative-definitions test by mocking UI helpers
gonzaloriestra Apr 30, 2026
4a443cc
Fix flaky declarative-definitions test by mocking UI helpers
gonzaloriestra Apr 30, 2026
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
84 changes: 19 additions & 65 deletions packages/app/src/cli/services/generate/shop-import/declarative-definitions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,22 @@ import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'

vi.mock('../../../api/admin-as-app.js')
vi.mock('@shopify/cli-kit/node/session')
vi.mock('@shopify/cli-kit/node/ui', async () => {
const actual: any = await vi.importActual('@shopify/cli-kit/node/ui')
return {
...actual,
renderTasks: vi.fn(async (tasks: {task: () => Promise<unknown>}[]) => {
for (const task of tasks) {
// eslint-disable-next-line no-await-in-loop
await task.task()
}
}),
renderSingleTask: vi.fn(async (task: {task: () => Promise<unknown>}) => {
return task.task()
}),
renderInfo: vi.fn(),
}
})

const defaultMetaobjectFragment = {
name: 'test',
Expand Down Expand Up @@ -1123,29 +1139,7 @@ describe('importDeclarativeDefinitions', () => {
appConfiguration: {},
} as any)

expect(outputMock.info()).toMatchInlineSnapshot(`
"╭─ info ───────────────────────────────────────────────────────────────────────╮
│ │
│ Conversion to TOML complete. │
│ │
│ Converted 0 metafields and 0 metaobjects from test-shop.myshopify.com into │
│ TOML, ready for you to copy. │
│ │
│ Next steps │
│ 1. Review the suggested TOML carefully before applying. │
│ 2. Missing sections? Make sure your app has the required access scopes │
│ to load metafields and metaobjects (e.g. \`read_customers\` to load │
│ customer metafields, \`read_metaobject_definitions\` to load │
│ metaobjects.) │
│ 3. Missing definitions? Only metafields and metaobjects that are │
│ app-reserved (using \`$app\` ) will be converted. │
│ 4. When you're ready, add the generated TOML to your app's configuration │
│ file and test out changes with the \`shopify app dev\` command. │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯

"
`)
expect(outputMock.info()).toMatchInlineSnapshot(`""`)
outputMock.clear()
})

Expand Down Expand Up @@ -1328,27 +1322,7 @@ describe('importDeclarativeDefinitions', () => {
} as any)

expect(outputMock.info()).toMatchInlineSnapshot(`
"╭─ info ───────────────────────────────────────────────────────────────────────╮
│ │
│ Conversion to TOML complete. │
│ │
│ Converted 1 metafields and 1 metaobjects from test-shop.myshopify.com into │
│ TOML, ready for you to copy. │
│ │
│ Next steps │
│ 1. Review the suggested TOML carefully before applying. │
│ 2. Missing sections? Make sure your app has the required access scopes │
│ to load metafields and metaobjects (e.g. \`read_customers\` to load │
│ customer metafields, \`read_metaobject_definitions\` to load │
│ metaobjects.) │
│ 3. Missing definitions? Only metafields and metaobjects that are │
│ app-reserved (using \`$app\` ) will be converted. │
│ 4. When you're ready, add the generated TOML to your app's configuration │
│ file and test out changes with the \`shopify app dev\` command. │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯

# type: $app:new
"# type: $app:new
[metaobjects.app.new.fields]
field = "single_line_text_field"

Expand All @@ -1365,27 +1339,7 @@ describe('importDeclarativeDefinitions', () => {
} as any)

expect(outputMock.info()).toMatchInlineSnapshot(`
"╭─ info ───────────────────────────────────────────────────────────────────────╮
│ │
│ Conversion to TOML complete. │
│ │
│ Converted 2 metafields and 2 metaobjects from test-shop.myshopify.com into │
│ TOML, ready for you to copy. │
│ │
│ Next steps │
│ 1. Review the suggested TOML carefully before applying. │
│ 2. Missing sections? Make sure your app has the required access scopes │
│ to load metafields and metaobjects (e.g. \`read_customers\` to load │
│ customer metafields, \`read_metaobject_definitions\` to load │
│ metaobjects.) │
│ 3. Missing definitions? Only metafields and metaobjects that are │
│ app-reserved (using \`$app\` ) will be converted. │
│ 4. When you're ready, add the generated TOML to your app's configuration │
│ file and test out changes with the \`shopify app dev\` command. │
│ │
╰──────────────────────────────────────────────────────────────────────────────╯

# type: $app:existing
"# type: $app:existing
[metaobjects.app.existing.fields]
field = "single_line_text_field"

Expand Down
Loading