Skip to content

Add structured {valid, issues} JSON contract for app config validate #7128

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
ryancbahan wants to merge 1 commit into
base: ryan/structured-app-errors
Choose a base branch
from
+27 −8
Open

Add structured {valid, issues} JSON contract for app config validate #7128

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
29 changes: 24 additions & 5 deletions packages/app/src/cli/services/validate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ describe('validateApp', () => {
test('outputs json success when --json is enabled and there are no errors', async () => {
const app = testAppLinked()
await validateApp(app, {json: true})
expect(outputResult).toHaveBeenCalledWith(JSON.stringify({valid: true, errors: []}, null, 2))
expect(outputResult).toHaveBeenCalledWith(JSON.stringify({valid: true, issues: []}, null, 2))
expect(renderSuccess).not.toHaveBeenCalled()
expect(renderError).not.toHaveBeenCalled()
})
Expand All @@ -60,7 +60,7 @@ describe('validateApp', () => {
expect(outputResult).not.toHaveBeenCalled()
})

test('outputs json errors and throws when --json is enabled and there are validation errors', async () => {
test('outputs structured json issues when --json is enabled and there are validation errors', async () => {
const errors = new AppErrors()
errors.addError({file: '/path/to/shopify.app.toml', message: 'client_id is required'})
errors.addError({file: '/path/to/extensions/my-ext/shopify.extension.toml', message: 'invalid type "unknown"'})
Expand All @@ -69,7 +69,17 @@ describe('validateApp', () => {

await expect(validateApp(app, {json: true})).rejects.toThrow(AbortSilentError)
expect(outputResult).toHaveBeenCalledWith(
JSON.stringify({valid: false, errors: ['client_id is required', 'invalid type "unknown"']}, null, 2),
JSON.stringify(
{
valid: false,
issues: [
{file: '/path/to/shopify.app.toml', message: 'client_id is required'},
{file: '/path/to/extensions/my-ext/shopify.extension.toml', message: 'invalid type "unknown"'},
],
},
null,
2,
),
)
expect(renderError).not.toHaveBeenCalled()
expect(renderSuccess).not.toHaveBeenCalled()
Expand All @@ -84,13 +94,22 @@ describe('validateApp', () => {
expect(outputResult).not.toHaveBeenCalled()
})

test('formats structured errors with paths for JSON output', async () => {
test('includes path and code in structured json issues', async () => {
const errors = new AppErrors()
errors.addError({file: '/path/to/shopify.app.toml', path: ['name'], message: 'Required', code: 'invalid_type'})
const app = testAppLinked()
app.errors = errors

await expect(validateApp(app, {json: true})).rejects.toThrow(AbortSilentError)
expect(outputResult).toHaveBeenCalledWith(JSON.stringify({valid: false, errors: ['[name]: Required']}, null, 2))
expect(outputResult).toHaveBeenCalledWith(
JSON.stringify(
{
valid: false,
issues: [{file: '/path/to/shopify.app.toml', message: 'Required', path: ['name'], code: 'invalid_type'}],
},
null,
2,
),
)
})
})
6 changes: 3 additions & 3 deletions packages/app/src/cli/services/validate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export async function validateApp(app: AppLinkedInterface, options: ValidateAppO

if (!appErrors || appErrors.isEmpty()) {
if (options.json) {
outputResult(JSON.stringify({valid: true, errors: []}, null, 2))
outputResult(JSON.stringify({valid: true, issues: []}, null, 2))
return
}

Expand All @@ -24,8 +24,8 @@ export async function validateApp(app: AppLinkedInterface, options: ValidateAppO
const errors = appErrors.getErrors()

if (options.json) {
const errorMessages = errors.map(formatConfigurationError)
outputResult(JSON.stringify({valid: false, errors: errorMessages}, null, 2))
const issues = errors.map(({file, message, path, code}) => ({file, message, path, code}))
outputResult(JSON.stringify({valid: false, issues}, null, 2))
throw new AbortSilentError()
}

Expand Down
Loading