Move BindOptions to action descriptors

sbomer · sbomer · commit 65f601ac71b5 · 2025-04-18T18:30:15.000Z
diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon/CollectionRules/Actions/CallbackAction.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon/CollectionRules/Actions/CallbackAction.cs
@@ -5,6 +5,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.Collections.Generic;
 using System.Threading;
@@ -79,6 +80,13 @@ internal sealed class CallbackActionDescriptor : ICollectionRuleActionDescriptor
         public string ActionName => CallbackAction.ActionName;
         public Type OptionsType => typeof(BaseRecordOptions);
         public Type FactoryType => typeof(CallbackActionFactory);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            BaseRecordOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 
     internal sealed class DelayedCallbackAction : ICollectionRuleAction
@@ -124,6 +132,13 @@ internal sealed class DelayedCallbackActionDescriptor : ICollectionRuleActionDes
         public string ActionName => DelayedCallbackAction.ActionName;
         public Type OptionsType => typeof(BaseRecordOptions);
         public Type FactoryType => typeof(DelayedCallbackActionFactory);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            BaseRecordOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 
     internal sealed class CallbackActionService
diff --git a/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon/CollectionRules/Actions/PassThroughAction.cs b/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.UnitTestCommon/CollectionRules/Actions/PassThroughAction.cs
@@ -5,6 +5,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.Collections.Generic;
 using System.Threading;
@@ -60,6 +61,13 @@ internal sealed class PassThroughActionDescriptor : ICollectionRuleActionDescrip
         public string ActionName => nameof(PassThroughAction);
         public Type OptionsType => typeof(PassThroughOptions);
         public Type FactoryType => typeof(PassThroughActionFactory);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            PassThroughOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 
     internal sealed record class PassThroughOptions : BaseRecordOptions
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectDumpAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectDumpAction.cs
@@ -5,6 +5,7 @@
 using Microsoft.Diagnostics.Monitoring.WebApi.Models;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using System;
 using System.ComponentModel.DataAnnotations;
