Don't run notebooks with Run on Databricks (#132)

https://user-images.githubusercontent.com/88345179/197475652-13dbbe77-3e40-4515-8335-7506ca6d5119.mov

Author: kartikgupta-db

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

@@ -1,5 +1,6 @@
 import {commands, debug, Uri, window} from "vscode";
 import {ConnectionManager} from "../configuration/ConnectionManager";
+import {isNotebook} from "../utils";
 
 /**
  * Run related commands
@@ -14,6 +15,13 @@ export class RunCommands {
         return async (resource: Uri) => {
             let targetResource = this.getTargetResource(resource);
             if (targetResource) {
+                if (await isNotebook(targetResource)) {
+                    await window.showErrorMessage(
+                        'Use "Run File as Workflow on Databricks" for running notebooks'
+                    );
+                    return;
+                }
+
                 if (this.connection.state === "CONNECTING") {
                     await this.connection.waitForConnect();
                 }

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

@@ -19,6 +19,7 @@ import {
     workspace,
 } from "vscode";
 import {SyncDestination} from "../configuration/SyncDestination";
+import {isNotebook} from "../utils";
 
 // TODO: add dispose, add persistence, reuse panel
 
@@ -112,14 +113,6 @@ export async function runAsWorkflow({
     }
 }
 
-async function isNotebook(uri: Uri): Promise<boolean> {
-    let 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")
-    );
-}
-
 export class WorkflowOutputPanel {
     private run?: WorkflowRun;
     constructor(private panel: WebviewPanel, private extensionUri: Uri) {

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

@@ -0,0 +1,10 @@
+import {TextDecoder} from "util";
+import {Uri, workspace} from "vscode";
+
+export async function isNotebook(uri: Uri): Promise<boolean> {
+    let 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")
+    );
+}

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

@@ -0,0 +1,24 @@
+import assert from "assert";
+import fs from "fs/promises";
+import {withFile} from "tmp-promise";
+import {Uri} from "vscode";
+import {isNotebook} from "./fileUtils";
+
+describe(__filename, async () => {
+    it("should detect notebook", async () => {
+        withFile(async (file) => {
+            await fs.writeFile(
+                file.path,
+                Buffer.from("# Databricks notebook source\ncontent")
+            );
+            assert.ok(await isNotebook(Uri.parse(file.path)));
+        });
+    });
+
+    it("should detect if not notebook", async () => {
+        withFile(async (file) => {
+            await fs.writeFile(file.path, Buffer.from("content"));
+            assert.ok(!(await isNotebook(Uri.parse(file.path))));
+        });
+    });
+});

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

@@ -0,0 +1 @@
+export * from "./FileUtils";