Use a generic success status for auth logout

Author: isaacroldan

packages/cli/README.md

@@ -3759,13 +3759,13 @@ DESCRIPTION
   {
     "type": "object",
     "properties": {
-      "loggedOut": {
-        "type": "boolean",
-        "const": true
+      "status": {
+        "type": "string",
+        "const": "success"
       }
     },
     "required": [
-      "loggedOut"
+      "status"
     ],
     "additionalProperties": false,
     "title": "AuthLogoutResult",

packages/cli/oclif.manifest.json

@@ -5571,7 +5571,7 @@
       ],
       "args": {
       },
-      "description": "Logs you out of the Shopify account or Partner account and store.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AuthLogoutResult` schema.\n\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"loggedOut\": {\n      \"type\": \"boolean\",\n      \"const\": true\n    }\n  },\n  \"required\": [\n    \"loggedOut\"\n  ],\n  \"additionalProperties\": false,\n  \"title\": \"AuthLogoutResult\",\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```",
+      "description": "Logs you out of the Shopify account or Partner account and store.\n\nUse `--json-schema` to print the result, error, and event schemas.\n\nOutput from `--json` conforms to the `AuthLogoutResult` schema.\n\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"string\",\n      \"const\": \"success\"\n    }\n  },\n  \"required\": [\n    \"status\"\n  ],\n  \"additionalProperties\": false,\n  \"title\": \"AuthLogoutResult\",\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\"\n}\n```",
       "descriptionWithMarkdown": "Logs you out of the Shopify account or Partner account and store.",
       "enableJsonFlag": false,
       "flags": {

packages/cli/src/cli/commands/auth/logout-json.test.ts

@@ -30,7 +30,7 @@ test.each(['--json', '-j'])('writes one completed result through the launcher wi
     })
 
     expect(logout).toHaveBeenCalledExactlyOnceWith()
-    expect(stdout()).toBe(`${JSON.stringify({loggedOut: true}, null, 2)}\n`)
+    expect(stdout()).toBe(`${JSON.stringify({status: 'success'}, null, 2)}\n`)
     expect(stderr()).toBe('')
   })
 })
@@ -41,7 +41,7 @@ test('supports the JSON environment flag', async () => {
   await withCapturedStandardStreams(async ({stdout, stderr}) => {
     await Logout.run([], import.meta.url)
 
-    expect(JSON.parse(stdout())).toEqual({loggedOut: true})
+    expect(JSON.parse(stdout())).toEqual({status: 'success'})
     expect(stderr()).toBe('')
   })
 })
