Show deploy and run commands in terminal (#1020)

## Changes
* show commands for deploying a bundle and running it in the terminal
* synchronise deploys so multiple deploys do not occur simultaneously
## Tests
<!-- How is this tested? -->

Author: kartikgupta-db

packages/databricks-vscode/package.json

@@ -772,13 +772,15 @@
         "@databricks/databricks-sdk": "file:../../vendor/databricks-sdk.tgz",
         "@databricks/databricks-vscode-types": "workspace:^",
         "@types/lodash": "^4.14.202",
+        "@types/shell-quote": "^1.7.5",
         "@vscode/debugadapter": "^1.64.0",
         "@vscode/extension-telemetry": "^0.9.1",
         "@vscode/webview-ui-toolkit": "^1.4.0",
         "add": "^2.0.6",
         "ansi-to-html": "^0.7.2",
         "bcryptjs": "^2.4.3",
         "lodash": "^4.17.21",
+        "shell-quote": "^1.8.1",
         "triple-beam": "^1.4.1",
         "winston": "^3.11.0",
         "yaml": "^2.3.4"

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

@@ -7,6 +7,7 @@ import {
     ResourceTreeNode as BundleResourceExplorerResourceTreeNode,
 } from "../ui/bundle-resource-explorer/types";
 import {BundleRunStatusManager} from "./run/BundleRunStatusManager";
+import {Mutex} from "../locking";
 
 const RUNNABLE_RESOURCES = [
     "pipelines",
@@ -38,6 +39,9 @@ export class BundleCommands implements Disposable {
         );
     }
 
+    private refreshStateMutex = new Mutex();
+
+    @Mutex.synchronise("refreshStateMutex")
     async refreshRemoteState() {
         await window.withProgress(
             {location: {viewId: "dabsResourceExplorerView"}},
@@ -61,6 +65,9 @@ export class BundleCommands implements Disposable {
         await this.refreshRemoteState();
     }
 
+    private deployMutex = new Mutex();
+
+    @Mutex.synchronise("deployMutex")
     async deploy() {
         this.prepareOutputChannel();
         await window.withProgress(

packages/databricks-vscode/src/bundle/run/CustomOutputTerminal.ts

@@ -1,4 +1,5 @@
 import {ChildProcess, SpawnOptions, spawn} from "child_process";
+import {quote} from "shell-quote";
 import {Pseudoterminal, Event, EventEmitter} from "vscode";
 
 export class CustomOutputTerminal implements Pseudoterminal {
@@ -33,7 +34,9 @@ export class CustomOutputTerminal implements Pseudoterminal {
         options: SpawnOptions;
     }): void {
         this.isClosed = false;
-        this.writeEmitter.fire("\x1b[2J\x1b[H");
+        this.writeEmitter.fire("\x1b[2J\x1b[H\r\n");
+        this.writeEmitter.fire(quote([cmd, ...args]) + "\r\n\r\n");
+
         this._process = spawn(cmd, args, options);
         if (!this.process) {
             throw new Error("Can't start process: process is undefined");

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

@@ -15,6 +15,7 @@ import {Cloud} from "../utils/constants";
 import {EnvVarGenerators, UrlUtils} from "../utils";
 import {AuthProvider} from "../configuration/auth/AuthProvider";
 import {removeUndefinedKeys} from "../utils/envVarGenerators";
+import {quote} from "shell-quote";
 
 const withLogContext = logging.withLogContext;
 const execFile = promisify(execFileCb);
@@ -292,28 +293,25 @@ export class CliWrapper {
         onStdOut?: (data: string) => void,
         onStdError?: (data: string) => void
     ) {
+        const cmd = [this.cliPath, "bundle", "deploy", "--target", target];
         if (onStdError) {
-            onStdError(`Deploying the bundle for target ${target}...\n\n`);
-            onStdError(`${this.cliPath} bundle deploy --target ${target}\n`);
+            onStdError(`Deploying the bundle for target ${target}...\n`);
             if (this.clusterId) {
                 onStdError(`DATABRICKS_CLUSTER_ID=${this.clusterId}\n\n`);
             }
+            onStdOut?.(quote(cmd) + "\n\n");
         }
-        const p = spawn(
-            this.cliPath,
-            ["bundle", "deploy", "--target", target],
-            {
-                cwd: workspaceFolder.fsPath,
-                env: {
-                    ...EnvVarGenerators.getEnvVarsForCli(configfilePath),
-                    ...EnvVarGenerators.getProxyEnvVars(),
-                    ...authProvider.toEnv(),
-                    // eslint-disable-next-line @typescript-eslint/naming-convention
-                    DATABRICKS_CLUSTER_ID: this.clusterId,
-                },
-                shell: true,
-            }
-        );
+        const p = spawn(cmd[0], cmd.slice(1), {
+            cwd: workspaceFolder.fsPath,
+            env: {
+                ...EnvVarGenerators.getEnvVarsForCli(configfilePath),
+                ...EnvVarGenerators.getProxyEnvVars(),
+                ...authProvider.toEnv(),
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                DATABRICKS_CLUSTER_ID: this.clusterId,
+            },
+            shell: true,
+        });
 
         return await waitForProcess(p, onStdOut, onStdError);
     }

yarn.lock

@@ -1558,6 +1558,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/shell-quote@npm:^1.7.5":
+  version: 1.7.5
+  resolution: "@types/shell-quote@npm:1.7.5"
+  checksum: 32b4d697c7d23dbadf40713692c47f1595f083a3b3deea76cb18e30a05d197aa9205d2b87f6d92edb60cda120b51e35d32bda96ed9b0a7e32921eed2deb4559e
+  languageName: node
+  linkType: hard
+
 "@types/sinonjs__fake-timers@npm:^8.1.5":
   version: 8.1.5
   resolution: "@types/sinonjs__fake-timers@npm:8.1.5"
@@ -3617,6 +3624,7 @@ __metadata:
     "@types/mocha": ^10.0.6
     "@types/mock-require": ^2.0.3
     "@types/node": ^20.10.4
+    "@types/shell-quote": ^1.7.5
     "@types/sinonjs__fake-timers": ^8.1.5
     "@types/tmp": ^0.2.6
     "@types/triple-beam": ^1.3.5
@@ -3649,6 +3657,7 @@ __metadata:
     mock-require: ^3.0.3
     nyc: ^15.1.0
     prettier: ^3.1.1
+    shell-quote: ^1.8.1
     tmp-promise: ^3.0.3
     triple-beam: ^1.4.1
     ts-mocha: ^10.0.0
@@ -9338,6 +9347,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"shell-quote@npm:^1.8.1":
+  version: 1.8.1
+  resolution: "shell-quote@npm:1.8.1"
+  checksum: 5f01201f4ef504d4c6a9d0d283fa17075f6770bfbe4c5850b074974c68062f37929ca61700d95ad2ac8822e14e8c4b990ca0e6e9272e64befd74ce5e19f0736b
+  languageName: node
+  linkType: hard
+
 "side-channel@npm:^1.0.4":
   version: 1.0.4
   resolution: "side-channel@npm:1.0.4"