Merge pull request #2722 from codefori/feature/debug_version_check

Show warning for unsupported minimum debug version

Author: worksofliam

src/api/configuration/DebugConfiguration.ts

@@ -102,10 +102,10 @@ export function resetDebugServiceDetails() {
 export async function getDebugServiceDetails(connection: IBMi): Promise<DebugServiceDetails> {
   if (!debugServiceDetails) {
     let details = {
-      version: `1.0.0`,
-      java: `8`,
+      version: `0.0.0`,
+      java: ``,
       semanticVersion: () => ({
-        major: 1,
+        major: 0,
         minor: 0,
         patch: 0
       })
@@ -129,17 +129,6 @@ export async function getDebugServiceDetails(connection: IBMi): Promise<DebugSer
         }
       }
     }
-    else {
-      details = {
-        version: `1.0.0`,
-        java: `8`,
-        semanticVersion: () => ({
-          major: 1,
-          minor: 0,
-          patch: 0
-        })
-      };
-    }
 
     debugServiceDetails = details;
   }

src/api/configuration/storage/ConnectionStorage.ts

@@ -6,6 +6,7 @@ const LAST_PROFILE_KEY = `currentProfile`;
 const SOURCE_LIST_KEY = `sourceList`;
 const DEPLOYMENT_KEY = `deployment`;
 const DEBUG_KEY = `debug`;
+const MESSAGE_SHOWN_KEY = `messageShown`;
 
 const RECENTLY_OPENED_FILES_KEY = `recentlyOpenedFiles`;
 const AUTHORISED_EXTENSIONS_KEY = `authorisedExtensions`
@@ -128,4 +129,17 @@ export class ConnectionStorage {
     const newExtensions = this.getAuthorisedExtensions().filter(ext => !extensions.includes(ext));
     return this.internalStorage.set(AUTHORISED_EXTENSIONS_KEY, newExtensions);
   }
+
+  hasMessageBeenShown(messageId: string): boolean {
+    const shownMessages = this.internalStorage.get<string[]>(MESSAGE_SHOWN_KEY) || [];
+    return shownMessages.includes(messageId);
+  }
+
+  async markMessageAsShown(messageId: string): Promise<void> {
+    const shownMessages = this.internalStorage.get<string[]>(MESSAGE_SHOWN_KEY) || [];
+    if (!shownMessages.includes(messageId)) {
+      shownMessages.push(messageId);
+      await this.internalStorage.set(MESSAGE_SHOWN_KEY, shownMessages);
+    }
+  }
 }

src/debug/index.ts

@@ -1,19 +1,19 @@
-import { ExtensionContext, Uri } from "vscode";
+import { env, ExtensionContext, Uri } from "vscode";
 import Instance from "../Instance";
 
 import path from "path";
 import * as vscode from 'vscode';
 
-import { instance } from "../instantiate";
-import { ObjectItem } from "../typings";
 import { ILELibrarySettings } from "../api/CompileTools";
+import { getDebugServiceDetails, ORIGINAL_DEBUG_CONFIG_FILE, resetDebugServiceDetails } from "../api/configuration/DebugConfiguration";
+import IBMi from "../api/IBMi";
+import { getStoredPassword } from "../config/passwords";
 import { Env, getEnvConfig } from "../filesystems/local/env";
+import { instance } from "../instantiate";
+import { ObjectItem } from "../typings";
+import { VscodeTools } from "../ui/Tools";
 import * as certificates from "./certificates";
-import { DebugConfiguration, getDebugServiceDetails, ORIGINAL_DEBUG_CONFIG_FILE, resetDebugServiceDetails } from "../api/configuration/DebugConfiguration";
 import * as server from "./server";
-import { VscodeTools } from "../ui/Tools";
-import { getStoredPassword } from "../config/passwords";
-import IBMi from "../api/IBMi";
 
 const debugExtensionId = `IBM.ibmidebug`;
 
