LSP server Integration via vscode-python-tools-extension + pivot away from FastAPI to direct ZenML library use

.eslintrc

@@ -0,0 +1,19 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+
+  "rules": {
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"]
+  },
+
+  "env": {
+    "browser": true,
+    "es2021": true
+  }
+}

.eslintrc.json

@@ -0,0 +1,24 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/naming-convention": [
+      "warn",
+      {
+        "selector": "import",
+        "format": ["camelCase", "PascalCase"]
+      }
+    ],
+    "@typescript-eslint/semi": "warn",
+    "curly": "warn",
+    "eqeqeq": "warn",
+    "no-throw-literal": "warn",
+    "semi": "off"
+  },
+  "ignorePatterns": ["out", "dist", "**/*.d.ts"]
+}

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: VSCode Extension CI
+
+on: [push, pull_request]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18.x'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build VSCode Extension
+        run: npm run compile
+
+      - name: Run VSCode Extension Formatter
+        run: npm run format
+
+      - name: Run VSCode Extension Linter
+        run: npm run lint
+
+      - name: Run headless test
+        uses: coactions/setup-xvfb@v1
+        with:
+          run: npm test

.gitignore

@@ -0,0 +1,40 @@
+.DS_Store
+Thumbs.db
+.vscode-test/
+.idea/
+.eslintcache
+lib-cov
+*.log
+*.log*
+pids
+
+# Node
+.npm/
+node_modules/
+package-lock.json
+npm-debug.log
+
+# Build outputs
+dist/
+out/
+build/
+*.tsbuildinfo
+.history/
+
+# env
+.env
+.env*
+
+# Output of 'npm pack'
+*.tgz
+
+# From vscode-python-tools-extension-template
+*.vsix
+.venv/
+.vs/
+.nox/
+bundled/libs/
+**/__pycache__
+**/.pytest_cache
+**/.vs
+

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "proseWrap": "preserve",
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "trailingComma": "es5",
+  "bracketSpacing": true
+}

.pylintrc

@@ -0,0 +1,7 @@
+[MESSAGES CONTROL]
+disable=
+    C0103, # Name doesn't conform to naming style
+    C0415, # Import outside toplevel
+    W0613, # Unused argument
+    R0801, # Similar lines in multiple files
+    R0903, # Too few public methods

.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "amodio.tsl-problem-matcher",
+    "ms-vscode.extension-test-runner"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,18 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}",
+      "timeout": 20000
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,19 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+  "python.defaultInterpreterPath": "",
+  "files.exclude": {
+    "out": false, // set this to true to hide the "out" folder with the compiled JS files
+    "dist": false // set this to true to hide the "dist" folder with the compiled JS files
+  },
+  "search.exclude": {
+    "out": true, // set this to false to include "out" folder in search results
+    "dist": true // set this to false to include "dist" folder in search results
+  },
+  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+  "typescript.tsc.autoDetect": "off",
+  "python.testing.pytestArgs": ["src/test/python_tests"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "python.testing.cwd": "${workspaceFolder}",
+  "python.analysis.extraPaths": ["bundled/libs", "bundled/tool"]
+}

.vscode/tasks.json

@@ -0,0 +1,45 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": "$ts-webpack-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never",
+        "group": "watchers"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "type": "npm",
+      "script": "watch-tests",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never",
+        "group": "watchers"
+      },
+      "group": "build"
+    },
+    {
+      "label": "tasks: watch-tests",
+      "dependsOn": ["npm: watch", "npm: watch-tests"],
+      "problemMatcher": []
+    },
+    {
+      "type": "npm",
+      "script": "compile",
+      "group": "build",
+      "problemMatcher": [],
+      "label": "npm: compile",
+      "detail": "webpack"
+    }
+  ]
+}

.vscodeignore

@@ -0,0 +1,15 @@
+.vscode/**
+.vscode-test/**
+out/**
+node_modules/**
+src/**
+.gitignore
+.yarnrc
+webpack.config.js
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.js.map
+**/*.ts
+**/.vscode-test.*

README.md

@@ -1,2 +1,43 @@
 # vscode-zenml
