Chore: Refactor Options (#48)

* chore: refactor options

options are not generally applicable - let's move to provider-specific options model, and remove some redundancies

* feat: deploy to a beta source

* refactor: stop running build for PRs, run publish-beta for PRs

* chore: all PRs, no ignored branches

* chore: publish coverage when publishing to beta

* chore: always publish to beta on PR

required for merge

* chore: indicate prerelease

* chore: remove redundant parenthesis

* use milestone for versioning

* need debugging

* output PR info

* chore: fix regex for posic

\d metacharacter not supported

* chore: only publish to beta if the milestone is a semantic version

* chore: make redis snapshot options generic

allowing configuration of different TSnapshots using Configure and ConfigureAll

* chore: rename

* chore: more standard prerelease versioning?

* chore: add doc comments

* chore: add a ToString override to make codacy shut up about generic parameter not being used

also, if we ever switch to record, it won't allow the connection strings to be exposed accidentally

Author: the-avid-engineer

.github/workflows/build.yml

@@ -11,16 +11,6 @@ on:
       - 'EntityDb.sln'
       - 'src/**'
       - 'test/**'
-  pull_request:
-    branches:
-      - '**'
-    paths:
-      - '.github/workflows/build.yml'
-      - 'global.json'
-      - 'Directory.Build.props'
-      - 'EntityDb.sln'
-      - 'src/**'
-      - 'test/**'
 
 name: Build
 

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

@@ -16,10 +16,13 @@ jobs:
       - id: parse
         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 POSIX does not support non-capturing groups: (?:...)
-          # To make it compatible, the non-capture modifiers have been removed.
-
-          semantic_version_pattern='^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-((0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$'
+          # 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'

.github/workflows/publish-beta.yml

@@ -0,0 +1,62 @@
+on: pull_request
+
+name: Publish to Beta
+
+jobs:
+  milestone:
+    name: Try Parsing Milestone
+    runs-on: ubuntu-latest
+    outputs:
+      is_semantic_version: ${{ steps.parse.outputs.is_semantic_version }}
+    steps:
+      - id: parse
+        env:
+          GITHUB_MILESTONE: ${{ github.event.pull_request.milestone.title }}
+        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_MILESTONE} =~ $semantic_version_pattern ]]; then
+            echo ::set-output name=is_semantic_version::'true'
+          else
+            echo ::set-output name=is_semantic_version::'false'
+          fi
+  beta:
+    needs: milestone
+    if: ${{ needs.milestone.outputs.is_semantic_version == 'true' }}
+    name: Publish to Beta
+    runs-on: ubuntu-latest
+    environment: beta
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+      - name: Start Redis
+        uses: supercharge/[email protected]
+        with:
+          redis-version: 6.2.5
+      - name: Start MongoDB
+        uses: supercharge/[email protected]
+        with:
+          mongodb-version: 5.0.3
+          mongodb-replica-set: entitydb
+      - name: Install .NET SDK
+        uses: actions/setup-dotnet@v1
+      - name: Restore Dependencies
+        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
+        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 }}

src/EntityDb.Common/Exceptions/CannotWriteInReadOnlyModeException.cs

@@ -1,13 +1,11 @@
 using EntityDb.Abstractions.Transactions;
-using EntityDb.Common.Transactions;
 using System;
 
 namespace EntityDb.Common.Exceptions;
 
 /// <summary>
 ///     The exception that is thrown when an actor passes a <see cref="ITransaction" /> to an
