Merged PR 722035: Added an environment variable that contain list of loaded plugin capabilities for every process pips

Added [BUILDXL]LOADED_PLUGIN_CAPABILITIES to pip env vars which lists the capabilities (supported message types) of the currently loaded plugins

Author: derekantrican

Public/Src/Engine/ProcessPipExecutor/PluginEndpoints.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
 using BuildXL.Pips.Operations;
@@ -27,6 +28,17 @@ public class PluginEndpoints
         /// </summary>
         public SandboxedProcessInfo ProcessInfo { get; set; }
 
+        /// <summary>
+        /// Gets a list of the plugin message types that the loaded plugins can handle
+        /// </summary>
+        public HashSet<PluginMessageType> LoadedPluginSupportedMessageTypes
+        {
+            get
+            {
+                return m_pluginManager?.GetSupportedMessageTypesOfLoadedPlugins() ?? new HashSet<PluginMessageType>();
+            }
+        }
+
         /// <summary>
         /// Creates a wrapper to pass relevant information to PluginManager
         /// </summary>

Public/Src/Engine/ProcessPipExecutor/SandboxedProcessPipExecutor.cs

@@ -2969,6 +2969,14 @@ private IBuildParameters PrepareEnvironmentVariables()
                 }
             }
 
+            if (m_pluginEP != null)
+            {
+                environmentVariables = environmentVariables.Override(new[]
+                {
+                    new KeyValuePair<string, string>(PluginConstants.PluginCapabilitiesEnvVar, string.Join(",", m_pluginEP.LoadedPluginSupportedMessageTypes.Select(m => m.ToString())))
+                });
+            }
+
             return environmentVariables;
         }
 

Public/Src/Utilities/Plugin/Plugin.cs

@@ -13,11 +13,21 @@
 
 namespace BuildXL.Plugin
 {
+    /// <nodoc />
+    public static class PluginConstants
+    {
+        /// <summary>
+        /// Name of the environment variable listing the capabilities of the currently loaded plugins
+        /// </summary>
+        public const string PluginCapabilitiesEnvVar = "[BUILDXL]LOADED_PLUGIN_CAPABILITIES";
+    }
+
     /// <nodoc />
     public class Plugin : IPlugin
     {
         private readonly TaskSourceSlim<Unit> m_startCompletionTaskSoure;
         private bool m_disposed = false;
+
         /// <nodoc />
         public string FilePath { get; }
         /// <nodoc />

Public/Src/Utilities/Plugin/PluginManager.cs

@@ -106,6 +106,21 @@ public bool CanHandleMessage(PluginMessageType messageType)
             return m_pluginHandlers.TryGet(messageType, out _);
         }
 
+        /// <nodoc />
+        public HashSet<PluginMessageType> GetSupportedMessageTypesOfLoadedPlugins()
+        {
+            HashSet<PluginMessageType> result = new HashSet<PluginMessageType>();
+            foreach (PluginMessageType messageType in Enum.GetValues(typeof(PluginMessageType)).Cast<PluginMessageType>())
+            {
+                if (CanHandleMessage(messageType))
+                {
+                    result.Add(messageType);
+                }
+            }
+
+            return result;
+        }
+
         /// <nodoc />
         private void EnsurePluginLoaded(IPlugin plugin)
         {
@@ -133,7 +148,7 @@ private async Task<Possible<T>> CallWithEnsurePluginLoadedWrapperAsync<T>(Plugin
             }
             catch(Exception e)
             {
-                Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"grpc call with type {messageType.ToString()} failed with {e}");
+                Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Grpc call with type {messageType.ToString()} failed with {e}");
                 return new Failure<T>(defaultReturnValue);
             }
         }
@@ -145,7 +160,7 @@ private async Task<Possible<IPlugin>> CreatePluginAsync(PluginCreationArgument p
             {
                 if (!File.Exists(pluinCreationArgument.PluginPath) && pluinCreationArgument.RunInSeparateProcess)
                 {
-                    Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Can't Load plugin because {pluinCreationArgument.PluginPath} doesn't exist");
+                    Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Can't load plugin because {pluinCreationArgument.PluginPath} doesn't exist");
                     new Failure<IPlugin>(null);
                 }
 
@@ -190,7 +205,7 @@ public async Task<Possible<LogParseResult>> LogParseAsync(string message, bool i
             var messageType = PluginMessageType.ParseLogMessage;
             if (!m_pluginHandlers.TryGet(messageType, out plugin))
             {
-                return new Failure<string>($"no plugin is available to handle {messageType}");
+                return new Failure<string>($"No plugin is available to handle {messageType}");
             }
 
             return await CallWithEnsurePluginLoadedWrapperAsync(
@@ -211,7 +226,7 @@ public async Task<Possible<ProcessResultMessageResponse>> ProcessResultAsync(str
             var messageType = PluginMessageType.ProcessResult;
             if (!m_pluginHandlers.TryGet(messageType, out plugin))
             {
-                return new Failure<string>($"no plugin is available to handle {messageType}");
+                return new Failure<string>($"No plugin is available to handle {messageType}");
             }
 
             return await CallWithEnsurePluginLoadedWrapperAsync(
@@ -274,15 +289,15 @@ public async Task<Possible<IPlugin>> GetOrCreateAsync(PluginCreationArgument sta
                     }
                     else
                     {
-                        Tracing.Logger.Log.PluginManagerErrorMessage(m_loggingContext, $"Two plugins({plugin.FilePath} and {alreadyRegisteredPlugin.FilePath}) can hanlde {pluginMessageType} that we don't suuport this scenario");
+                        Tracing.Logger.Log.PluginManagerErrorMessage(m_loggingContext, $"Two plugins ({plugin.FilePath} and {alreadyRegisteredPlugin.FilePath}) can handle {pluginMessageType}. This scenario is not currently supported.");
                     }
                 }
-                Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Supported Messagey Type for {plugin.Name} is {string.Join(",", messageType.Result)}");
+                Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Supported message types for {plugin.Name} is {string.Join(",", messageType.Result)}");
                 plugin.SupportedMessageType = messageType.Result;
             }
             else
             {
-                Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Can't get supported message tyep for {plugin.Name}");
+                Tracing.Logger.Log.PluginManagerLogMessage(m_loggingContext, $"Can't get supported message types for {plugin.Name}");
             }
 
             return creationResult;