-VSCode extension for ZenML
+
+![](resources/zenml-extension.gif)
+
+The ZenML VSCode extension seamlessly integrates with the ZenML CLI to enhance your MLOps workflow within VSCode. It is designed to accurately mirror the current state of your ZenML environment within your IDE, ensuring a smooth and integrated experience.
+
+## Features
+
+- **Server, Stacks, and Pipeline Runs Views**: Interact directly with ML stacks, pipeline runs, and server configurations from the Activity Bar.
+- **Python Tool Integration**: Utilizes a Language Server Protocol (LSP) server for real-time synchronization with the ZenML environment.
+- **Real-Time Configuration Monitoring**: Leverages `watchdog` to dynamically update configurations, keeping the extension in sync with your ZenML setup.
+- **Status Bar Indicators**: Display the current stack name and connection status.
+
+## Getting Started
+
+1. **Install the Extension**: Search for "ZenML" in the VSCode Extensions view (`Ctrl+Shift+X`) and install it.
+2. **Connect to ZenML Server**: Use the `ZenML: Connect` command to connect to your ZenML server.
+3. **Explore ZenML Views**: Navigate to the ZenML activity bar to access the Server, Stacks, and Pipeline Runs views.
+
+## Using ZenML in VSCode
+
+- **Manage Server Connections**: Connect or disconnect from ZenML servers and refresh server status.
+- **Stack Operations**: View stack details, rename, copy, or set active stacks directly from VSCode.
+- **Pipeline Runs**: Monitor and manage pipeline runs, including deleting runs from the system.
+- **Environment Information**: Get detailed snapshots of the development environment, aiding troubleshooting.
+
+## Requirements
+
+- **ZenML Installation:** ZenML needs to be installed in the local Python environment associated with the Python interpreter selected in the current VS Code workspace. This extension interacts directly with your ZenML environment, so ensuring that ZenML is installed and properly configured is essential.
+- **ZenML Version**: To ensure full functionality and compatibility, make sure you have ZenML version 0.55.0 or newer.
+- **Python Version**: Python 3.8 or greateris required for the operation of the LSP server, which is a part of this extension.
+
+## Feedback and Contributions
+
+Your feedback and contributions are welcome! Please refer to our [contribution guidelines](https://github.com/zenml-io/vscode-zenml/CONTRIBUTING.md) for more information.
+
+## License
+
+Apache-2.0
+
+---
+
+ZenML © 2024, ZenML. Released under the [Apache-2.0 License](LICENSE).

bundled/tool/__init__.py

@@ -0,0 +1,12 @@
+#  Copyright (c) ZenML GmbH 2024. All Rights Reserved.
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.

bundled/tool/_debug_server.py

@@ -0,0 +1,52 @@
+#  Copyright (c) ZenML GmbH 2024. All Rights Reserved.
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+
+"""Debugging support for LSP."""
+
+import os
+import pathlib
+import runpy
+import sys
+
+
+def update_sys_path(path_to_add: str) -> None:
+    """Add given path to `sys.path`."""
+    if path_to_add not in sys.path and os.path.isdir(path_to_add):
+        sys.path.append(path_to_add)
+
+
+# Ensure debugger is loaded before we load anything else, to debug initialization.
+debugger_path = os.getenv("DEBUGPY_PATH", None)
+if debugger_path:
+    if debugger_path.endswith("debugpy"):
+        debugger_path = os.fspath(pathlib.Path(debugger_path).parent)
+
+    # pylint: disable=wrong-import-position,import-error
+    import debugpy
+
+    update_sys_path(debugger_path)
+
+    # pylint: disable=wrong-import-position,import-error
+
+    # 5678 is the default port, If you need to change it update it here
+    # and in launch.json.
+    debugpy.connect(5678)
+
+    # This will ensure that execution is paused as soon as the debugger
+    # connects to VS Code. If you don't want to pause here comment this
+    # line and set breakpoints as appropriate.
+    debugpy.breakpoint()
+
+SERVER_PATH = os.fspath(pathlib.Path(__file__).parent / "lsp_server.py")
+# NOTE: Set breakpoint in `lsp_server.py` before continuing.
+runpy.run_path(SERVER_PATH, run_name="__main__")

bundled/tool/constants.py

@@ -0,0 +1,26 @@
+#  Copyright (c) ZenML GmbH 2024. All Rights Reserved.
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at:
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+#  or implied. See the License for the specific language governing
+#  permissions and limitations under the License.
+
+"""Constants for ZenML Tool"""
+
+TOOL_MODULE_NAME = "zenml-python"
+TOOL_DISPLAY_NAME = "ZenML"
+MIN_ZENML_VERSION = "0.55.0"
+
+"""Constants for ZenML Notifications and Events"""
+
+IS_ZENML_INSTALLED = "zenml/isInstalled"
+ZENML_CLIENT_INITIALIZED = "zenml/clientInitialized"
+ZENML_SERVER_CHANGED = "zenml/serverChanged"
+ZENML_STACK_CHANGED = "zenml/stackChanged"
+ZENML_REQUIREMENTS_NOT_MET = "zenml/requirementsNotMet"