Merge branch 'develop'

Author: rasmus

.gitattributes

@@ -0,0 +1 @@
+*.png filter=lfs diff=lfs merge=lfs -text

Documentation/Images/logo_resharper.png

@@ -156,6 +156,11 @@ several areas that you could help out with.
    point to specfic EventFlow functionality that might be done better, then
    please create an issue or ask in the Gitter chat
 
+## Thanks
+
+![ReSharper](./Documentation/Images/logo_resharper.png)
+
+
 ## License
 
 ```

README.md

@@ -1,4 +1,25 @@
-### New in 0.17 (not released yet)
+### New in 0.18 (not released yet)
+
+* POTENTIAL DATA LOSS for the **files event store**: The EventFlow
+  internal functionality regarding event stores has been refactored resulting
+  in information regarding aggregate names being removed from the event
+  persistence layer. The files based event store no longer stores its events in
+  the path `[STORE PATH]\[AGGREGATE NAME]\[AGGREGATE ID]\[SEQUENCE].json`, but
+  in the path `[STORE PATH]\[AGGREGATE ID]\[SEQUENCE].json`. Thus if you are
+  using the files event store for tests, you should move the events into the
+  new file structure. Alternatively, implement the new `IFilesEventLocator` and
+  provide your own custom event file layout.
+* Breaking: Event stores have been split into two parts, the `IEventStore`
+  and the new `IEventPersistence`. `IEventStore` has the same interface before
+  but the implementation is now no longer responsible for persisting the events,
+  only converting and serializing the persisted events. `IEventPersistence`
+  handles the actual storing of events and thus if any custom event stores have
+  been implemented, they should implement to the new `IEventPersistence`
+  instead.
+* New: Added `IEntity`, `IEntity<>` and an optional `Entity<>` that developers
+  can use to implement DDD entities.
+
+### New in 0.17.1134 (released 2015-09-28)
 
 * Fixed: Using NuGet package `EventFlow.Autofac` causes an exception with the
   message `The type 'EventFlow.Configuration.Registrations.AutofacStartable'

RELEASE_NOTES.md

@@ -23,7 +23,6 @@
 using System.Net;
 using System.Threading;
 using System.Threading.Tasks;
-using EventFlow.Aggregates;
 using EventFlow.Configuration;
 using EventFlow.Core;
 using EventFlow.EventStores.EventStore.Extensions;

Source/EventFlow.EventStores.EventStore.Tests/IntegrationTests/EventStoreEventStoreTestConfiguration.cs

@@ -51,7 +51,7 @@
     <Compile Include="..\SolutionInfo.cs">
       <Link>Properties\SolutionInfo.cs</Link>
     </Compile>
-    <Compile Include="EventStoreEventStore.cs" />
+    <Compile Include="EventStoreEventPersistence.cs" />
     <Compile Include="Extensions\EventFlowOptionsExtensions.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>

Source/EventFlow.EventStores.EventStore/EventFlow.EventStores.EventStore.csproj

@@ -27,39 +27,36 @@
 using System.Threading;
 using System.Threading.Tasks;
 using EventFlow.Aggregates;