-///     <see cref="ITransactionRepository" /> that was created with
-///     <see cref="TransactionSessionOptions.ReadOnly" /> equal to <c>true</c>.
+///     <see cref="ITransactionRepository" /> that was created for read-only mode.
 /// </summary>
 public class CannotWriteInReadOnlyModeException : Exception
 {

src/EntityDb.Common/Extensions/ServiceCollectionExtensions.cs

@@ -58,6 +58,12 @@ internal static void Add<TService>(this IServiceCollection serviceCollection, Se
         serviceCollection.Add(new ServiceDescriptor(typeof(TService), serviceFactory, serviceLifetime));
     }
 
+    internal static void Add<TService>(this IServiceCollection serviceCollection, ServiceLifetime serviceLifetime)
+        where TService : class
+    {
+        serviceCollection.Add(new ServiceDescriptor(typeof(TService), typeof(TService), serviceLifetime));
+    }
+
     /// <summary>
     ///     Adds an internal implementation of <see cref="IPartialTypeResolver" /> which resolves types by using assembly
     ///     information.

src/EntityDb.Common/Snapshots/SnapshotSessionOptions.cs

@@ -0,0 +1,12 @@
+namespace EntityDb.InMemory.Sessions;
+
+/// <summary>
+///     Configures the in-memory snapshot repository.
+/// </summary>
+public class InMemorySnapshotSessionOptions
+{
+    /// <summary>
+    ///     If <c>true</c>, indicates the agent only intends to execute queries.
+    /// </summary>
+    public bool ReadOnly { get; set; }
+}

src/EntityDb.Common/Transactions/TransactionSessionOptions.cs

@@ -13,14 +13,14 @@ internal class InMemorySnapshotRepositoryFactory<TSnapshot> : DisposableResource
     ISnapshotRepositoryFactory<TSnapshot>
 {
     private readonly IInMemorySession<TSnapshot> _inMemorySession;
-    private readonly IOptionsFactory<SnapshotSessionOptions> _optionsFactory;
+    private readonly IOptionsFactory<InMemorySnapshotSessionOptions> _optionsFactory;
     private readonly IServiceProvider _serviceProvider;
 
     public InMemorySnapshotRepositoryFactory
     (
         IServiceProvider serviceProvider,
         IInMemorySession<TSnapshot> inMemorySession,
-        IOptionsFactory<SnapshotSessionOptions> optionsFactory
+        IOptionsFactory<InMemorySnapshotSessionOptions> optionsFactory
     )
     {
         _serviceProvider = serviceProvider;
@@ -33,9 +33,9 @@ public async Task<ISnapshotRepository<TSnapshot>> CreateRepository(string snapsh
     {
         await Task.Yield();
 
-        var snapshotSessionOptions = _optionsFactory.Create(snapshotSessionOptionsName);
+        var options = _optionsFactory.Create(snapshotSessionOptionsName);
 
-        var inMemorySession = snapshotSessionOptions.ReadOnly
+        var inMemorySession = options.ReadOnly
             ? new ReadOnlyInMemorySession<TSnapshot>(_inMemorySession)
             : _inMemorySession;
 

src/EntityDb.InMemory/Sessions/InMemorySessionOptions.cs

@@ -4,32 +4,28 @@
 using EntityDb.MongoDb.Transactions;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
-using System;
 
 namespace EntityDb.MongoDb.Provisioner.Extensions;
 
 internal static class ServiceCollectionExtensions
 {
     public static void AddAutoProvisionMongoDbTransactions(
-        this IServiceCollection serviceCollection, string databaseName,
-        Func<IConfiguration, string> getConnectionString, bool testMode = false)
+        this IServiceCollection serviceCollection, bool testMode = false)
     {
         serviceCollection.AddBsonDocumentEnvelopeService(true);
 
+        serviceCollection.Add<MongoDbTransactionRepositoryFactory>
+        (
+            testMode ? ServiceLifetime.Singleton : ServiceLifetime.Transient
+        );
+
         serviceCollection.Add<ITransactionRepositoryFactory>
         (
             testMode ? ServiceLifetime.Singleton : ServiceLifetime.Transient,
-            serviceProvider =>
-            {
-                var configuration = serviceProvider.GetRequiredService<IConfiguration>();
-
-                var connectionString = getConnectionString.Invoke(configuration);
-
-                return MongoDbTransactionRepositoryFactory
-                    .Create(serviceProvider, connectionString, databaseName)
-                    .UseTestMode(testMode)
-                    .UseAutoProvisioning(serviceProvider);
-            }
+            serviceProvider => serviceProvider
+                .GetRequiredService<MongoDbTransactionRepositoryFactory>()
+                .UseTestMode(testMode)
+                .UseAutoProvisioning(serviceProvider)
         );
     }
 }