DRN.Framework.Utils 0.5.1-preview001

Prefix Reserved

This is a prerelease version of DRN.Framework.Utils.

There is a newer version of this package available.
See the version list below for details.

dotnet add package DRN.Framework.Utils --version 0.5.1-preview001

NuGet\Install-Package DRN.Framework.Utils -Version 0.5.1-preview001

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="DRN.Framework.Utils" Version="0.5.1-preview001" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add DRN.Framework.Utils --version 0.5.1-preview001

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: DRN.Framework.Utils, 0.5.1-preview001"

#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 DRN.Framework.Utils as a Cake Addin
#addin nuget:?package=DRN.Framework.Utils&version=0.5.1-preview001&prerelease

// Install DRN.Framework.Utils as a Cake Tool
#tool nuget:?package=DRN.Framework.Utils&version=0.5.1-preview001&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DRN.Framework.Utils package contains common codes for other DRN.Framework packages and projects developed with DRN.Framework.

Module

DRN.Utils can be added with following module

namespace DRN.Framework.Utils;

public static class UtilsModule
{
    public static IServiceCollection AddDrnUtils(this IServiceCollection collection)
    {
        collection.AddServicesWithAttributes();

        return collection;
    }
}

Dependency Injection with Attributes

Each module should be created in the assembly that will be scanned.

public static class InfraModule
{
    public static IServiceCollection AddSampleInfraServices(this IServiceCollection sc)
    {
        sc.AddServicesWithAttributes();

        return sc;
    }
}

Services resolution for attribute based services can be validated with a single line.

serviceProvider.ValidateServicesAddedByAttributes();

Attribute based dependency injection reduces wiring efforts and helps developer to focus on developing. This approach also improves service resolution validation during startup and integration testing.

    [Theory]
    [DataInlineContext]
    public void Validate_Sample_Dependencies(TestContext context)
    {
        context.ServiceCollection.AddSampleApplicationServices();
        context.ServiceCollection.AddSampleInfraServices();
        context.ValidateServices();
    }

Lifetime Attributes

Example attribute usage:

[Transient<IIndependent>]
public class Independent : IIndependent
{
}

Following attributes marks services with a lifetime and when service collection called with AddServicesWithAttributes method in the assembly marked belong they are automatically added.

namespace DRN.Framework.Utils.DependencyInjection.Attributes;

public class LifetimeAttribute<TService>(ServiceLifetime serviceLifetime, bool tryAdd = true, object? key = null)
    : LifetimeAttribute(serviceLifetime, typeof(TService), tryAdd, key);

public class LifetimeWithKeyAttribute<TService>(ServiceLifetime serviceLifetime, object key, bool tryAdd = true)
    : LifetimeAttribute(serviceLifetime, typeof(TService), tryAdd, key);

public class ScopedAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Scoped, tryAdd);

public class ScopedWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Scoped, key, tryAdd);

public class TransientAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Transient, tryAdd);

public class TransientWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Transient, key, tryAdd);

public class SingletonAttribute<TService>(bool tryAdd = true) : LifetimeAttribute<TService>(ServiceLifetime.Singleton, tryAdd);

public class SingletonWithKeyAttribute<TService>(object key, bool tryAdd = true) : LifetimeWithKeyAttribute<TService>(ServiceLifetime.Singleton, key, tryAdd);

HasServiceCollectionModuleAttribute

Attributes derived from HasServiceCollectionModuleAttribute can be used to mark custom service collection modules. In the following example HasDrnContextServiceCollectionModuleAttribute marks DrnContext<TContext> and its service collection module. This way dbContexts inherited from DrnContext doesn't need a lifetime attribute and they can be registered by AddServicesWithAttributes with their custom factory.

This offers following flexibility:

ServiceCollectionModule of DrnContexts are defined in DRN.Framework.EntityFramework
Inherited dbContexts are defined in user defined projects and points a module in another project.
AddServicesWithAttributes extension method defined in DRN.Framework.Utils registers them without depending DRN.Framework.EntityFramework project

