Merge pull request #897 from eventflow/support-multiple-sql-databases

Support multiple SQL databases for read models

Author: rasmus

MIGRATION_GUIDE.md

@@ -20,6 +20,37 @@ Here is the general motivation for introducing breaking changes to EventFlow.
 - Add obviously missing async/await on critical methods
 - Remove non-async methods wrapper methods
 
+## Notable new features in 1.x
+
+While the main focus of 1.x is to bring EventFlow up to speed with the latest
+standards, there some changes/features that has been added as well. Features
+that wasn't possible to add before as introducing them would cause breaking changes.
+
+- **Multiple MSSQL connection strings:** Its now possible to have read models
+  outside the main database by adding a `[SqlReadModelConnectionStringName]`
+  attribute to the read models. The named connection string is then used for
+  that read model. To configure the named connection strings, provide them
+  during the initial configuration.
+
+  ```csharp
+  MsSqlConfiguration.New
+    .SetConnectionString(/* events connection string */)
+    .SetConnectionString("my-awesome-read-model", /* alternative connection string */)
+  ```
+
+  If the connection string is not known at initialization, provide your own instance
+  of the `IMsSqlConfiguration` which now has a new method.
+  
+  ```csharp
+   Task<string> GetConnectionStringAsync(
+      Label label,
+      string name,
+      CancellationToken cancellationToken);
+  ```
+
+  This allows for connection strings to be fetched runtime from external sources.
+
+
 ## Data in event stores
 
 Upgrading EventFlow should **never** break existing data in event stores, not even

RELEASE_NOTES.md

@@ -1,17 +1,37 @@
 ### New in 1.0 alpha (not released yet)
 
+**IMPORTANT:** Major API breaking changes *might* occur between 1.0 pre-releases. As breaking
+API changes will need to be tested and verified before the final 1.0 release.
+
 Read the complete migration guide to get the full list of changes as well
 as recommendations on how to do the migration.
 
 https://github.com/eventflow/EventFlow/blob/develop-v1/MIGRATION_GUIDE.md
 
+* New/breaking: Replace internal IoC implementation with `Microsoft.Extensions.DependencyInjection`
+* New/breaking: Replace internal logging implementation with `Microsoft.Extensions.Logging`
+* New/breaking: SQL read models now support different connection strings using the
+  `[SqlReadModelConnectionStringName]` attribute. To allow executing queries using different
+  connection strings, all methods on `IMsSqlConnection` and `ISqlConnection` now have an
+  additional argument, `string connectionStringName` to signify which connection string
+  should be used for the query
+* New/breaking: SQL connection strings are now fetched from the
+  `SqlConfiguration<T>.GetConnectionStringAsync(...)` instead of a property, allowing more
+  control of the connection string used at runtime
+* New: Its now possible to change the execution timeout for database migrations using the
+  `SetUpgradeExecutionTimeout(...)` on the SQL configuration
+* Breaking: Removed the following dead and/or confusion MSSQL attributes. The real ones
+  are named the same, with with `Sql...` instead of `MsSql...`
+  - `MsSqlReadModelIdentityColumn`
+  - `MsSqlReadModelIgnoreColumn`
+  - `MsSqlReadModelVersionColumn`
+* Breaking: Methods on `IMsSqlDatabaseMigrator` and `ISqlDatabaseMigrator` have been
+  made async and have an extra `CancellationToken` argument
 * Breaking: Remove support for .NET Framework and consolidate on .NET Core LTS versions
-* Breaking: Replace internal IoC implementation with `Microsoft.Extensions.DependencyInjection`
-* Breaking: Replace internal logging implementation with `Microsoft.Extensions.Logging`
 * Breaking: Replace internal in-memory caching with `Microsoft.Extensions.Caching.Memory`
-* Breaking: Remove `IAmAsyncReadModelFor` and made `IAmReadModelFor` async
+* Breaking: Removed `IAmAsyncReadModelFor` and made `IAmReadModelFor` async
 * Breaking: Removed `EventFlow.Core.AsyncHelper` as well as all async wrapper methods
-  that used it.
+  that used it
   - `IAggregateStore.Load`
   - `IAggregateStore.Store`
   - `IAggregateStore.Update`
