2m.Shared.Infrastructure 1.0.3

Shared Infrastructure Library

This library provides reusable components for ASP.NET Core applications, including authentication, context services, middleware, health checks, HTTP resilience, and more.

Table of Contents

1. Installation
2. Authentication & User Context
3. Time Zone Handling
4. Swagger Configuration
5. MassTransit/RabbitMQ Integration
6. Health Checks
7. Resilient HTTP Client
8. Pagination Helper
9. Middleware Setup

Installation

1. Add the shared infrastructure project to your solution
2. Reference the project in your API application
3. Register services in your application startup:
   • Call AddSharedInfrastructure() on your service collection
4. Configure the middleware pipeline:
   • Use UseSharedInfrastructure() for standard components
   • Add UseSharedHealthChecks() for health endpoints

Authentication & User Context

Configuration

Add JWT settings to your application configuration:

• Key: 256-bit secret key for signing tokens
• Issuer: Token issuer identifier
• Audience: Valid token audience

User Context Usage

The IUserContext service provides access to:

• Current user's unique identifier
• Associated company and branch identifiers
• Role verification methods
• Claims-based information from authenticated tokens

Inject IUserContext into services to access authenticated user information throughout your application.

Time Zone Handling

Middleware Setup

Add time zone middleware to automatically handle client time zones:

• Processes "TimeZone" claim from authentication tokens
• Falls back to UTC for invalid or missing time zones
• Stores resolved time zone in request context

Service Usage

Inject ITimeZoneContext into services to:

• Convert UTC times to user's local time
• Convert local times back to UTC
• Perform time-sensitive operations in the correct time zone

Swagger Configuration

Automatically configures Swagger with JWT support when using the shared infrastructure setup.

Customization Options

• Set custom API title
• Define API version number
• Modify security scheme details
• Adjust authentication requirements

Access

• Development environment: Access at /swagger endpoint
• Production: Secure through authentication and authorization

MassTransit/RabbitMQ Integration

Setup

Configure messaging through options:

• Specify RabbitMQ host address
• Provide connection credentials
• Register message consumers
• Configure endpoint mappings

Implementation

Create message consumers to handle specific message types. The library manages:

• Connection pooling and reconnection
• Message serialization
• Error handling
• Endpoint configuration

Health Checks

Setup

1. Register health checks with AddSharedHealthChecks()
2. Enable health endpoint with UseSharedHealthChecks()
3. Configure database connection strings in application settings

Features

• PostgreSQL database connectivity check
• RabbitMQ service availability verification
• Configurable component inclusion/exclusion
• Standardized health endpoint at /health
• Detailed status reporting

Resilient HTTP Client

Registration

Configure resilient HTTP clients with:

• Base address from configuration
• Connection pooling with automatic renewal
• Automatic retry for transient socket errors
• Configurable timeout periods
• Exponential backoff strategy for retries

Usage

Define typed clients that leverage the resilient handler. The library automatically handles:

• Transient network errors
• DNS resolution failures
• Temporary connection issues
• Socket exceptions

Pagination Helper

Usage

Apply consistent pagination to any queryable data source:

• Automatic total record count calculation
• Configurable page sizes
• Efficient data retrieval
• Standardized response structure

Response Format

• TotalCount: Total records available
• Page: Current page number
• PageSize: Number of items per page
• Data: Collection of paginated results

Middleware Setup

Standard Pipeline

Call UseSharedInfrastructure() to enable:

• Time zone handling
• Authentication
• Authorization
• Swagger documentation UI
• Health check endpoints

Customization Options

Build custom pipelines by selectively adding components:

1. TimeZoneMiddleware
2. Authentication
3. Authorization
4. Swagger documentation
5. Health checks
6. Custom middleware components

Health Checks Endpoint

• Path: /health
• Aggregates all registered health checks
• Provides machine-readable status report
• Includes detailed component health information

Support

For implementation assistance, contact: platform-engineering@yourcompany.com
Issue tracking: GitHub Issues
Documentation: Shared Infrastructure Wiki