public class HasDrnContextServiceCollectionModuleAttribute : HasServiceCollectionModuleAttribute
{
    static HasDrnContextServiceCollectionModuleAttribute() =>
        ModuleMethodInfo = typeof(ServiceCollectionExtensions)
            .GetMethod(nameof(ServiceCollectionExtensions.AddDbContextsWithConventions))!;

    public override async Task PostStartupValidationAsync(object service, IServiceProvider serviceProvider)
    {
        var appSettings = serviceProvider.GetRequiredService<IAppSettings>();
        var migrate = appSettings.Configuration.GetValue(DbContextConventions.AutoMigrateDevEnvironmentKey, false);
        if (appSettings.Environment == AppEnvironment.Development && migrate && service is DbContext context)
            await context.Database.MigrateAsync();
    }
}

[HasDrnContextServiceCollectionModule]
public abstract class DrnContext<TContext> : DbContext, IDesignTimeDbContextFactory<TContext>, IDesignTimeServices where TContext : DbContext, new()
{
...

HasServiceCollectionModuleAttribute's PostStartupValidationAsync will be called when,

ValidateServicesAddedByAttributes extension method called from service provider if all services resolved successfully.
For instance, DrnContext can apply EF migrations after service provider services resolved successfully.

Configurations

Following configuration sources can be used to add configurations from different sources

JsonSerializerConfigurationSource converts poco objects to configuration
RemoteJsonConfigurationSource fetches remote configuration (experimental and incomplete)

Following MountedSettingsConventions will be added to configuration.

/appconfig/json-settings json files will be added to configuration if any exist
/appconfig/key-per-file-settings files will be added to configuration if any exist
IMountedSettingsConventionsOverride overrides default /appconfig location if added to service collection before host built

namespace DRN.Framework.Utils.Settings.Conventions;

public static class MountedSettingsConventions
{
    public const string DefaultMountDirectory = "/appconfig";
    
    public static string JsonSettingsMountDirectory(string? mountDirectory = null)
        => Path.Combine(mountDirectory ?? DefaultMountDirectory, "json-settings");
    public static string KeyPerFileSettingsMountDirectory(string? mountDirectory = null)
        => Path.Combine(mountDirectory ?? DefaultMountDirectory, "key-per-file-settings");

    public static DirectoryInfo JsonSettingDirectoryInfo(string? mountDirectory = null)
        => new(JsonSettingsMountDirectory(mountDirectory));
}

public interface IMountedSettingsConventionsOverride
{
    string? MountedSettingsDirectory { get; }
}

AppSettings

Following IAppSettings interface is defined and can be used to obtain appsettings. It has utility methods that allow fail fast.

namespace DRN.Framework.Utils.Settings;

public interface IAppSettings
{
    AppEnvironment Environment { get; }
    IConfiguration Configuration { get; }
    bool TryGetConnectionString(string name, out string connectionString);
    string GetRequiredConnectionString(string name);
    bool TryGetSection(string key, out IConfigurationSection section);
    IConfigurationSection GetRequiredSection(string key);
    T? GetValue<T>(string key);
    T? GetValue<T>(string key, T defaultValue);
    T? Get<T>(string key, Action<BinderOptions>? configureOptions = null);
    ConfigurationDebugView GetDebugView();
}

ExtensionMethods

ServiceCollectionExtensions
- ReplaceInstance
- ReplaceTransient
- ReplaceScoped
- ReplaceSingleton
- GetAllAssignableTo<TService>
StringExtensions
- ToStream
TypeExtensions
- MakeGenericMethod
AssemblyExtensions
- GetTypesAssignableTo

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-09-22 21:27:25 +0300
Hash: 5a1c8bb025cb41aef5138d4831359ed67c721257

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. 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.

net8.0
- DRN.Framework.SharedKernel (>= 0.5.1-preview001)
- Flurl.Http (>= 4.0.2)
- Microsoft.Extensions.Caching.Hybrid (>= 9.0.0-preview.7.24406.2)
- Microsoft.Extensions.Caching.Memory (>= 9.0.0-preview.7.24405.7)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.0)
- System.Net.Http (>= 4.3.4)
- System.Text.Json (>= 8.0.4)
- System.Text.RegularExpressions (>= 4.3.1)

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DRN.Framework.Utils:

