Adds beta support. Closes #51 (#64)

Author: garrytrinder

src/constants.ts

@@ -195,15 +195,4 @@ export const pluginDocs: PluginDocs = {
     name: 'Retry After Plugin',
     url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/retryafterplugin',
   }
-};
-
-export const testDevProxyInstall: DevProxyInstall = {
-  filePath: 'somepath/devproxy',
-  isBeta: false,
-  isInstalled: true,
-  isLatest: true,
-  latestVersion: '0.14.1',
-  platform: 'win32',
-  version: '0.14.1',
-  isRunning: false
-}; 
+};

src/detect.ts

@@ -1,42 +1,12 @@
 import { exec } from 'child_process';
-import { DevProxyInstall, Release } from './types';
+import { DevProxyInstall } from './types';
 import os from 'os';
 
-const getExecutablePath = async (filename: string): Promise<string> => {
-    const command = getFindCommand();
-    if (command === '') {
-        return '';
-    }
-
+export const getVersion = async () => {
     try {
-        return await executeCommand(`${command} ${filename}`);
-    } catch (error) {
-        console.error(error);
-        return '';
-    }
-};
-
-const getFindCommand = () => {
-    const platform = os.platform();
-    let command = '';
-    if (platform === 'win32') {
-        command = 'pwsh.exe -c "where.exe devproxy"';
-    }
-    if (platform === 'darwin') {
-        command = '$SHELL -c "which devproxy"';
-    }
-    return command;
-};
-
-const getVersion = async (filePath: string) => {
-    if (filePath === '') {
-        return '';
-    }
-    try {
-        const version = await executeCommand(`${filePath.trim()} --version`);
+        const version = await executeCommand(`devproxy --version`);
         return version.trim();
     } catch (error) {
-        console.error(error);
         return "";
     }
 };
@@ -56,31 +26,32 @@ export const executeCommand = async (cmd: string): Promise<string> => {
 };
 
 export const detectDevProxyInstall = async (): Promise<DevProxyInstall> => {
-    const filePath = await getExecutablePath('devproxy');
-    const version = await getVersion(filePath);
-    const isInstalled = filePath !== '';
+    const version = await getVersion();
+    const isInstalled = version !== '';
     const isBeta = version.includes('beta');
     const platform = os.platform();
-    const latestVersion = await getLatestVersion();
-    const isLatest = latestVersion === version;
+    const outdatedVersion = await getOutdatedVersion();
+    const isOutdated = isInstalled && outdatedVersion !== '';
     const isRunning = await isDevProxyRunning();
 
     return {
-        filePath,
         version,
         isInstalled,
         isBeta,
         platform,
-        latestVersion,
-        isLatest,
+        outdatedVersion,
+        isOutdated,
         isRunning
     };
 };
 
-export const getLatestVersion = async (): Promise<string> => {
-    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', '');
+export const getOutdatedVersion = async (): Promise<string> => {
+    try {
+        const outdated = await executeCommand(`devproxy outdated --short`);
+        return outdated ? outdated.trim() : '';
+    } catch (error) {
+        return "";
+    }
 };
 
 export const isDevProxyRunning = async (): Promise<boolean> => {

src/notifications.ts

@@ -31,10 +31,9 @@ export const handleStartNotification = (context: vscode.ExtensionContext) => {
             };
         };
     };
-
-    if (!devProxyInstall.isLatest) {
+    if (devProxyInstall.isOutdated) {
         return () => {
-            const message = `New Dev Proxy version ${devProxyInstall.latestVersion} is available.`;
+            const message = `New Dev Proxy version ${devProxyInstall.outdatedVersion} is available.`;
             return {
                 message,
                 show: async () => {

src/state.ts

@@ -1,9 +1,6 @@
 import * as vscode from 'vscode';
 import { detectDevProxyInstall } from './detect';
-import { testDevProxyInstall } from './constants';
 
 export const updateGlobalState = async (context: vscode.ExtensionContext) => {
-    context.extensionMode === vscode.ExtensionMode.Production
-        ? context.globalState.update('devProxyInstall', await detectDevProxyInstall())
-        : context.globalState.update('devProxyInstall', testDevProxyInstall);
+    context.globalState.update('devProxyInstall', await detectDevProxyInstall());
 };

src/statusbar.ts

@@ -17,19 +17,19 @@ export const updateStatusBar = (context: vscode.ExtensionContext, statusBar: vsc
 export const handleStatusBarUpdate = (context: vscode.ExtensionContext, statusBar: vscode.StatusBarItem): vscode.StatusBarItem => {
     const devProxyInstall = context.globalState.get<DevProxyInstall>('devProxyInstall');
     if (!devProxyInstall) { return statusBar; }
-    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) {
+    if (devProxyInstall.isInstalled && !devProxyInstall.isOutdated) {
+        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 && devProxyInstall.isOutdated) {
         statusBar.backgroundColor = new vscode.ThemeColor('statusBarItem.warningBackground');
         statusBar.color = new vscode.ThemeColor('statusBarItem.warningForeground');
         statusBar.text = `$(warning) Dev Proxy ${devProxyInstall.version}`;

src/test/extension.test.ts

@@ -12,9 +12,19 @@ import parse from 'json-to-ast';
 import { createCodeLensForPluginNodes } from '../codelens';
 import { handleStartNotification } from '../notifications';
 import { handleStatusBarUpdate, statusBarLoop } from '../statusbar';
-import { testDevProxyInstall } from '../constants';
 import * as sinon from 'sinon';
 import * as detect from '../detect';
+import { DevProxyInstall } from '../types';
+
+export const testDevProxyInstall: DevProxyInstall = {
+  isBeta: false,
+  isInstalled: true,
+  isOutdated: true,
+  isRunning: false,
+  outdatedVersion: '0.14.1',
+  platform: 'win32',
+  version: '0.14.1',
+}; 
 
 suite('extension', () => {
 
@@ -300,14 +310,14 @@ suite('notifications', () => {
   test('should show install notification when devproxy is not installed on mac', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: '',
-      version: '',
-      platform: 'darwin',
-      isInstalled: false,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: false
-    });
+      isInstalled: false,
+      isOutdated: false,
+      isRunning: false,
+      platform: 'darwin',
+      outdatedVersion: '0.14.1',
+      version: '',
+    } as DevProxyInstall);
 
     const notification = handleStartNotification(context);
 
@@ -395,14 +405,14 @@ suite('notifications', () => {
   test('should show upgrade notification when devproxy is not latest version', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: 'somepath/devproxy',
-      version: '0.1.0',
-      platform: 'win32',
-      isInstalled: true,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: false
-    });
+      isInstalled: true,
+      isOutdated: true,
+      isRunning: false,
+      platform: 'win32',
+      outdatedVersion: '0.14.1',
+      version: '0.1.0',
+    } as DevProxyInstall);
 
     const notification = handleStartNotification(context);
 
@@ -427,14 +437,14 @@ suite('statusbar', () => {
   test('should show error statusbar when devproxy is not installed', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: '',
-      version: '',
-      platform: 'darwin',
-      isInstalled: false,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: false
-    });
+      isInstalled: false,
+      isOutdated: false,
+      isRunning: false,
+      platform: 'win32',
+      outdatedVersion: '0.14.1',
+      version: '0.1.0',
+    } as DevProxyInstall);
     const statusBar = vscode.window.createStatusBarItem(
       vscode.StatusBarAlignment.Right,
       100
@@ -449,14 +459,14 @@ suite('statusbar', () => {
   test('should show warning statusbar when devproxy is not latest version', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: 'somepath/devproxy',
-      version: '0.1.0',
-      platform: 'win32',
-      isInstalled: true,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: false
-    });
+      isInstalled: true,
+      isOutdated: true,
+      isRunning: false,
+      platform: 'win32',
+      outdatedVersion: '0.14.1',
+      version: '0.1.0',
+    } as DevProxyInstall);
     const statusBar = vscode.window.createStatusBarItem(
       vscode.StatusBarAlignment.Right,
       100
@@ -471,14 +481,14 @@ suite('statusbar', () => {
   test('should show success statusbar when devproxy is installed and latest version', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: 'somepath/devproxy',
-      version: '0.14.1',
-      platform: 'win32',
-      isInstalled: true,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: true
-    });
+      isInstalled: true,
+      isOutdated: false,
+      isRunning: false,
+      platform: 'win32',
+      outdatedVersion: '',
+      version: '0.14.1',
+    } as DevProxyInstall);
     const statusBar = vscode.window.createStatusBarItem(
       vscode.StatusBarAlignment.Right,
       100
@@ -521,14 +531,14 @@ suite('schema', () => {
   test('should show warning when $schema property does not match installed version', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: 'somepath/devproxy',
-      version: '0.1.0',
-      platform: 'win32',
-      isInstalled: true,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: false
-    });
+      isInstalled: true,
+      isOutdated: true,
+      isRunning: false,
+      platform: 'win32',
+      outdatedVersion: '0.14.1',
+      version: '0.1.0',
+    } as DevProxyInstall);
 
     const fileName = 'config-schema-mismatch.json';
     const filePath = path.resolve(__dirname, 'examples', fileName);
@@ -550,14 +560,14 @@ suite('schema', () => {
   test('should not show warning when $schema property matches installed version', async () => {
     const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
     await context.globalState.update('devProxyInstall', {
-      filePath: 'somepath/devproxy',
-      version: '0.14.1',
-      platform: 'win32',
-      isInstalled: true,
-      latestVersion: '0.14.1',
       isBeta: false,
-      isLatest: true
-    });
+      isInstalled: true,
+      isOutdated: false,
+      isRunning: false,
+      platform: 'win32',
+      outdatedVersion: '',
+      version: '0.14.1',
+    } as DevProxyInstall);
 
     const fileName = 'config-schema-version.json';
     const filePath = path.resolve(__dirname, 'examples', fileName);

src/types.ts

@@ -18,14 +18,13 @@ export type PluginSnippets = {
 };
 
 export type DevProxyInstall = {
-  filePath: string;
-  version: string;
-  isInstalled: boolean;
   isBeta: boolean;
-  platform: NodeJS.Platform;
-  latestVersion: string;
-  isLatest: boolean;
+  isInstalled: boolean;
+  isOutdated: boolean;
   isRunning: boolean;
+  outdatedVersion: string;
+  platform: NodeJS.Platform;
+  version: string;
 };
 
 export type Release = {