@@ -73,5 +74,12 @@ internal sealed class CollectDumpActionDescriptor : ICollectionRuleActionDescrip
         public string ActionName => KnownCollectionRuleActions.CollectDump;
         public Type FactoryType => typeof(CollectDumpActionFactory);
         public Type OptionsType => typeof(CollectDumpOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectDumpOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectExceptionsAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectExceptionsAction.cs
@@ -5,6 +5,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.ComponentModel.DataAnnotations;
 using Utils = Microsoft.Diagnostics.Monitoring.WebApi.Utilities;
@@ -62,5 +63,12 @@ internal sealed class CollectExceptionsActionDescriptor : ICollectionRuleActionD
         public string ActionName => KnownCollectionRuleActions.CollectExceptions;
         public Type FactoryType => typeof(CollectExceptionsActionFactory);
         public Type OptionsType => typeof(CollectExceptionsOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectExceptionsOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectGCDumpAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectGCDumpAction.cs
@@ -3,6 +3,7 @@
 
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using System;
 using System.ComponentModel.DataAnnotations;
@@ -66,5 +67,12 @@ internal sealed class CollectGCDumpActionDescriptor : ICollectionRuleActionDescr
         public string ActionName => KnownCollectionRuleActions.CollectGCDump;
         public Type FactoryType => typeof(CollectGCDumpActionFactory);
         public Type OptionsType => typeof(CollectGCDumpOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectGCDumpOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectLiveMetricsAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectLiveMetricsAction.cs
@@ -6,6 +6,7 @@
 using Microsoft.Diagnostics.Monitoring.WebApi.Models;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 using System;
@@ -102,5 +103,12 @@ internal sealed class CollectLiveMetricsActionDescriptor : ICollectionRuleAction
         public string ActionName => KnownCollectionRuleActions.CollectLiveMetrics;
         public Type FactoryType => typeof(CollectLiveMetricsActionFactory);
         public Type OptionsType => typeof(CollectLiveMetricsOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectLiveMetricsOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectLogsAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectLogsAction.cs
@@ -8,6 +8,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
@@ -90,5 +91,12 @@ internal sealed class CollectLogsActionDescriptor : ICollectionRuleActionDescrip
         public string ActionName => KnownCollectionRuleActions.CollectLogs;
         public Type FactoryType => typeof(CollectLogsActionFactory);
         public Type OptionsType => typeof(CollectLogsOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectLogsOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectStacksAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectStacksAction.cs
@@ -5,6 +5,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.ComponentModel.DataAnnotations;
 using Utils = Microsoft.Diagnostics.Monitoring.WebApi.Utilities;
@@ -78,5 +79,12 @@ internal sealed class CollectStacksActionDescriptor : ICollectionRuleActionDescr
         public string ActionName => KnownCollectionRuleActions.CollectStacks;
         public Type FactoryType => typeof(CollectStacksActionFactory);
         public Type OptionsType => typeof(CollectStacksOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectStacksOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectTraceAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectTraceAction.cs
@@ -8,6 +8,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.ComponentModel.DataAnnotations;
 using Utils = Microsoft.Diagnostics.Monitoring.WebApi.Utilities;
@@ -114,5 +115,12 @@ internal sealed class CollectTraceActionDescriptor : ICollectionRuleActionDescri
         public string ActionName => KnownCollectionRuleActions.CollectTrace;
         public Type FactoryType => typeof(CollectTraceActionFactory);
         public Type OptionsType => typeof(CollectTraceOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            CollectTraceOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectionRuleActionOperations.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/CollectionRuleActionOperations.cs
@@ -5,6 +5,7 @@
 
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
 using System;
 using System.Collections.Generic;
@@ -59,13 +60,15 @@ public bool TryCreateFactory(
         }
 
         /// <inheritdoc/>
-        public bool TryCreateOptions(
+        public bool TryBindOptions(
             string actionName,
+            IConfigurationSection actionSection,
             out object options)
         {
             if (_map.TryGetValue(actionName, out ICollectionRuleActionDescriptor descriptor))
             {
-                options = Activator.CreateInstance(descriptor.OptionsType);
+                IConfigurationSection settingsSection = actionSection.GetSection(nameof(CollectionRuleActionOptions.Settings));
+                descriptor.BindOptions(settingsSection, out options);
                 return true;
             }
 
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/ExecuteAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/ExecuteAction.cs
@@ -5,6 +5,7 @@
 using Microsoft.Diagnostics.Monitoring.WebApi;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
@@ -112,5 +113,12 @@ internal sealed class ExecuteActionDescriptor : ICollectionRuleActionDescriptor
         public string ActionName => KnownCollectionRuleActions.Execute;
         public Type FactoryType => typeof(ExecuteActionFactory);
         public Type OptionsType => typeof(ExecuteOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            ExecuteOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/GetEnvironmentVariableAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/GetEnvironmentVariableAction.cs
@@ -6,6 +6,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
@@ -90,5 +91,12 @@ internal sealed class GetEnvironmentVariableActionDescriptor : ICollectionRuleAc
         public string ActionName => KnownCollectionRuleActions.GetEnvironmentVariable;
         public Type OptionsType => typeof(GetEnvironmentVariableOptions);
         public Type FactoryType => typeof(GetEnvironmentVariableActionFactory);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            GetEnvironmentVariableOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/ICollectionRuleActionOperations.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/ICollectionRuleActionOperations.cs
@@ -3,6 +3,7 @@
 
 #nullable disable
 
+using Microsoft.Extensions.Configuration;
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
 
@@ -25,8 +26,9 @@ bool TryCreateFactory(
         /// Attempts to create an options instance of the options type
         /// associated with the registered action name.
         /// </summary>
-        bool TryCreateOptions(
+        bool TryBindOptions(
             string actionName,
+            IConfigurationSection actionSection,
             out object options);
 
         /// <summary>
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/LoadProfilerAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/LoadProfilerAction.cs
@@ -6,6 +6,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.ComponentModel.DataAnnotations;
 using System.Threading;
@@ -75,5 +76,12 @@ internal sealed class LoadProfilerActionDescriptor : ICollectionRuleActionDescri
         public string ActionName => KnownCollectionRuleActions.LoadProfiler;
         public Type FactoryType => typeof(LoadProfilerActionFactory);
         public Type OptionsType => typeof(LoadProfilerOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            LoadProfilerOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Actions/SetEnvironmentVariableAction.cs b/src/Tools/dotnet-monitor/CollectionRules/Actions/SetEnvironmentVariableAction.cs
@@ -6,6 +6,7 @@
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
 using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Configuration;
 using System;
 using System.ComponentModel.DataAnnotations;
 using System.Threading;
@@ -75,5 +76,12 @@ internal sealed class SetEnvironmentVariableActionDescriptor : ICollectionRuleAc
         public string ActionName => KnownCollectionRuleActions.SetEnvironmentVariable;
         public Type FactoryType => typeof(SetEnvironmentVariableActionFactory);
         public Type OptionsType => typeof(SetEnvironmentVariableOptions);
+
+        public void BindOptions(IConfigurationSection settingsSection, out object settings)
+        {
+            SetEnvironmentVariableOptions options = new();
+            settingsSection.Bind(options);
+            settings = options;
+        }
     }
 }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Configuration/CollectionRuleBindingHelper.cs b/src/Tools/dotnet-monitor/CollectionRules/Configuration/CollectionRuleBindingHelper.cs
@@ -13,12 +13,8 @@ internal static class CollectionRuleBindingHelper
         public static void BindActionSettings(IConfigurationSection actionSection, CollectionRuleActionOptions actionOptions, ICollectionRuleActionOperations actionOperations)
         {
             if (null != actionOptions &&
-                actionOperations.TryCreateOptions(actionOptions.Type, out object actionSettings))
+                actionOperations.TryBindOptions(actionOptions.Type, actionSection, out object actionSettings))
             {
-                IConfigurationSection settingsSection = actionSection.GetSection(nameof(CollectionRuleActionOptions.Settings));
-
-                settingsSection.Bind(actionSettings);
-
                 actionOptions.Settings = actionSettings;
             }
         }
diff --git a/src/Tools/dotnet-monitor/CollectionRules/Configuration/ICollectionRuleActionDescriptor.cs b/src/Tools/dotnet-monitor/CollectionRules/Configuration/ICollectionRuleActionDescriptor.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using Microsoft.Extensions.Configuration;
 
 namespace Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration
 {
@@ -12,5 +13,7 @@ internal interface ICollectionRuleActionDescriptor
         Type FactoryType { get; }
 
         Type OptionsType { get; }
+
+        void BindOptions(IConfigurationSection settingsSection, out object settings);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`
`6`	`6`	`using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;`
`7`	`7`	`using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options;`
	`8`	`+using Microsoft.Extensions.Configuration;`
`8`	`9`	`using Microsoft.Extensions.Logging;`
`9`	`10`	`using System;`
`10`	`11`	`using System.Collections.Generic;`
`@@ -59,13 +60,15 @@ public bool TryCreateFactory(`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`/// <inheritdoc/>`
`62`		`- public bool TryCreateOptions(`
	`63`	`+ public bool TryBindOptions(`
`63`	`64`	`string actionName,`
	`65`	`+ IConfigurationSection actionSection,`
`64`	`66`	`out object options)`
`65`	`67`	`{`
`66`	`68`	`if (_map.TryGetValue(actionName, out ICollectionRuleActionDescriptor descriptor))`
`67`	`69`	`{`
`68`		`- options = Activator.CreateInstance(descriptor.OptionsType);`
	`70`	`+ IConfigurationSection settingsSection = actionSection.GetSection(nameof(CollectionRuleActionOptions.Settings));`
	`71`	`+ descriptor.BindOptions(settingsSection, out options);`
`69`	`72`	`return true;`
`70`	`73`	`}`
`71`	`74`