Refresh JSON schema documentation after rebase

Author: gonzaloriestra

packages/cli/README.md

@@ -15583,12 +15583,10 @@ DESCRIPTION
             "type": "string"
           },
           "line": {
-            "type": "integer",
-            "minimum": 0
+            "type": "number"
           },
           "col": {
-            "type": "integer",
-            "minimum": 0
+            "type": "number"
           }
         },
         "required": [
@@ -15610,8 +15608,7 @@ DESCRIPTION
             "type": "number"
           },
           "frame": {
-            "type": "integer",
-            "minimum": 0
+            "type": "number"
           }
         },
         "required": [
@@ -15704,8 +15701,7 @@ DESCRIPTION
             "items": {
               "type": "array",
               "items": {
-                "type": "integer",
-                "minimum": 0
+                "type": "number"
               }
             }
           },
@@ -15767,8 +15763,7 @@ DESCRIPTION
                         "type": "string"
                       },
                       "activeProfileIndex": {
-                        "type": "integer",
-                        "minimum": 0
+                        "type": "number"
                       }
                     },
                     "required": [
@@ -15819,6 +15814,11 @@ DESCRIPTION
                       "message": {
                         "type": "string"
                       },
+                      "code": {
+                        "type": "string",
+                        "minLength": 1,
+                        "description": "A stable error code, included only when known."
+                      },
                       "tryMessage": {
                         "type": "string"
                       },
@@ -15859,7 +15859,9 @@ DESCRIPTION
                           "additionalProperties": false
                         }
                       },
-                      "details": {}
+                      "details": {
+                        "description": "Selected domain details, preserving native API payloads such as GraphQL errors, extensions, and data."
+                      }
                     },
                     "required": [
                       "type",
@@ -15877,6 +15879,9 @@ DESCRIPTION
                       "message": {
                         "$ref": "#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message"
                       },
+                      "code": {
+                        "$ref": "#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code"
+                      },
                       "tryMessage": {
                         "$ref": "#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage"
                       },
@@ -15909,6 +15914,9 @@ DESCRIPTION
                       "message": {
                         "$ref": "#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/message"
                       },
+                      "code": {
+                        "$ref": "#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/code"
+                      },
                       "tryMessage": {
                         "$ref": "#/definitions/ThemeEnvironment/anyOf/1/properties/error/anyOf/0/properties/tryMessage"
                       },

packages/cli/oclif.manifest.json

@@ -1,7 +1,10 @@
 import Profile from './profile.js'
 import {themeProfileJsonOutputSchema, type ThemeProfileResult} from '../../services/profile/types.js'
+import * as themeStorage from '../../services/local-storage.js'
 import {expect, test, vi} from 'vitest'
 import {withCapturedStandardStreams} from '@shopify/cli-kit/node/testing/output'
+import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs'
+import {LocalStorage} from '@shopify/cli-kit/node/local-storage'
 
 vi.mock('../../utilities/theme-selector.js')
 vi.mock('../../utilities/theme-environment/storefront-renderer.js')
@@ -46,7 +49,7 @@ test('exposes Speedscope evented and sampled profiles while retaining extension
   ).toThrow()
 })
 
