VSCode: Make plugin extensible (#96)

fjakobs · web-flow · commit f71584d85986 · 2022-09-14T17:43:52.000+02:00
See also paiqo/Databricks-VSCode#94 for how this API can be consumed. ![Screenshot 2022-09-14 at 11 03 53](https://user-images.githubusercontent.com/40952/190119140-49d43cb7-2b86-4139-8428-791ee15500e0.png)
diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -55,7 +55,7 @@ jobs:
             - run: mkdir -p packages/databricks-vscode/artifacts
 
             - name: Build VSIX
-              run: yarn workspace databricks package -o artifacts -t darwin-x64
+              run: yarn workspace databricks-vscode package -o artifacts -t darwin-x64
 
             - name: Upload artifacts
               uses: actions/upload-artifact@v3
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -129,7 +129,7 @@ jobs:
                   timeout_minutes: 10
                   retry_on: any
                   command: |
-                      yarn workspace databricks run test:integ:clean
+                      yarn workspace databricks-vscode run test:integ:clean
                       yarn install --immutable
                       yarn build
                       cd packages/databricks-vscode
diff --git a/databricks-vscode.code-workspace b/databricks-vscode.code-workspace
@@ -11,6 +11,10 @@
         {
             "path": "packages/databricks-vscode",
             "name": "Extension"
+        },
+        {
+            "path": "packages/databricks-vscode-types",
+            "name": "Extension Types"
         }
     ],
     "settings": {
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "databricks-vscode",
+    "name": "@databricks/databricks-vscode",
     "version": "0.0.1",
     "private": true,
     "workspaces": [
diff --git a/packages/databricks-vscode-types/.gitignore b/packages/databricks-vscode-types/.gitignore
@@ -0,0 +1,2 @@
+index.d.ts
+index.js
diff --git a/packages/databricks-vscode-types/README.md b/packages/databricks-vscode-types/README.md
@@ -0,0 +1,58 @@
+# Databricks Extension for VSCode Interfaces and Types
+
+Package with types and interfaces required for extending the Databricks VSCode extension.
+
+## How to extend the Databricks VSCode extension
+
+### Importing and using the API
+
+package.json
+
+```json
+{
+    ...
+    "extensionDependencies": [
+		"databricks.databricks-vscode"
+	],
+    "devDependencies": {
+        ...
+        "@databricks/databricks-vscode-types": "*",
+    }
+}
+```
+
+src/extension.ts
+
+```js
+import {PublicApi} from "@databricks/databricks-vscode-types";
+
+export async function activate(context: vscode.ExtensionContext) {
+    const dbExtension =
+        extensions.getExtension < PublicApi > "databricks.databricks-vscode";
+
+    if (!dbExtension) {
+        throw new Error("Databricks extension not installed");
+    }
+    await dbExtension.activate();
+    const dbApi = dbExtension.exports;
+    //...
+}
+```
+
+### Adding a view to the Databricks activity bar
+
+```js
+    "contributes" {
+        // ...
+		"views": {
+			"databricksBar": [
+				{
+					"id": "databricksJobs",
+					"name": "Jobs"
+				},
+                // ...
+            ],
+            // ...
+        }
+    }
+```
diff --git a/packages/databricks-vscode-types/index.ts b/packages/databricks-vscode-types/index.ts
@@ -0,0 +1,18 @@
+import {ApiClient} from "@databricks/databricks-sdk";
+import {Cluster} from "@databricks/databricks-sdk";
+import {Event} from "vscode";
+export type ConnectionState = "CONNECTED" | "CONNECTING" | "DISCONNECTED";
+
+export interface PublicApi {
+    connectionManager: {
+        onDidChangeState: Event<ConnectionState>;
+
+        get profile(): string | undefined;
+        get me(): string | undefined;
+        get state(): ConnectionState;
+        get cluster(): Cluster | undefined;
+        get apiClient(): ApiClient | undefined;
+
+        waitForConnect(): Promise<void>;
+    };
+}
diff --git a/packages/databricks-vscode-types/package.json b/packages/databricks-vscode-types/package.json
@@ -0,0 +1,27 @@
+{
+  "name": "@databricks/databricks-vscode-types",
+  "version": "1.0.0",
+  "description": "Package with types and interfaces to develop extensions to the Databricks VSCode plugin",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/databricks/databricks-vscode.git"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/databricks/databricks-vscode/issues"
+  },
+  "homepage": "https://github.com/databricks/databricks-vscode#readme",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w"
+  },
+  "devDependencies": {
+    "@types/vscode": "^1.69.1",
+    "typescript": "^4.8.3"
+  },
+  "dependencies": {
+    "@databricks/databricks-sdk": "workspace:^"
+  }
+}
diff --git a/packages/databricks-vscode-types/tsconfig.json b/packages/databricks-vscode-types/tsconfig.json
@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "module": "CommonJS",
+        "target": "ES2020",
+        "declaration": true,
+        "esModuleInterop": true,
+        "isolatedModules": true,
+        "lib": ["ES2020", "ES2021.String"],
+        "rootDir": ".",
+        "strict": true /* enable all strict type-checking options */
+    },
+    "include": ["*.ts"]
+}
diff --git a/packages/databricks-vscode/package.json b/packages/databricks-vscode/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "databricks",
+    "name": "databricks-vscode",
     "displayName": "Databricks for Visual Studio Code",
     "description": "IDE support for Databricks",
     "publisher": "databricks",
