Resolve JSON schema from flowkit instead of Flow CLI (#831)

Author: jribbink

extension/src/flow-cli/cli-versions-provider.ts

@@ -4,23 +4,25 @@ import { execDefault } from '../utils/shell/exec'
 import { Observable, distinctUntilChanged } from 'rxjs'
 import { isEqual } from 'lodash'
 
-const CHECK_FLOW_CLI_CMD = (flowCommand: string): string => `${flowCommand} version --output=json`
-const CHECK_FLOW_CLI_CMD_NO_JSON = (flowCommand: string): string => `${flowCommand} version`
+const CHECK_FLOW_CLI_CMD = (flowCommand: string): string => `${flowCommand} version -v --output=json`
+const FLOWKIT_PACKAGE_NAME = 'github.com/onflow/flowkit/v2'
 
 export enum KNOWN_FLOW_COMMANDS {
   DEFAULT = 'flow',
 }
 
-// Matches the version number from the output of the Flow CLI
-const LEGACY_VERSION_REGEXP = /Version:\s*v(.*)(?:\s|$)/m
-
 export interface CliBinary {
   command: string
   version: semver.SemVer
+  flowkitVersion: semver.SemVer
 }
 
 interface FlowVersionOutput {
   version: string
+  dependencies?: Array<{
+    package: string
+    version: string
+  }>
 }
 
 export class CliVersionsProvider {
@@ -84,31 +86,13 @@ export class CliVersionsProvider {
       // Format version string from output
       const versionInfo: FlowVersionOutput = JSON.parse(buffer)
 
-      return cliBinaryFromVersion(bin, versionInfo.version)
-    } catch {
-      // Fallback to old method if JSON is not supported/fails
-      return await this.#fetchBinaryInformationOld(bin)
-    }
-  }
-
-  // Old version of fetchBinaryInformation (before JSON was supported)
-  // Used as fallback for old CLI versions
-  async #fetchBinaryInformationOld (bin: string): Promise<CliBinary | null> {
-    try {
-      // Get user's version information
-      const output = (await execDefault(CHECK_FLOW_CLI_CMD_NO_JSON(
-        bin
-      )))
-
-      let versionStr: string | null = parseFlowCliVersion(output.stdout)
-      if (versionStr === null) {
-        // Try to fallback to stderr as patch for bugged version
-        versionStr = parseFlowCliVersion(output.stderr)
-      }
-
-      if (versionStr == null) return null
+      // Extract flowkit version from dependencies
+      const flowkitDep = versionInfo.dependencies?.find(dep =>
+        dep.package === FLOWKIT_PACKAGE_NAME
+      )
+      const flowkitVersionStr = flowkitDep?.version
 
-      return cliBinaryFromVersion(bin, versionStr)
+      return cliBinaryFromVersion(bin, versionInfo.version, flowkitVersionStr)
     } catch {
       return null
     }
@@ -130,16 +114,15 @@ export class CliVersionsProvider {
   }
 }
 
-export function parseFlowCliVersion (buffer: Buffer | string): string | null {
-  const rawMatch = buffer.toString().match(LEGACY_VERSION_REGEXP)?.[1] ?? null
-  if (rawMatch == null) return null
-  return semver.clean(rawMatch)
-}
-
-function cliBinaryFromVersion (bin: string, versionStr: string): CliBinary | null {
+function cliBinaryFromVersion (bin: string, versionStr: string, flowkitVersionStr?: string): CliBinary | null {
   // Ensure user has a compatible version number installed
   const version: semver.SemVer | null = semver.parse(versionStr)
   if (version === null) return null
 
-  return { command: bin, version }
+  // Parse flowkit version - both CLI and flowkit versions are required
+  if (flowkitVersionStr == null) return null
+  const flowkitVersion: semver.SemVer | null = semver.parse(flowkitVersionStr)
+  if (flowkitVersion === null) return null
+
+  return { command: bin, version, flowkitVersion }
 }

extension/src/json-schema-provider.ts

@@ -6,7 +6,7 @@ import fetch from 'node-fetch'
 import { CliProvider } from './flow-cli/cli-provider'
 
 const CADENCE_SCHEMA_URI = 'cadence-schema'
-const GET_FLOW_SCHEMA_URL = (version: string): string => `https://raw.githubusercontent.com/onflow/flow-cli/v${version}/flowkit/schema.json`
+const GET_FLOW_SCHEMA_URL = (version: string): string => `https://raw.githubusercontent.com/onflow/flowkit/v${version}/schema.json`
 
 // This class provides the JSON schema for the flow.json file
 // It is accessible via the URI scheme "cadence-schema:///flow.json"
@@ -37,21 +37,21 @@ export class JSONSchemaProvider implements vscode.FileSystemProvider, vscode.Dis
       return await this.getLocalSchema()
     }
 
