Update info about legacy http handler (#3775)

Added the "deprecationInfo" property for deprecated knobs. Updated the warning message about using legacy http handler.
microsoft · Mar 9, 2022 · 43189fc · 43189fc
1 parent 9042b0d
commit 43189fc
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/src/Agent.Sdk/Knob/AgentKnobs.cs b/src/Agent.Sdk/Knob/AgentKnobs.cs
@@ -145,6 +145,7 @@ public class AgentKnobs
         public static readonly Knob UseLegacyHttpHandler = new DeprecatedKnob(
             nameof(UseLegacyHttpHandler),
             "Use the libcurl-based HTTP handler rather than .NET's native HTTP handler, as we did on .NET Core 2.1",
+            "Legacy http handler will be removed in one of the next agent releases with migration to .Net Core 6. We are highly recommend to not use it.",
             new EnvironmentKnobSource(LegacyHttpVariableName),
             new BuiltInDefaultKnobSource("false"));
 

diff --git a/src/Agent.Sdk/Knob/Knob.cs b/src/Agent.Sdk/Knob/Knob.cs
@@ -11,8 +11,15 @@ namespace Agent.Sdk.Knob
     public class DeprecatedKnob : Knob
     {
         public override bool IsDeprecated => true;
+        public string DeprecationInfo;
         public DeprecatedKnob(string name, string description, params IKnobSource[] sources) : base(name, description, sources)
         {
+            DeprecationInfo = "";
+        }
+
+        public DeprecatedKnob(string name, string description, string deprecationInfo, params IKnobSource[] sources) : base(name, description, sources)
+        {
+            DeprecationInfo = deprecationInfo;
         }
     }
 

diff --git a/src/Agent.Worker/JobExtension.cs b/src/Agent.Worker/JobExtension.cs
@@ -147,9 +147,16 @@ public async Task<List<IStep>> InitializeJob(IExecutionContext jobContext, Pipel
                                 HostContext.SecretMasker.AddValue(stringValue, $"JobExtension_InitializeJob_{knob.Name}");
                             }
                             var outputLine = $"   Knob: {knob.Name} = {stringValue} Source: {value.Source.GetDisplayString()} {tag}";
+
                             if (knob.IsDeprecated)
                             {
                                 context.Warning(outputLine);
+
+                                string deprecationInfo = (knob as DeprecatedKnob).DeprecationInfo;
+                                if (!string.IsNullOrEmpty(deprecationInfo))
+                                {
+                                    context.Warning(deprecationInfo);
+                                }
                             }
                             else
                             {