SonghayCore 8.0.2

SonghayCore

Here is the Core code to install as a NuGet package for all of my studio Solutions. Anyone who may be reading this 👀 is free to do the same. This package is based on net8.0.

NuGet package 📦: SonghayCore

documentation 📚: SonghayCore API

core reusable, opinionated concerns

Songhay.Hosting

One of the most important additions to .NET came in .NET 6.0 (circa 2021): the .NET Generic Host [📖 docs]. This host concept from Microsoft allows developers to not have to reinvent:

• Dependency injection (DI)
• Logging
• Configuration
• App shutdown
• IHostedService implementations (for long-running background tasks [📖 docs ])

All ASP.NET developers expect to get these things “for free” and, finally, Microsoft is basically letting all .NET developers get these things for free. This Core recognizes the .NET Generic Host, stating with the DefaultHostedService class (see Songhay.Extensions below for more details).

Songhay.Diagnostics

This Core is concerned with tracing as well as logging. Logging concerns should be logically above this Core. TraceSources and TraceSourceExtensions define how tracing should be implemented with a bias toward using all source levels. When tracing is not configured for this Core then it will be ignored without throwing exceptions.

For a review of the organizational difference between tracing and logging, see “Tracing vs Logging vs Monitoring: What’s the Difference?” by Chrissy Kidd.

Documentation 📚: Songhay.Diagnostics

Songhay.Extensions

The Songhay System uses imperative C# code with a view to make it more functional in an effort to control complexity and enhance maintainability.

The preference for extension methods encourages stateless, reusable routines (many of them are “pure” functions).

Notable extensions:

• IConfigurationExtensions — defines shared routines based on conventions around the .NET Generic Host [📖 docs].

• IConfigurationBuilderExtensions — defines shared routines for application configuration building under .NET Standard.

• ILoggerExtensions — defines shared routines based on conventions around the .NET Generic Host [📖 docs].

• HttpRequestMessageExtensions — defines shared routines for HTTP access under .NET Standard with a lazy-loaded HttpClient. Routines for Azure Blob Storage are included here.

• HttpWebRequestExtensions — defines shared routines for HTTP access for the legacy .NET Framework.

There is support for URI templates (to be used with RestApiMetadata) in the form of extension methods, running on top of Tavis.UriTemplates.

Documentation 📚: Songhay.Extensions

Songhay.Models

The Core models of the Songhay System define types for MIME, XHTML, OPML, REST, the Repository, the Display Item (for WPF and other MVVM solutions), etc.

The Core models are “anemic” by design (there are very few abstract classes)—any logic would be found first in an Extension Method.

Notable models:

• DisplayItemModel — defines the conventional way to display data.

• MenuDisplayItemModel — defines the conventional way to display nested/grouped data.

• RestApiMetadata — defines conventional REST API metadata.

Documentation 📚: Songhay.Models

Songhay.Xml

The “core” of the Core is concern for XML. The Songhay System started out as utilities around XPathDocument and grew into LINQ for XML—over XDocument.

Documentation 📚: Songhay.Xml

fundamental boundary-crossing abstractions

This Core features the ‘boundary-crossing abstractions’ (and default implementations) needed for the enterprise work based on my historical needs:

• IApiEndpoint — defines the conventional way to access distributed data (default implementation: ApiEndpoint).
• IApiRequestStrategy — defines the conventional way to request data from an endpoint (default implementations: ApiRequestStrategy and AzureBlobApiRequestStrategy).
• IBlobStreamApiEndpoint — defines the conventional way to request BLOB data from an endpoint (default implementation: BlobStreamApiEndpoint).

Dependency-injecting these ‘boundary-crossing abstractions’ are far more mockable than, say, using HttpRequestMessage directly.

the core Activity concept

This Core features the concept of the Activity which is a way to formally recognize that all line of business applications can be thought of as a ‘tree’ of inputs and outputs. It follows that each ‘node’ of this ‘tree’ can be called an Activity. The following abstractions classify the Activities needed so far:

• IActivity — defines the conventional, synchronous, input-output Activities
• IActivityOutputOnly — defines the conventional, synchronous Activities with output only (input usually comes from IConfiguration in this case)
• IActivityOutputOnlyTask — defines the conventional, asynchronous Activities with output only (input usually comes from IConfiguration in this case)
• IActivityTask — defines the conventional, asynchronous, input-output Activities

This Activity concept which I regard as fundamental is the least likely architectural reality that would be shared by my peers 😐 From the Microsoft point of view, my Activity concept would be buried under Windows Workflow Foundation or BizTalk Server.

satellite packages

SonghayCore.xUnit

Defines reusable class definitions for xUnit. Featured is the ProjectFileDataAttribute, allowing test data files to be loaded from a relative path.

NuGet package 📦: SonghayCore.xUnit

Documentation 📚: Songhay.Tests

SonghayCore.Newtonsoft

Core reusable, opinionated Newtonsoft concerns for my C# projects.

GitHub repo: https://github.com/BryanWilhite/SonghayCore.Newtonsoft

NuGet package 📦: SonghayCore.Newtonsoft

Studio packages dependent on SonghayCore

graph BT
    netstandard2[.NET Standard 2.0]
    net8[.NET 8.0]

    1[SonghayCore]
    2[SonghayCore.Newtonsoft]

    net8-->1
    netstandard2-->2
    2-..->|optional addition|1

    1-->3[SonghayCore.xUnit]
    1-->4[Songhay.DataAccess]
    1-->5[Songhay.Feeds]
    1-->6[Songhay.Publications]
    1-->7[Songhay.Social]

@BryanWilhite