Add Lazy and method to create optional rules

open-telemetry · Sep 15, 2023 · 5efcf1e · 5efcf1e
1 parent 452ca11
commit 5efcf1e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 15 deletions.
diff --git a/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuleEngine.cs b/src/OpenTelemetry.AutoInstrumentation.StartupHook/RulesEngine/RuleEngine.cs
@@ -28,14 +28,15 @@ internal class RuleEngine
         new MinSupportedFrameworkRule()
     };
 
-    private readonly List<Rule>? _optionalRules;
+    private readonly Lazy<List<Rule>> _optionalRules;
 
     internal RuleEngine()
+        : this(new Lazy<List<Rule>>(CreateDefaultOptionalRules))
     {
     }
 
     // This constructor is used for test purpose.
-    internal RuleEngine(List<Rule> optionalRules)
+    internal RuleEngine(Lazy<List<Rule>> optionalRules)
     {
         _optionalRules = optionalRules;
     }
@@ -59,15 +60,8 @@ internal bool ValidateRules()
             return result;
         }
 
-        var optionalRules = _optionalRules ?? new()
-        {
-            new OpenTelemetrySdkMinimumVersionRule(),
-            new AssemblyFileVersionRule(),
-            new NativeProfilerDiagnosticsRule()
-        };
-
         // All the rules are validated here.
-        foreach (var rule in optionalRules)
+        foreach (var rule in _optionalRules.Value)
         {
             if (!EvaluateRule(rule))
             {
@@ -95,4 +89,14 @@ private static bool EvaluateRule(Rule rule)
 
         return true;
     }
+
+    private static List<Rule> CreateDefaultOptionalRules()
+    {
+        return new()
+        {
+            new OpenTelemetrySdkMinimumVersionRule(),
+            new AssemblyFileVersionRule(),
+            new NativeProfilerDiagnosticsRule()
+        };
+    }
 }
diff --git a/test/OpenTelemetry.AutoInstrumentation.StartupHook.Tests/RuleEngineTests.cs b/test/OpenTelemetry.AutoInstrumentation.StartupHook.Tests/RuleEngineTests.cs
@@ -32,7 +32,7 @@ public void RuleEngineValidation_WhenShouldTrackIsTrue()
         // Arrange
         SetShouldTrackEnvironmentVariable(true);
         var testRule = new TestRule();
-        var ruleEngine = new RuleEngine(new List<Rule> { testRule });
+        var ruleEngine = new RuleEngine(new Lazy<List<Rule>>(() => new() { testRule }));
 
         // Act
         var result = ruleEngine.ValidateRules();
@@ -48,7 +48,7 @@ public void RuleEngineValidation_WhenShouldTrackIsFalse()
         // Arrange
         SetShouldTrackEnvironmentVariable(false);
         var testRule = new TestRule();
-        var ruleEngine = new RuleEngine(new List<Rule> { testRule });
+        var ruleEngine = new RuleEngine(new Lazy<List<Rule>>(() => new() { testRule }));
 
         // Act
         var result = ruleEngine.ValidateRules();
@@ -64,7 +64,7 @@ public void RuleEngineValidation_WhenShouldTrackIsNull()
         // Arrange
         SetShouldTrackEnvironmentVariable(null);
         var testRule = new TestRule();
-        var ruleEngine = new RuleEngine(new List<Rule> { testRule });
+        var ruleEngine = new RuleEngine(new Lazy<List<Rule>>(() => new() { testRule }));
 
         // Act
         var result = ruleEngine.ValidateRules();
@@ -79,7 +79,7 @@ public void RuleEngineValidation_WhenShouldTrackIsNotSet()
     {
         // Arrange
         var testRule = new TestRule();
-        var ruleEngine = new RuleEngine(new List<Rule> { testRule });
+        var ruleEngine = new RuleEngine(new Lazy<List<Rule>>(() => new() { testRule }));
 
         // Act
         var result = ruleEngine.ValidateRules();
@@ -95,7 +95,7 @@ public void RuleEngineValidation_WhenShouldTrackHasInvalidValue()
         // Arrange
         Environment.SetEnvironmentVariable("OTEL_DOTNET_AUTO_RULE_ENGINE_ENABLED", "Invalid");
         var testRule = new TestRule();
-        var ruleEngine = new RuleEngine(new List<Rule> { testRule });
+        var ruleEngine = new RuleEngine(new Lazy<List<Rule>>(() => new() { testRule }));
 
         // Act
         var result = ruleEngine.ValidateRules();