Package	Downloads
DRN.Framework.EntityFramework DRN.Framework.EntityFramework provides DrnContext with conventions to develop rapid and effective domain models. ## Commit Info Author: Duran Serkan KILIÇ Date: 2024-11-14 19:53:05 +0300 Hash: a5c387d29e9caafed30ff182ceb7c960e8c07726	4.5K
DRN.Framework.Hosting DRN.Framework.Hosting ## Commit Info Author: Duran Serkan KILIÇ Date: 2024-11-14 19:53:05 +0300 Hash: a5c387d29e9caafed30ff182ceb7c960e8c07726	2.8K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.7.0-preview001	0	11/14/2024
0.6.0	81	11/10/2024
0.6.0-preview002	60	11/10/2024
0.6.0-preview001	58	11/10/2024
0.5.1-preview002	64	9/30/2024
0.5.1-preview001	68	9/22/2024
0.5.0	125	8/30/2024
0.5.0-preview011	93	8/30/2024
0.5.0-preview010	138	8/25/2024
0.5.0-preview009	120	8/8/2024
0.5.0-preview008	112	8/7/2024
0.5.0-preview007	89	8/2/2024
0.5.0-preview006	79	7/30/2024
0.5.0-preview005	98	7/27/2024
0.5.0-preview004	108	7/15/2024
0.5.0-preview003	129	6/6/2024
0.5.0-preview002	116	6/5/2024
0.5.0-preview001	112	6/4/2024
0.4.0	124	5/19/2024
0.4.0-preview006	101	5/19/2024
0.4.0-preview005	92	5/12/2024
0.4.0-preview004	88	5/12/2024
0.4.0-preview003	92	5/11/2024
0.4.0-preview002	94	5/8/2024
0.4.0-preview001	116	5/5/2024
0.3.1-preview001	105	4/26/2024
0.3.0	122	4/23/2024
0.3.0-preview002	108	4/23/2024
0.3.0-preview001	120	4/23/2024
0.2.2-preview010	117	4/11/2024
0.2.2-preview009	121	3/18/2024
0.2.2-preview008	128	3/18/2024
0.2.2-preview007	115	3/16/2024
0.2.2-preview006	116	3/11/2024
0.2.2-preview005	113	3/10/2024
0.2.2-preview004	115	3/10/2024
0.2.2-preview003	136	1/22/2024
0.2.2-preview002	105	1/18/2024
0.2.2-preview001	124	1/14/2024
0.2.1	211	1/7/2024
0.2.0	155	12/31/2023
0.2.0-preview009	122	12/31/2023
0.2.0-preview008	119	12/30/2023
0.2.0-preview007	125	12/28/2023
0.2.0-preview006	119	12/27/2023
0.2.0-preview005	116	12/25/2023
0.2.0-preview004	122	12/23/2023
0.2.0-preview003	111	12/20/2023
0.2.0-preview002	140	12/19/2023
0.2.0-preview001	138	12/18/2023
0.1.0	169	11/26/2023
0.1.0-preview013	125	11/26/2023
0.1.0-preview012	96	11/20/2023
0.1.0-preview011	124	11/19/2023
0.1.0-preview010	113	10/30/2023
0.1.0-preview009	121	10/29/2023
0.1.0-preview008	130	10/27/2023
0.1.0-preview007	114	10/11/2023
0.1.0-preview006	130	10/9/2023
0.1.0-preview005	127	10/8/2023
0.1.0-preview004	127	10/8/2023
0.1.0-preview003	109	10/3/2023
0.1.0-preview002	129	10/3/2023
0.1.0-preview001	123	10/2/2023

Not every version includes changes, features or bug fixes. This project can increment version to keep consistency with other DRN.Framework projects.

