Conqueror.Common.Abstractions 0.2.0-beta.1

This is a prerelease version of Conqueror.Common.Abstractions.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Conqueror.Common.Abstractions --version 0.2.0-beta.1                
NuGet\Install-Package Conqueror.Common.Abstractions -Version 0.2.0-beta.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Conqueror.Common.Abstractions" Version="0.2.0-beta.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Conqueror.Common.Abstractions --version 0.2.0-beta.1                
#r "nuget: Conqueror.Common.Abstractions, 0.2.0-beta.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Conqueror.Common.Abstractions as a Cake Addin
#addin nuget:?package=Conqueror.Common.Abstractions&version=0.2.0-beta.1&prerelease

// Install Conqueror.Common.Abstractions as a Cake Tool
#tool nuget:?package=Conqueror.Common.Abstractions&version=0.2.0-beta.1&prerelease                

Conqueror

A set of libraries to powercharge your .NET development.

Open points

  • for some features provide code snippets in documentation instead of library (e.g. common middlewares etc.)
  • use .ConfigureAwait(false) everywhere
  • add null checks to public API methods to support users that do not use nullable reference types

CQS

  • create analyzers (including code fixes)
    • non-empty ConfigurePipeline method
    • enforce IConfigureCommandPipeline interface to be present on all handler types that implement ConfigurePipeline method
    • enforce IConfigureCommandPipeline interface to be present on all command handler types
    • enforce IConfigureCommandPipeline interface to only be present on command handler types
    • custom handler interfaces may not have extra methods
    • handler must not implement multiple custom interface for same command
    • middlewares must not implement more than one middleware interface of the same type (i.e. not implement interface with and without configuration)
  • rename CommandHandlerMetadata to CommandHandlerRegistration and make it public in the abstractions to allow external libraries to use it for server transports
    • same for queries
  • add tests for handlers that throw exceptions to assert contexts are properly cleared
  • expose command/query and conqueror context objects directly on middleware contexts
  • allow registering all custom interfaces in assembly as clients with AddConquerorCommandClientsFromAssembly(Assembly assembly, Action<ICommandPipelineBuilder> configurePipeline)
  • when .NET 7 is released skip analyzers that are superfluous with .NET 7 (i.e. everything related to pipeline configuration methods)
    • adjust tests to expect compilation error diagnostic instead of analyzer diagnostic

      // in analyzer
      if (context.SemanticModel.SyntaxTree.Options is CSharpParseOptions opt && opt.PreprocessorSymbolNames.Contains("NET7_0_OR_GREATER"))
      {
          return;
      }
      
      // in verifiers
      project = project.WithParseOptions(((CSharpParseOptions)project.ParseOptions!).WithLanguageVersion(LanguageVersion.Latest)
                                                                                    .WithPreprocessorSymbols("NET7_0_OR_GREATER"));
      
CQS middleware
  • create projects for common middlewares, e.g.
    • Conqueror.CQS.Middleware.Timeout
    • Conqueror.CQS.Middleware.Retry
CQS ASP Core
  • rename libraries to Conqueror.CQS.Transport.Http.Client and Conqueror.CQS.Transport.Http.Server.AspNetCore

  • delegate route path creation to service

    • in config for client middleware allow setting path convention
      • instruct users to place their route convention into their contracts module to allow both server and client to use the same convention
    • allow path to be set for http commands and queries via attribute
    • allow version to be set for http commands and queries via attribute
  • allow complex objects in GET queries by JSON-serializing them

  • move exceptions into abstractions

  • move client builder extensions into common root namespace

  • allow registering commands and queries via DI extension instead of attribute

  • add missing tests

    • complex query objects for GET
    • custom serializer settings for read/write
    • null properties
    • null GET parameters
    • throw error on double http service registration
  • http server edge cases

    • throw error when duplicate command name is found

Eventing

  • make event publisher middleware pipeline configurable
  • make event publishing strategy customizable
    • ship two strategies out of the box (parallel and sequential)
      • make them available as service collection extension methods
    • sequential strategy as default
    • handle cancellation in strategy
  • add tests for service collection configuration
  • for .NET 6 add analyzer that ensures the ConfigurePipeline method is present on all handlers with pipeline configuration interface (including code fix)

Interactive streaming

  • implement middleware support
  • implement clients and transport infrastructure
  • for .NET 6 add analyzer that ensures the ConfigurePipeline method is present on all handlers with pipeline configuration interface (including code fix)
Interactive streaming ASP Core
  • refactor implementation to use transport client
  • ensure api description works
  • add tests for behavior when websocket connection is interrupted (i.e. disconnect without proper close handshake)
    • consider adding explicit message for signaling the end of the stream
  • propagate conqueror context
  • delegate route path creation to service
  • allow setting prefetch options (e.g. buffer size, prefetch batch size)

Reactive streaming

  • implement basic version
  • implement middleware support
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.

NuGet packages (10)

Showing the top 5 NuGet packages that depend on Conqueror.Common.Abstractions:

Package Downloads
Conqueror.CQS.Abstractions

Part of the Conqueror library set. Abstractions for all command-query-separation (CQS) packages.

Conqueror.Common

Part of the Conqueror library set. Common functionality for all Conqueror packages.

Conqueror.Eventing.Abstractions

Part of the Conqueror library set. Abstractions for all eventing packages.

Conqueror.CQS.Middleware.Logging

Part of the Conqueror library set. Logging middlewares for command-query-separation (CQS).

Conqueror.CQS.Middleware.DataAnnotationValidation

Part of the Conqueror library set. Data annotation validation middlewares for command-query-separation (CQS).

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.6.0-beta.2 77 8/25/2024
0.6.0-beta.1 86 8/13/2024
0.5.0-beta.4 205 11/19/2023
0.5.0-beta.3 125 7/18/2023
0.5.0-beta.2 99 7/15/2023
0.5.0-beta.1 98 4/22/2023
0.4.0-beta.2 111 2/26/2023
0.4.0-beta.1 95 2/25/2023
0.3.0-beta.3 103 2/12/2023
0.3.0-beta.2 127 1/9/2023
0.3.0-beta.1 118 1/7/2023
0.2.0-beta.3 112 1/1/2023
0.2.0-beta.2 169 11/9/2022
0.2.0-beta.1 120 11/6/2022
0.1.0-beta.21 112 10/29/2022
0.1.0-beta.20 104 10/28/2022
0.1.0-beta.19 149 10/20/2022
0.1.0-beta.18 109 10/16/2022
0.1.0-beta.17 99 10/16/2022
0.1.0-beta.16 103 10/16/2022
0.1.0-beta.15 108 10/15/2022