Return version result as an object

Assisted-By: devx/c4197d39-027e-4413-9b97-5c38707a9864

Author: dmerand

packages/cli/README.md

@@ -5859,7 +5859,16 @@ DESCRIPTION
 
   ```json
   {
-    "type": "string",
+    "type": "object",
+    "properties": {
+      "version": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "version"
+    ],
+    "additionalProperties": false,
     "title": "VersionResult",
     "$schema": "http://json-schema.org/draft-07/schema#"
   }

packages/cli/oclif.manifest.json

@@ -11492,7 +11492,7 @@
       ],
       "args": {
       },
-      "description": "Shopify CLI version currently installed.\n\nOutput from `--json` conforms to the `VersionResult` schema.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\n```json\n{\n  \"type\": \"string\",\n  \"title\": \"VersionResult\",\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```",
+      "description": "Shopify CLI version currently installed.\n\nOutput from `--json` conforms to the `VersionResult` schema.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"version\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"version\"\n  ],\n  \"additionalProperties\": false,\n  \"title\": \"VersionResult\",\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```",
       "descriptionWithMarkdown": "Shopify CLI version currently installed.",
       "enableJsonFlag": false,
       "flags": {

packages/cli/src/cli/commands/version.test.ts

@@ -1,12 +1,13 @@
 import Version from './version.js'
-import {versionJsonOutputSchema, versionService} from '../services/commands/version.js'
+import {versionService} from '../services/commands/version/index.js'
+import {versionJsonOutputSchema} from '../services/commands/version/types.js'
 import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
 import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'
 import {execa} from 'execa'
 import {afterEach, describe, expect, test, vi} from 'vitest'
 
-vi.mock('../services/commands/version.js', async (importOriginal) => ({
-  ...(await importOriginal<typeof import('../services/commands/version.js')>()),
+vi.mock('../services/commands/version/index.js', async (importOriginal) => ({
+  ...(await importOriginal<typeof import('../services/commands/version/index.js')>()),
   versionService: vi.fn(),
 }))
 
@@ -44,7 +45,7 @@ const runVersion = async (arguments_: string[]) => {
 describe('version command', () => {
   test('writes the raw version text by default', async () => {
     const outputMock = mockAndCaptureOutput()
-    vi.mocked(versionService).mockResolvedValue('2.2.2')
+    vi.mocked(versionService).mockResolvedValue({version: '2.2.2'})
 
     await Version.run([], import.meta.url)
 
@@ -53,22 +54,22 @@ describe('version command', () => {
     expect(outputMock.warn()).toBe('')
   })
 
-  test('writes one scalar JSON document when requested', async () => {
+  test('writes one JSON document when requested', async () => {
     const outputMock = mockAndCaptureOutput()
-    vi.mocked(versionService).mockResolvedValue('2.2.2')
+    vi.mocked(versionService).mockResolvedValue({version: '2.2.2'})
 
     await Version.run(['--json'], import.meta.url)
 
-    expect(outputMock.output()).toBe('"2.2.2"')
-    expect(JSON.parse(outputMock.output())).toBe('2.2.2')
+    expect(outputMock.output()).toBe(JSON.stringify({version: '2.2.2'}, null, 2))
+    expect(JSON.parse(outputMock.output())).toEqual({version: '2.2.2'})
     expect(outputMock.warn()).toBe('')
   })
 
-  test('exposes the scalar schema and JSON flags in help', () => {
+  test('exposes the object schema and JSON flags in help', () => {
     expect(Version.jsonOutputSchema).toBe(versionJsonOutputSchema)
     expect(Version.flags.json).toBeDefined()
     expect(Version.description).toContain('Output from `--json` conforms to the `VersionResult` schema.')
-    expect(Version.description).toContain('"type": "string"')
+    expect(Version.description).toContain('"type": "object"')
   })
 
   test('writes the installed version without stderr output', {timeout: 20000}, async () => {
@@ -84,15 +85,19 @@ describe('version command', () => {
 
     expect(result.exitCode).toBe(0)
     expect(result.stderr).toBe('')
-    expect(result.stdout).toBe(`${JSON.stringify(CLI_KIT_VERSION)}\n`)
-    expect(JSON.parse(result.stdout)).toBe(CLI_KIT_VERSION)
+    expect(result.stdout).toBe(`${JSON.stringify({version: CLI_KIT_VERSION}, null, 2)}\n`)
+    expect(JSON.parse(result.stdout)).toEqual({version: CLI_KIT_VERSION})
   })
 
-  test('writes a schema with a string result without stderr output', {timeout: 20000}, async () => {
+  test('writes a schema with an object result without stderr output', {timeout: 20000}, async () => {
     const result = await runVersion(['--json-schema'])
 
     expect(result.exitCode).toBe(0)
     expect(result.stderr).toBe('')
-    expect(JSON.parse(result.stdout).definitions.Result.type).toBe('string')
+    const definition = JSON.parse(result.stdout).definitions.Result
+    expect(definition.type).toBe('object')
+    expect(definition.properties.version).toEqual({type: 'string'})
+    expect(definition.required).toEqual(['version'])
+    expect(definition.additionalProperties).toBe(false)
   })
 })

packages/cli/src/cli/commands/version.ts

@@ -1,7 +1,8 @@
-import {versionJsonOutputSchema, versionService} from '../services/commands/version.js'
+import {versionService} from '../services/commands/version/index.js'
+import {presentVersionResult} from '../services/commands/version/result.js'
+import {versionJsonOutputSchema} from '../services/commands/version/types.js'
 import Command from '@shopify/cli-kit/node/base-command'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
-import {outputResult} from '@shopify/cli-kit/node/output'
 
 export default class Version extends Command {
   static descriptionWithMarkdown = 'Shopify CLI version currently installed.'
@@ -19,8 +20,8 @@ export default class Version extends Command {
 
   async run(): Promise<void> {
     const {flags} = await this.parse(Version)
-    const version = await versionService()
+    const result = await versionService()
 
-    outputResult(flags.json ? versionJsonOutputSchema.encode(version) : version)
+    presentVersionResult(result, flags.json ? 'json' : 'text')
   }
 }

packages/cli/src/cli/services/commands/version.test.ts

@@ -0,0 +1,19 @@
+import {versionService} from './index.js'
+import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'
+import {afterEach, describe, expect, test, vi} from 'vitest'
+
+vi.mock('@shopify/cli-kit/common/version', () => ({CLI_KIT_VERSION: '2.2.2'}))
+
+afterEach(() => {
+  mockAndCaptureOutput().clear()
+})
+
+describe('version service', () => {
+  test('returns the installed version as an object without writing output', async () => {
+    const outputMock = mockAndCaptureOutput()
+
+    await expect(versionService()).resolves.toEqual({version: '2.2.2'})
+
+    expect(outputMock.output()).toBe('')
+  })
+})

packages/cli/src/cli/services/commands/version/index.test.ts

@@ -0,0 +1,6 @@
+import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
+import type {VersionResult} from './types.js'
+
+export async function versionService(): Promise<VersionResult> {
+  return {version: CLI_KIT_VERSION}
+}

packages/cli/src/cli/services/commands/version/index.ts

@@ -0,0 +1,47 @@
+import {presentVersionResult} from './result.js'
+import {versionJsonOutputSchema} from './types.js'
+import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'
+import {afterEach, describe, expect, test} from 'vitest'
+
+afterEach(() => {
+  mockAndCaptureOutput().clear()
+})
+
+describe('presentVersionResult', () => {
+  test('writes the raw version text by default', () => {
+    const outputMock = mockAndCaptureOutput()
+
+    presentVersionResult({version: '2.2.2'}, 'text')
+
+    expect(outputMock.output()).toBe('2.2.2')
+    expect(outputMock.warn()).toBe('')
+  })
+
+  test('writes one JSON document when requested', () => {
+    const outputMock = mockAndCaptureOutput()
+
+    presentVersionResult({version: '2.2.2'}, 'json')
+
+    expect(outputMock.output()).toBe(JSON.stringify({version: '2.2.2'}, null, 2))
+    expect(JSON.parse(outputMock.output())).toEqual({version: '2.2.2'})
+  })
+})
+
+describe('version JSON result contract', () => {
+  test('encodes an object with a version string', () => {
+    expect(versionJsonOutputSchema.encode({version: '2.2.2'})).toBe(JSON.stringify({version: '2.2.2'}, null, 2))
+  })
+
+  test.each([['2.2.2'], [{}], [{version: 1}]])('rejects %j', (value) => {
+    expect(() => versionJsonOutputSchema.validate(value)).toThrow()
+  })
+
+  test('declares a closed object schema with a required version string', () => {
+    expect(versionJsonOutputSchema.jsonSchema).toMatchObject({
+      type: 'object',
+      properties: {version: {type: 'string'}},
+      required: ['version'],
+      additionalProperties: false,
+    })
+  })
+})

packages/cli/src/cli/services/commands/version/result.test.ts

@@ -0,0 +1,6 @@
+import {versionJsonOutputSchema, type VersionResult} from './types.js'
+import {outputResult} from '@shopify/cli-kit/node/output'
+
+export function presentVersionResult(result: VersionResult, format: 'json' | 'text'): void {
+  outputResult(format === 'json' ? versionJsonOutputSchema.encode(result) : result.version)
+}

packages/cli/src/cli/services/commands/version/result.ts

@@ -1,14 +1,9 @@
-import {CLI_KIT_VERSION} from '@shopify/cli-kit/common/version'
 import {defineJsonOutputSchema, type InferJsonOutputSchema} from '@shopify/cli-kit/node/json-output-schema'
 import {zod} from '@shopify/cli-kit/node/schema'
 
 export const versionJsonOutputSchema = defineJsonOutputSchema({
   name: 'VersionResult',
-  schema: zod.string(),
+  schema: zod.object({version: zod.string()}),
 })
 
 export type VersionResult = InferJsonOutputSchema<typeof versionJsonOutputSchema>
-
-export async function versionService(): Promise<VersionResult> {
-  return CLI_KIT_VERSION
-}