DRN.Framework.SharedKernel 0.7.0-preview004

Prefix Reserved
This is a prerelease version of DRN.Framework.SharedKernel.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package DRN.Framework.SharedKernel --version 0.7.0-preview004                
NuGet\Install-Package DRN.Framework.SharedKernel -Version 0.7.0-preview004                
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.SharedKernel" Version="0.7.0-preview004" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DRN.Framework.SharedKernel --version 0.7.0-preview004                
#r "nuget: DRN.Framework.SharedKernel, 0.7.0-preview004"                
#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.SharedKernel as a Cake Addin
#addin nuget:?package=DRN.Framework.SharedKernel&version=0.7.0-preview004&prerelease

// Install DRN.Framework.SharedKernel as a Cake Tool
#tool nuget:?package=DRN.Framework.SharedKernel&version=0.7.0-preview004&prerelease                

master develop Quality Gate Status

Security Rating Maintainability Rating Reliability Rating Vulnerabilities Bugs Lines of Code Coverage

DRN.Framework.SharedKernel package is an lightweight package that contains common codes suitable for contract and domain layers. It can be referenced by any projects such as other DRN.Framework packages, projects developed with DRN.Framework.

JsonConventions

System.Text.Json defaults will be overridden by JsonConventions when

  • TestContext is used in tests
  • DrnHostBuilder is used to build host
namespace DRN.Framework.SharedKernel.Json;

public static class JsonConventions
{
    private const string JsonHelpersFQN = "System.Net.Http.Json.JsonHelpers";
    private const string JsonHelpersOptions = "s_defaultSerializerOptions";
    private const string DefaultSerializerOptions = "s_defaultOptions";
    private const BindingFlags StaticPrivate = BindingFlags.Static | BindingFlags.NonPublic;

    static JsonConventions()
    {
        //https://stackoverflow.com/questions/58331479/how-to-globally-set-default-options-for-system-text-json-jsonserializer
        UpdateDefaultJsonSerializerOptions();
        UpdateHttpClientDefaultJsonSerializerOptions();
    }

    public static readonly JsonSerializerOptions DefaultOptions = SetJsonDefaults();
...
    /// <summary>
    ///   <para>Option values appropriate to Web-based scenarios.</para>
    ///   <para>This member implies that:</para>
    ///   <para>- Property names are treated as case-insensitive.</para>
    ///   <para>- "camelCase" name formatting should be employed.</para>
    ///   <para>- Quoted numbers (JSON strings for number properties) are allowed.</para>
    /// </summary>
    public static JsonSerializerOptions SetJsonDefaults(JsonSerializerOptions? options = null)
    {
        options ??= new JsonSerializerOptions(JsonSerializerDefaults.Web);
        options.Converters.Add(new JsonStringEnumConverter());
        options.AllowTrailingCommas = true;
        options.PropertyNameCaseInsensitive = true;
        options.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
        options.NumberHandling = JsonNumberHandling.AllowReadingFromString;

        return options;
    }
}

Exceptions

DrnException are used in DRN.Framework and DRN.Nexus and can be used any project. These exceptions contain additional category property so that same exception types can be differentiated with a subcategory. They also contain status code so that HttpScopeHandler can respect that.

ExceptionFor factory class groups all DrnExceptions.

namespace DRN.Framework.SharedKernel;

/// <summary>
/// DrnExceptions are handled by scope handler and can be used to short circuit the processing pipeline
/// </summary>
public abstract class DrnException(string message, Exception? ex, string? category, short? status = null)
    : Exception(message, ex)
{
    public const string DefaultCategory = "default";
    public string Category { get; } = category ?? DefaultCategory;
    public short Status { get; } = status ?? 500;
}

/// <summary>
/// Scope handler returns 400 when thrown
/// </summary>
public class ValidationException(string message, Exception? ex = null, string? category = null)
    : DrnException(message, ex, category, 400);
...
    
public static class ExceptionFor
{
    private const string Default = DrnException.DefaultCategory;