@@ -22,6 +42,8 @@ https://github.com/eventflow/EventFlow/blob/develop-v1/MIGRATION_GUIDE.md
   - `IQueryProcessor.Process`
   - `IReadModelPopulator.Populate`
   - `IReadModelPopulator.Purge`
+* Version of 0.x included: `0.83.4713`. 0.x changes are merged to 1.x at regular
+  intervals, but might be one or two releases behind
 
 
 ### New in 0.83.4713 (released 2021-09-07)

Source/EventFlow.MsSql.Tests/Extensions/MsSqlDatabaseExtensions.cs

@@ -30,9 +30,12 @@ namespace EventFlow.MsSql.Tests.Extensions
 {
     public static class MsSqlDatabaseExtensions
     {
-        public static IReadOnlyCollection<T> Query<T>(this IMsSqlDatabase database, string sql)
+        public static IReadOnlyCollection<T> Query<T>(
+            this IMsSqlDatabase database,
+            string sql,
+            object param = null)
         {
-            return database.WithConnection<IReadOnlyCollection<T>>(c => c.Query<T>(sql).ToList());
+            return database.WithConnection<IReadOnlyCollection<T>>(c => c.Query<T>(sql, param).ToList());
         }
 
         public static int Execute(this IMsSqlDatabase database, string sql, object param)

Source/EventFlow.MsSql.Tests/IntegrationTests/EventStores/MsSqlEventStoreTests.cs

@@ -22,6 +22,7 @@
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Threading;
 using EventFlow.MsSql.EventStores;
 using EventFlow.MsSql.Extensions;
 using EventFlow.TestHelpers;
@@ -48,8 +49,11 @@ protected override IServiceProvider Configure(IEventFlowOptions eventFlowOptions
             var serviceProvider = base.Configure(eventFlowOptions);
 
             var databaseMigrator = serviceProvider.GetRequiredService<IMsSqlDatabaseMigrator>();
-            EventFlowEventStoresMsSql.MigrateDatabase(databaseMigrator);
-            databaseMigrator.MigrateDatabaseUsingEmbeddedScripts(GetType().Assembly);
+            EventFlowEventStoresMsSql.MigrateDatabaseAsync(databaseMigrator, CancellationToken.None).Wait();
+            databaseMigrator.MigrateDatabaseUsingEmbeddedScriptsAsync(
+                GetType().Assembly,
+                null, /* TODO */
+                CancellationToken.None).Wait();
 
             return serviceProvider;
         }
@@ -60,4 +64,4 @@ public void TearDown()
             _testDatabase.Dispose();
         }
     }
-}
+}

Source/EventFlow.MsSql.Tests/IntegrationTests/ReadStores/MsSqlReadModelStoreTests.cs

@@ -22,6 +22,7 @@
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 using System;
+using System.Threading;
 using EventFlow.Extensions;
 using EventFlow.MsSql.EventStores;
 using EventFlow.MsSql.Extensions;
@@ -60,8 +61,11 @@ protected override IServiceProvider Configure(IEventFlowOptions eventFlowOptions
             var serviceProvider = base.Configure(eventFlowOptions);
 
             var databaseMigrator = serviceProvider.GetRequiredService<IMsSqlDatabaseMigrator>();
-            EventFlowEventStoresMsSql.MigrateDatabase(databaseMigrator);
-            databaseMigrator.MigrateDatabaseUsingEmbeddedScripts(GetType().Assembly);
+            EventFlowEventStoresMsSql.MigrateDatabaseAsync(databaseMigrator, CancellationToken.None).Wait();
+            databaseMigrator.MigrateDatabaseUsingEmbeddedScriptsAsync(
+                GetType().Assembly,
+                null /* TODO */,
+                CancellationToken.None).Wait();
 
             return serviceProvider;
         }

Source/EventFlow.MsSql.Tests/IntegrationTests/ReadStores/QueryHandlers/MsSqlThingyGetMessagesQueryHandler.cs

@@ -28,6 +28,7 @@
 using EventFlow.Core;
 using EventFlow.MsSql.Tests.IntegrationTests.ReadStores.ReadModels;
 using EventFlow.Queries;
