Show 'Create New Repo' prompt which opens host in browser (#138)

https://user-images.githubusercontent.com/88345179/198254984-4bcf31f0-a658-4607-ae05-82a7786cbeab.mov

Author: kartikgupta-db

packages/databricks-vscode/src/configuration/ConnectionCommands.ts

@@ -1,9 +1,10 @@
-import {Cluster, Repo} from "@databricks/databricks-sdk";
+import {Cluster, Repo, WorkspaceService} from "@databricks/databricks-sdk";
 import {homedir} from "node:os";
 import {resolve} from "node:path";
 import {
     Disposable,
     QuickPickItem,
+    QuickPickItemKind,
     ThemeIcon,
     Uri,
     window,
@@ -12,6 +13,7 @@ import {
 import {ClusterListDataProvider} from "../cluster/ClusterListDataProvider";
 import {ClusterModel} from "../cluster/ClusterModel";
 import {ConnectionManager} from "./ConnectionManager";
+import {UrlUtils} from "../utils";
 
 function formatQuickPickClusterSize(sizeInMB: number): string {
     if (sizeInMB > 1024) {
@@ -37,8 +39,8 @@ export function formatQuickPickClusterDetails(cluster: Cluster) {
 }
 
 export interface WorkspaceItem extends QuickPickItem {
-    id: number;
-    path: string;
+    id?: number;
+    path?: string;
 }
 
 export interface ClusterItem extends QuickPickItem {
@@ -170,32 +172,59 @@ export class ConnectionCommands implements Disposable {
 
             quickPick.busy = true;
             quickPick.canSelectMany = false;
+            const items: WorkspaceItem[] = [
+                {
+                    label: "Create New Repo",
+                    detail: `Open databricks in browser and create a new repo under /Repo/${me}`,
+                    alwaysShow: true,
+                },
+                {
+                    label: "",
+                    kind: QuickPickItemKind.Separator,
+                },
+            ];
+            quickPick.items = items;
+
             quickPick.show();
 
             let repos = await Repo.list(apiClient, {
                 // eslint-disable-next-line @typescript-eslint/naming-convention
                 path_prefix: `/Repos/${me}`,
             });
 
-            quickPick.items = repos!.map((r) => ({
-                label: r.path.split("/").pop() || "",
-                detail: r.path,
-                path: r.path,
-                id: r.id,
-            }));
+            quickPick.items = items.concat(
+                ...repos!.map((r) => ({
+                    label: r.path.split("/").pop() || "",
+                    detail: r.path,
+                    path: r.path,
+                    id: r.id,
+                }))
+            );
             quickPick.busy = false;
 
             await new Promise<void>((resolve) => {
                 quickPick.onDidAccept(async () => {
-                    const repoPath = quickPick.selectedItems[0].path;
-                    await this.connectionManager.attachSyncDestination(
-                        Uri.from({
-                            scheme: "dbws",
-                            path: repoPath,
-                        })
-                    );
-                    quickPick.dispose();
-                    resolve();
+                    if (
+                        quickPick.selectedItems[0].label === "Create New Repo"
+                    ) {
+                        await UrlUtils.openExternal(
+                            `${
+                                (
+                                    await this.connectionManager.apiClient?.host
+                                )?.href ?? ""
+                            }#folder/${this.connectionManager.repoRootId ?? ""}`
+                        );
+                    } else {
+                        const repoPath = quickPick.selectedItems[0].path;
+                        await this.connectionManager.attachSyncDestination(
+                            Uri.from({
+                                scheme: "dbws",
+                                path: repoPath,
+                            })
+                        );
+                        quickPick.dispose();
+                        resolve();
+                    }
                 });
 
                 quickPick.onDidHide(() => {

packages/databricks-vscode/src/configuration/ConnectionManager.ts

@@ -5,6 +5,8 @@ import {
     CredentialProvider,
     WorkspaceConf,
     scim,
+    WorkspaceService,
+    HttpError,
 } from "@databricks/databricks-sdk";
 import {
     env,
@@ -19,6 +21,7 @@ import {SyncDestination} from "./SyncDestination";
 import {ProjectConfigFile} from "./ProjectConfigFile";
 import {selectProfile} from "./selectProfileWizard";
 import {ClusterManager} from "../cluster/ClusterManager";
+import {workspace} from "@databricks/databricks-sdk";
 import {DatabricksWorkspace} from "./DatabricksWorkspace";
 
 const extensionVersion = require("../../package.json").version;
@@ -37,6 +40,7 @@ export class ConnectionManager {
     private _syncDestination?: SyncDestination;
     private _projectConfigFile?: ProjectConfigFile;
     private _clusterManager?: ClusterManager;
+    private _repoRootDetails?: workspace.ObjectInfo;
     private _databricksWorkspace?: DatabricksWorkspace;
 
     private readonly onDidChangeStateEmitter: EventEmitter<ConnectionState> =
@@ -71,6 +75,9 @@ export class ConnectionManager {
         return this._syncDestination;
     }
 
+    get repoRootId() {
+        return this._repoRootDetails?.object_id;
+    }
     get databricksWorkspace(): DatabricksWorkspace | undefined {
         return this._databricksWorkspace;
     }
@@ -180,6 +187,18 @@ export class ConnectionManager {
             this.updateSyncDestination(undefined);
         }
 
+        try {
+            this._repoRootDetails = await new WorkspaceService(
+                apiClient
+            ).getStatus({
+                path: `/Repos/${this.databricksWorkspace?.userName}`,
+            });
+        } catch (e) {
+            if (!(e instanceof HttpError && e.code === 404)) {
+                throw e;
+            }
+        }
+
         this.updateState("CONNECTED");
     }
 
@@ -192,6 +211,7 @@ export class ConnectionManager {
 
         this._projectConfigFile = undefined;
         this._apiClient = undefined;
+        this._repoRootDetails = undefined;
         this._databricksWorkspace = undefined;
         this.updateCluster(undefined);
         this.updateSyncDestination(undefined);

packages/databricks-vscode/src/utils/UtilsCommands.ts

@@ -1,15 +1,13 @@
 import {Disposable, env, TreeItem, Uri, window} from "vscode";
+import {openExternal} from "./urlUtils";
 
 export class UtilsCommands implements Disposable {
     private disposables: Disposable[] = [];
     constructor() {}
 
     openExternalCommand() {
         return async (value: TreeItem) => {
-            const url = `${value.description}`.startsWith("http")
-                ? `${value.description}`
-                : `https://${value.description}`;
-            await env.openExternal(Uri.parse(url, true));
+            await openExternal(`${value.description}`);
         };
     }
 

packages/databricks-vscode/src/utils/index.ts

@@ -1 +1,3 @@
 export * from "./fileUtils";
+export * as UrlUtils from "./urlUtils";
+export * from "./UtilsCommands";

packages/databricks-vscode/src/utils/urlUtils.test.ts

@@ -0,0 +1,18 @@
+import assert from "assert";
+import {addHttpsIfNoProtocol} from "./urlUtils";
+
+describe(__filename, () => {
+    it("should add https if the url does not have it", () => {
+        assert(
+            addHttpsIfNoProtocol("www.example.com"),
+            "https://www.example.com"
+        );
+    });
+
+    it("should not add https if url has it", () => {
+        assert(
+            addHttpsIfNoProtocol("https://www.example.com"),
+            "https://www.example.com"
+        );
+    });
+});

packages/databricks-vscode/src/utils/urlUtils.ts

@@ -0,0 +1,8 @@
+import {env, Uri} from "vscode";
+
+export function addHttpsIfNoProtocol(url: string) {
+    return `${url}`.startsWith("http") ? `${url}` : `https://${url}`;
+}
+export async function openExternal(url: string) {
+    await env.openExternal(Uri.parse(addHttpsIfNoProtocol(url), true));
+}