-    const version = cliBinary.version.format()
-    if (this.#schemaCache[version] == null) {
-      // Try to get schema from flow-cli repo based on the flow-cli version
-      this.#schemaCache[version] = fetch(GET_FLOW_SCHEMA_URL(version)).then(async (response: Response) => {
+    const flowkitVersion = cliBinary.flowkitVersion.format()
+    if (this.#schemaCache[flowkitVersion] == null) {
+      // Try to get schema from flowkit repo based on the flowkit version
+      this.#schemaCache[flowkitVersion] = fetch(GET_FLOW_SCHEMA_URL(flowkitVersion)).then(async (response: Response) => {
         if (!response.ok) {
-          throw new Error(`Failed to fetch schema for flow-cli version ${version}`)
+          throw new Error(`Failed to fetch schema for flowkit version ${flowkitVersion}`)
         }
         return await response.text()
       }).catch(async () => {
-        void vscode.window.showWarningMessage('Failed to fetch flow.json schema from flow-cli repo, using local schema instead.  Please update flow-cli to the latest version to get the latest schema.')
+        void vscode.window.showWarningMessage('Failed to fetch flow.json schema from flowkit repo, using local schema instead.  Please update flow-cli to the latest version to get the latest schema.')
         return await this.getLocalSchema()
       })
     }
 
-    return await this.#schemaCache[version]
+    return await this.#schemaCache[flowkitVersion]
   }
 
   async getLocalSchema (): Promise<string> {

extension/test/integration/1 - language-server.test.ts

@@ -23,7 +23,8 @@ suite('Language Server & Emulator Integration', () => {
     // create a mock cli provider without invokign the constructor
     cliBinary$ = new BehaviorSubject<CliBinary>({
       command: 'flow',
-      version: new SemVer('1.0.0')
+      version: new SemVer('1.0.0'),
+      flowkitVersion: new SemVer('1.0.0')
     })
     const mockCliProvider = {
       currentBinary$: cliBinary$,
@@ -61,7 +62,8 @@ suite('Language Server & Emulator Integration', () => {
     // Check that client remains stopped even if CLI binary changes
     cliBinary$.next({
       command: 'flow',
-      version: new SemVer('1.0.1')
+      version: new SemVer('1.0.1'),
+      flowkitVersion: new SemVer('1.0.1')
     })
 
     assert.equal(client?.state, State.Stopped)

extension/test/integration/3 - schema.test.ts

@@ -13,6 +13,7 @@ import { Subject } from 'rxjs'
 
 suite('JSON schema tests', () => {
   let mockFlowVersionValue: SemVer | null = null
+  let mockFlowkitVersionValue: SemVer | null = null
   let mockCliProvider: CliProvider
   let extensionPath: string
   let schemaProvider: JSONSchemaProvider
@@ -28,10 +29,11 @@ suite('JSON schema tests', () => {
     // Mock cli provider
     mockCliProvider = {
       currentBinary$: new Subject(),
-      getCurrentBinary: sinon.stub().callsFake(async () => ((mockFlowVersionValue != null)
+      getCurrentBinary: sinon.stub().callsFake(async () => ((mockFlowVersionValue != null && mockFlowkitVersionValue != null)
         ? {
             name: 'flow',
-            version: mockFlowVersionValue
+            version: mockFlowVersionValue,
+            flowkitVersion: mockFlowkitVersionValue
           }
         : null))
     } as any
@@ -41,7 +43,7 @@ suite('JSON schema tests', () => {
     ;(fetch as unknown as any).default = async (url: string) => {
       // only mock valid response for version 1.0.0 for testing
       // other versions will return 404 and emulate a missing schema
-      if (url === 'https://raw.githubusercontent.com/onflow/flow-cli/v1.0.0/flowkit/schema.json') {
+      if (url === 'https://raw.githubusercontent.com/onflow/flowkit/v1.0.0/schema.json') {
         return {
           ok: true,
           text: async () => JSON.stringify({
@@ -72,6 +74,7 @@ suite('JSON schema tests', () => {
 
   test('Defaults to local schema when version not found', async () => {
     mockFlowVersionValue = new SemVer('0.0.0')
+    mockFlowkitVersionValue = new SemVer('0.0.0')
 
     // Assert that the schema is the same as the local schema
     await vscode.workspace.fs.readFile(vscode.Uri.parse('cadence-schema:///flow.json')).then((data) => {
@@ -81,15 +84,17 @@ suite('JSON schema tests', () => {
 
   test('Defaults to local schema when version is invalid', async () => {
     mockFlowVersionValue = null
+    mockFlowkitVersionValue = null
 
     // Assert that the schema is the same as the local schema
     await vscode.workspace.fs.readFile(vscode.Uri.parse('cadence-schema:///flow.json')).then((data) => {
       assert.strictEqual(data.toString(), readFileSync(path.resolve(extensionPath, './flow-schema.json'), 'utf-8'))
     })
   }).timeout(MaxTimeout)
 
-  test('Fetches remote schema for current CLI version', async () => {
-    mockFlowVersionValue = new SemVer('1.0.0')
+  test('Fetches remote schema for current flowkit version', async () => {
+    mockFlowVersionValue = new SemVer('2.0.0')
+    mockFlowkitVersionValue = new SemVer('1.0.0')
 
     // Assert that the schema is the same as the remote schema
     await vscode.workspace.fs.readFile(vscode.Uri.parse('cadence-schema:///flow.json')).then((data) => {