Uniphar.Platform.Common 1.0.12

platform-dotnet-common

This repository contains common libraries and utilities for .NET applications used across various projects within the organization.

KV management

Uniphar uses 2 kv's per domain, to do app segregation you can use this:

 builder.Configuration.AddUniKeyVault("frontgate", "platform", builder.Environment.EnvironmentName, creds); // eg dev

It will do 3 things, setup the keyvault, authenticated with the TokenCredential provided, grab both all common--- and frontgate--- prefixed keyvault, and transforms configs the same way as usual AddAzureKeyVault does.

By default every common--- secret is loaded. To load only the common secrets you need, use ExcludeCommon() followed by fluent adds:

 builder.Configuration.AddUniKeyVault("frontgate", "platform", builder.Environment.EnvironmentName, creds, o => o
    .ExcludeCommon()
    .AddCommonCosmos($"uni-devops-{env}")      // common---uni-devops-{env}-cosmos-access-key
    .AddCommonPwPush("my-api")                 // common---my-api-pw-push-auth-token
    .AddCommonSecret("some-other-secret"));    // common---some-other-secret

Secrets prefixed with the app name (frontgate---) are always loaded. AddCommonSecret is the generic add (the common--- prefix is added for you); AddCommonCosmos and AddCommonPwPush are helpers on top of it.

For IntegrationTests:

 builder
    .Configuration
    .AddIntegrationTestsUniKeyVault("frontgate", "platform", builder.Environment.EnvironmentName, creds); // eg dev

This additionally loads all secrets from the integration Key Vault.

During migration, apps still on the shared legacy vault (uni-devops-app-{env}-kv) can use AddUniOldKeyvault(app, domain, env, creds) / AddIntegrationTestOldUniKeyvault(app, domain, env, creds) (same signature as the new methods, to ease the move). They use the standard -- delimiter and reload every 24h. The optional configure argument is accepted for signature parity but ignored, as the legacy vault has no prefixes and is always loaded in full. Remove once migrated.

For integration tests, AddIntegrationTestsUniKeyVault honours configure for the default vault (e.g. ExcludeCommon()), while the integration vault is always loaded in full.

Locking across regions

Distributed locking allows for coordination between different regions/application instances to ensure that certain operations are performed in a mutually exclusive manner.

This is particularly useful - given Uniphar tech stack - to run dapr based applications in multiple regions

Internal application uses Cosmos document to record lock status and job assignments. Job is simply an id for the operation that is being performed and requires locking.

Locks are periodically renewed and assignments periodically refreshed to ensure that they remain valid and rebalanced. Configuration is provided via DistributedLockServiceOptions.

Usage

To instrument the locking in the app, service collection and service provider extension methods have been provided.

 builder.Services.AddCosmosLockService("cosmos-connection-string");

Then as you build the app, you can initialize the lock service

await app.Services.InitializeDistributedLockAsync("region-designation", "cosmos-database-name", "cosmos-collection-name");

Once initialized, you can use the DistributedLockService to acquire and release locks. For example:

bool lockAcquired = await dls.AcquireJobLockAsync(context.JobId);

if (lockAcquired)
{
    //lock acquired, proceed with job processing
}
else
{
    // Failed to acquire the lease, another instance may be processing
}