Fix circular reference issue building up meter provider. (#3806)

Co-authored-by: Utkarsh Umesan Pillai <utpilla@microsoft.com>

src/OpenTelemetry/Internal/Builder/ProviderBuilderServiceCollectionExtensions.cs

@@ -31,6 +31,7 @@ public static IServiceCollection AddOpenTelemetryMeterProviderBuilderServices(th
     {
         services.AddOpenTelemetryProviderBuilderServices();
 
+        services.TryAddSingleton<MeterProviderBuilderState>();
         services.RegisterOptionsFactory(configuration => new MetricReaderOptions(configuration));
 
         return services;
@@ -40,8 +41,8 @@ public static IServiceCollection AddOpenTelemetryTracerProviderBuilderServices(t
     {
         services.AddOpenTelemetryProviderBuilderServices();
 
-        services.RegisterOptionsFactory(configuration => new ExportActivityProcessorOptions(configuration));
         services.TryAddSingleton<TracerProviderBuilderState>();
+        services.RegisterOptionsFactory(configuration => new ExportActivityProcessorOptions(configuration));
 
         return services;
     }

src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderBase.cs

@@ -46,14 +46,14 @@ internal MeterProviderBuilderBase(MeterProviderBuilderState state)
             this.State = state;
         }
 
-        // This ctor is for AddOpenTelemetryTracing scenario where the builder
-        // is bound to an external service collection.
+        // This ctor is for ConfigureOpenTelemetryMetrics +
+        // AddOpenTelemetryMetrics scenarios where the builder is bound to an
+        // external service collection.
         internal MeterProviderBuilderBase(IServiceCollection services)
         {
             Guard.ThrowIfNull(services);
 
             services.AddOpenTelemetryMeterProviderBuilderServices();
-
             services.TryAddSingleton<MeterProvider>(sp => new MeterProviderSdk(sp, ownsServiceProvider: false));
 
             this.services = services;
@@ -67,6 +67,8 @@ protected MeterProviderBuilderBase()
             var services = new ServiceCollection();
 
             services.AddOpenTelemetryMeterProviderBuilderServices();
+            services.AddSingleton<MeterProvider>(
+                sp => throw new NotSupportedException("External MeterProvider created through Sdk.CreateMeterProviderBuilder cannot be accessed using service provider."));
 
             this.services = services;
             this.ownsServices = true;

src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderState.cs

@@ -41,6 +41,7 @@ internal sealed class MeterProviderBuilderState
         internal int MaxMetricStreams = MaxMetricsDefault;
         internal int MaxMetricPointsPerMetricStream = MaxMetricPointsPerMetricDefault;
 
+        private bool hasEnteredBuildPhase;
         private MeterProviderBuilderSdk? builder;
 
         public MeterProviderBuilderState(IServiceProvider serviceProvider)
@@ -52,6 +53,16 @@ public MeterProviderBuilderState(IServiceProvider serviceProvider)
 
         public MeterProviderBuilderSdk Builder => this.builder ??= new MeterProviderBuilderSdk(this);
 
+        public void CheckForCircularBuild()
+        {
+            if (this.hasEnteredBuildPhase)
+            {
+                throw new NotSupportedException("MeterProvider cannot be accessed while build is executing.");
+            }
+
+            this.hasEnteredBuildPhase = true;
+        }
+
         public void AddInstrumentation(
             string instrumentationName,
             string instrumentationVersion,

src/OpenTelemetry/Metrics/MeterProviderSdk.cs

@@ -22,6 +22,7 @@
 using System.Diagnostics.Metrics;
 using System.Linq;
 using System.Text;
+using Microsoft.Extensions.DependencyInjection;
 using OpenTelemetry.Internal;
 using OpenTelemetry.Resources;
 
@@ -47,6 +48,9 @@ internal MeterProviderSdk(
         {
             Debug.Assert(serviceProvider != null, "serviceProvider was null");
 
+            var state = serviceProvider!.GetRequiredService<MeterProviderBuilderState>();
+            state.CheckForCircularBuild();
+
             this.ServiceProvider = serviceProvider!;
 
             if (ownsServiceProvider)
@@ -57,8 +61,6 @@ internal MeterProviderSdk(
 
             OpenTelemetrySdkEventSource.Log.MeterProviderSdkEvent("Building MeterProvider.");
 
-            var state = new MeterProviderBuilderState(serviceProvider!);
-
             MeterProviderBuilderServiceCollectionHelper.InvokeRegisteredConfigureStateCallbacks(
                 serviceProvider!,
                 state);

test/OpenTelemetry.Tests/Metrics/MeterProviderBuilderExtensionsTests.cs

@@ -261,6 +261,56 @@ public void ConfigureBuilderIConfigurationModifiableTest()
             Assert.True(configureBuilderCalled);
         }
 
+        [Theory]
+        [InlineData(true)]
+        [InlineData(false)]
+        public void MeterProviderNestedResolutionUsingBuilderTest(bool callNestedConfigure)
+        {
+            bool innerTestExecuted = false;
+
+            using var provider = Sdk.CreateMeterProviderBuilder()
+                .ConfigureServices(services =>
+                {
+                    if (callNestedConfigure)
+                    {
+                        services.ConfigureOpenTelemetryMetrics();
+                    }
+                })
+                .ConfigureBuilder((sp, builder) =>
+                {
+                    innerTestExecuted = true;
+                    Assert.Throws<NotSupportedException>(() => sp.GetService<MeterProvider>());
+                })
+                .Build();
+
+            Assert.True(innerTestExecuted);
+
+            Assert.Throws<NotSupportedException>(() => provider.GetServiceProvider()?.GetService<MeterProvider>());
+        }
+
+        [Fact]
+        public void MeterProviderNestedResolutionUsingConfigureTest()
+        {
+            bool innerTestExecuted = false;
+
+            var serviceCollection = new ServiceCollection();
+
+            serviceCollection.ConfigureOpenTelemetryMetrics(builder =>
+            {
+                builder.ConfigureBuilder((sp, builder) =>
+                {
+                    innerTestExecuted = true;
+                    Assert.Throws<NotSupportedException>(() => sp.GetService<MeterProvider>());
+                });
+            });
+
+            using var serviceProvider = serviceCollection.BuildServiceProvider();
+
+            var resolvedProvider = serviceProvider.GetRequiredService<MeterProvider>();
+
+            Assert.True(innerTestExecuted);
+        }
+
         private static void RunBuilderServiceLifecycleTest(
             MeterProviderBuilder builder,
             Func<MeterProviderSdk> buildFunc,