Add experimental diagnostics ids

Author: Martin Taillefer

Directory.Build.targets

@@ -35,9 +35,8 @@
     <!-- Prevent analyzer crashes from stopping things -->
     <NoWarn>$(NoWarn);AD0001</NoWarn>
 
-    <!-- R9A029 is for customers, not for this repo -->
-    <NoWarn>$(NoWarn);R9A029</NoWarn>
-
+    <!-- Experimental warnings are for customers, not for this repo -->
+    <NoWarn>$(NoWarn);EXTEXP0001;EXTEXP0002;EXTEXP0003;EXTEXP0004;EXTEXP0005;;EXTEXP0006;EXTEXP0007;EXTEXP0008;EXTEXP0009;EXTEXP00010;EXTEXP00011;EXTEXP0001;EXTEXP0001;EXTEXP0001;EXTEXP0001</NoWarn>
 
     <!-- NU5104: A stable release of a package should not have a prerelease dependency -->
     <NoWarn>$(NoWarn);NU5104</NoWarn>

eng/MSBuild/Shared.props

@@ -1,6 +1,6 @@
 <Project>
   <ItemGroup>
-    <Compile Include="$(MSBuildThisFileDirectory)\..\..\src\Shared\WarningDefinitions.cs" LinkBase="Shared" />
+    <Compile Include="$(MSBuildThisFileDirectory)\..\..\src\Shared\DiagnosticIds\*.cs" LinkBase="Shared\DiagnosticIds" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(InjectSharedThrow)' == 'true'">

src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/DiagDescriptors.cs

@@ -101,17 +101,7 @@ internal static class DiagDescriptors
         helpLinkUri: "https://TODO/r9a022",
         isEnabledByDefault: true);
 
