Use LocalConfigError for validate json handling

Author: dmerand

packages/app/src/cli/services/validate.test.ts

@@ -97,6 +97,132 @@ describe('validateApp', () => {
     expect(renderSuccess).not.toHaveBeenCalled()
   })
 
+  test('outputs only structured issues when the rendered message matches them exactly', async () => {
+    // Given
+    const errors = new AppErrors()
+    errors.addError('/path/to/shopify.app.toml', '• [client_id]: Required', [
+      {
+        filePath: '/path/to/shopify.app.toml',
+        path: ['client_id'],
+        pathString: 'client_id',
+        message: 'Required',
+        code: 'invalid_type',
+      },
+    ])
+    const app = testAppLinked()
+    app.errors = errors
+
+    // When / Then
+    await expect(validateApp(app, {json: true})).rejects.toThrow(AbortSilentError)
+    expect(outputResult).toHaveBeenCalledWith(
+      JSON.stringify(
+        {
+          valid: false,
+          issues: [
+            {
+              filePath: '/path/to/shopify.app.toml',
+              path: ['client_id'],
+              pathString: 'client_id',
+              message: 'Required',
+              code: 'invalid_type',
+            },
+          ],
+        },
+        null,
+        2,
+      ),
+    )
+  })
+
+  test('outputs only structured issues when the rendered message is a validation wrapper around them', async () => {
+    // Given
+    const errors = new AppErrors()
+    errors.addError(
+      '/path/to/shopify.app.toml',
+      'Validation errors in /path/to/shopify.app.toml:\n\n• [client_id]: Required',
+      [
+        {
+          filePath: '/path/to/shopify.app.toml',
+          path: ['client_id'],
+          pathString: 'client_id',
+          message: 'Required',
+          code: 'invalid_type',
+        },
+      ],
+    )
+    const app = testAppLinked()
+    app.errors = errors
+
+    // When / Then
+    await expect(validateApp(app, {json: true})).rejects.toThrow(AbortSilentError)
+    expect(outputResult).toHaveBeenCalledWith(
+      JSON.stringify(
+        {
+          valid: false,
+          issues: [
+            {
+              filePath: '/path/to/shopify.app.toml',
+              path: ['client_id'],
+              pathString: 'client_id',
+              message: 'Required',
+              code: 'invalid_type',
+            },
+          ],
+        },
+        null,
+        2,
+      ),
+    )
+  })
+
+  test('adds a root issue when the rendered message includes extra context beyond the structured issues', async () => {
+    // Given
+    const errors = new AppErrors()
+    errors.addError(
+      '/path/to/shopify.app.toml',
+      'Validation errors in /path/to/shopify.app.toml:\n\n• [client_id]: Required\n\nFix the app config before continuing.',
+      [
+        {
+          filePath: '/path/to/shopify.app.toml',
+          path: ['client_id'],
+          pathString: 'client_id',
+          message: 'Required',
+          code: 'invalid_type',
+        },
+      ],
+    )
+    const app = testAppLinked()
+    app.errors = errors
+
+    // When / Then
+    await expect(validateApp(app, {json: true})).rejects.toThrow(AbortSilentError)
+    expect(outputResult).toHaveBeenCalledWith(
+      JSON.stringify(
+        {
+          valid: false,
+          issues: [
+            {
+              filePath: '/path/to/shopify.app.toml',
+              path: ['client_id'],
+              pathString: 'client_id',
+              message: 'Required',
+              code: 'invalid_type',
+            },
+            {
+              filePath: '/path/to/shopify.app.toml',
+              path: [],
+              pathString: 'root',
+              message:
+                'Validation errors in /path/to/shopify.app.toml:\n\n• [client_id]: Required\n\nFix the app config before continuing.',
+            },
+          ],
+        },
+        null,
+        2,
+      ),
+    )
+  })
+
   test('renders success when errors object exists but is empty', async () => {
     // Given
     const errors = new AppErrors()