Yes, comments

jet · Feb 13, 2020 · e8ce18e · e8ce18e
1 parent 0221b4a
commit e8ce18e
Show file tree

Hide file tree

Showing 10 changed files with 17 additions and 6 deletions.
diff --git a/equinox-fc/Domain.Tests/Domain.Tests.fsproj b/equinox-fc/Domain.Tests/Domain.Tests.fsproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>netcoreapp3.1</TargetFramework>
+        <TargetFramework>netcoreapp2.1</TargetFramework>
         <WarningLevel>5</WarningLevel>
         <RootNamespace>Fc.Domain.Tests</RootNamespace>
         <IsPackable>false</IsPackable>

diff --git a/equinox-fc/Domain.Tests/Infrastructure.fs b/equinox-fc/Domain.Tests/Infrastructure.fs
@@ -48,4 +48,4 @@ let createLogger sink =
 //        .MinimumLevel.Debug()
         .Destructure.FSharpTypes()
         .WriteTo.Sink(sink)
-        .CreateLogger()
+        .CreateLogger()
diff --git a/equinox-fc/Domain.Tests/LocationEpochTests.fs b/equinox-fc/Domain.Tests/LocationEpochTests.fs
@@ -54,4 +54,4 @@ let [<Property>] properties transactionId carriedForward delta1 closeImmediately
 let [<Property>] ``codec can roundtrip`` event =
     let ee = Events.codec.Encode(None,event)
     let ie = FsCodec.Core.TimelineEvent.Create(0L, ee.EventType, ee.Data)
-    test <@ Some event = Events.codec.TryDecode ie @>
+    test <@ Some event = Events.codec.TryDecode ie @>
diff --git a/equinox-fc/Domain.Tests/LocationSeriesTests.fs b/equinox-fc/Domain.Tests/LocationSeriesTests.fs
@@ -41,4 +41,4 @@ let [<Property>] properties c1 c2 =
 let [<Property>] ``codec can roundtrip`` event =
     let ee = Events.codec.Encode(None,event)
     let ie = FsCodec.Core.TimelineEvent.Create(0L, ee.EventType, ee.Data)
-    test <@ Some event = Events.codec.TryDecode ie @>
+    test <@ Some event = Events.codec.TryDecode ie @>
diff --git a/equinox-fc/Domain.Tests/LocationTests.fs b/equinox-fc/Domain.Tests/LocationTests.fs
@@ -68,4 +68,4 @@ type Cosmos(testOutput) =
         let maxEvents = max 1 maxEvents
         let shouldClose (state : Epoch.Fold.OpenState) = state.count > maxEvents
         let service = Location.Cosmos.createService (zeroBalance, shouldClose) (context, cache, 50)
-        run service args
+        run service args
diff --git a/equinox-fc/Domain/InventoryEpoch.fs b/equinox-fc/Domain/InventoryEpoch.fs
@@ -1,3 +1,6 @@
+/// Manages the ingestion (and deduplication based on a TransactionId) of events reflecting transfers or stock adjustments
+///   that have been effected across a given set of Inventory
+/// See Inventory.Service for surface level API which manages the ingestion, including transitioning to a new Epoch when an epoch reaches 'full' state
 module Fc.Inventory.Epoch
 
 // NB - these types and the union case names reflect the actual storage formats and hence need to be versioned with care

diff --git a/equinox-fc/Domain/InventorySeries.fs b/equinox-fc/Domain/InventorySeries.fs
@@ -1,3 +1,7 @@
+/// Manages a) the ingestion epoch id b) the current checkpointed read position for a long-running Inventory Series
+/// See InventoryEpoch for the logic managing the actual events logged within a given epoch
+/// See Inventory.Service for the surface API which manages the writing
+
 module Fc.Inventory.Series
 
 // NB - these types and the union case names reflect the actual storage formats and hence need to be versioned with care

diff --git a/equinox-fc/Domain/Location.fs b/equinox-fc/Domain/Location.fs
@@ -5,7 +5,7 @@ type Wip<'R> =
     | Pending of decide : (Epoch.Fold.Balance -> 'R * Epoch.Events.Event list)
     | Complete of 'R
 
-/// Manages a Series of Epochs, with a running total being carried forward to the next Epoch when it's Closed
+/// Manages Reads and Writes for a Series of Epochs, with a running total being carried forward to the next Epoch when it's marked Closed
 type Service internal (zeroBalance, shouldClose, series : Series.Service, epochs : Epoch.Service) =
 
     let rec execute locationId originEpochId =

diff --git a/equinox-fc/Domain/LocationEpoch.fs b/equinox-fc/Domain/LocationEpoch.fs
@@ -1,3 +1,6 @@
+/// Manages Stock adjustments and deltas for a given Location
+/// Provides for controlled opening and closing of an epoch, carrying forward incoming balances when a given Epoch reaches a 'full' state
+/// See Location.Service for the logic that allows competing readers/writers to co-operate in bringing this about
 module Fc.Location.Epoch
 
 // NOTE - these types and the union case names reflect the actual storage formats and hence need to be versioned with care

diff --git a/equinox-fc/Domain/LocationSeries.fs b/equinox-fc/Domain/LocationSeries.fs
@@ -1,3 +1,4 @@
+/// Manages the active epoch for a given Location
 module Fc.Location.Series
 
 // NOTE - these types and the union case names reflect the actual storage formats and hence need to be versioned with care