Infra Template

[bnaya-payoneer]

PBI

Template Repo

• System.Text.Json

  • Feature comparison

• OTEL

  • Corallogix: FileBit is Old, recommend to move into OTEL [3:08, Passcode: fGOd7+&.]

• Swagger version

• Common Docker Compose (base-line, mongo, sql-server, etc.)

• Mongo WiKi

Each switch should have a WIKI page which will be address from the ReadMe.md

[bnaya-payoneer]

• Pubcom: Remove, Check Easychaching
• NLog: Remove
• Add HealthCheck.
• v1, v2 convention [Obsolete]

[bnaya-payoneer]

Check Api Versioning:

• Bnaya Demo: https://github.com/bnaya-payoneer/ApiVersioningDemo
• https://code-maze.com/aspnetcore-api-versioning/
• https://www.milanjovanovic.tech/blog/api-versioning-in-aspnetcore
• https://weblogs.asp.net/ricardoperes/asp-net-core-api-versioning

[bnaya-payoneer]

Guidelines

• [ ] The template will be modular via switches
  • [ ] Each switch should have a WIKI page which will be address from the ReadMe.md
  • [ ] legacy switch will provide the legacy template as it's before this initiative
  • [ ] have switches to append modules to existing repo (created by this template)
• [ ] If possible, the template will trigger DevOps Portal via API to generate a repo and activate the pipeline
• [ ] Prefer record over class for data object

Wish List

• [ ] Healthcheck
• [ ] Http Client
• [ ] GZip
• [ ] Redis Pub/Sub
• [ ] ILogger
  • [ ] Remove NLog dependencies
  • [ ] Sample for right Logging generator pattern
• [ ] Caching:
  • [ ] Redis Distributed Cache
  • [ ] Remove Pub-comp: Remove (PostSharp!)
  • [ ] Check Easychaching @Arnold
  • [ ] Use [Response Caching](Response caching)
• [ ] EF Coupling
• [ ] Dapper
• [ ] GraphQL:
  • Data Loader
  • Video
  • Article
  • Video
• [ ] Mongo
  • [ ] Events
• [ ] Open Telemetry
  • [ ] Kafka
• [ ] Versioning convention v1, v2
  • [ ] use [Obsolete] for retirement
• [ ] Setup a Wiki
• [ ] AsyncApi (Swagger for event-based pattern) Payoneer
• [ ] Mono-repo
• [ ] remove: wwwroot
• [ ] Docker
  • [ ] Dockerfile
  • [ ] Docker Compose
  • [ ] Tests with Docker Compose
  • [ ] WebApplicationFactory
  • Video
• [ ] Testing
  • [ ] Remove PostSharp
• [ ] Data Event
  • [ ] Via Debezium DeOutbox Event Routerbisium an Kafka Connect
  • [ ] TBD: EventualizeDb and Kafka Connect

Notes:

• Minimal Api + Controllers
• Remove .ConfigureAwait(false)
• return Ok(result.ToContractEnumerable())?
• Prefer immutability
  • Services should return ImmutableArray or Array rather than public async Task<IEnumerable<ExampleModel>> GetAsync()
• Should the sample be based on EF? `ExampleDomainContext context

[bnaya-payoneer]

Health:

• The Best Way to Add Health Checks in Any .NET App
• Health Check Docs
• Article

Current State

https://dev.azure.com/Payoneer/Payoneer/_git/datacollection-profile-service?path=/ProfileService.WebApi/Startup.cs

Payoneer.Infrastructure.HealthCheckNetcoreExtensions

[bnaya-payoneer]

domain-repo

• Sample
• Card

mono-repo

gbt-psfx-glps-engine gbt-providers-integration paycloud-compliance-kycv - Repos (azure.com)

TODO

• [ ] Agree on the structure (architects)
  • [ ] Trunk based
• [ ] Cli call DevOps portal
• [ ] Setup a structure
  • [ ] @Shay Lami: close the ci/cd flow
  • [ ] Deploy only changes
  • [ ] Directory.Build.props (no version)
  • [ ] Wishful: reference enforcement
• [ ] Standard
  • [ ] TBD: Error details: https://www.rfc-editor.org/rfc/rfc7807.html @Jonathan Horowitz (not compatible with our Open API)

Features

• [ ] Sub-Repo: Verticals
• [ ] Shared: cross domain's contracts, domain's infa
• [ ] Pipelines: Common + for each Sub Repo
• [ ] Sonar Cube: coverage false alarm
• [ ] Reference enforcement
• [ ] Directory.Build.props (no version)
• [ ] Testing & Automation:
  • [ ] XUnit (@Tal Ainvoner)
• [ ] Wishful: reference enforcement

Review @Ram Yaari

[bnaya-payoneer]

Polly

var services = new ServiceCollection();

// Define a resilience pipeline with the name "my-pipeline"
services.AddResiliencePipeline("my-pipeline", builder =>
{
    builder
        .AddRetry(new RetryStrategyOptions())
        .AddTimeout(TimeSpan.FromSeconds(10));
});

// Build the service provider
var serviceProvider = services.BuildServiceProvider();

// Retrieve a ResiliencePipelineProvider that dynamically creates and caches the resilience pipelines
var pipelineProvider = serviceProvider.GetRequiredService<ResiliencePipelineProvider<string>>();

// Retrieve your resilience pipeline using the name it was registered with
ResiliencePipeline pipeline = pipelineProvider.GetPipeline("my-pipeline");

// Alternatively, you can use keyed services to retrieve the resilience pipeline
pipeline = serviceProvider.GetRequiredKeyedService<ResiliencePipeline>("my-pipeline");

// Execute the pipeline
await pipeline.ExecuteAsync(static async token =>
{
    // Your custom logic goes here
});

 _pipeline = new ResiliencePipelineBuilder()
    .AddRetry(new RetryStrategyOptions()) // Add retry using the default options
    .AddTimeout(TimeSpan.FromSeconds(10)) // Add 10 seconds timeout
    .Build(); // Builds the resilience pipeline

[bnaya-payoneer]

OTEL

Logging

• UseW3CLogging: here and here

[bnaya-payoneer]

Outbox Pattern

• WIKI
• debezium
  • Sample
  • Confluence Kafka Avro

[bnaya-payoneer]

Devops Portal

[bnaya-payoneer]

Logging

TODO

• [ ] Speak with Coralogix about the right way to propagate logs + OTEL span / correlation
• [ ] Speak with @Yuval Glasman - SRE
  • [ ] Discussion about how to replace the nlog.config files in order to have json-formatted logs in Coralogix Sample
  • [ ] Dynamic changes of filtering

[bnaya-payoneer]

EF

• Common mistakes in EF Core
• Sample with Compiled Query

[bnaya-payoneer]

Distributed Lock

• RedLock

[bnaya-payoneer]

Error Details: Consider using : https://www.rfc-editor.org/rfc/rfc7807.html

[bnaya-payoneer]

Docker

Integration Tests

• Test Containers
  • Modules
  • Sample test within a container
  • GitHub