Merge pull request #545 from jpogran/GH-541-check-pdk-latest

(GH-541) Check for latest PDK Version

Author: glennsarti

package-lock.json

@@ -433,6 +433,11 @@
             "none"
           ]
         },
+        "puppet.pdk.checkVersion": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable/disable checking if installed PDK version is latest"
+        },
         "puppet.titleBar.pdkNewModule.enable": {
           "type": "boolean",
           "default": true,
@@ -562,6 +567,7 @@
     "vscode-debugadapter": "^1.19.0",
     "vscode-debugprotocol": "^1.19.0",
     "vscode-extension-telemetry": "0.1.1",
-    "vscode-languageclient": "^5.2.1"
+    "vscode-languageclient": "^5.2.1",
+    "axios": "0.19.0"
   }
 }

package.json

@@ -35,6 +35,7 @@ interface IRubyConfiguration {
   readonly pdkRubyBinDir:string;
   readonly pdkGemVerDir:string;
   readonly pdkPuppetVersions: string[];
+  readonly pdkVersion:string;
 }
 
 /** The IConnectionConfiguration interface describes the connection used to
@@ -117,6 +118,7 @@ export class AggregateConfiguration implements IAggregateConfiguration {
       pdkRubyBinDir: pdkInstance.rubyBinDir,
       pdkGemVerDir: pdkInstance.gemVerDir,
       pdkPuppetVersions: puppetVersions,
+      pdkVersion: this.getPdkVersionFromFile(puppetBaseDir),
     };
 
     this.connection = {
@@ -227,6 +229,16 @@ export class AggregateConfiguration implements IAggregateConfiguration {
     }
   }
 
+  private getPdkVersionFromFile(puppetBaseDir:string){
+    let basePath = path.join(puppetBaseDir, 'PDK_VERSION');
+    if(fs.existsSync(basePath)){
+      let contents = fs.readFileSync(basePath, 'utf8').toString();
+      return contents.trim();
+    }else{
+      return '';
+    }
+  }
+
   private findFirstDirectory(rootDir: string): string {
     if (!fs.existsSync(rootDir)) { return undefined; }
     var files = fs.readdirSync(rootDir);

src/configuration.ts

@@ -16,12 +16,14 @@ import { ConnectionHandler } from './handler';
 import { DockerConnectionHandler } from './handlers/docker';
 import { StdioConnectionHandler } from './handlers/stdio';
 import { TcpConnectionHandler } from './handlers/tcp';
-import { ConnectionType, ProtocolType, PuppetInstallType } from './settings';
+import { ConnectionType, ProtocolType, PuppetInstallType, ISettings } from './settings';
 import { ILogger } from './logging';
 import { OutputChannelLogger } from './logging/outputchannel';
 import { legacySettings, SettingsFromWorkspace } from './settings';
 import { Reporter, reporter } from './telemetry/telemetry';
 
+const axios = require('axios');
+
 export const puppetLangID = 'puppet'; // don't change this
 export const puppetFileLangID = 'puppetfile'; // don't change this
 const debugType = 'Puppet';  // don't change this
@@ -36,6 +38,7 @@ export function activate(context: vscode.ExtensionContext) {
   extContext = context;
 
   notifyOnNewExtensionVersion(extContext);
+
   checkForLegacySettings();
 
   context.subscriptions.push(new Reporter(extContext));
@@ -76,6 +79,12 @@ export function activate(context: vscode.ExtensionContext) {
     // This can be revisited to enable disabling language server portion
     return;
   }
+  
+  // this happens after checkInstallDirectory so that we don't check pdk version
+  // if it's not installed
+  if(settings.pdk.checkVersion){
+    notifyIfNewPDKVersion(extContext, configSettings);
+  }
 
   switch (configSettings.workspace.editorService.protocol) {
     case ProtocolType.STDIO:
@@ -232,3 +241,57 @@ async function notifyEditorServiceDisabled(context: vscode.ExtensionContext) {
     context.globalState.update(suppressEditorServicesDisabled, true);
   }
 }
+
+async function notifyIfNewPDKVersion(context: vscode.ExtensionContext, settings:IAggregateConfiguration) {
+  const suppressPDKUpdateCheck = 'suppressPDKUpdateCheck';
+  const dontCheckAgainNotice = "Don't check again";
+  const viewPDKDownloadPage = "More info";
+
+  if (context.globalState.get(suppressPDKUpdateCheck, false)) {
+    return;
+  }
+
+  let version = '';
+  if(settings.ruby.pdkVersion){
+    version = settings.ruby.pdkVersion;
+  }else{
+    // should we throw a warning here? technically this is only reached *if* a
+    // PDK install is found, so the only way this is null is if the PDK_VERSION
+    // file was removed.
+    return;
+  }
+
+  axios.get('https://s3.amazonaws.com/puppet-pdk/pdk/LATEST')
+    .then(response => {
+      return response.data;
+    })
+    .then(latest_version => {
+      if(version !== latest_version){
+        return vscode.window.showWarningMessage(
+          `The installed PDK version is ${version}, the newest version is ${latest_version}. To find out how to update to the latest version click the more info button`,
+          { modal: false },
+          { title: dontCheckAgainNotice },
+          { title: viewPDKDownloadPage }
+        );
+      }
+    })
+    .then(result=>{
+      if (result === undefined) {
+        return;
+      }
+    
+      if (result.title === dontCheckAgainNotice) {
+        context.globalState.update(suppressPDKUpdateCheck, true);
+      }
+
+      if (result.title === viewPDKDownloadPage) {
+        vscode.commands.executeCommand(
+          'vscode.open',
+          vscode.Uri.parse('https://puppet.com/download-puppet-development-kit')
+        );
+      }
+    })
+    .catch(error => {
+      logger.error(error);
+    });
+}

src/extension.ts

@@ -60,7 +60,7 @@ export interface ILintSettings {
 }
 
 export interface IPDKSettings {
-  // Future Use
+  checkVersion?: boolean;
 }
 
 export interface INotificationSettings {
@@ -173,6 +173,7 @@ export function DefaultWorkspaceSettings(): ISettings {
       puppetResource: "messagebox"
     },
     pdk: {
+      checkVersion: true,
     }
   };
 }