Architecture & design decisions: docs/ARCHITECTURE.md
Integrates VS Code with the Essedum AI Platform: OAuth 2.0/PKCE authentication, pipeline browsing, job submission, and real-time execution monitoring.
Features
- OAuth 2.0 / PKCE Authentication — one-click login via Keycloak, no manual token copying
- Pipeline Browsing — view available pipelines from the Activity Bar sidebar
- Job Submission — submit and monitor pipeline executions without leaving the editor
- Automatic Token Refresh — seamless session management
Requirements
- VS Code 1.103.0+
- Active Essedum Platform account
- Port 8085 available (OAuth callback — configurable)
Installation
- Install the extension via VS Code Extensions Marketplace
- Reload VS Code
- The Essedum icon will appear in the Activity Bar
Design and Architecture
The extension acts as a client for the Essedum Platform.
Architecture Overview
- Extension Host: Runs in the VS Code process.
- Sidebar Provider: Renders the UI for managing platform resources.
- Command Palette: Exposes commands for quick access.
- Authentication Module:
- Implements PKCE (Proof Key for Code Exchange) flow.
- Launches system browser for login.
- Listens on a local port for the callback code.
- API Client:
- Communicates with the Essedum Backend (e.g.,
https://aiplatform...).
- Attaches Bearer tokens to requests.
Authentication Flow
sequenceDiagram
participant User
participant VSCode as VS Code Ext
participant Browser
participant Keycloak
User->>VSCode: Click Login
VSCode->>VSCode: Generate PKCE Challenge
VSCode->>Browser: Open Keycloak Login URL
Browser->>Keycloak: User Authenticates
Keycloak->>Browser: Redirect to localhost:8085 with Code
Browser->>VSCode: Send Code (Callback)
VSCode->>Keycloak: Exchange Code for Token
Keycloak-->>VSCode: Access Token + Refresh Token
VSCode->>VSCode: Store Token
| |
