v3.27.2

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 Represents the **NuGet** versions.
 
+## v3.27.2
+- *Fixed:* The `IServiceCollection.AddCosmosDb` extension method was registering as a singleton; this has been corrected to register as scoped. The dependent `CosmosClient` should remain a singleton as is [best practice](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/best-practice-dotnet).
+
 ## v3.27.1
 - *Fixed:* Updated `Microsoft.Extensions.Caching.Memory` package depenedency to latest (including related); resolve [Microsoft Security Advisory CVE-2024-43483](https://github.com/advisories/GHSA-qj66-m88j-hmgj).
 - *Fixed:* Fixed the `ExecutionContext.UserIsAuthorized` to have base implementation similar to `UserIsInRole`.

Common.targets

@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>3.27.1</Version>
+		<Version>3.27.2</Version>
 		<LangVersion>preview</LangVersion>
 		<Authors>Avanade</Authors>
 		<Company>Avanade</Company>

samples/My.Hr/My.Hr.Api/Startup.cs

@@ -34,7 +34,7 @@ public void ConfigureServices(IServiceCollection services)
             .AddAzureServiceBusSender()
             .AddAzureServiceBusPurger()
             .AddJsonMergePatch()
-            .AddWebApi((_, c) => c.UnhandledExceptionAsync = (ex, _, _) => Task.FromResult(ex is DbUpdateConcurrencyException efex ? WebApiBase.CreateActionResultFromExtendedException(new ConcurrencyException()) : null))
+            .AddWebApi((_, webapi) => webapi.UnhandledExceptionAsync = (ex, _, _) => Task.FromResult(ex is DbUpdateConcurrencyException efex ? webapi.CreateActionResultFromExtendedException(new ConcurrencyException()) : null))
             .AddReferenceDataContentWebApi()
             .AddRequestCache();
 

samples/My.Hr/My.Hr.Functions/Startup.cs

@@ -40,7 +40,7 @@ public override void Configure(IFunctionsHostBuilder builder)
                 .AddEventPublisher()
                 .AddSingleton(sp => new Az.ServiceBusClient(sp.GetRequiredService<HrSettings>().ServiceBusConnection__fullyQualifiedNamespace))
                 .AddAzureServiceBusSender()
-                .AddWebApi((_, c) => c.UnhandledExceptionAsync = (ex, _, _) => Task.FromResult(ex is DbUpdateConcurrencyException efex ? WebApiBase.CreateActionResultFromExtendedException(new ConcurrencyException()) : null))
+                .AddWebApi((_, webapi) => webapi.UnhandledExceptionAsync = (ex, _, _) => Task.FromResult(ex is DbUpdateConcurrencyException efex ? webapi.CreateActionResultFromExtendedException(new ConcurrencyException()) : null))
                 .AddJsonMergePatch()
                 .AddWebApiPublisher()
                 .AddAzureServiceBusSubscriber();

src/CoreEx.AspNetCore/WebApis/WebApiBase.cs

@@ -63,6 +63,12 @@ public abstract class WebApiBase(ExecutionContext executionContext, SettingsBase
         /// <remarks>Searches the <see cref="HttpRequest.Headers"/> for <see cref="HttpConsts.CorrelationIdHeaderName"/> or one of the other <see cref="SecondaryCorrelationIdNames"/> to determine the <see cref="ExecutionContext.CorrelationId"/> (uses first value found in sequence).</remarks>
         public IEnumerable<string> SecondaryCorrelationIdNames { get; set; } = ["x-ms-client-tracking-id"];
 
+        /// <summary>
+        /// Gets or sets the <see cref="IExtendedException"/> <see cref="IActionResult"/> creator function used by <see cref="CreateActionResultFromExtendedException(IExtendedException)"/>.
+        /// </summary>
+        /// <remarks>This allows an alternate serialization or handling as required. Defaults to the <see cref="DefaultExtendedExceptionActionResultCreator"/>.</remarks>
+        public Func<IExtendedException, IActionResult> ExtendedExceptionActionResultCreator { get; set; } = DefaultExtendedExceptionActionResultCreator;
+
         /// <summary>
         /// Gets the list of correlation identifier names, being <see cref="HttpConsts.CorrelationIdHeaderName"/> and <see cref="SecondaryCorrelationIdNames"/> (inclusive).
         /// </summary>
@@ -183,7 +189,9 @@ public static async Task<IActionResult> CreateActionResultFromExceptionAsync(Web
                 if (eex.ShouldBeLogged)
                     logger.LogError(exception, "{Error}", exception.Message);
 
-                ar = CreateActionResultFromExtendedException(eex);
+                ar = owner is null 
+                    ? DefaultExtendedExceptionActionResultCreator(eex)
+                    : owner.CreateActionResultFromExtendedException(eex);
             }
             else
             {
@@ -204,7 +212,14 @@ public static async Task<IActionResult> CreateActionResultFromExceptionAsync(Web
         /// Creates an <see cref="IActionResult"/> from an <paramref name="extendedException"/>.
         /// </summary>
         /// <param name="extendedException">The <see cref="IExtendedException"/>.</param>
-        public static IActionResult CreateActionResultFromExtendedException(IExtendedException extendedException)
+        public IActionResult CreateActionResultFromExtendedException(IExtendedException extendedException) => ExtendedExceptionActionResultCreator(extendedException);
+
+        /// <summary>
+        /// The default <see cref="ExtendedExceptionActionResultCreator"/>.
+        /// </summary>
+        /// <param name="extendedException">The <see cref="IExtendedException"/>.</param>
+        /// <returns>The resulting <see cref="IActionResult"/>.</returns>
+        public static IActionResult DefaultExtendedExceptionActionResultCreator(IExtendedException extendedException)
         {
             if (extendedException is ValidationException vex && vex.Messages is not null && vex.Messages.Count > 0)
             {

src/CoreEx.Cosmos/CosmosDb.cs

@@ -24,6 +24,10 @@ namespace CoreEx.Cosmos
     /// <param name="database">The <see cref="Microsoft.Azure.Cosmos.Database"/>.</param>
     /// <param name="mapper">The <see cref="IMapper"/>.</param>
     /// <param name="invoker">Enables the <see cref="Invoker"/> to be overridden; defaults to <see cref="CosmosDbInvoker"/>.</param>
+    /// <remarks>It is recommended that the <see cref="CosmosDb"/> is registered as a scoped service to enable capabilities such as <see cref="CosmosDbArgs.FilterByTenantId"/> that <i>must</i> be scoped. 
+    /// Use <see cref="Microsoft.Extensions.DependencyInjection.CosmosDbServiceCollectionExtensions.AddCosmosDb{TCosmosDb}(Microsoft.Extensions.DependencyInjection.IServiceCollection, Func{IServiceProvider, TCosmosDb}, string?)"/> to 
+    /// register the scoped <see cref="CosmosDb"/> instance.
+    /// <para>The dependent <see cref="CosmosClient"/> should however be registered as a singleton as is <see href="https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/best-practice-dotnet">best practice</see>.</para></remarks>
     public class CosmosDb(Database database, IMapper mapper, CosmosDbInvoker? invoker = null) : ICosmosDb
     {
         private static CosmosDbInvoker? _invoker;
@@ -181,7 +185,8 @@ public async Task<Result> SelectMultiSetWithResultAsync(PartitionKey partitionKe
 
             if (multiSetList.Any(x => !x.Container.IsCosmosDbValueModel))
                 throw new ArgumentException($"All {nameof(IMultiSetArgs)} containers must be of type CosmosDbValueContainer.", nameof(multiSetArgs));
-
+
+            // Build the Cosmos SQL statement.
             var container = multiSetList[0].Container;
             var types = new Dictionary<string, IMultiSetArgs>([ new KeyValuePair<string, IMultiSetArgs>(container.ModelType.Name, multiSetList[0]) ]);
             var sb = string.IsNullOrEmpty(sql) ? new StringBuilder($"SELECT * FROM c WHERE c.type in (\"{container.ModelType.Name}\"") : null; 

src/CoreEx.Cosmos/CosmosDbServiceCollectionExtensions.cs

@@ -14,7 +14,7 @@ namespace Microsoft.Extensions.DependencyInjection
     public static class CosmosDbServiceCollectionExtensions
     {
         /// <summary>
-        /// Adds an <see cref="ICosmosDb"/> as a singleton service.
+        /// Adds an <see cref="ICosmosDb"/> as a scoped service.
         /// </summary>
         /// <typeparam name="TCosmosDb">The <see cref="ICosmosDb"/> <see cref="Type"/>.</typeparam>
         /// <param name="services">The <see cref="IServiceCollection"/>.</param>
@@ -23,15 +23,15 @@ public static class CosmosDbServiceCollectionExtensions
         /// <returns>The <see cref="IServiceCollection"/> to support fluent-style method-chaining.</returns>
         public static IServiceCollection AddCosmosDb<TCosmosDb>(this IServiceCollection services, Func<IServiceProvider, TCosmosDb> create, bool healthCheck = true) where TCosmosDb : class, ICosmosDb
         {
-            services.ThrowIfNull(nameof(services)).AddSingleton(sp => create.ThrowIfNull(nameof(create)).Invoke(sp));
+            services.ThrowIfNull(nameof(services)).AddScoped(sp => create.ThrowIfNull(nameof(create)).Invoke(sp));
             if (healthCheck)
                 services.AddHealthChecks().AddCosmosDbHealthCheck<TCosmosDb>();
 
             return services;
         }
 
         /// <summary>
-        /// Adds an <see cref="ICosmosDb"/> as a singleton service including a corresponding health check.
+        /// Adds an <see cref="ICosmosDb"/> as a scoped service including a corresponding health check.
         /// </summary>
         /// <typeparam name="TCosmosDb">The <see cref="ICosmosDb"/> <see cref="Type"/>.</typeparam>
         /// <param name="services">The <see cref="IServiceCollection"/>.</param>
@@ -40,7 +40,7 @@ public static IServiceCollection AddCosmosDb<TCosmosDb>(this IServiceCollection
         /// <returns>The <see cref="IServiceCollection"/> to support fluent-style method-chaining.</returns>
         public static IServiceCollection AddCosmosDb<TCosmosDb>(this IServiceCollection services, Func<IServiceProvider, TCosmosDb> create, string? healthCheckName) where TCosmosDb : class, ICosmosDb
         {
-            services.ThrowIfNull(nameof(services)).AddSingleton(sp => create.ThrowIfNull(nameof(create)).Invoke(sp));
+            services.ThrowIfNull(nameof(services)).AddScoped(sp => create.ThrowIfNull(nameof(create)).Invoke(sp));
             services.AddHealthChecks().AddCosmosDbHealthCheck<TCosmosDb>(healthCheckName);
             return services;
         }

src/CoreEx/Events/EventDataFormatter.cs

@@ -152,7 +152,7 @@ public virtual void Format(EventData @event)
             var value = @event.Value;
 
             @event.Id ??= Guid.NewGuid().ToString();
-            @event.Timestamp ??= new DateTimeOffset(ExecutionContext.SystemTime.UtcNow);
+            @event.Timestamp ??= new DateTimeOffset(ExecutionContext.HasCurrent ? ExecutionContext.Current.Timestamp : ExecutionContext.SystemTime.UtcNow);
 
             if (PropertySelection.HasFlag(EventDataProperty.Key))
             {

src/CoreEx/ExecutionContext.cs

@@ -8,7 +8,6 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading;
 
 namespace CoreEx