Allow running scala/r/sql notebooks as workflow (#402)

https://user-images.githubusercontent.com/40952/215535517-6e5308c5-1d22-4ad1-a254-4949c5ecf2d7.mov

Author: fjakobs

packages/databricks-vscode/package.json

@@ -346,7 +346,7 @@
                 },
                 {
                     "command": "databricks.run.runEditorContentsAsWorkflow",
-                    "when": "resourceLangId == python || resourceExtname == .ipynb",
+                    "when": "resourceLangId == python || resourceLangId == scala || resourceLangId == r || resourceLangId == sql || resourceExtname == .ipynb",
                     "group": "navigation@1"
                 }
             ],
@@ -464,7 +464,10 @@
             {
                 "type": "databricks-workflow",
                 "languages": [
-                    "python"
+                    "python",
+                    "sql",
+                    "r",
+                    "scala"
                 ],
                 "label": "Databricks Workflow",
                 "configurationAttributes": {
@@ -666,4 +669,4 @@
         ],
         "report-dir": "coverage"
     }
-}
+}

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

@@ -231,7 +231,7 @@ export class ConnectionCommands implements Disposable {
                     alwaysShow: true,
                     detail: workspaceConfigs.enableFilesInWorkspace
                         ? ""
-                        : `Open Databricks in the browser and create a new repo under /Repo/${me}`,
+                        : `Open Databricks in the browser and create a new Repo under /Repo/${me}`,
                 },
                 {
                     label: "",

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

@@ -376,7 +376,7 @@ export class ConnectionManager {
                 this.databricksWorkspace === undefined
             ) {
                 throw new Error(
-                    "Can't attach a Repo when profile is not connected"
+                    "Can't attach a Sync Destination when profile is not connected"
                 );
             }
             if (!(await SyncDestination.validateRemote(this, workspacePath))) {

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

@@ -157,7 +157,7 @@ export class SyncDestination {
     localToRemoteNotebook(localPath: Uri): string {
         assert.equal(localPath.scheme, "file");
         return this.localToRemote(localPath).replace(
-            /^\/Workspace(\/.*)\.(py|ipynb)/g,
+            /^\/Workspace(\/.*)\.(py|ipynb|scala|r|sql)/g,
             "$1"
         );
     }

packages/databricks-vscode/src/run/DatabricksWorkflowDebugAdapter.ts

@@ -25,6 +25,7 @@ import {Subject} from "./Subject";
 import {WorkflowRunner} from "./WorkflowRunner";
 import {promptForClusterStart} from "./prompts";
 import {CodeSynchronizer} from "../sync/CodeSynchronizer";
+import {isNotebook} from "../utils";
 
 /**
  * This interface describes the mock-debug specific launch attributes
@@ -154,6 +155,13 @@ export class DatabricksWorkflowDebugSession extends LoggingDebugSession {
         parameters: Record<string, string>,
         args: Array<string>
     ): Promise<void> {
+        if (
+            !(await isNotebook(Uri.file(program))) &&
+            !program.endsWith(".py")
+        ) {
+            return this.onError("Only Python files can be run as a workflow");
+        }
+
         if (this.connection.state === "CONNECTING") {
             await this.connection.waitForConnect();
         }

packages/databricks-vscode/src/run/RunCommands.ts

@@ -34,12 +34,12 @@ export class RunCommands {
                 if (this.connection.syncDestination === undefined) {
                     await promptForAttachingSyncDest(async () => {
                         window.showErrorMessage(
-                            "Execution cancelled because no Databricks Repo is attached"
+                            "Execution cancelled because no Sync Destination is configured"
                         );
                     });
                     if (this.connection.syncDestination === undefined) {
                         window.showErrorMessage(
-                            "Execution cancelled because no Databricks Repo is attached"
+                            "Execution cancelled because no Sync Destination is configured"
                         );
                         return;
                     }
@@ -73,12 +73,12 @@ export class RunCommands {
                 if (this.connection.syncDestination === undefined) {
                     await promptForAttachingSyncDest(async () => {
                         window.showErrorMessage(
-                            "Execution cancelled because no Databricks Repo is attached"
+                            "Execution cancelled because no Sync Destination is configured"
                         );
                     });
                     if (this.connection.syncDestination === undefined) {
                         window.showErrorMessage(
-                            "Execution cancelled because no Databricks Repo is attached"
+                            "Execution cancelled because no Sync Destination is configured"
                         );
                         return;
                     }

packages/databricks-vscode/src/run/prompts.ts

@@ -30,12 +30,12 @@ export async function promptForAttachingSyncDest(
     onAccept: () => Promise<void> = async () => {}
 ) {
     const response = await window.showErrorMessage(
-        "Please configure a Databricks Repo for syncing",
-        "Attach Repo",
+        "Please configure a Sync Destination",
+        "Configure Sync Destination",
         "Cancel"
     );
     switch (response) {
-        case "Attach Repo":
+        case "Configure Sync Destination":
             await commands.executeCommand(
                 "databricks.connection.attachSyncDestination"
             );

packages/databricks-vscode/src/sync/CodeSynchronizer.ts

@@ -83,7 +83,7 @@ export class CodeSynchronizer implements Disposable {
 
     // This function waits for sync to reach WATCHING_FOR_CHANGES which is a
     // necessary condition to execute local code on databricks. This state denotes
-    // all local changes have been synced to remote workspace repo
+    // all local changes have been synced to remote workspace
     async waitForSyncComplete(): Promise<void> {
         if (this._state !== "WATCHING_FOR_CHANGES") {
             return await new Promise((resolve) => {

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

@@ -2,12 +2,26 @@ import {TextDecoder} from "util";
 import {Uri, workspace} from "vscode";
 
 export async function isNotebook(uri: Uri): Promise<boolean> {
-    if (uri.path.match(/\.ipynb$/)) {
+    const ext = uri.path.split(".").pop()?.toLowerCase();
+    if (!ext) {
+        return false;
+    }
+
+    if (ext === "ipynb") {
         return true;
     }
+
+    const comment = {
+        py: "#",
+        scala: "//",
+        sql: "--",
+        r: "#",
+    }[ext];
+
     const bytes = await workspace.fs.readFile(uri);
     const lines = new TextDecoder().decode(bytes).split(/\r?\n/);
     return (
-        lines.length > 0 && lines[0].startsWith("# Databricks notebook source")
+        lines.length > 0 &&
+        lines[0].startsWith(`${comment} Databricks notebook source`)
     );
 }