Add proxy running detection (#49)

Author: garrytrinder

.github/workflows/pr.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 21.x
+          node-version: 18.x
       - run: npm install
       - run: xvfb-run -a npm test
         if: runner.os == 'Linux'

package-lock.json

@@ -49,6 +49,7 @@
     "@types/json-to-ast": "^2.1.4",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.11.17",
+    "@types/sinon": "^17.0.3",
     "@types/vscode": "^1.85.0",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",
@@ -57,6 +58,7 @@
     "copy-webpack-plugin": "^12.0.2",
     "eslint": "^8.56.0",
     "gts": "^5.2.0",
+    "sinon": "^17.0.1",
     "ts-loader": "^9.5.1",
     "typescript": "^5.3.3",
     "webpack": "^5.89.0",

package.json

@@ -204,5 +204,6 @@ export const testDevProxyInstall: DevProxyInstall = {
   isLatest: true,
   latestVersion: '0.14.1',
   platform: 'win32',
-  version: '0.14.1'
+  version: '0.14.1',
+  isRunning: false
 }; 

src/constants.ts

@@ -63,6 +63,7 @@ export const detectDevProxyInstall = async (): Promise<DevProxyInstall> => {
     const platform = os.platform();
     const latestVersion = await getLatestVersion();
     const isLatest = latestVersion === version;
+    const isRunning = await isDevProxyRunning();
 
     return {
         filePath,
@@ -71,12 +72,27 @@ export const detectDevProxyInstall = async (): Promise<DevProxyInstall> => {
         isBeta,
         platform,
         latestVersion,
-        isLatest
+        isLatest,
+        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 isDevProxyRunning = async (): Promise<boolean> => {
+    const platform = os.platform();
+
+    if (platform === 'win32') {
+        const processId = await executeCommand('pwsh.exe -c "(Get-Process devproxy -ErrorAction SilentlyContinue).Id"');
+        return processId.trim() !== '';
+    };
+    if (platform === 'darwin') {
+        const processId = await executeCommand('$SHELL -c "ps -ef | grep devproxy | grep -v grep | awk \'{print $2}\'"');
+        return processId.trim() !== '';
+    };
+    return false;
 };

src/detect.ts

@@ -3,7 +3,7 @@ import { registerCommands } from './commands';
 import { handleStartNotification, processNotification } from './notifications';
 import { registerDocumentListeners } from './documents';
 import { registerCodeLens } from './codelens';
-import { createStatusBar, updateStatusBar } from './statusbar';
+import { createStatusBar, statusBarLoop, updateStatusBar } from './statusbar';
 import { registerCodeActions } from './codeactions';
 import { updateGlobalState } from './state';
 
@@ -12,14 +12,19 @@ export const activate = async (context: vscode.ExtensionContext): Promise<vscode
   await updateGlobalState(context);
 
   const collection = vscode.languages.createDiagnosticCollection('Dev Proxy');
+
   registerDocumentListeners(context, collection);
   registerCodeActions(context);
   registerCodeLens(context);
   registerCommands(context);
+
   const notification = handleStartNotification(context);
   processNotification(notification);
-
+  
   updateStatusBar(context, statusBar);
+
+  setInterval(() => statusBarLoop(context, statusBar), 5000);
+
   return context;
 };
 

src/extension.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 import { DevProxyInstall } from './types';
+import { isDevProxyRunning } from './detect';
 
 export const createStatusBar = (context: vscode.ExtensionContext): vscode.StatusBarItem => {
     const statusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
@@ -34,5 +35,18 @@ export const handleStatusBarUpdate = (context: vscode.ExtensionContext, statusBa
         statusBar.text = `$(warning) Dev Proxy ${devProxyInstall.version}`;
         statusBar.tooltip = `An update is available`;
     }
+    if (devProxyInstall.isRunning) {
+        statusBar.text = `$(radio-tower) Dev Proxy ${devProxyInstall.version}`;
+        statusBar.tooltip = 'Dev Proxy is active';
+        statusBar.backgroundColor = new vscode.ThemeColor('statusBarItem.prominentBackground');
+        statusBar.color = new vscode.ThemeColor('statusBarItem.prominentForeground');
+    }
     return statusBar;
-};
+};
+
+export const statusBarLoop = async (context: vscode.ExtensionContext, statusBar: vscode.StatusBarItem) => {
+    const isRunning = await isDevProxyRunning();
+    const globalState = context.globalState.get<DevProxyInstall>('devProxyInstall');
+    await context.globalState.update('devProxyInstall', { ...globalState, isRunning });
+    updateStatusBar(context, statusBar);
+  };

src/statusbar.ts

@@ -11,8 +11,10 @@ import * as path from 'path';
 import parse from 'json-to-ast';
 import { createCodeLensForPluginNodes } from '../codelens';
 import { handleStartNotification } from '../notifications';
-import { handleStatusBarUpdate } from '../statusbar';
+import { handleStatusBarUpdate, statusBarLoop } from '../statusbar';
 import { testDevProxyInstall } from '../constants';
+import * as sinon from 'sinon';
+import * as detect from '../detect';
 
 suite('extension', () => {
 
@@ -487,6 +489,22 @@ suite('statusbar', () => {
     const actual = updatedStatusBar.text;
     assert.strictEqual(actual, expected);
   });
+
+  test('should show radio tower icon when devproxy is running', async () => {
+    const stub = sinon.stub(detect, 'isDevProxyRunning').resolves(true);
+    const context = await vscode.extensions.getExtension('garrytrinder.dev-proxy-toolkit')?.activate() as vscode.ExtensionContext;
+    const statusBar = vscode.window.createStatusBarItem(
+      vscode.StatusBarAlignment.Right,
+      100
+    );
+    await statusBarLoop(context, statusBar);
+
+    const expected = '$(radio-tower) Dev Proxy 0.14.1';
+    const actual = statusBar.text;
+    stub.restore();
+    assert.strictEqual(actual, expected);
+  });
+
 });
 
 suite('schema', () => {
@@ -550,6 +568,6 @@ suite('schema', () => {
     const expected = 0;
     const actual = diagnostics.length;
     assert.deepStrictEqual(actual, expected);
-  }); 
+  });
 
 });

src/test/extension.test.ts

@@ -25,6 +25,7 @@ export type DevProxyInstall = {
   platform: NodeJS.Platform;
   latestVersion: string;
   isLatest: boolean;
+  isRunning: boolean;
 };
 
 export type Release = {