Add proxy version to status bar (#47)

Author: garrytrinder

src/detect.ts

@@ -76,7 +76,7 @@ export const detectDevProxyInstall = async (): Promise<DevProxyInstall> => {
 };
 
 export const getLatestVersion = async (): Promise<string> => {
-    const request = await fetch('https://api.github.com/repos/microsoft/dev-proxy/releases');
+    const request = await fetch('https://api.github.com/repos/microsoft/dev-proxy/releases/latest');
     const release = await request.json() as Release;
     return release.tag_name.replace('v', '');
 };

src/extension.ts

@@ -4,16 +4,19 @@ import { detectDevProxyInstall } from './detect';
 import { handleStartNotification, processNotification } from './notifications';
 import { registerDocumentListeners } from './documents';
 import { registerCodeLens } from './codelens';
+import { createStatusBar, updateStatusBar } from './statusbar';
 
 export const activate = async (context: vscode.ExtensionContext) => {
   const collection = vscode.languages.createDiagnosticCollection('Dev Proxy');
+  let statusBar = createStatusBar(context);
   registerDocumentListeners(context, collection);
   registerCommands(context);
   registerCodeLens(context);
-  
+
   const devProxyInstall = await detectDevProxyInstall();
   const notification = handleStartNotification(devProxyInstall);
   processNotification(notification);
+  updateStatusBar(statusBar, devProxyInstall);
 };
 
 export const deactivate = () => { };

src/statusbar.ts

@@ -0,0 +1,36 @@
+import * as vscode from 'vscode';
+import { DevProxyInstall } from './types';
+
+export const createStatusBar = (context: vscode.ExtensionContext): vscode.StatusBarItem => {
+    const statusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
+    statusBar.text = '$(sync~spin) Dev Proxy';
+    statusBar.show();
+    context.subscriptions.push(statusBar);
+    return statusBar;
+};
+
+export const updateStatusBar = (statusBar: vscode.StatusBarItem, devProxyInstall: DevProxyInstall) => {
+    statusBar = handleStatusBarUpdate(statusBar, devProxyInstall);
+};
+
+export const handleStatusBarUpdate = (statusBar: vscode.StatusBarItem, devProxyInstall: DevProxyInstall): vscode.StatusBarItem => {
+    if (devProxyInstall.isInstalled) {
+        statusBar.backgroundColor = new vscode.ThemeColor('statusBar.background');
+        statusBar.color = new vscode.ThemeColor('statusBar.foreground');
+        statusBar.text = `$(check) Dev Proxy ${devProxyInstall.version}`;
+        statusBar.tooltip = `You have the latest version installed`;
+    }
+    if (!devProxyInstall.isInstalled) {
+        statusBar.backgroundColor = new vscode.ThemeColor('statusBarItem.errorBackground');
+        statusBar.color = new vscode.ThemeColor('statusBarItem.errorForeground');
+        statusBar.text = `$(error) Dev Proxy`;
+        statusBar.tooltip = `Dev Proxy is not installed`;
+    }
+    if (devProxyInstall.isInstalled && !devProxyInstall.isLatest) {
+        statusBar.backgroundColor = new vscode.ThemeColor('statusBarItem.warningBackground');
+        statusBar.color = new vscode.ThemeColor('statusBarItem.warningForeground');
+        statusBar.text = `$(warning) Dev Proxy ${devProxyInstall.version}`;
+        statusBar.tooltip = `An update is available`;
+    }
+    return statusBar;
+};

src/test/extension.test.ts

@@ -12,6 +12,7 @@ import parse from 'json-to-ast';
 import { createCodeLensForPluginNodes } from '../codelens';
 import { DevProxyInstall } from '../types';
 import { handleStartNotification } from '../notifications';
+import { handleStatusBarUpdate } from '../statusbar';
 
 suite('urlsToWatch', () => {
   test('should show error when opening document with no urlsToWatch found', async () => {
@@ -335,4 +336,69 @@ suite('notifications', () => {
     const actual = notification !== undefined && notification().message;
     assert.strictEqual(actual, expected);
   });
+});
+
+suite('statusbar', () => {
+  test('should show error statusbar when devproxy is not installed', async () => {
+    const devProxyInstall: DevProxyInstall = {
+      filePath: '',
+      version: '',
+      platform: 'darwin',
+      isInstalled: false,
+      latestVersion: '0.14.1',
+      isBeta: false,
+      isLatest: false
+    };
+    const statusBar = vscode.window.createStatusBarItem(
+      vscode.StatusBarAlignment.Right,
+      100
+    );
+    const updatedStatusBar = handleStatusBarUpdate(statusBar, devProxyInstall);
+
+    const expected = '$(error) Dev Proxy';
+    const actual = updatedStatusBar.text;
+    assert.strictEqual(actual, expected);
+  });
+
+  test('should show warning statusbar when devproxy is not latest version', async () => {
+    const devProxyInstall: DevProxyInstall = {
+      filePath: 'somepath/devproxy',
+      version: '0.1.0',
+      platform: 'win32',
+      isInstalled: true,
+      latestVersion: '0.14.1',
+      isBeta: false,
+      isLatest: false
+    };
+    const statusBar = vscode.window.createStatusBarItem(
+      vscode.StatusBarAlignment.Right,
+      100
+    );
+    const updatedStatusBar = handleStatusBarUpdate(statusBar, devProxyInstall);
+
+    const expected = '$(warning) Dev Proxy 0.1.0';
+    const actual = updatedStatusBar.text;
+    assert.strictEqual(actual, expected);
+  });
+
+  test('should show success statusbar when devproxy is installed and latest version', async () => {
+    const devProxyInstall: DevProxyInstall = {
+      filePath: 'somepath/devproxy',
+      version: '0.14.1',
+      platform: 'win32',
+      isInstalled: true,
+      latestVersion: '0.14.1',
+      isBeta: false,
+      isLatest: true
+    };
+    const statusBar = vscode.window.createStatusBarItem(
+      vscode.StatusBarAlignment.Right,
+      100
+    );
+    const updatedStatusBar = handleStatusBarUpdate(statusBar, devProxyInstall);
+
+    const expected = '$(check) Dev Proxy 0.14.1';
+    const actual = updatedStatusBar.text;
+    assert.strictEqual(actual, expected);
+  });
 });