+using EventFlow.Core;
 using EventFlow.Exceptions;
 using EventFlow.Logs;
 using EventStore.ClientAPI;
 using EventStore.ClientAPI.Exceptions;
 
 namespace EventFlow.EventStores.EventStore
 {
-    public class EventStoreEventStore : EventStoreBase
+    public class EventStoreEventPersistence : IEventPersistence
     {
+        private readonly ILog _log;
         private readonly IEventStoreConnection _connection;
 
         private class EventStoreEvent : ICommittedDomainEvent
         {
             public string AggregateId { get; set; }
-            public string AggregateName { get; set; }
             public string Data { get; set; }
             public string Metadata { get; set; }
             public int AggregateSequenceNumber { get; set; }
         }
 
-        public EventStoreEventStore(
+        public EventStoreEventPersistence(
             ILog log,
-            IAggregateFactory aggregateFactory,
-            IEventJsonSerializer eventJsonSerializer,
-            IEventUpgradeManager eventUpgradeManager,
-            IEventStoreConnection connection,
-            IEnumerable<IMetadataProvider> metadataProviders)
-            : base(log, aggregateFactory, eventJsonSerializer, eventUpgradeManager, metadataProviders)
+            IEventStoreConnection connection)
         {
+            _log = log;
             _connection = connection;
         }
 
-        protected override async Task<AllCommittedEventsPage> LoadAllCommittedDomainEvents(
+        public async Task<AllCommittedEventsPage> LoadAllCommittedEvents(
             GlobalPosition globalPosition,
             int pageSize,
             CancellationToken cancellationToken)
@@ -104,19 +101,17 @@ private static Position ParsePosition(GlobalPosition globalPosition)
             return new Position(commitPosition, preparePosition);
         }
 
-        protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> CommitEventsAsync<TAggregate, TIdentity>(
-            TIdentity id,
+        public async Task<IReadOnlyCollection<ICommittedDomainEvent>> CommitEventsAsync(
+            IIdentity id,
             IReadOnlyCollection<SerializedEvent> serializedEvents,
             CancellationToken cancellationToken)
         {
-            var aggregateName = typeof (TAggregate).Name;
             var committedDomainEvents = serializedEvents
                 .Select(e => new EventStoreEvent
                     {
                         AggregateSequenceNumber = e.AggregateSequenceNumber,
                         Metadata = e.SerializedMetadata,
                         AggregateId = id.Value,
-                        AggregateName = aggregateName,
                         Data = e.SerializedData
                     })
                 .ToList();
@@ -126,7 +121,7 @@ protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> Commit
                 .Select(e =>
                     {
                         var guid = Guid.Parse(e.Metadata["guid"]);
-                        var eventType = string.Format("{0}.{1}.{2}", aggregateName, e.Metadata.EventName, e.Metadata.EventVersion);
+                        var eventType = string.Format("{0}.{1}.{2}", e.Metadata[MetadataKeys.AggregateName], e.Metadata.EventName, e.Metadata.EventVersion);
                         var data = Encoding.UTF8.GetBytes(e.SerializedData);
                         var meta = Encoding.UTF8.GetBytes(e.SerializedMetadata);
                         return new EventData(guid, eventType, true, data, meta);
@@ -142,9 +137,9 @@ protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> Commit
                 {
                     await transaction.WriteAsync(eventDatas).ConfigureAwait(false);
                     var writeResult = await transaction.CommitAsync().ConfigureAwait(false);
-                    Log.Verbose(
-                        "Wrote aggregate {0} with version {1} ({2},{3})",
-                        aggregateName,
+                    _log.Verbose(
+                        "Wrote entity {0} with version {1} ({2},{3})",
+                        id,
                         writeResult.NextExpectedVersion - 1,
                         writeResult.LogPosition.CommitPosition,
                         writeResult.LogPosition.PreparePosition);
@@ -158,8 +153,8 @@ protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> Commit
             return committedDomainEvents;
         }
 
-        protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> LoadCommittedEventsAsync<TAggregate, TIdentity>(
-            TIdentity id,
+        public async Task<IReadOnlyCollection<ICommittedDomainEvent>> LoadCommittedEventsAsync(
+            IIdentity id,
             CancellationToken cancellationToken)
         {
             var streamEvents = new List<ResolvedEvent>();
@@ -182,9 +177,7 @@ protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> LoadCo
             return Map(streamEvents);
         }
 
-        public override Task DeleteAggregateAsync<TAggregate, TIdentity>(
-            TIdentity id,
-            CancellationToken cancellationToken)
+        public Task DeleteEventsAsync(IIdentity id, CancellationToken cancellationToken)
         {
             return _connection.DeleteStreamAsync(id.Value, ExpectedVersion.Any);
         }
@@ -197,10 +190,9 @@ private static IReadOnlyCollection<EventStoreEvent> Map(IEnumerable<ResolvedEven
                         AggregateSequenceNumber = e.Event.EventNumber + 1,
                         Metadata = Encoding.UTF8.GetString(e.Event.Metadata),
                         AggregateId = e.OriginalStreamId,
-                        AggregateName = e.Event.EventType.Split('.')[0],
                         Data = Encoding.UTF8.GetString(e.Event.Data),
                     })
                 .ToList();
         }
     }
-}
+}

Source/EventFlow.EventStores.EventStore/EventStoreEventStore.cs renamed to Source/EventFlow.EventStores.EventStore/EventStoreEventPersistence.cs

@@ -22,7 +22,6 @@
 
 using System.Net;
 using EventFlow.Configuration;
-using EventFlow.Configuration.Registrations;
 using EventFlow.Core;
 using EventFlow.Extensions;
 using EventStore.ClientAPI;
@@ -34,7 +33,7 @@ public static class EventFlowOptionsExtensions
         public static IEventFlowOptions UseEventStoreEventStore(
             this IEventFlowOptions eventFlowOptions)
         {
-            return eventFlowOptions.UseEventStore<EventStoreEventStore>();
+            return eventFlowOptions.UseEventStore<EventStoreEventPersistence>();
         }
 
         public static IEventFlowOptions UseEventStoreEventStore(
@@ -59,7 +58,7 @@ public static IEventFlowOptions UseEventStoreEventStore(
 
             return eventFlowOptions
                 .RegisterServices(f => f.Register(r => eventStoreConnection, Lifetime.Singleton))
-                .UseEventStore<EventStoreEventStore>();
+                .UseEventStore<EventStoreEventPersistence>();
         }
     }
 }

Source/EventFlow.EventStores.EventStore/Extensions/EventFlowOptionsExtensions.cs

@@ -50,7 +50,7 @@
     </Compile>
     <Compile Include="EventFlowEventStoresMsSql.cs" />
     <Compile Include="Extensions\EventFlowOptionsExtensions.cs" />
-    <Compile Include="MsSqlEventStore.cs" />
+    <Compile Include="MsSqlEventPersistence.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>

Source/EventFlow.EventStores.MsSql/EventFlow.EventStores.MsSql.csproj

@@ -28,7 +28,7 @@ public static class EventFlowOptionsExtensions
     {
         public static IEventFlowOptions UseMssqlEventStore(this IEventFlowOptions eventFlowOptions)
         {
-            return eventFlowOptions.UseEventStore<MsSqlEventStore>();
+            return eventFlowOptions.UseEventStore<MsSqlEventPersistence>();
         }
     }
 }

Source/EventFlow.EventStores.MsSql/Extensions/EventFlowOptionsExtensions.cs

@@ -34,7 +34,7 @@
 
 namespace EventFlow.EventStores.MsSql
 {
-    public class MsSqlEventStore : EventStoreBase
+    public class MsSqlEventPersistence : IEventPersistence
     {
         public class EventDataModel : ICommittedDomainEvent
         {
@@ -47,21 +47,18 @@ public class EventDataModel : ICommittedDomainEvent
             public int AggregateSequenceNumber { get; set; }
         }
 
+        private readonly ILog _log;
         private readonly IMsSqlConnection _connection;
 
-        public MsSqlEventStore(
+        public MsSqlEventPersistence(
             ILog log,
-            IAggregateFactory aggregateFactory,
-            IEventJsonSerializer eventJsonSerializer,
-            IEventUpgradeManager eventUpgradeManager,
-            IEnumerable<IMetadataProvider> metadataProviders,
             IMsSqlConnection connection)
-            : base(log, aggregateFactory, eventJsonSerializer, eventUpgradeManager, metadataProviders)
         {
+            _log = log;
             _connection = connection;
         }
 
-        protected override async Task<AllCommittedEventsPage> LoadAllCommittedDomainEvents(
+        public async Task<AllCommittedEventsPage> LoadAllCommittedEvents(
             GlobalPosition globalPosition,
             int pageSize,
             CancellationToken cancellationToken)
@@ -97,17 +94,13 @@ ORDER BY
             return new AllCommittedEventsPage(new GlobalPosition(nextPosition.ToString()), eventDataModels);
         }
 
-        protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> CommitEventsAsync<TAggregate, TIdentity>(
-            TIdentity id,
-            IReadOnlyCollection<SerializedEvent> serializedEvents,
-            CancellationToken cancellationToken)
+        public async Task<IReadOnlyCollection<ICommittedDomainEvent>> CommitEventsAsync(IIdentity id, IReadOnlyCollection<SerializedEvent> serializedEvents, CancellationToken cancellationToken)
         {
             if (!serializedEvents.Any())
             {
                 return new ICommittedDomainEvent[] {};
             }
 
-            var aggregateType = typeof(TAggregate);
             var eventDataModels = serializedEvents
                 .Select((e, i) => new EventDataModel
                     {
@@ -120,10 +113,9 @@ protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> Commit
                     })
                 .ToList();
 
-            Log.Verbose(
-                "Committing {0} events to MSSQL event store for aggregate {1} with ID '{2}'",
+            _log.Verbose(
+                "Committing {0} events to MSSQL event store for entity with ID '{1}'",
                 eventDataModels.Count,
-                aggregateType.Name,
                 id);
 
             const string sql = @"
@@ -151,9 +143,8 @@ OUTPUT CAST(INSERTED.GlobalSequenceNumber as bigint)
             {
                 if (exception.Number == 2601)
                 {
-                    Log.Verbose(
-                        "MSSQL event insert detected an optimistic concurrency exception for aggregate '{0}' with ID '{1}'",
-                        aggregateType.Name,
+                    _log.Verbose(
+                        "MSSQL event insert detected an optimistic concurrency exception for entity with ID '{0}'",
                         id);
                     throw new OptimisticConcurrencyException(exception.Message, exception);
                 }
@@ -174,9 +165,7 @@ OUTPUT CAST(INSERTED.GlobalSequenceNumber as bigint)
             return eventDataModels;
         }
 
-        protected override async Task<IReadOnlyCollection<ICommittedDomainEvent>> LoadCommittedEventsAsync<TAggregate, TIdentity>(
-            TIdentity id,
-            CancellationToken cancellationToken)
+        public async Task<IReadOnlyCollection<ICommittedDomainEvent>> LoadCommittedEventsAsync(IIdentity id, CancellationToken cancellationToken)
         {
             const string sql = @"
                 SELECT
@@ -198,9 +187,7 @@ ORDER BY
             return eventDataModels;
         }
 
-        public override async Task DeleteAggregateAsync<TAggregate, TIdentity>(
-            TIdentity id,
-            CancellationToken cancellationToken)
+        public async Task DeleteEventsAsync(IIdentity id, CancellationToken cancellationToken)
         {
             const string sql = @"DELETE FROM EventFlow WHERE AggregateId = @AggregateId";
             var affectedRows = await _connection.ExecuteAsync(
@@ -210,11 +197,10 @@ public override async Task DeleteAggregateAsync<TAggregate, TIdentity>(
                 new {AggregateId = id.Value})
                 .ConfigureAwait(false);
 
-            Log.Verbose(
-                "Deleted aggregate '{0}' with ID '{1}' by deleting all of its {2} events",
-                typeof(TAggregate).Name,
+            _log.Verbose(
+                "Deleted entity with ID '{0}' by deleting all of its {1} events",
                 id,
                 affectedRows);
         }
     }
-}
+}

Source/EventFlow.EventStores.MsSql/MssqlEventStore.cs renamed to Source/EventFlow.EventStores.MsSql/MsSqlEventPersistence.cs

@@ -51,7 +51,7 @@ public override IRootResolver CreateRootResolver(IEventFlowOptions eventFlowOpti
 
             var resolver = eventFlowOptions
                 .ConfigureMsSql(MsSqlConfiguration.New.SetConnectionString(TestDatabase.ConnectionString.Value))
-                .UseEventStore<MsSqlEventStore>()
+                .UseEventStore<MsSqlEventPersistence>()
                 .UseMssqlReadModel<MsSqlTestAggregateReadModel>()
                 .CreateResolver();
 

Source/EventFlow.MsSql.Tests/IntegrationTests/MsSqlIntegrationTestConfiguration.cs

@@ -20,10 +20,8 @@
 // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-using System;
 using EventFlow.EventStores;
 using EventFlow.EventStores.InMemory;
-using EventFlow.Extensions;
 using FluentAssertions;
 using NUnit.Framework;
 
@@ -40,12 +38,12 @@ public void CanResolve()
                 .CreateResolver(true);
 
             // Act
-            IEventStore eventStore = null;
-            Assert.DoesNotThrow(() => eventStore = resolver.Resolve<IEventStore>());
+            IEventPersistence eventPersistence = null;
+            Assert.DoesNotThrow(() => eventPersistence = resolver.Resolve<IEventPersistence>());
 
             // Assert
-            eventStore.Should().NotBeNull();
-            eventStore.Should().BeAssignableTo<InMemoryEventStore>();
+            eventPersistence.Should().NotBeNull();
+            eventPersistence.Should().BeAssignableTo<InMemoryEventPersistence>();
         }
     }
 }

Source/EventFlow.Tests/IntegrationTests/ConfigurationTests.cs

@@ -34,7 +34,7 @@
 
 namespace EventFlow.Tests.UnitTests.EventStores
 {
-    public class EventStoreTests : TestsFor<InMemoryEventStore>
+    public class EventStoreTests : TestsFor<InMemoryEventPersistence>
     {
         private Mock<IEventUpgradeManager> _eventUpgradeManagerMock;
         private Mock<IEventJsonSerializer> _eventJsonSerializerMock;