+using EventFlow.Sql.Extensions;
 using EventFlow.TestHelpers.Aggregates.Entities;
 using EventFlow.TestHelpers.Aggregates.Queries;
 
@@ -47,6 +48,7 @@ public async Task<IReadOnlyCollection<ThingyMessage>> ExecuteQueryAsync(ThingyGe
         {
             var readModels = await _msSqlConnection.QueryAsync<MsSqlThingyMessageReadModel>(
                 Label.Named("mssql-fetch-thingy-message-read-model"),
+                ReadModelExtensions.GetConnectionStringName<MsSqlThingyMessageReadModel>(),
                 cancellationToken,
                 "SELECT * FROM [ReadModel-ThingyMessage] WHERE ThingyId = @ThingyId",
                 new { ThingyId = query.ThingyId.Value })
@@ -56,4 +58,4 @@ public async Task<IReadOnlyCollection<ThingyMessage>> ExecuteQueryAsync(ThingyGe
                 .ToList();
         }
     }
-}
+}

Source/EventFlow.MsSql.Tests/IntegrationTests/ReadStores/QueryHandlers/MsSqlThingyGetQueryHandler.cs

@@ -27,6 +27,7 @@
 using EventFlow.Core;
 using EventFlow.MsSql.Tests.IntegrationTests.ReadStores.ReadModels;
 using EventFlow.Queries;
+using EventFlow.Sql.Extensions;
 using EventFlow.TestHelpers.Aggregates;
 using EventFlow.TestHelpers.Aggregates.Queries;
 
@@ -46,11 +47,12 @@ public async Task<Thingy> ExecuteQueryAsync(ThingyGetQuery query, CancellationTo
         {
             var readModels = await _msSqlConnection.QueryAsync<MsSqlThingyReadModel>(
                 Label.Named("mssql-fetch-test-read-model"),
+                ReadModelExtensions.GetConnectionStringName<MsSqlThingyReadModel>(),
                 cancellationToken,
                 "SELECT * FROM [ReadModel-ThingyAggregate] WHERE AggregateId = @AggregateId",
                 new { AggregateId = query.ThingyId.Value })
                 .ConfigureAwait(false);
             return readModels.SingleOrDefault()?.ToThingy();
         }
     }
-}
+}

Source/EventFlow.MsSql.Tests/IntegrationTests/ReadStores/QueryHandlers/MsSqlThingyGetVersionQueryHandler.cs

@@ -27,6 +27,7 @@
 using EventFlow.Core;
 using EventFlow.MsSql.Tests.IntegrationTests.ReadStores.ReadModels;
 using EventFlow.Queries;
+using EventFlow.Sql.Extensions;
 using EventFlow.TestHelpers.Aggregates.Queries;
 
 namespace EventFlow.MsSql.Tests.IntegrationTests.ReadStores.QueryHandlers
@@ -45,6 +46,7 @@ public MsSqlThingyGetVersionQueryHandler(
         {
             var readModels = await _msSqlConnection.QueryAsync<MsSqlThingyReadModel>(
                 Label.Named("mssql-fetch-test-read-model"),
+                ReadModelExtensions.GetConnectionStringName<MsSqlThingyReadModel>(),
                 cancellationToken,
                 "SELECT * FROM [ReadModel-ThingyAggregate] WHERE AggregateId = @AggregateId",
                 new { AggregateId = query.ThingyId.Value })

Source/EventFlow.MsSql.Tests/IntegrationTests/ReadStores/ReadModels/MsSqlThingyMessageReadModel.cs

@@ -26,8 +26,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 using EventFlow.Aggregates;
-using EventFlow.MsSql.ReadStores.Attributes;
 using EventFlow.ReadStores;
+using EventFlow.Sql.ReadModels.Attributes;
 using EventFlow.TestHelpers.Aggregates;
 using EventFlow.TestHelpers.Aggregates.Entities;
 using EventFlow.TestHelpers.Aggregates.Events;
@@ -41,7 +41,7 @@ public class MsSqlThingyMessageReadModel : IReadModel,
     {
         public string ThingyId { get; set; }
 
-        [MsSqlReadModelIdentityColumn]
+        [SqlReadModelIdentityColumn]
         public string MessageId { get; set; }
 
         public string Message { get; set; }