Add loading fresh generated bundle schema to redhat.vscode-yaml extension (#398)

Author: shreyas-goenka

packages/databricks-vscode/package.json

@@ -42,7 +42,11 @@
         "onView:clusterView",
         "onTaskType:databricks",
         "onDebugResolve:databricks",
-        "onDebugResolve:databricks-workflow"
+        "onDebugResolve:databricks-workflow",
+        "workspaceContains:**/databricks.yml",
+        "workspaceContains:**/bundle.yml",
+        "workspaceContains:**/databricks.yaml",
+        "workspaceContains:**/bundle.yaml"
     ],
     "main": "out/extension.js",
     "types": "out/extension.d.ts",

packages/databricks-vscode/src/bundle/GenerateBundle.ts

@@ -0,0 +1,46 @@
+import {CliWrapper} from "../cli/CliWrapper";
+import {extensions, Uri} from "vscode";
+import path from "node:path";
+
+export async function generateBundleSchema(cli: CliWrapper) {
+    // get freshly generated bundle schema
+    const bundleSchema = await cli.getBundleSchema();
+
+    // URI scheme for DABs JSON schemas
+    const dabsUriScheme = "dabs";
+
+    // URI for bundle root config json schema
+    const rootConfigSchemaUri = `${dabsUriScheme}:///root.json`;
+
+    const extensionYaml = extensions.getExtension("redhat.vscode-yaml");
+    if (extensionYaml) {
+        const redHatYamlSchemaApi = await extensionYaml.activate();
+
+        // We use the API exposed from teh activate() function of the redhat.vscode-yaml
+        // extension to registor a custom schema provider
+        redHatYamlSchemaApi.registerContributor(
+            "dabs",
+            (resource: string) => {
+                const validFileNames: string[] = [
+                    "databricks.yml",
+                    "databricks.yaml",
+                    "bundle.yml",
+                    "bundle.yaml",
+                ];
+                for (const name of validFileNames) {
+                    if (path.basename(resource) === name) {
+                        return rootConfigSchemaUri;
+                    }
+                }
+                return undefined;
+            },
+            (uri: string) => {
+                // Any JSON schemas with URI scheme = "dabs" resolves here
+                const parsedUri = Uri.parse(uri);
+                if (parsedUri.scheme === dabsUriScheme) {
+                    return bundleSchema;
+                }
+            }
+        );
+    }
+}

packages/databricks-vscode/src/cli/CliWrapper.ts

@@ -95,6 +95,15 @@ export class CliWrapper {
         return result;
     }
 
+    public async getBundleSchema(): Promise<string> {
+        const execFile = promisify(execFileCb);
+        const {stdout} = await execFile(
+            this.context.asAbsolutePath("./bin/bricks"),
+            ["bundle", "schema"]
+        );
+        return stdout;
+    }
+
     getAddProfileCommand(profile: string, host: URL): Command {
         return {
             command: this.context.asAbsolutePath("./bin/bricks"),

packages/databricks-vscode/src/extension.ts

@@ -21,6 +21,7 @@ import {workspaceConfigs} from "./WorkspaceConfigs";
 import {PackageJsonUtils, UtilsCommands} from "./utils";
 import {ConfigureAutocomplete} from "./language/ConfigureAutocomplete";
 import {WorkspaceFsCommands, WorkspaceFsDataProvider} from "./workspace-fs";
+import {generateBundleSchema} from "./bundle/GenerateBundle";
 
 export async function activate(
     context: ExtensionContext
@@ -297,6 +298,15 @@ export async function activate(
         )
     );
 
+    // generate a json schema for bundle root and load a custom provider into
+    // redhat.vscode-yaml extension to validate bundle config files with this schema
+    generateBundleSchema(cli).catch((e) => {
+        NamedLogger.getOrCreate("Extension").error(
+            "Failed to load bundle schema: ",
+            e
+        );
+    });
+
     connectionManager.login(false).catch((e) => {
         NamedLogger.getOrCreate("Extension").error("Login error", e);
     });