chore(schema): add tracing for schema extraction (#6019)

Author: sgulseth

packages/sanity/src/_internal/cli/actions/schema/extractAction.ts

@@ -9,6 +9,7 @@ import {
   type ExtractSchemaWorkerData,
   type ExtractSchemaWorkerResult,
 } from '../../threads/extractSchema'
+import {SchemaExtractedTrace} from './extractSchema.telemetry'
 
 interface ExtractFlags {
   workspace?: string
@@ -21,10 +22,11 @@ export type SchemaValidationFormatter = (result: ExtractSchemaWorkerResult) => s
 
 export default async function extractAction(
   args: CliCommandArguments<ExtractFlags>,
-  {workDir, output}: CliCommandContext,
+  {workDir, output, telemetry}: CliCommandContext,
 ): Promise<void> {
   const flags = args.extOptions
-  const formatFlat = flags.format || 'groq-type-nodes'
+  const formatFlag = flags.format || 'groq-type-nodes'
+  const enforceRequiredFields = flags['enforce-required-fields'] || false
 
   const rootPkgPath = readPkgUp.sync({cwd: __dirname})?.path
   if (!rootPkgPath) {
@@ -43,32 +45,51 @@ export default async function extractAction(
   const spinner = output
     .spinner({})
     .start(
-      flags['enforce-required-fields']
+      enforceRequiredFields
         ? 'Extracting schema, with enforced required fields'
         : 'Extracting schema',
     )
 
+  const trace = telemetry.trace(SchemaExtractedTrace)
+  trace.start()
+
   const worker = new Worker(workerPath, {
     workerData: {
       workDir,
       workspaceName: flags.workspace,
-      enforceRequiredFields: flags['enforce-required-fields'],
-      format: formatFlat,
+      enforceRequiredFields,
+      format: formatFlag,
     } satisfies ExtractSchemaWorkerData,
     // eslint-disable-next-line no-process-env
     env: process.env,
   })
 
-  const {schema} = await new Promise<ExtractSchemaWorkerResult>((resolve, reject) => {
-    worker.addListener('message', resolve)
-    worker.addListener('error', reject)
-  })
+  try {
+    const {schema} = await new Promise<ExtractSchemaWorkerResult>((resolve, reject) => {
+      worker.addListener('message', resolve)
+      worker.addListener('error', reject)
+    })
+
+    trace.log({
+      schemaAllTypesCount: schema.length,
+      schemaDocumentTypesCount: schema.filter((type) => type.type === 'document').length,
+      schemaTypesCount: schema.filter((type) => type.type === 'type').length,
+      enforceRequiredFields,
+      schemaFormat: formatFlag,
+    })
 
-  const path = flags.path || join(process.cwd(), 'schema.json')
+    const path = flags.path || join(process.cwd(), 'schema.json')
 
-  spinner.text = `Writing schema to ${path}`
+    spinner.text = `Writing schema to ${path}`
 
-  await writeFile(path, JSON.stringify(schema, null, 2))
+    await writeFile(path, JSON.stringify(schema, null, 2))
 
-  spinner.succeed('Extracted schema')
+    trace.complete()
+
+    spinner.succeed('Extracted schema')
+  } catch (err) {
+    trace.error(err)
+    spinner.fail('Failed to extract schema')
+    throw err
+  }
 }

packages/sanity/src/_internal/cli/actions/schema/extractSchema.telemetry.ts

@@ -0,0 +1,16 @@
+import {defineTrace} from '@sanity/telemetry'
+
+interface SchemaExtractedTraceAttrubutes {
+  schemaAllTypesCount: number
+  schemaDocumentTypesCount: number
+  schemaTypesCount: number
+
+  enforceRequiredFields: boolean
+  schemaFormat: string
+}
+
+export const SchemaExtractedTrace = defineTrace<SchemaExtractedTraceAttrubutes>({
+  name: 'Schema Extracted',
+  version: 0,
+  description: 'Trace emitted when extracting schema',
+})