@@ -64,6 +64,7 @@
         "onDebugResolve:databricks-workflow"
     ],
     "main": "out/extension.js",
+    "types": "out/extension.d.ts",
     "contributes": {
         "commands": [
             {
@@ -452,7 +453,7 @@
         "test:unit": "yarn run build && node ./out/test/runTest.js",
         "test:integ:clean": "yarn run clean && rm -rf /tmp/vscode-test-databricks /tmp/databricks-vscode-test-extensions",
         "test:integ:prepare": "CODE_VERSION=1.69.1 && yarn run package && extest get-vscode --code_version $CODE_VERSION --storage /tmp/vscode-test-databricks && extest get-chromedriver --code_version 1.69.1 --storage /tmp/vscode-test-databricks",
-        "test:integ:install-vsix": "extest install-vsix --storage /tmp/vscode-test-databricks -f databricks-0.0.1.vsix -e /tmp/databricks-vscode-test-extensions",
+        "test:integ:install-vsix": "extest install-vsix --storage /tmp/vscode-test-databricks -f databricks-vscode*.vsix -e /tmp/databricks-vscode-test-extensions",
         "test:integ:run": "yarn run build && node out/test/e2e/scripts/e2e.js -e /tmp/databricks-vscode-test-extensions --storage /tmp/vscode-test-databricks --code_settings src/test/e2e/settings.json 'out/**/*.e2e.js'",
         "test:integ": "yarn run test:integ:prepare && yarn run test:integ:install-vsix && yarn run test:integ:run",
         "test:cov": "nyc yarn run test:unit",
@@ -461,6 +462,7 @@
     },
     "dependencies": {
         "@databricks/databricks-sdk": "*",
+        "@databricks/databricks-vscode-types": "workspace:^",
         "@vscode/debugadapter": "^1.57.0",
         "@vscode/webview-ui-toolkit": "^1.0.1"
     },
@@ -505,4 +507,4 @@
         ],
         "report-dir": "coverage"
     }
-}
+}
diff --git a/packages/databricks-vscode/src/configuration/ConnectionManager.ts b/packages/databricks-vscode/src/configuration/ConnectionManager.ts
@@ -317,14 +317,14 @@ export class ConnectionManager {
         }
     }
 
-    async waitForConnect() {
+    async waitForConnect(): Promise<void> {
         if (this._state === "CONNECTED") {
             return;
         } else if (this._state === "CONNECTING") {
             return await new Promise((resolve) => {
                 const changeListener = this.onDidChangeState(() => {
                     changeListener.dispose();
-                    resolve(resolve);
+                    resolve();
                 }, this);
             });
         }
diff --git a/packages/databricks-vscode/src/extension.ts b/packages/databricks-vscode/src/extension.ts
@@ -22,8 +22,9 @@ import {CodeSynchronizer} from "./sync/CodeSynchronizer";
 import {BricksTaskProvider} from "./cli/BricksTasks";
 import {ProjectConfigFileWatcher} from "./configuration/ProjectConfigFileWatcher";
 import {QuickstartCommands} from "./quickstart/QuickstartCommands";
+import {PublicApi} from "@databricks/databricks-vscode-types";
 
-export function activate(context: ExtensionContext) {
+export function activate(context: ExtensionContext): PublicApi {
     let cli = new CliWrapper(context);
     // Configuration group
     let connectionManager = new ConnectionManager(cli);
@@ -199,6 +200,10 @@ export function activate(context: ExtensionContext) {
             quickstartCommands
         )
     );
+
+    return {
+        connectionManager: connectionManager,
+    };
 }
 
 // this method is called when your extension is deactivated
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,10 @@`
`11`	`11`	`{`
`12`	`12`	`"path": "packages/databricks-vscode",`
`13`	`13`	`"name": "Extension"`
	`14`	`+ },`
	`15`	`+ {`
	`16`	`+ "path": "packages/databricks-vscode-types",`
	`17`	`+ "name": "Extension Types"`
`14`	`18`	`}`
`15`	`19`	`],`
`16`	`20`	`"settings": {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "databricks-vscode",`
	`2`	`+ "name": "@databricks/databricks-vscode",`
`3`	`3`	`"version": "0.0.1",`
`4`	`4`	`"private": true,`
`5`	`5`	`"workspaces": [`