feat: Add Analytics webview panel (#269)

Author: Hellebore

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Cache dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ~/.npm
         key: npm-${{ hashFiles('package-lock.json') }}

package.json

@@ -156,7 +156,7 @@
 			},
 			{
 				"command": "sourcery.hub.start",
-				"title": "Manage Sourcery account",
+				"title": "Open Sourcery Analytics",
 				"category": "Sourcery"
 			},
 			{

src/chat.ts

@@ -61,6 +61,7 @@ export class ChatProvider implements vscode.WebviewViewProvider {
   private _view?: vscode.WebviewView;
   private _extensionUri: vscode.Uri;
   private _assetsUri: vscode.Uri;
+  private _panel?: vscode.WebviewPanel; // Track the current panel
 
   public recipes: Recipe[] = []; // this data is used in the "Ask Sourcery" command prompt, so can't be removed
 
@@ -131,6 +132,77 @@ export class ChatProvider implements vscode.WebviewViewProvider {
     );
   }
 
+  /**
+   * Creates a new webview panel with chat functionality or reveals an existing one
+   */
+  public async createOrShowWebviewPanel(): Promise<vscode.WebviewPanel> {
+    if (this._panel) {
+      // If panel already exists, reveal it
+      this._panel.reveal();
+      return this._panel;
+    }
+
+    // Create a new panel
+    const panel = vscode.window.createWebviewPanel(
+      "sourceryChatPanel", // Unique identifier
+      "Analytics", // Title
+      vscode.ViewColumn.Active,
+      {
+        enableScripts: true,
+        retainContextWhenHidden: true,
+        localResourceRoots: [this._extensionUri, this._assetsUri],
+      }
+    );
+
+    // Set the panel's HTML content
+    panel.webview.html = await this._getHtmlForWebview(panel.webview);
+
+    // Set up message handling
+    panel.webview.onDidReceiveMessage(
+      async ({ message, ...rest }: { message: OutboundMessage }) => {
+        switch (message.target) {
+          case "languageServer":
+            vscode.commands.executeCommand("sourcery.coding_assistant", {
+              message,
+              ...rest,
+            });
+            break;
+          case "extension":
+            switch (message.request) {
+              case "openLink":
+                this.handleOpenLinkRequest(message);
+                break;
+              case "copyToClipboard": {
+                this.handleCopyToClipboardRequest(message);
+                break;
+              }
+              case "insertAtCursor": {
+                this.handleInsertAtCursorRequest(message);
+                break;
+              }
+              case "updateConfiguration": {
+                await vscode.workspace
+                  .getConfiguration()
+                  .update(
+                    message.section,
+                    message.value,
+                    message.configurationTarget
+                  );
+              }
+            }
+        }
+      }
+    );
+
+    // Track this panel and handle disposal
+    this._panel = panel;
+    panel.onDidDispose(() => {
+      this._panel = undefined;
+    });
+
+    return panel;
+  }
+
   public postCommand(command: any) {
     // Intercept the addRecipes command
     // The "Ask Sourcery" user interface needs to have the recipes available
@@ -142,7 +214,22 @@ export class ChatProvider implements vscode.WebviewViewProvider {
         break;
       }
     }
-    this._view.webview.postMessage(command);
+
+    // Send to the sidebar view if it exists
+    if (this._view?.webview) {
+      this._view.webview.postMessage(command);
+    }
+
+    // Also send to the panel if it exists
+    if (this._panel?.webview) {
+      switch (command.command) {
+        case "context/update": {
+          command["updates"]["isAnalyticsPanel"] = true;
+          break;
+        }
+      }
+      this._panel.webview.postMessage(command);
+    }
   }
 
   private handleOpenLinkRequest({

src/extension.ts

@@ -99,8 +99,8 @@ function showSourceryStatusBarItem(context: ExtensionContext) {
   // Create the status bar
   const myStatusBarItem = window.createStatusBarItem(StatusBarAlignment.Left);
   myStatusBarItem.command = "sourcery.hub.start";
-  myStatusBarItem.text = "Sourcery";
-  myStatusBarItem.tooltip = "Manage Sourcery account";
+  myStatusBarItem.text = "Sourcery Analytics";
+  myStatusBarItem.tooltip = "See analytics for your repo";
   context.subscriptions.push(myStatusBarItem);
   myStatusBarItem.show();
 }
@@ -477,10 +477,14 @@ function registerCommands(
   // This is activated from the status bar (see below)
   context.subscriptions.push(
     commands.registerCommand("sourcery.hub.start", async () => {
+      // Instruct the language server to start the hub server
       languageClient.sendRequest(ExecuteCommandRequest.type, {
-        command: "sourcery.openHub",
+        command: "sourcery.startHub",
         arguments: [],
       });
+
+      // Create or show the chat panel
+      await chatProvider.createOrShowWebviewPanel();
     })
   );
 }