Remove sync support from Cosmos provider (#37103)

Closes #37059

Author: roji

src/EFCore.Cosmos/Diagnostics/CosmosEventId.cs

@@ -25,6 +25,7 @@ public static class CosmosEventId
     private enum Id
     {
         // Database events
+        [Obsolete("Synchronous I/O has been fully removed and now always throws.")]
         SyncNotSupported = CoreEventId.ProviderBaseId,
 
         // Command events
@@ -44,19 +45,6 @@ private enum Id
         NoPartitionKeyDefined = CoreEventId.ProviderBaseId + 600,
     }
 
-    private static readonly string DatabasePrefix = DbLoggerCategory.Database.Name + ".";
-
-    /// <summary>
-    ///     Azure Cosmos DB does not support synchronous I/O. Make sure to use and correctly await only async
-    ///     methods when using Entity Framework Core to access Azure Cosmos DB.
-    ///     See https://aka.ms/ef-cosmos-nosync for more information.
-    /// </summary>
-    /// <remarks>
-    ///     This event is in the <see cref="DbLoggerCategory.Database" /> category.
-    /// </remarks>
-    public static readonly EventId SyncNotSupported
-        = new((int)Id.SyncNotSupported, DatabasePrefix + Id.SyncNotSupported);
-
     private static readonly string CommandPrefix = DbLoggerCategory.Database.Command.Name + ".";
 
     /// <summary>

src/EFCore.Cosmos/Diagnostics/Internal/CosmosLoggerExtensions.cs

@@ -19,32 +19,6 @@ namespace Microsoft.EntityFrameworkCore.Cosmos.Diagnostics.Internal;
 /// </summary>
 public static class CosmosLoggerExtensions
 {
-    /// <summary>
-    ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
-    ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
-    ///     any release. You should only use it directly in your code with extreme caution and knowing that
-    ///     doing so can result in application failures when updating to a new Entity Framework Core release.
-    /// </summary>
-    public static void SyncNotSupported(
-        this IDiagnosticsLogger<DbLoggerCategory.Database> diagnostics)
-    {
-        var definition = CosmosResources.LogSyncNotSupported(diagnostics);
-
-        if (diagnostics.ShouldLog(definition))
-        {
-            definition.Log(diagnostics);
-        }
-
-        if (diagnostics.NeedsEventData(definition, out var diagnosticSourceEnabled, out var simpleLogEnabled))
-        {
-            var eventData = new EventData(
-                definition,
-                (d, p) => ((EventDefinition)d).GenerateMessage());
-
-            diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);
-        }
-    }
-
     /// <summary>
     ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
     ///     the same compatibility standards as public APIs. It may be changed or removed without notice in

src/EFCore.Cosmos/Diagnostics/Internal/CosmosLoggingDefinitions.cs

@@ -75,14 +75,6 @@ public class CosmosLoggingDefinitions : LoggingDefinitions
     /// </summary>
     public EventDefinitionBase? LogExecutedDeleteItem;
 
-    /// <summary>
-    ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
-    ///     the same compatibility standards as public APIs. It may be changed or removed without notice in
-    ///     any release. You should only use it directly in your code with extreme caution and knowing that
-    ///     doing so can result in application failures when updating to a new Entity Framework Core release.
-    /// </summary>
-    public EventDefinitionBase? LogSyncNotSupported;
-
     /// <summary>
     ///     This is an internal API that supports the Entity Framework Core infrastructure and not subject to
     ///     the same compatibility standards as public APIs. It may be changed or removed without notice in

src/EFCore.Cosmos/Extensions/CosmosDbContextOptionsExtensions.cs

@@ -52,8 +52,6 @@ public static DbContextOptionsBuilder UseCosmos(
         Check.NotNull(optionsBuilder);
         Check.NotNull(cosmosOptionsAction);
 
-        ConfigureWarnings(optionsBuilder);
-
         cosmosOptionsAction.Invoke(new CosmosDbContextOptionsBuilder(optionsBuilder));
 
         return optionsBuilder;
@@ -120,8 +118,6 @@ public static DbContextOptionsBuilder UseCosmos(
             .WithAccountKey(accountKey)
             .WithDatabaseName(databaseName);
 
-        ConfigureWarnings(optionsBuilder);
-
         ((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(extension);
 
         cosmosOptionsAction?.Invoke(new CosmosDbContextOptionsBuilder(optionsBuilder));
@@ -190,8 +186,6 @@ public static DbContextOptionsBuilder UseCosmos(
             .WithTokenCredential(tokenCredential)
             .WithDatabaseName(databaseName);
 
-        ConfigureWarnings(optionsBuilder);
-
         ((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(extension);
 
         cosmosOptionsAction?.Invoke(new CosmosDbContextOptionsBuilder(optionsBuilder));
@@ -253,8 +247,6 @@ public static DbContextOptionsBuilder UseCosmos(
             .WithConnectionString(connectionString)
             .WithDatabaseName(databaseName);
 
-        ConfigureWarnings(optionsBuilder);
-
         ((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(extension);
 
         cosmosOptionsAction?.Invoke(new CosmosDbContextOptionsBuilder(optionsBuilder));
@@ -268,10 +260,6 @@ var coreOptionsExtension
             = optionsBuilder.Options.FindExtension<CoreOptionsExtension>()
             ?? new CoreOptionsExtension();
 
-        coreOptionsExtension = coreOptionsExtension.WithWarningsConfiguration(
-            coreOptionsExtension.WarningsConfiguration.TryWithExplicit(
-                CosmosEventId.SyncNotSupported, WarningBehavior.Throw));
-
         ((IDbContextOptionsBuilderInfrastructure)optionsBuilder).AddOrUpdateExtension(coreOptionsExtension);
     }
 }

src/EFCore.Cosmos/Properties/CosmosStrings.Designer.cs

@@ -250,10 +250,6 @@
     <value>The key property '{entityType}.{property}' is not configured to generate values and has the CLR default or sentinel value while saving a new entity to the database. The Azure Cosmos DB database provider for EF Core does not generate key values by default. This means key values must be explicitly set before saving new entities. See https://aka.ms/ef-cosmos-keys for more information.</value>
     <comment>Warning CosmosEventId.PrimaryKeyValueNotSet string string</comment>
   </data>
-  <data name="LogSyncNotSupported" xml:space="preserve">
-    <value>Azure Cosmos DB does not support synchronous I/O. Make sure to use and correctly await only async methods when using Entity Framework Core to access Azure Cosmos DB. See https://aka.ms/ef-cosmos-nosync for more information.</value>
-    <comment>Error CosmosEventId.SyncNotSupported</comment>
-  </data>
   <data name="MissingOrderingInSelectExpression" xml:space="preserve">
     <value>'Reverse' could not be translated to the server because there is no ordering on the server side.</value>
   </data>
@@ -353,6 +349,9 @@
   <data name="SingleFirstOrDefaultNotSupportedOnNonNullableQueries" xml:space="preserve">
     <value>SingleOrDefault and FirstOrDefault cannot be used Cosmos SQL does not allow Offset without Limit. Consider specifying a 'Take' operation on the query.</value>
   </data>
+  <data name="SyncNotSupported" xml:space="preserve">
+    <value>Azure Cosmos DB does not support synchronous I/O. Make sure to use and correctly await only async methods when using Entity Framework Core to access Azure Cosmos DB.</value>
+  </data>
   <data name="ThroughputMismatch" xml:space="preserve">
     <value>The provisioned throughput was configured to '{throughput1}' on '{entityType1}', but on '{entityType2}' it was configured to '{throughput2}'. All entity types mapped to the same container '{container}' must be configured with the same provisioned throughput.</value>
   </data>

src/EFCore.Cosmos/Properties/CosmosStrings.resx

@@ -5,6 +5,7 @@
 
 using System.Collections;
 using System.Text;
+using Microsoft.EntityFrameworkCore.Cosmos.Internal;
 using Microsoft.EntityFrameworkCore.Cosmos.Storage.Internal;
 using Newtonsoft.Json.Linq;
 
@@ -64,7 +65,7 @@ public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken cancellationToke
             => new AsyncEnumerator(this, cancellationToken);
 
         public IEnumerator<T> GetEnumerator()
-            => new Enumerator(this);
+            => throw new InvalidOperationException(CosmosStrings.SyncNotSupported);
 
         IEnumerator IEnumerable.GetEnumerator()
             => GetEnumerator();
@@ -99,95 +100,6 @@ public string ToQueryString()
             return builder.Append(sqlQuery.Query).ToString();
         }
 
-        private sealed class Enumerator : IEnumerator<T>
-        {
-            private readonly QueryingEnumerable<T> _queryingEnumerable;
-            private readonly CosmosQueryContext _cosmosQueryContext;
-            private readonly Func<CosmosQueryContext, JToken, T> _shaper;
-            private readonly Type _contextType;
-            private readonly string _cosmosContainer;
-            private readonly PartitionKey _cosmosPartitionKey;
-            private readonly IDiagnosticsLogger<DbLoggerCategory.Query> _queryLogger;
-            private readonly bool _standAloneStateManager;
-            private readonly IConcurrencyDetector _concurrencyDetector;
-            private readonly IExceptionDetector _exceptionDetector;
-
-            private IEnumerator<JToken> _enumerator;
-
-            public Enumerator(QueryingEnumerable<T> queryingEnumerable)
-            {
-                _queryingEnumerable = queryingEnumerable;
-                _cosmosQueryContext = queryingEnumerable._cosmosQueryContext;
-                _shaper = queryingEnumerable._shaper;
-                _contextType = queryingEnumerable._contextType;
-                _cosmosContainer = queryingEnumerable._cosmosContainer;
-                _cosmosPartitionKey = queryingEnumerable._cosmosPartitionKey;
-                _queryLogger = queryingEnumerable._queryLogger;
-                _standAloneStateManager = queryingEnumerable._standAloneStateManager;
-                _exceptionDetector = _cosmosQueryContext.ExceptionDetector;
-
-                _concurrencyDetector = queryingEnumerable._threadSafetyChecksEnabled
-                    ? _cosmosQueryContext.ConcurrencyDetector
-                    : null;
-            }
-
-            public T Current { get; private set; }
-
-            object IEnumerator.Current
-                => Current;
-
-            public bool MoveNext()
-            {
-                try
-                {
-                    using var _ = _concurrencyDetector?.EnterCriticalSection();
-
-                    if (_enumerator == null)
-                    {
-                        var sqlQuery = _queryingEnumerable.GenerateQuery();
-
-                        EntityFrameworkMetricsData.ReportQueryExecuting();
-
-                        _enumerator = _cosmosQueryContext.CosmosClient
-                            .ExecuteSqlQuery(_cosmosContainer, _cosmosPartitionKey, sqlQuery)
-                            .GetEnumerator();
-                        _cosmosQueryContext.InitializeStateManager(_standAloneStateManager);
-                    }
-
-                    var hasNext = _enumerator.MoveNext();
-
-                    Current
-                        = hasNext
-                            ? _shaper(_cosmosQueryContext, _enumerator.Current)
-                            : default;
-
-                    return hasNext;
-                }
-                catch (Exception exception)
-                {
-                    if (_exceptionDetector.IsCancellation(exception))
-                    {
-                        _queryLogger.QueryCanceled(_contextType);
-                    }
-                    else
-                    {
-                        _queryLogger.QueryIterationFailed(_contextType, exception);
-                    }
-
-                    throw;
-                }
-            }
-
-            public void Dispose()
-            {
-                _enumerator?.Dispose();
-                _enumerator = null;
-            }
-
-            public void Reset()
-                => throw new NotSupportedException(CoreStrings.EnumerableResetNotSupported);
-        }
-
         private sealed class AsyncEnumerator : IAsyncEnumerator<T>
         {
             private readonly QueryingEnumerable<T> _queryingEnumerable;