-test.each(['profile', 'empty', 'failure', 'invalid result'])(
+test.each(['profile', 'empty', 'unknown location', 'fractional location', 'failure', 'invalid result'])(
   'keeps %s JSON on stdout and progress events on stderr',
   async (mode) => {
     const {default: StreamProfile} = await import('./profile.js')
@@ -66,28 +69,47 @@ test.each(['profile', 'empty', 'failure', 'invalid result'])(
       processing: false,
       createdAtRuntime: false,
     })
-    const result = mode === 'empty' ? {...profile, profiles: [], shared: {frames: []}} : profile
+    let result = profile
+    if (mode === 'empty') result = {...profile, profiles: [], shared: {frames: []}}
+    if (mode === 'unknown location' || mode === 'fractional location') {
+      const position = mode === 'unknown location' ? -1 : 0.5
+      result = {...profile, shared: {frames: [{name: 'layout', line: position, col: position}]}}
+    }
     // Keep unusual whitespace and upstream field order to catch accidental reserialization.
     const source = mode === 'invalid result' ? '{"profiles":false}' : ` ${JSON.stringify(result, null, 4)}\n`
     vi.mocked(render).mockResolvedValue(new Response(source, {status: 200}))
     if (mode === 'failure') vi.mocked(render).mockRejectedValue(new Error('Network error'))
-    await withCapturedStandardStreams(async ({stdout, stderr}) => {
-      const operation = runWithCommandEventsForCommand(['--json'], () =>
-        new StreamProfile(['--store=shop.myshopify.com', '--json'], config).run(),
-      )
-      if (mode === 'failure') await expect(operation).rejects.toThrow('Network error')
-      else if (mode === 'invalid result') await expect(operation).rejects.toThrow()
-      else await operation
-      expect(openURL).not.toHaveBeenCalled()
-      const failed = mode === 'failure' || mode === 'invalid result'
-      expect(stdout()).toBe(failed ? '' : `${source}\n`)
-      if (!failed) expect(JSON.parse(stdout())).toEqual(result)
-      const events = stderr()
-        .trim()
-        .split('\n')
-        .map((line) => JSON.parse(line))
-      expect(events.map((event) => event.status)).toEqual(failed ? ['started', 'failed'] : ['started', 'completed'])
-      expect(events.every((event) => event.type === 'progress')).toBe(true)
+    await inTemporaryDirectory(async (directory) => {
+      const storage = new LocalStorage<themeStorage.ThemeLocalStorageSchema>({cwd: directory})
+      const {getThemeStore, setThemeStore} = themeStorage
+      const getStore = vi.spyOn(themeStorage, 'getThemeStore').mockImplementation(() => getThemeStore(storage))
+      const setStore = vi
+        .spyOn(themeStorage, 'setThemeStore')
+        .mockImplementation((store) => setThemeStore(store, storage))
+      try {
+        await withCapturedStandardStreams(async ({stdout, stderr}) => {
+          const operation = runWithCommandEventsForCommand(['--json'], () =>
+            new StreamProfile(['--store=shop.myshopify.com', '--json'], config).run(),
+          )
+          if (mode === 'failure') await expect(operation).rejects.toThrow('Network error')
+          else if (mode === 'invalid result') await expect(operation).rejects.toThrow()
+          else await operation
+          expect(openURL).not.toHaveBeenCalled()
+          const failed = mode === 'failure' || mode === 'invalid result'
+          expect(stdout()).toBe(failed ? '' : `${source}\n`)
+          if (!failed) expect(JSON.parse(stdout())).toEqual(result)
+          const events = stderr()
+            .trim()
+            .split('\n')
+            .map((line) => JSON.parse(line))
+          expect(events.map((event) => event.status)).toEqual(failed ? ['started', 'failed'] : ['started', 'completed'])
+          expect(events.every((event) => event.type === 'progress')).toBe(true)
+        })
+        expect(storage.get('themeStore')).toBe('shop.myshopify.com')
+      } finally {
+        getStore.mockRestore()
+        setStore.mockRestore()
+      }
     })
   },
 )

packages/theme/src/cli/commands/theme/profile.test.ts

@@ -71,10 +71,6 @@ export default class Profile extends ThemeCommand {
     return result?.result
   }
 
-  protected collectsEnvironmentResults(flags: Partial<ProfileFlags>): boolean {
-    return Boolean(flags.json)
-  }
-
   protected renderEnvironmentResults(environments: ThemeEnvironmentResult[]): void {
     outputResult(themeProfileJsonOutputSchema.encode({environments}))
   }

packages/theme/src/cli/commands/theme/profile.ts

@@ -90,6 +90,17 @@ describe('profile', () => {
     expect(htmlContent).toContain('speedscope')
   })
 
+  test.each([-1, 0.5])('opens native profiles with source position %s', async (position) => {
+    const data = {...mockProfileData, shared: {frames: [{name: 'layout', line: position, col: position}]}}
+    vi.mocked(render).mockResolvedValue(new Response(JSON.stringify(data), {status: 200}))
+
+    const result = await profile(mockAdminSession, themeId, urlPath)
+    expect(result.result).toEqual(data)
+    await renderThemeProfileResult(result, 'text')
+
+    expect(openURL).toHaveBeenCalledWith(expect.stringMatching(/^file:\/\/.*\.html$/))
+  })
+
   test('throws error when fetch fails', async () => {
     // Given
     vi.mocked(render).mockRejectedValue(new Error('Network error'))

packages/theme/src/cli/services/profile.test.ts

@@ -7,15 +7,15 @@ const ProfileFrameSchema = zod
   .object({
     name: zod.string(),
     file: zod.string().optional(),
-    line: zod.number().int().nonnegative().optional(),
-    col: zod.number().int().nonnegative().optional(),
+    line: zod.number().optional(),
+    col: zod.number().optional(),
   })
   .passthrough()
 const ProfileEventSchema = zod
   .object({
     type: zod.enum(['O', 'C']),
     at: zod.number(),
-    frame: zod.number().int().nonnegative(),
+    frame: zod.number(),
   })
   .passthrough()
 const ProfileBaseSchema = zod.object({
@@ -30,7 +30,7 @@ const EventedProfileSchema = ProfileBaseSchema.extend({
 }).passthrough()
 const SampledProfileSchema = ProfileBaseSchema.extend({
   type: zod.literal('sampled'),
-  samples: zod.array(zod.array(zod.number().int().nonnegative())),
+  samples: zod.array(zod.array(zod.number())),
   weights: zod.array(zod.number()),
 }).passthrough()
 const ProfileSharedSchema = zod.object({frames: zod.array(ProfileFrameSchema)}).passthrough()
@@ -42,7 +42,7 @@ export const themeProfileResultSchema = zod
     profiles: zod.array(zod.discriminatedUnion('type', [EventedProfileSchema, SampledProfileSchema])),
     name: zod.string().optional(),
     exporter: zod.string().optional(),
-    activeProfileIndex: zod.number().int().nonnegative().optional(),
+    activeProfileIndex: zod.number().optional(),
   })
   .passthrough()
   .describe(