(maint) Enforce puppet loading order for facts and types

Previously facts and puppet types were loaded asynchronously which was causing
an unseen issue whereby some types (e.g. Service, Package) were not seen as
loaded.  This was due to gem based facter loading the these types before the
type loader.  This would not normally be in an issue in Puppet Agent as
native facter would not share the same ruby environment.  However in development
, or soon to add, PDK workflows, a gem based facter would be used.

This commit changes the load order to synchronously load the types first and
then load the facts, classes and functions asynchronously.

Author: glennsarti

client/CHANGELOG.md

@@ -8,6 +8,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 - ([GH-225](https://github.com/jpogran/puppet-vscode/issues/225)) Readd Local Workspace comand line option
 - ([GH-231](https://github.com/jpogran/puppet-vscode/issues/231)) Make Document Validation asynchronous
+- ([GH-236](https://github.com/jpogran/puppet-vscode/issues/236)) Remove the preload option
 
 ## 0.9.0 - 2018-02-01
 

client/package.json

@@ -288,11 +288,6 @@
           "default": 10,
           "description": "The timeout to connect to the local Puppet Language Server"
         },
-        "puppet.languageserver.preLoadPuppet": {
-          "type": "boolean",
-          "default": true,
-          "description": "Initalize Puppet and Facter when local Puppet Language Server starts"
-        },
         "puppet.languageserver.debugFilePath": {
           "type": "string",
           "default": "",

client/src/configuration.ts

@@ -6,11 +6,10 @@ import { IConnectionConfiguration, ConnectionType } from './interfaces';
 import { ConnectionManager } from './connection';
 
 export class ConnectionConfiguration implements IConnectionConfiguration {
-  public type: ConnectionType = ConnectionType.Unknown; 
+  public type: ConnectionType = ConnectionType.Unknown;
   public host: string = undefined;
   public port: number = undefined;
   public timeout: number = undefined;
-  public preLoadPuppet: boolean = undefined;
   public debugFilePath: string = undefined;
   public puppetAgentDir: string = undefined;
 
@@ -20,9 +19,8 @@ export class ConnectionConfiguration implements IConnectionConfiguration {
     this.host          = config['languageserver']['address'];
     this.port          = config['languageserver']['port'];
     this.timeout       = config['languageserver']['timeout'];
-    this.preLoadPuppet = config['languageserver']['preLoadPuppet'];
     this.debugFilePath = config['languageserver']['debugFilePath'];
-    
+
     this.puppetAgentDir = config['puppetAgentDir'];
   }
 }

client/src/connection.ts

@@ -170,7 +170,6 @@ export class ConnectionManager implements IConnectionManager {
     }
     args.push('--port=' + this.connectionConfiguration.port);
     args.push('--timeout=' + this.connectionConfiguration.timeout);
-    if (this.connectionConfiguration.preLoadPuppet == false) { args.push('--no-preload'); }
     if ((this.connectionConfiguration.debugFilePath != undefined) && (this.connectionConfiguration.debugFilePath != '')) {
       args.push('--debug=' + this.connectionConfiguration.debugFilePath);
     }
@@ -291,10 +290,10 @@ export class ConnectionManager implements IConnectionManager {
 
         connectionManager.languageClient.sendRequest(messages.PuppetVersionRequest.type).then((versionDetails) => {
           lastVersionResponse = versionDetails
-          if (!connectionManager.connectionConfiguration.preLoadPuppet || (versionDetails.factsLoaded &&
+          if (versionDetails.factsLoaded &&
               versionDetails.functionsLoaded &&
               versionDetails.typesLoaded &&
-              versionDetails.classesLoaded)) {
+              versionDetails.classesLoaded) {
             clearInterval(handle);
             this.setConnectionStatus(lastVersionResponse.puppetVersion, ConnectionStatus.Running);
             resolve();

client/src/debugAdapter.ts

@@ -43,7 +43,6 @@ class DebugConfiguration implements IConnectionConfiguration {
   public host: string = "127.0.0.1";
   public port: number = 8082;
   public timeout: number = 10;
-  public preLoadPuppet: boolean = false;
   public debugFilePath: string; // = "STDOUT";
   public puppetAgentDir: string;
 }
@@ -117,7 +116,7 @@ function startDebugServer(config:DebugConfiguration, debugLogger: ILogger) {
   if (localServer == null) { localServer = RubyHelper.getRubyEnvFromPuppetAgent(rubyfile, config, debugLogger); }
   // Commented out for the moment.  This will be enabled once the configuration and exact user story is figured out.
   // if (localServer == null) { localServer = RubyHelper.getRubyEnvFromPDK(rubyfile, config, debugLogger); }
-  
+
   if (localServer == null) {
     sendErrorMessage("Unable to find a valid ruby environment");
     process.exit(255);
@@ -145,7 +144,7 @@ function startDebugging(config:DebugConfiguration, debugLogger:ILogger) {
   debugServerProc.on('close', (exitCode) => {
     debugLogger.debug("Debug server terminated with exit code: " + exitCode);
     debugServerProc.kill();
-    process.exit(exitCode); 
+    process.exit(exitCode);
   });
 
   debugServerProc.on('error', (data) => {
@@ -155,19 +154,19 @@ function startDebugging(config:DebugConfiguration, debugLogger:ILogger) {
   process.on('SIGTERM', () => {
     debugLogger.debug("Received SIGTERM");
     debugServerProc.kill();
-    process.exit(0); 
+    process.exit(0);
   });
 
   process.on('SIGHUP', () => {
     debugLogger.debug("Received SIGHUP");
     debugServerProc.kill();
-    process.exit(0); 
+    process.exit(0);
   });
 
   process.on('exit', () => {
     debugLogger.debug("Received Exit");
     debugServerProc.kill();
-    process.exit(0); 
+    process.exit(0);
   });
 }
 

client/src/interfaces.ts

@@ -21,7 +21,6 @@ export interface IConnectionConfiguration {
   host: string;
   port: number;
   timeout: number;
-  preLoadPuppet: boolean;
   debugFilePath: string;
   puppetAgentDir: string;
 }

server/lib/puppet-languageserver.rb

@@ -56,7 +56,8 @@ def self.parse(options)
           args[:connection_timeout] = timeout.to_i
         end
 
-        opts.on('-d', '--no-preload', 'Do not preload Puppet information when the language server starts.  Default is to preload') do |_misc|
+        opts.on('-d', '--no-preload', '** DEPRECATED ** Do not preload Puppet information when the language server starts.  Default is to preload') do |_misc|
+          puts '** WARNING ** Using "--no-preload" may cause Puppet Type loading to be incomplete.'
           args[:preload_puppet] = false
         end
 
@@ -118,12 +119,12 @@ def self.init_puppet_worker(options)
 
     log_message(:info, "Using Facter v#{Facter.version}")
     if options[:preload_puppet]
+      log_message(:info, 'Preloading Puppet Types (Sync)...')
+      PuppetLanguageServer::PuppetHelper.load_types
+
       log_message(:info, 'Preloading Facter (Async)...')
       PuppetLanguageServer::FacterHelper.load_facts_async
 
-      log_message(:info, 'Preloading Puppet Types (Async)...')
-      PuppetLanguageServer::PuppetHelper.load_types_async
-
       log_message(:info, 'Preloading Functions (Async)...')
       PuppetLanguageServer::PuppetHelper.load_functions_async