Add version check (#43)

Author: garrytrinder

package-lock.json

@@ -48,7 +48,7 @@
   "devDependencies": {
     "@types/json-to-ast": "^2.1.4",
     "@types/mocha": "^10.0.6",
-    "@types/node": "20.8.2",
+    "@types/node": "^20.11.17",
     "@types/vscode": "^1.85.0",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",

package.json

@@ -17,4 +17,10 @@ export const registerCommands = (context: vscode.ExtensionContext) => {
             }
         )
     );
+
+    context.subscriptions.push(
+        vscode.commands.registerCommand('dev-proxy-toolkit.upgrade', async () => {
+            const url = 'https://aka.ms/devproxy/upgrade';
+            vscode.env.openExternal(vscode.Uri.parse(url));
+        }));
 };

src/commands.ts

@@ -1,5 +1,5 @@
 import { exec } from 'child_process';
-import { DevProxyInstall } from './types';
+import { DevProxyInstall, Release } from './types';
 import os from 'os';
 
 const getExecutablePath = async (filename: string): Promise<string> => {
@@ -61,12 +61,22 @@ export const detectDevProxyInstall = async (): Promise<DevProxyInstall> => {
     const isInstalled = filePath !== '';
     const isBeta = version.includes('beta');
     const platform = os.platform();
+    const latestVersion = await getLatestVersion();
+    const isLatest = latestVersion === version;
 
     return {
         filePath,
         version,
         isInstalled,
         isBeta,
-        platform
+        platform,
+        latestVersion,
+        isLatest
     };
+};
+
+export const getLatestVersion = async (): Promise<string> => {
+    const request = await fetch('https://api.github.com/repos/microsoft/dev-proxy/releases');
+    const release = await request.json() as Release;
+    return release.tag_name.replace('v', '');
 };

src/detect.ts

@@ -16,6 +16,21 @@ export const handleStartNotification = (devProxyInstall: DevProxyInstall) => {
             };
         };
     };
+
+    if (!devProxyInstall.isLatest) {
+        return () => {
+            const message = `New Dev Proxy version ${devProxyInstall.latestVersion} is available.`;
+            return {
+                message,
+                show: async () => {
+                    const result = await vscode.window.showInformationMessage(message, 'Upgrade');
+                    if (result === 'Upgrade') {
+                        await vscode.commands.executeCommand('dev-proxy-toolkit.upgrade');
+                    };
+                }
+            };
+        };
+    };
 };
 
 export const processNotification = (notification: (() => { message: string; show: () => Promise<void>; }) | undefined) => {

src/notifications.ts

@@ -18,7 +18,7 @@ suite('urlsToWatch', () => {
     const fileName = 'config-urls-to-watch-required.json';
     const filePath = path.resolve(__dirname, 'examples', fileName);
     const document = await vscode.workspace.openTextDocument(filePath);
-        const diagnostics = vscode.languages.getDiagnostics(document.uri);
+    const diagnostics = vscode.languages.getDiagnostics(document.uri);
 
     const expected = {
       message: 'Add at least one url to watch.',
@@ -241,7 +241,9 @@ suite('notifications', () => {
       version: '',
       platform: 'darwin',
       isInstalled: false,
+      latestVersion: '0.14.1',
       isBeta: false,
+      isLatest: false
     };
     const notification = handleStartNotification(devProxyInstall);
 
@@ -256,7 +258,9 @@ suite('notifications', () => {
       version: '',
       platform: 'win32',
       isInstalled: false,
+      latestVersion: '0.14.1',
       isBeta: false,
+      isLatest: false
     };
     const notification = handleStartNotification(devProxyInstall);
 
@@ -268,10 +272,12 @@ suite('notifications', () => {
   test('should not show install notification when devproxy is installed on mac', async () => {
     const devProxyInstall: DevProxyInstall = {
       filePath: 'somepath/devproxy',
-      version: '0.1.0',
+      version: '0.14.1',
       platform: 'darwin',
       isInstalled: true,
+      latestVersion: '0.14.1',
       isBeta: false,
+      isLatest: true
     };
     const notification = handleStartNotification(devProxyInstall);
 
@@ -285,7 +291,9 @@ suite('notifications', () => {
       version: '0.1.0',
       platform: 'win32',
       isInstalled: true,
+      latestVersion: '0.14.1',
       isBeta: false,
+      isLatest: true
     };
     const notification = handleStartNotification(devProxyInstall);
 
@@ -297,15 +305,34 @@ suite('notifications', () => {
   test('should not show install notification when running in unsupported operating system', async () => {
     const devProxyInstall: DevProxyInstall = {
       filePath: 'somepath/devproxy',
-      version: '0.1.0',
+      version: '0.14.1',
       platform: 'linux',
       isInstalled: true,
+      latestVersion: '0.14.1',
       isBeta: false,
+      isLatest: true
     };
     const notification = handleStartNotification(devProxyInstall);
 
     const expected = true;
     const actual = notification === undefined;
     assert.strictEqual(actual, expected);
   });
+
+  test('should show upgrade notification 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 notification = handleStartNotification(devProxyInstall);
+
+    const expected = 'New Dev Proxy version 0.14.1 is available.';
+    const actual = notification !== undefined && notification().message;
+    assert.strictEqual(actual, expected);
+  });
 });

src/test/extension.test.ts

@@ -23,4 +23,86 @@ export type DevProxyInstall = {
   isInstalled: boolean;
   isBeta: boolean;
   platform: NodeJS.Platform;
-};
+  latestVersion: string;
+  isLatest: boolean;
+};
+
+export type Release = {
+  url: string
+  assets_url: string
+  upload_url: string
+  html_url: string
+  id: number
+  author: Author
+  node_id: string
+  tag_name: string
+  target_commitish: string
+  name: string
+  draft: boolean
+  prerelease: boolean
+  created_at: string
+  published_at: string
+  assets: Asset[]
+  tarball_url: string
+  zipball_url: string
+  body: string
+  mentions_count: number
+};
+
+type Author = {
+  login: string
+  id: number
+  node_id: string
+  avatar_url: string
+  gravatar_id: string
+  url: string
+  html_url: string
+  followers_url: string
+  following_url: string
+  gists_url: string
+  starred_url: string
+  subscriptions_url: string
+  organizations_url: string
+  repos_url: string
+  events_url: string
+  received_events_url: string
+  type: string
+  site_admin: boolean
+};
+
+type Asset = {
+  url: string
+  id: number
+  node_id: string
+  name: string
+  label: string
+  uploader: Uploader
+  content_type: string
+  state: string
+  size: number
+  download_count: number
+  created_at: string
+  updated_at: string
+  browser_download_url: string
+};
+
+type Uploader = {
+  login: string
+  id: number
+  node_id: string
+  avatar_url: string
+  gravatar_id: string
+  url: string
+  html_url: string
+  followers_url: string
+  following_url: string
+  gists_url: string
+  starred_url: string
+  subscriptions_url: string
+  organizations_url: string
+  repos_url: string
+  events_url: string
+  received_events_url: string
+  type: string
+  site_admin: boolean
+};