Refactor: Better Transaction Subscriber (#49)

* refactor: better transaction subscriber

introduces a concept of ITransactionProcess which handles the logic of processing a transaction, and does nothing else. allows the queueing logic to be abstracted away and code coverage the be better

* Empty commit

* Empty commit

* chore: use reportgenerator github action

generate new license key and store as a secret

* chore: remove dead file

* refactor: attempt to reduce cyclomatic complexity

* chore: publish to myget before running coverage tools

* chore: packages & symbols artifact?

* bugfix: glob pattern is backwards

* chore: do package artifact before running coverage

* chore: change release process

manually tagging no more, just create a release and choose a tag which is a version number

Author: the-avid-engineer

.config/dotnet-tools.json

@@ -51,12 +51,32 @@ jobs:
         run: dotnet restore EntityDb.sln --locked-mode
       - name: Run Project Tests
         run: dotnet test EntityDb.sln --no-restore -c Debug --collect:"XPlat Code Coverage" -r ./TestResults -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=opencover
-      - name: Publish Coverage Results
+      - name: Pack Projects into Nuget Packages
+        run: dotnet pack EntityDb.sln --no-restore -c Release /p:Version='${{ github.event.pull_request.milestone.title }}-beta.${{ github.event.number }}.${{ github.run_number }}.${{ github.run_attempt }}'
+      - name: Publish to Beta
+        run: dotnet nuget push ./**/*.nupkg -s ${{ secrets.NUGET_SOURCE }} -k ${{ secrets.NUGET_API_KEY }}
+      - name: Packages & Symbols Artifact
+        uses: actions/[email protected]
+        with:
+          name: Packages & Symbols
+          path: |
+            ./**/*.nupkg
+            ./**/*.snupkg
+      - name: Publish Coverage Results to Codacy
         uses: codacy/codacy-coverage-reporter-action@v1
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           coverage-reports: ./TestResults/**/*.xml
-      - name: Pack Projects into Nuget Packages
-        run: dotnet pack EntityDb.sln --no-restore -c Release /p:Version='${{ github.event.pull_request.milestone.title }}-beta.${{ github.event.number }}.${{ github.run_number }}.${{ github.run_attempt }}'
-      - name: Publish to Beta
-        run: dotnet nuget push */**.nupkg -s ${{ secrets.NUGET_SOURCE }} -k ${{ secrets.NUGET_API_KEY }}
+      - name: Generate Coverage Report
+        uses: danielpalme/[email protected]
+        with:
+          reports: './TestResults/**/coverage.opencover.xml'
+          targetdir: 'CoverageReport'
+          reporttypes: 'HtmlInline'
+          license: ${{ secrets.REPORTGENERATOR_LICENSE }}
+          toolpath: 'reportgeneratortool'
+      - name: Coverage Report Artifact
+        uses: actions/[email protected]
+        with:
+          name: CoverageReport
+          path: CoverageReport

.github/workflows/create-release-draft.yml

@@ -6,22 +6,41 @@ on:
 name: Publish to Stable
 
 jobs:
-  extract:
-    name: Extract Release Information
+  tag:
+    name: Try Parsing Tag
     runs-on: ubuntu-latest
     outputs:
-      version: ${{ steps.get_release.outputs.tag_name }}
+      is_semantic_version: ${{ steps.parse.outputs.is_semantic_version }}
     steps:
       - id: get_release
         uses: bruceadams/[email protected]
         env:
           GITHUB_TOKEN: ${{ github.token }}
+      - id: parse
+        env:
+          GITHUB_TAG: ${{ steps.get_release.outputs.tag_name }}
+        run: |
+          # This pattern comes from https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+          # However, Bash uses POSIX regular expressions, and there are some unsupported features.
+          # POSIX does not support non-capturing groups: (?:...)
+          # - To make it compatible, the non-capture modifiers have been removed
+          # POSIX does not support the digit metacharacter: \d
+          # - To make it compatible, the digit metacharacters have been replaced with [0-9]
+          
+          semantic_version_pattern='^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-((0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$'
+
+          if [[ ${GITHUB_REF/refs\/tags\//} =~ $semantic_version_pattern ]]; then
+            echo ::set-output name=is_semantic_version::'true'
+          else
+            echo ::set-output name=is_semantic_version::'false'
+          fi
 
   stable:
+    needs: tag
+    if: ${{ needs.tag.outputs.is_semantic_version == 'true' }}
     name: Publish to Stable
     runs-on: ubuntu-latest
     environment: stable
-    needs: extract
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
@@ -43,4 +62,11 @@ jobs:
       - name: Pack Projects into Nuget Packages
         run: dotnet pack EntityDb.sln --no-restore -c Release /p:Version=${{ needs.extract.outputs.version }}
       - name: Publish to Stable
-        run: dotnet nuget push */**.nupkg -s ${{ secrets.NUGET_SOURCE }} -k ${{ secrets.NUGET_API_KEY }}
+        run: dotnet nuget push ./**/*.nupkg -s ${{ secrets.NUGET_SOURCE }} -k ${{ secrets.NUGET_API_KEY }}
+      - name: Packages & Symbols Artifact
+        uses: actions/[email protected]
+        with:
+          name: Packages & Symbols
+          path: |
+            ./**/*.nupkg
+            ./**/*.snupkg

.github/workflows/publish-beta.yml

@@ -6,13 +6,15 @@
 using EntityDb.Common.Entities;
 using EntityDb.Common.Projections;
 using EntityDb.Common.Transactions.Builders;
-using EntityDb.Common.Transactions.Processors;
 using EntityDb.Common.Transactions.Subscribers;
+using EntityDb.Common.Transactions.Subscribers.ProcessorQueues;
+using EntityDb.Common.Transactions.Subscribers.Processors;
 using EntityDb.Common.TypeResolvers;
 using Microsoft.Extensions.DependencyInjection;
 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
+using System.Threading.Tasks.Dataflow;
 
 namespace EntityDb.Common.Extensions;
 
@@ -21,34 +23,24 @@ namespace EntityDb.Common.Extensions;
 /// </summary>
 public static class ServiceCollectionExtensions
 {
-    [ExcludeFromCodeCoverage(Justification = "Don't need coverage for non-test mode.")]
-    private static void AddSnapshotTransactionProcessor<TTransactionProcessor>(
-        this IServiceCollection serviceCollection, bool testMode,
-        Func<IServiceProvider, TTransactionProcessor> transactionProcessorFactory)
+    private static void AddTestModeTransactionProcessorQueue<TTransactionProcessor>(this IServiceCollection serviceCollection)
         where TTransactionProcessor : ITransactionProcessor
     {
-        serviceCollection.AddSingleton(serviceProvider =>
-        {
-            var transactionProcessor = transactionProcessorFactory.Invoke(serviceProvider);
+        serviceCollection.AddSingleton<ITransactionProcessorQueue<TTransactionProcessor>, TestModeTransactionQueue<TTransactionProcessor>>();
+    }
 
-            return TransactionProcessorSubscriber<TTransactionProcessor>.Create(serviceProvider, transactionProcessor,
-                testMode);
-        });
+    [ExcludeFromCodeCoverage(Justification = "Tests are only meant to run in test mode.")]
+    private static void AddBufferBlockTransactionProcessorQueue<TTransactionProcessor>(this IServiceCollection serviceCollection)
+        where TTransactionProcessor : ITransactionProcessor
+    {
+        serviceCollection.AddSingleton<BufferBlockTransactionQueue<TTransactionProcessor>>();
 
-        serviceCollection.AddSingleton<ITransactionSubscriber>(
-            serviceProvider =>
-                serviceProvider.GetRequiredService<TransactionProcessorSubscriber<TTransactionProcessor>>()
-        );
+        serviceCollection.AddSingleton<ITransactionProcessorQueue<TTransactionProcessor>>(serviceProvider => serviceProvider.GetRequiredService<BufferBlockTransactionQueue<TTransactionProcessor>>());
 
-        if (testMode)
-        {
-            return;
-        }
+        serviceCollection.AddHostedService(serviceProvider =>
+          serviceProvider.GetRequiredService<BufferBlockTransactionQueue<TTransactionProcessor>>());
 
-        serviceCollection.AddHostedService(
-            serviceProvider =>
-                serviceProvider.GetRequiredService<TransactionProcessorSubscriber<TTransactionProcessor>>()
-        );
+        serviceCollection.AddSingleton<ITransactionSubscriber, TransactionProcessorSubscriber<TTransactionProcessor>>();
     }
 
     internal static void Add<TService>(this IServiceCollection serviceCollection, ServiceLifetime serviceLifetime,
@@ -64,6 +56,39 @@ internal static void Add<TService>(this IServiceCollection serviceCollection, Se
         serviceCollection.Add(new ServiceDescriptor(typeof(TService), typeof(TService), serviceLifetime));
     }
 
+    /// <summary>
+    ///     Registers the transaction processor provided, along with a transaction processor subscriber,
+    ///     and a transaction processor queue. For test mode, the queue is not actually a queue and will
+    ///     immediately process the transaction. For non-test mode, the queue uses a <see cref="BufferBlock{ITransaction}"/>.
+    /// </summary>
+    /// <typeparam name="TTransactionProcessor">The type of the transaction processor.</typeparam>
+    /// <param name="serviceCollection">The service collection.</param>
+    /// <param name="testMode">Wether or not to run in test mode.</param>
+    /// <param name="transactionProcessorFactory">A factory for creating the transaction processor.</param>
+    [ExcludeFromCodeCoverage(Justification = "Tests are only meant to run in test mode.")]
+    public static void AddTransactionProcessorSubscriber<TTransactionProcessor>(this IServiceCollection serviceCollection,
+        bool testMode, Func<IServiceProvider, TTransactionProcessor> transactionProcessorFactory)
+        where TTransactionProcessor : class, ITransactionProcessor
+    {
+        serviceCollection.AddSingleton(transactionProcessorFactory.Invoke);
+
+        serviceCollection.AddSingleton<TransactionProcessorSubscriber<TTransactionProcessor>>();
+
+        serviceCollection.AddSingleton<ITransactionSubscriber>(
+            serviceProvider =>
+                serviceProvider.GetRequiredService<TransactionProcessorSubscriber<TTransactionProcessor>>()
+        );
+
+        if (testMode)
+        {
+            serviceCollection.AddTestModeTransactionProcessorQueue<TTransactionProcessor>();
+        }
+        else
+        {
+            serviceCollection.AddBufferBlockTransactionProcessorQueue<TTransactionProcessor>();
+        }
+    }
+
     /// <summary>
     ///     Adds an internal implementation of <see cref="IPartialTypeResolver" /> which resolves types by using assembly
     ///     information.
@@ -137,7 +162,7 @@ public static void AddEntitySnapshotTransactionSubscriber<TEntity>(this IService
         string transactionSessionOptionsName, string snapshotSessionOptionsName, bool testMode = false)
         where TEntity : IEntity<TEntity>
     {
-        serviceCollection.AddSnapshotTransactionProcessor(testMode, serviceProvider => EntitySnapshotTransactionProcessor<TEntity>.Create(
+        serviceCollection.AddTransactionProcessorSubscriber(testMode, serviceProvider => EntitySnapshotTransactionProcessor<TEntity>.Create(
             serviceProvider, transactionSessionOptionsName, snapshotSessionOptionsName));
     }
 
@@ -167,7 +192,7 @@ public static void AddProjectionSnapshotTransactionSubscriber<TProjection>(
         string transactionSessionOptionsName, string snapshotSessionOptionsName, bool testMode = false)
         where TProjection : IProjection<TProjection>
     {
-        serviceCollection.AddSnapshotTransactionProcessor(testMode, serviceProvider => ProjectionSnapshotTransactionProcessor<TProjection>.Create(
+        serviceCollection.AddTransactionProcessorSubscriber(testMode, serviceProvider => ProjectionSnapshotTransactionProcessor<TProjection>.Create(
             serviceProvider, transactionSessionOptionsName, snapshotSessionOptionsName));
     }
 }

.github/workflows/publish-stable.yml

@@ -59,7 +59,7 @@ public static IProjectionRepository<TProjection> Create(IServiceProvider service
         ITransactionRepository transactionRepository,
         ISnapshotRepository<TProjection>? snapshotRepository = null)
     {
-        if (snapshotRepository == null)
+        if (snapshotRepository is null)
         {
             return ActivatorUtilities.CreateInstance<ProjectionRepository<TProjection>>(serviceProvider,
                 transactionRepository);