ITenantPropagator interface

Namespace: Tenantry.Pro · Package: Tenantry.Pro · API reference

An extension point: for code that extends the package, such as another package that builds on it. An application rarely needs it.

Carries the tenant into jobs and messages, with tenant ids as text, so a transport needs no tenant key type. Tenantry.Pro's Hangfire, MassTransit, Quartz.NET and Rebus integrations use it; use it to carry the tenant over another bus or job library. UsePro registers it as a singleton.

On the sending side, put ITenantPropagator.CurrentTenantId in the job's or message's headers, under HeaderName. On the receiving side, pass that header to ITenantPropagator.ResolveAsync with the integration's TenantPropagationOptions, then run the work inside ITenantPropagator.Use. A carried tenant id is trusted as it is: only let producers you control send work. For the integrations' options and startup check too, write an ITenantPropagationAdapter.

var tenant = await propagator.ResolveAsync(message.Headers["tenantry-tenant-id"], options, "Kafka message", message.Id, ct);
if (tenant.Skip)
    return;

using (propagator.Use(tenant))     await handler.HandleAsync(message, ct); ```

```csharp
[EditorBrowsable(EditorBrowsableState.Advanced)]
public interface ITenantPropagator

PropertiesCopy Anchor Link

CurrentTenantIdCopy Anchor Link

The current tenant's id, as text, or null when no tenant is current.

string? CurrentTenantId { get; }

Value: string

MethodsCopy Anchor Link

GetTenantIdsAsync(CancellationToken)Copy Anchor Link

The ids, as text, of every tenant in the store that ValidateTenantActivity allows, for work scheduled once for each tenant.

ValueTask<IReadOnlyList<string>> GetTenantIdsAsync(CancellationToken cancellationToken = default)

Parameters:

• cancellationToken CancellationToken: Cancels the store read.

Returns: ValueTask<IReadOnlyList<string>>

Resolve(string?, TenantPropagationOptions, string, object?)Copy Anchor Link

As ITenantPropagator.ResolveAsync, blocking on the tenant lookup, for a host whose filters are synchronous.

PropagatedTenant Resolve(string? tenantId, TenantPropagationOptions options, string carrier, object? carrierId)

Parameters:

• tenantId string: The tenant id the job or message carries, or null.
• options TenantPropagationOptions: The integration's policy.
• carrier string: What carries the tenant, for log messages and errors, such as Kafka message.
• carrierId object: The job's or message's id, for log messages and errors.

Returns: PropagatedTenant: The tenant to make current with ITenantPropagator.Use, none, or that the work must not run.

Exceptions:

• TenantNotResolvedException: The policy that applies is TenantPropagationBehavior.Reject.

ResolveAsync(string?, TenantPropagationOptions, string, object?, CancellationToken)Copy Anchor Link

Finds the tenant a job or message carries, applying options when it carries none, an id that is not valid, a tenant the store does not have, or one ValidateTenantActivity refuses.

ValueTask<PropagatedTenant> ResolveAsync(string? tenantId, TenantPropagationOptions options, string carrier, object? carrierId, CancellationToken cancellationToken = default)

Parameters:

• tenantId string: The tenant id the job or message carries, or null.
• options TenantPropagationOptions: The integration's policy.
• carrier string: What carries the tenant, for log messages and errors, such as Kafka message.
• carrierId object: The job's or message's id, for log messages and errors.
• cancellationToken CancellationToken: Cancels the tenant lookup.

Returns: ValueTask<PropagatedTenant>: The tenant to make current with ITenantPropagator.Use, none, or that the work must not run.

Exceptions:

• TenantNotResolvedException: The policy that applies is TenantPropagationBehavior.Reject.

Use(PropagatedTenant)Copy Anchor Link

Makes the resolved tenant current until the returned handle is disposed, tags the current activity with tenant.id and opens a log scope with TenantId. For PropagatedTenant.WithoutTenant, makes no tenant current instead, so the work does not run as a tenant that was current around it.

IDisposable Use(PropagatedTenant tenant)

Parameters:

• tenant PropagatedTenant: What ITenantPropagator.ResolveAsync returned, unless it is PropagatedTenant.Skipped.

Returns: IDisposable: A handle that restores the tenant that was current before.

Exceptions:

• ArgumentException: tenant is PropagatedTenant.Skipped, or its tenant is not an ITenantDescriptor<TKey> of the application's tenant key type.

Call it in the method that runs the work: the tenant is ambient, and an async method's changes to it end when that method returns.