@@ -296,29 +296,56 @@ export async function initialize(context: ExtensionContext) {
     async () => {
       activateDebugExtension();
       const connection = instance.getConnection();
-      if (connection && (await server.isDebugSupported(connection))) {
-        vscode.commands.executeCommand(`setContext`, ptfContext, true);
+      if (connection) {
+        const debuggerInstalled = server.debugPTFInstalled(connection);
+        const debugDetails = await getDebugServiceDetails(connection);
+        if (debuggerInstalled) {
+          if (debugDetails.semanticVersion().major >= server.MIN_DEBUG_VERSION) {
+            vscode.commands.executeCommand(`setContext`, ptfContext, true);
 
-        //Enable debug related commands
-        vscode.commands.executeCommand(`setContext`, debugContext, true);
+            //Enable debug related commands
+            vscode.commands.executeCommand(`setContext`, debugContext, true);
 
-        //Enable service entry points related commands
-        vscode.commands.executeCommand(`setContext`, debugSEPContext, true);
+            //Enable service entry points related commands
+            vscode.commands.executeCommand(`setContext`, debugSEPContext, true);
 
-        const isDebugManaged = isManaged();
-        vscode.commands.executeCommand(`setContext`, `code-for-ibmi:debugManaged`, isDebugManaged);
-        if (!isDebugManaged) {
-          if (validateIPv4address(connection.currentHost)) {
-            vscode.window.showWarningMessage(`You are using an IPv4 address to connect to this system. This may cause issues with debugging. Please use a hostname in the Login Settings instead.`);
-          }
+            const isDebugManaged = isManaged();
+            vscode.commands.executeCommand(`setContext`, `code-for-ibmi:debugManaged`, isDebugManaged);
 
-          // Set the debug environment variables early to be safe
-          setCertEnv(true, connection);
+            if (!isDebugManaged) {
+              if (validateIPv4address(connection.currentHost)) {
+                vscode.window.showWarningMessage(`You are using an IPv4 address to connect to this system. This may cause issues with debugging. Please use a hostname in the Login Settings instead.`);
+              }
 
-          // Download the client certificate if it doesn't exist.
-          certificates.checkClientCertificate(connection).catch(() => {
-            vscode.commands.executeCommand(`code-for-ibmi.debug.setup.local`);
-          });
+              // Set the debug environment variables early to be safe
+              setCertEnv(true, connection);
+
+              // Download the client certificate if it doesn't exist.
+              certificates.checkClientCertificate(connection).catch(() => {
+                vscode.commands.executeCommand(`code-for-ibmi.debug.setup.local`);
+              });
+            }
+          }
+          else {
+            const storage = instance.getStorage();
+            if (storage && debugDetails.semanticVersion().major < server.MIN_DEBUG_VERSION) {
+              const debugUpdateMessageId = `debugUpdateRequired-${server.MIN_DEBUG_VERSION}`;
+              const showMessage = !storage.hasMessageBeenShown(debugUpdateMessageId);
+
+              if (showMessage) {
+                vscode.window.showWarningMessage(`Debug service version ${debugDetails.version} is below the minimum required version ${server.MIN_DEBUG_VERSION}.0.0. Please update the debug service PTF.`, `Open docs`, `Dismiss`).then(selected => {
+                  switch (selected) {
+                    case `Open docs`:
+                      env.openExternal(Uri.parse(`https://codefori.github.io/docs/developing/debug/`));
+                      break;
+                    case `Dismiss`:
+                      storage.markMessageAsShown(debugUpdateMessageId);
+                      break;
+                  }
+                });
+              }
+            }
+          }
         }
       }
     });
@@ -372,7 +399,7 @@ export async function startDebug(instance: Instance, options: DebugOptions) {
   secure = setCertEnv(secure, connection);
 
   if (options.sep) {
-    if (serviceDetails.version === `1.0.0`) {
+    if (serviceDetails.semanticVersion().major < 2) {
       vscode.window.showErrorMessage(`The debug service on this system, version ${serviceDetails.version}, does not support service entry points.`);
       return;
     }

src/debug/server.ts

@@ -10,12 +10,14 @@ export type DebugJob = {
   ports: number[]
 }
 
+export const MIN_DEBUG_VERSION = 3;
+
 export function debugPTFInstalled(connection: IBMi) {
   return connection.debugPTFInstalled()
 }
 
 export async function isDebugSupported(connection: IBMi) {
-  return debugPTFInstalled(connection) && (await getDebugServiceDetails(connection)).semanticVersion().major >= 3;
+  return debugPTFInstalled(connection) && (await getDebugServiceDetails(connection)).semanticVersion().major >= MIN_DEBUG_VERSION;
 }
 
 export async function startService(connection: IBMi) {