@@ -51,7 +51,7 @@ test.each([false, true])('keeps no-input independent from JSON output: %s', asyn
     await Logout.run(['--no-input', ...(json ? ['--json'] : [])], import.meta.url)
 
     if (json) {
-      expect(JSON.parse(stdout())).toEqual({loggedOut: true})
+      expect(JSON.parse(stdout())).toEqual({status: 'success'})
       expect(stderr()).toBe('')
     } else {
       expect(stdout()).toBe('')
@@ -75,8 +75,8 @@ test('discovers the schema without logging out', async () => {
 
     expect(JSON.parse(stdout()).definitions.Result).toMatchObject({
       type: 'object',
-      properties: {loggedOut: {type: 'boolean', const: true}},
-      required: ['loggedOut'],
+      properties: {status: {type: 'string', const: 'success'}},
+      required: ['status'],
       additionalProperties: false,
     })
     expect(logout).not.toHaveBeenCalled()
@@ -92,7 +92,7 @@ test('writes diagnostics to stderr separately from the result', async () => {
   await withCapturedStandardStreams(async ({stdout, stderr}) => {
     await Logout.run(['--json'], import.meta.url)
 
-    expect(JSON.parse(stdout())).toEqual({loggedOut: true})
+    expect(JSON.parse(stdout())).toEqual({status: 'success'})
     expect(JSON.parse(stderr())).toMatchObject({
       type: 'diagnostic',
       level: 'info',

packages/cli/src/cli/services/commands/auth/logout/index.test.ts

@@ -12,7 +12,7 @@ afterEach(() => {
 test('returns a completed logout without presenting output', async () => {
   const output = mockAndCaptureOutput()
 
-  await expect(logoutService()).resolves.toEqual({loggedOut: true})
+  await expect(logoutService()).resolves.toEqual({status: 'success'})
 
   expect(logout).toHaveBeenCalledExactlyOnceWith()
   expect(output.output()).toBe('')
@@ -22,8 +22,8 @@ test('returns a completed logout without presenting output', async () => {
 test('returns the same result when logout has no remaining sessions', async () => {
   vi.mocked(logout).mockResolvedValue(undefined)
 
-  await expect(logoutService()).resolves.toEqual({loggedOut: true})
-  await expect(logoutService()).resolves.toEqual({loggedOut: true})
+  await expect(logoutService()).resolves.toEqual({status: 'success'})
+  await expect(logoutService()).resolves.toEqual({status: 'success'})
 
   expect(logout).toHaveBeenCalledTimes(2)
 })

packages/cli/src/cli/services/commands/auth/logout/index.ts

@@ -3,5 +3,5 @@ import type {AuthLogoutResult} from './types.js'
 
 export async function logoutService(): Promise<AuthLogoutResult> {
   await logout()
-  return {loggedOut: true}
+  return {status: 'success'}
 }

packages/cli/src/cli/services/commands/auth/logout/result.test.ts

@@ -9,10 +9,10 @@ afterEach(() => {
 })
 
 test('encodes a completed logout', () => {
-  expect(authLogoutJsonOutputSchema.encode({loggedOut: true})).toBe(JSON.stringify({loggedOut: true}, null, 2))
+  expect(authLogoutJsonOutputSchema.encode({status: 'success'})).toBe(JSON.stringify({status: 'success'}, null, 2))
 })
 
-test.each([{}, {loggedOut: false}, {loggedOut: 'true'}, {loggedOut: null}, {loggedOut: true, accessToken: 'secret'}])(
+test.each([{}, {status: 'failed'}, {status: true}, {status: null}, {status: 'success', accessToken: 'secret'}])(
   'rejects an invalid result %j',
   (value) => {
     expect(() => authLogoutJsonOutputSchema.validate(value)).toThrow()
@@ -21,16 +21,16 @@ test.each([{}, {loggedOut: false}, {loggedOut: 'true'}, {loggedOut: null}, {logg
 
 test('writes one JSON result without the success message', async () => {
   await withCapturedStandardStreams(({stdout, stderr}) => {
-    presentLogoutResult({loggedOut: true}, 'json')
+    presentLogoutResult({status: 'success'}, 'json')
 
-    expect(stdout()).toBe(`${JSON.stringify({loggedOut: true}, null, 2)}\n`)
+    expect(stdout()).toBe(`${JSON.stringify({status: 'success'}, null, 2)}\n`)
     expect(stderr()).toBe('')
   })
 })
 
 test('keeps the exact text and stderr channel', async () => {
   await withCapturedStandardStreams(({stdout, stderr}) => {
-    presentLogoutResult({loggedOut: true}, 'text')
+    presentLogoutResult({status: 'success'}, 'text')
 
     expect(stdout()).toBe('')
     expect(unstyled(stderr())).toBe('✅ Success! Logged out from all the accounts.\n')

packages/cli/src/cli/services/commands/auth/logout/result.ts

@@ -3,7 +3,7 @@ import {outputResult, outputSuccess} from '@shopify/cli-kit/node/output'
 
 export function presentLogoutResult(result: AuthLogoutResult, format: 'json' | 'text'): void {
   if (format === 'json') {
-    outputResult(authLogoutJsonOutputSchema.encode({loggedOut: result.loggedOut}))
+    outputResult(authLogoutJsonOutputSchema.encode({status: result.status}))
     return
   }
 

packages/cli/src/cli/services/commands/auth/logout/types.ts

@@ -3,7 +3,7 @@ import {zod} from '@shopify/cli-kit/node/schema'
 
 export const authLogoutJsonOutputSchema = defineJsonOutputSchema({
   name: 'AuthLogoutResult',
-  schema: zod.object({loggedOut: zod.literal(true)}).strict(),
+  schema: zod.object({status: zod.literal('success')}).strict(),
 })
 
 export type AuthLogoutResult = InferJsonOutputSchema<typeof authLogoutJsonOutputSchema>