## Version 0.5.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to August 30 Victory Day, a day that marks the decisive victory achieved by the Turkish people against imperialism during the Turkish War of Independence, leading to the establishment of the Republic of Türkiye.

### New Features

* IScopedUser, ScopedUserSummary and ScopeContext added
* IScopedLog
* TraceIdentifier support
* Inner exception support
* Flurl exception support
* IExternalRequest - Added with singleton lifetime as request factory for external requests
* IAppSettings.DrnAppFeatures
* UseHttpRequestLogger Flag
* LaunchExternalDependencies Flag
* NexusAddress Url property

## Version 0.4.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 19 May Commemoration of Atatürk, Youth and Sports Day.

### Breaking Changes

* AttributeSpecifiedServiceCollectionModule - renamed as AttributeSpecifiedServiceModule
* HasServiceCollectionModuleAttribute - renamed as ServiceRegistrationAttribute
* HasDrnContextServiceCollectionModuleAttribute - renamed as DrnContextServiceRegistrationAttribute
* ServiceRegistrationAttribute MethodInfo property - replaced with ServiceRegistration method to make usage strongly typed and support inheritance

### New Features

* DrnAppFeatures property - added to IAppSettings
* InternalRequestHttpVersion can be set as "1.1" or "2.0"
* InternalRequestProtocol can be set as "http" or "https ""
* IInternalRequest and InternalRequest - added to generate internal Flurl requests with configurable **Linkerd compatible** sensible defaults
* HttpResponse and following flurl response extensions - added to fluently get strongly typed response and flurl response together:
* ToStringAsync
* ToBytesAsync
* ToStreamAsync
* ToJsonAsync<TResponse>

## Version 0.3.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to 23 April National Sovereignty and Children's Day.

### New Features
* AppSettings now has GetDebugView() method that returns ConfigurationDebugView
* ConfigurationDebugView has ToSummary() method that returns human friendly configuration summary model.
* AppSettings now has GetValue<> and Get<> methods to get values from configuration
* MountedSettingsConventions added.
* /appconfig/json-settings json files will be added to configuration if any exist
* /appconfig/key-per-file-settings files will be added to configuration if any exist
* IMountedSettingsConventionsOverride overrides default /appconfig location if added to service collection before host built
* HasServiceCollectionModuleAttribute has PostStartupValidationAsync when,
* ValidateServicesAddedByAttributes extension method called from service provider,
* PostStartupValidationAsync will be called if all services resolved successfully.
* For instance, DrnContext can apply migrations after service provider services resolved successfully.
* ScopedLog and IScopedLog added to aggregate related log within a scope such as a http request.

## Version 0.2.0

### Breaking Changes

* LifetimeContainer renamed as DrnServiceContainer
* Lifetime attributes moved to DRN.Framework.Utils.DependencyInjection.Attributes namespace

### New Features

* JsonSerializerConfigurationSource - added to add dotnet objects to configuration
* RemoteJsonConfigurationSource - added to remote settings to configuration (experimental)
* ConnectionStringsCollection - added as poco model to serialize connection strings
* StringExtensions
* ToStream method added to convert strings to in memory stream
* HasServiceCollectionModuleAttribute

## Version 0.1.0

### New Features

* AppSettings
* ServiceCollectionExtensions
* ReplaceInstance
* ReplaceTransient
* ReplaceScoped
* ReplaceSingleton
* Attribute based dependency injection
* ScopedAttribute, TransientAttribute, SingletonAttribute and LifetimeAttribute
* ScopedWithKeyAttribute, TransientWithKeyAttribute, SingletonWithKeyAttribute and LifetimeWithKeyAttribute
* ServiceCollection AddServicesWithAttributes extension
* ServiceProvider ValidateServicesAddedByAttributes extension

---

**Semper Progredi: Always Progressive**

## Commit Info
Author: Duran Serkan KILIÇ
Date: 2024-09-22 21:27:25 +0300
Hash: 5a1c8bb025cb41aef5138d4831359ed67c721257