-    // R9A023..R9A028 retired
-
-    public static DiagnosticDescriptor UsingExperimentalApi { get; } = new(
-        id: "R9A029",
-        messageFormat: Resources.UsingExperimentalApiMessage,
-        title: Resources.UsingExperimentalApiTitle,
-        category: Reliability,
-        description: Resources.UsingExperimentalApiDescription,
-        defaultSeverity: DiagnosticSeverity.Warning,
-        helpLinkUri: "https://TODO/r9a029",
-        isEnabledByDefault: true);
+    // R9A023..R9A029 retired
 
     public static DiagnosticDescriptor StartsEndsWith { get; } = new(
         id: "R9A030",

src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/Resources.Designer.cs

@@ -180,15 +180,6 @@
   <data name="SequentialFixAllInSolution" xml:space="preserve">
     <value>Apply code fix for all issues in current solution</value>
   </data>
-  <data name="UsingExperimentalApiDescription" xml:space="preserve">
-    <value>Indicates that code is depending on an experimental API</value>
-  </data>
-  <data name="UsingExperimentalApiTitle" xml:space="preserve">
-    <value>Using experimental API</value>
-  </data>
-  <data name="UsingExperimentalApiMessage" xml:space="preserve">
-    <value>'{0}' is experimental and is subject to change without notice</value>
-  </data>
   <data name="StartsEndsWithDescription" xml:space="preserve">
     <value>When checking for a single character, prefer the character overloads of 'String.StartsWith' and 'String.EndsWith' for improved performance</value>
   </data>

src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/Resources.resx

@@ -8,6 +8,7 @@
 using Microsoft.Extensions.Compliance.Classification;
 using Microsoft.Extensions.Http.Telemetry;
 using Microsoft.Shared.Data.Validation;
+using Microsoft.Shared.DiagnosticIds;
 
 namespace Microsoft.AspNetCore.Telemetry;
 
@@ -67,7 +68,7 @@ public class LoggingOptions
     /// <value>
     /// The default value is <see cref="HttpRouteParameterRedactionMode.Strict"/>.
     /// </value>
-    [Experimental(diagnosticId: "TBD", UrlFormat = WarningDefinitions.SharedUrlFormat)]
+    [Experimental(diagnosticId: Experiments.Telemetry, UrlFormat = Experiments.UrlFormat)]
     public HttpRouteParameterRedactionMode RequestPathParameterRedactionMode { get; set; } = DefaultPathParameterRedactionMode;
 
     /// <summary>
@@ -208,7 +209,7 @@ public class LoggingOptions
     /// };
     /// </code>
     /// </example>
-    [Experimental(diagnosticId: "TBD", UrlFormat = WarningDefinitions.SharedUrlFormat)]
+    [Experimental(diagnosticId: Experiments.Telemetry, UrlFormat = Experiments.UrlFormat)]
     [Required]
     [SuppressMessage("Usage", "CA2227:Collection properties should be read only",
         Justification = "Options pattern.")]

src/Analyzers/Microsoft.Extensions.ExtraAnalyzers/Common/UsingExperimentalApiAnalyzer.cs

@@ -5,6 +5,7 @@
 using System.ComponentModel.DataAnnotations;
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.Extensions.Compliance.Classification;
+using Microsoft.Shared.DiagnosticIds;
 
 namespace Microsoft.AspNetCore.Telemetry;
 
@@ -20,7 +21,7 @@ public class RequestHeadersLogEnricherOptions
     /// Default value is an empty dictionary.
     /// </remarks>
     [Required]
-    [Experimental(diagnosticId: "TBD", UrlFormat = WarningDefinitions.SharedUrlFormat)]
+    [Experimental(diagnosticId: Experiments.Telemetry, UrlFormat = Experiments.UrlFormat)]
 #pragma warning disable CA2227 // Collection properties should be read only
     public IDictionary<string, DataClassification> HeadersDataClasses { get; set; } = new Dictionary<string, DataClassification>();
 #pragma warning restore CA2227 // Collection properties should be read only

src/Libraries/Microsoft.AspNetCore.Telemetry.Middleware/Logging/LoggingOptions.cs

@@ -9,6 +9,7 @@
 using Microsoft.Extensions.Options;
 using Microsoft.Extensions.Options.Validation;
 using Microsoft.Extensions.Telemetry.Internal;
+using Microsoft.Shared.DiagnosticIds;
 using Microsoft.Shared.Diagnostics;
 using OpenTelemetry.Instrumentation.AspNetCore;
 using OpenTelemetry.Trace;
@@ -116,7 +117,7 @@ public static TracerProviderBuilder AddHttpTraceEnricher(this TracerProviderBuil
     /// <param name="services">The <see cref="IServiceCollection"/> to add this enricher.</param>
     /// <returns><see cref="IServiceCollection"/> for chaining.</returns>
     /// <exception cref="ArgumentNullException">The argument <paramref name="services"/> is <see langword="null"/>.</exception>
-    [Experimental(diagnosticId: "TBD", UrlFormat = WarningDefinitions.SharedUrlFormat)]
+    [Experimental(diagnosticId: Experiments.Telemetry, UrlFormat = Experiments.UrlFormat)]
     public static IServiceCollection AddHttpTraceEnricher<T>(this IServiceCollection services)
         where T : class, IHttpTraceEnricher
     {
@@ -132,7 +133,7 @@ public static IServiceCollection AddHttpTraceEnricher<T>(this IServiceCollection
     /// <param name="enricher">Enricher to be added.</param>
     /// <returns><see cref="TracerProviderBuilder"/> for chaining.</returns>
     /// <exception cref="ArgumentNullException">The argument <paramref name="services"/> or <paramref name="enricher"/> is <see langword="null" />.</exception>
-    [Experimental(diagnosticId: "TBD", UrlFormat = WarningDefinitions.SharedUrlFormat)]
+    [Experimental(diagnosticId: Experiments.Telemetry, UrlFormat = Experiments.UrlFormat)]
     public static IServiceCollection AddHttpTraceEnricher(this IServiceCollection services, IHttpTraceEnricher enricher)
     {
         _ = Throw.IfNull(services);

src/Libraries/Microsoft.AspNetCore.Telemetry/Enrichment.RequestHeaders/RequestHeadersLogEnricherOptions.cs

@@ -7,6 +7,7 @@
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.Extensions.Compliance.Classification;
 using Microsoft.Extensions.Http.Telemetry;
+using Microsoft.Shared.DiagnosticIds;
 
 namespace Microsoft.AspNetCore.Telemetry;
 
@@ -51,7 +52,7 @@ public class HttpTracingOptions
     /// <remarks>
     /// This property is applicable when the <see cref="IncludePath"/> option is enabled.
     /// </remarks>
-    [Experimental(diagnosticId: "TBD", UrlFormat = WarningDefinitions.SharedUrlFormat)]
+    [Experimental(diagnosticId: Experiments.Telemetry, UrlFormat = Experiments.UrlFormat)]
     public HttpRouteParameterRedactionMode RequestPathParameterRedactionMode { get; set; } = DefaultPathParameterRedactionMode;
 
     /// <summary>