    /// <summary>
    /// Scope handler returns 400 when thrown
    /// </summary>
    public static ValidationException Validation(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 401 when thrown
    /// </summary>
    public static UnauthorizedException Unauthorized(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 403 when thrown
    /// </summary>
    public static ForbiddenException Forbidden(string message, Exception? exception = null, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 404 when thrown
    /// </summary>
    public static NotFoundException NotFound(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 409 when thrown
    /// </summary>
    public static ConflictException Conflict(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 410 when thrown
    /// </summary>
    public static ExpiredException Expired(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// Scope handler returns 500 when thrown
    /// </summary>
    public static ConfigurationException Configuration(string message, Exception? ex = null, string? category = Default)
        => new(message, ex, category);

    /// <summary>
    /// Scope handler returns 422 when thrown
    /// </summary>
    public static UnprocessableEntityException UnprocessableEntity(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);

    /// <summary>
    /// To abort requests that doesn't even deserve a result
    /// </summary>
    public static MaliciousRequestException MaliciousRequest(string message, Exception exception = null!, string? category = Default)
        => new(message, exception, category);
}

Attributes

When an object, property, or field is annotated with the IgnoreLog attribute, the IScopeLog implementation detects this attribute and excludes the marked element from the log data.

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Property | AttributeTargets.Field)]
public class IgnoreLogAttribute : Attribute;

public static class IgnoreLogExtensions
{
public static bool IgnoredLog(this object obj) => obj.GetType().GetCustomAttributes()
.Any(attribute => attribute.GetType() == typeof(IgnoreLogAttribute));

    public static bool IgnoredLog(this PropertyInfo info) =>
        info.PropertyType == typeof(object) ||
        info.GetCustomAttributes().Union(info.PropertyType.GetCustomAttributes())
            .Any(attribute => attribute.GetType() == typeof(IgnoreLogAttribute));
}

AppConstants

namespace DRN.Framework.SharedKernel;

public static class AppConstants
{
    public static int ProcessId { get; } = Environment.ProcessId;
    public static Guid ApplicationId { get; } = Guid.NewGuid();
    public static string EntryAssemblyName { get; } = Assembly.GetEntryAssembly()?.GetName().Name ?? "Entry Assembly Not Found";
    public static string TempPath { get; } = GetTempPath(); //Cleans directory at every startup
    public static string LocalIpAddress { get; } = GetLocalIpAddress();
...
}

Domain Base Definitions

Following definitions provide guidance and conventions for rapid and effective domain design. Their usage is not necessary however other framework features such as DrnContext benefits from them.

  • An entity should always have an long Id. It can have an additional ids.
  • All DateTime values should include offset
  • Entities should encapsulate their events
  • Entity status changes should be marked automatically by dbContext
  • Domain events should be published automatically by dbContext
namespace DRN.Framework.SharedKernel.Domain;

public abstract class AggregateRoot : Entity;

public abstract class Entity
{
    private List<IDomainEvent> DomainEvents { get; } = new();
    public IReadOnlyList<IDomainEvent> GetDomainEvents() => DomainEvents;
    public long Id { get; protected set; }

    [ConcurrencyCheck]
    public DateTimeOffset ModifiedAt { get; protected set; }
    public DateTimeOffset CreatedAt { get; protected set; }

    protected void AddDomainEvent(DomainEvent? e)
    {
        if (e != null) DomainEvents.Add(e);
    }

    public void MarkAsCreated()
    {
        CreatedAt = DateTimeOffset.UtcNow;
        ModifiedAt = DateTimeOffset.UtcNow;
        AddDomainEvent(GetCreatedEvent());
    }

    public void MarkAsModified()
    {
        ModifiedAt = DateTimeOffset.UtcNow;
        AddDomainEvent(GetModifiedEvent());
    }

    public void MarkAsDeleted()
    {
        AddDomainEvent(GetDeletedEvent());
    }

    protected abstract EntityCreated? GetCreatedEvent();
    protected abstract EntityModified? GetModifiedEvent();
    protected abstract EntityDeleted? GetDeletedEvent();

    private bool Equals(Entity other) => Id == other.Id;
    public override bool Equals(object? obj) => ReferenceEquals(this, obj) || obj is Entity other && Equals(other);
    public override int GetHashCode() => Id.GetHashCode();
    public static bool operator ==(Entity? left, Entity? right) => Equals(left, right);
    public static bool operator !=(Entity? left, Entity? right) => !Equals(left, right);
}
public interface IDomainEvent
{
    Guid Id { get; }
    DateTimeOffset Date { get; }
    long EntityId { get; }
    string EntityName { get; }
}

public abstract class DomainEvent(Entity entity) : IDomainEvent
{
    public Guid Id { get; protected init; } = Guid.NewGuid();
    public DateTimeOffset Date { get; protected init; } = DateTimeOffset.UtcNow;
    public long EntityId => entity.Id;
    public string EntityName { get; protected init; } = entity.GetType().FullName!;
}

public abstract class EntityCreated(Entity entity) : DomainEvent(entity);
public abstract class EntityModified(Entity entity) : DomainEvent(entity);
public abstract class EntityDeleted(Entity entity) : DomainEvent(entity);

Semper Progredi: Always Progressive

Commit Info

Author: Duran Serkan KILIÇ
Date: 2024-11-23 12:55:43 +0300
Hash: 32f0afe1111835522efd4371482436aa3de7c36d

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

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DRN.Framework.SharedKernel:

Package Downloads
DRN.Framework.Utils

DRN.Framework.Utils package contains common codes for other DRN.Framework packages, projects developed with DRN.Framework. ## Commit Info Author: Duran Serkan KILIÇ Date: 2024-12-22 23:30:25 +0300 Hash: 25fb02068c9add44038c1806651e6aafe0ab0dad

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.7.0-preview006 19 12/23/2024
0.7.0-preview005 72 11/27/2024
0.7.0-preview004 83 11/23/2024
0.7.0-preview003 94 11/20/2024
0.7.0-preview002 86 11/17/2024
0.7.0-preview001 94 11/14/2024
0.6.0 133 11/10/2024
0.6.0-preview002 94 11/10/2024
0.6.0-preview001 87 11/10/2024
0.5.1-preview002 96 9/30/2024
0.5.1-preview001 94 9/22/2024
0.5.0 148 8/30/2024
0.5.0-preview011 108 8/30/2024
0.5.0-preview010 140 8/25/2024
0.5.0-preview009 142 8/8/2024
0.5.0-preview008 126 8/7/2024
0.5.0-preview007 87 8/2/2024
0.5.0-preview006 92 7/30/2024
0.5.0-preview005 103 7/27/2024
0.5.0-preview004 119 7/15/2024
0.5.0-preview003 143 6/6/2024
0.5.0-preview002 130 6/5/2024
0.5.0-preview001 125 6/4/2024
0.4.0 126 5/19/2024
0.4.0-preview006 99 5/19/2024
0.4.0-preview005 121 5/12/2024
0.4.0-preview004 121 5/12/2024
0.4.0-preview003 124 5/11/2024
0.4.0-preview002 123 5/8/2024
0.4.0-preview001 134 5/5/2024
0.3.1-preview001 123 4/26/2024
0.3.0 142 4/23/2024
0.3.0-preview002 113 4/23/2024
0.3.0-preview001 139 4/23/2024
0.2.2-preview010 130 4/11/2024
0.2.2-preview009 127 3/18/2024
0.2.2-preview008 133 3/18/2024
0.2.2-preview007 128 3/16/2024
0.2.2-preview006 110 3/11/2024
0.2.2-preview005 113 3/10/2024
0.2.2-preview004 116 3/10/2024
0.2.2-preview003 139 1/22/2024
0.2.2-preview002 100 1/18/2024
0.2.2-preview001 131 1/14/2024
0.2.1 223 1/7/2024
0.2.0 175 12/31/2023
0.2.0-preview009 134 12/31/2023
0.2.0-preview008 154 12/30/2023
0.2.0-preview007 167 12/28/2023
0.2.0-preview006 151 12/27/2023
0.2.0-preview005 149 12/25/2023
0.2.0-preview004 151 12/23/2023
0.2.0-preview003 151 12/20/2023
0.2.0-preview002 148 12/19/2023
0.2.0-preview001 154 12/18/2023
0.1.0 225 11/26/2023
0.1.0-preview013 150 11/26/2023
0.1.0-preview012 169 11/20/2023
0.1.0-preview011 158 11/19/2023
0.1.0-preview010 202 10/30/2023
0.1.0-preview009 180 10/29/2023
0.1.0-preview008 181 10/27/2023
0.1.0-preview007 174 10/11/2023
0.1.0-preview006 178 10/9/2023
0.1.0-preview005 158 10/8/2023
0.1.0-preview004 185 10/8/2023
0.1.0-preview003 173 10/3/2023
0.1.0-preview002 179 10/3/2023
0.1.0-preview001 186 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.6.0

My family celebrates the enduring legacy of Mustafa Kemal Atatürk's enlightenment ideals. This release is dedicated to the memory of Mustafa Kemal Atatürk, founder of the Republic of Türkiye, and to his vision for a modern, enlightened, democratic nation. In his eternal rest, he continues to guide us through his ideals of freedom, progress, and national sovereignty.

## 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.

### Breaking Changes

* DrnException implementations - refactored
 * Http status code parameter added
 * ExceptionFor factory class added to create DrnExceptions as needed

## 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.

## 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.

### Breaking Changes

* JsonSerializerOptions - moved to JsonConventions. System.Text.Json defaults will be overridden by JsonConventions when
 * TestContext is used in tests
 * DrnHostBuilder is used to build host

### New Features

* Entity and AggregateRoot base classes' ModifiedAt property now has `ConcurrencyCheck` attribute and can be used for optimistic concurrency.

### Bug Fixes

* `AppConstants` LocalIpAddress calculation exception handling

## Version 0.2.0

### New Features

* JsonSerializerOptions - added to AppConstants which is same with default dotnet settings for now.
* AggregateRoot, Entity, DomainEvent

## Version 0.1.0

### New Features

* AppConstants
* DRN Framework exceptions
 * ValidationException
 * NotFoundException
 * NotSavedException
 * ExpiredException
 * ConfigurationException

---

**Semper Progredi: Always Progressive**  
 
## Commit Info  
Author: Duran Serkan KILIÇ  
Date: 2024-11-23 12:55:43 +0300  
Hash: 32f0afe1111835522efd4371482436aa3de7c36d