DurableWorkerProjectionOutcome Outcome { get; }
Source
Gets the observable worker outcome.
Workers
Namespaces
IDurableWorkerExecutor<TWork, TResult>
SourceExecutes the side-effecting portion of a durable worker chain.
Type Parameters
TWorkType of work claimed by the chain.TResultType of terminal result produced by executor activity.
Remarks
Executors are expected to run inside host-owned durable activities, queue handlers, or equivalent runtime work. They should not be invoked by projection repair paths. Projection repair uses durable completion facts through IDurableWorkerProjectionContract{TWork,TResult,TProjection} instead.
ExecuteAsync
ValueTask<TResult> ExecuteAsync(DurableWorkerEnvelope<TWork> work, CancellationToken cancellationToken = default)
Source
Runs the side-effecting worker activity for a claimed work item.
Parameters
workClaimed work envelope that authorized executor scheduling.cancellationTokenToken that cancels executor work.
Returns
The terminal result that should be recorded with the projection contract.
DurableWorkerProjectionOutcome
SourceIdentifies the observable result of durable worker claim, completion, or projection repair work.
Remarks
The numeric values are part of the public worker contract. Do not reorder, remove, renumber, or reuse values. Additive values must be appended with explicit numbers and documented migration behavior.
DurableWorkerEnvelope<TPayload>
SourceCarries a durable worker outcome, correlation identifiers, optional typed payload, and privacy-safe metadata.
Type Parameters
TPayloadTyped payload associated with the outcome.
Remarks
Envelopes are the stable boundary between app-owned worker contracts and host/runtime adapters. They describe what happened; they do not execute side effects, persist data, or schedule runtime work by themselves.
Outcome
ReasonCode
string ReasonCode { get; }
Source
Gets the stable machine-readable reason code.
Retryability
DurableWorkerRetryability Retryability { get; }
Source
Gets the retry classification for this outcome.
Correlation
DurableWorkerCorrelation Correlation { get; }
Source
Gets correlation identifiers for the operation.
Payload
TPayload? Payload { get; }
Source
Gets the optional typed payload associated with the outcome.
Metadata
IReadOnlyDictionary<string, string> Metadata { get; }
Source
Gets sanitized metadata for logs, durable facts, and projection repair reports.
Diagnostic
DurableWorkerDiagnostic? Diagnostic { get; }
Source
Gets optional sanitized diagnostic details.
AppSurfaceWorkersModule
SourceRegisters the passive AppSurface durable worker contract surface.
Remarks
The module intentionally does not register queues, storage providers, background services, Durable Task workers, EF Core contexts, Postgres connections, endpoints, or authentication handlers. Host applications own runtime infrastructure and persistence; this package provides the shared worker contracts.
IDurableWorkerProjectionContract<TWork, TResult, TProjection>
SourceRecords durable worker execution facts and repairs visible projections from those facts.
Type Parameters
TWorkType of work claimed by the chain.TResultType of terminal execution result.TProjectionType of visible projection repaired from durable facts.
Remarks
Implementations are app-owned and persistence-specific. The contract separates side-effect execution from projection repair: TryClaimAsync decides whether executor activity may run, CompleteAsync records a terminal fact, and reconciliation methods update projections without re-running executor activity.
TryClaimAsync
ValueTask<DurableWorkerEnvelope<TWork>> TryClaimAsync(TWork work, DurableWorkerCorrelation correlation, CancellationToken cancellationToken = default)
Source
Attempts to claim a work item before executor activity is scheduled.
Parameters
workTyped work payload.correlationCorrelation identifiers for the claim.cancellationTokenToken that cancels claim evaluation.
Returns
A claim envelope. DurableWorkerProjectionOutcome.Claimed means executor activity may be scheduled; duplicate, stale, conflict, and unrecoverable outcomes must not schedule executor activity.
CompleteAsync
ValueTask<DurableWorkerEnvelope<TResult>> CompleteAsync(TWork work, TResult result, DurableWorkerCorrelation correlation, CancellationToken cancellationToken = default)
Source
Records a terminal execution fact after executor activity completes.
Parameters
workTyped work payload.resultTerminal result produced by executor activity.correlationCorrelation identifiers for the completion fact.cancellationTokenToken that cancels completion recording.
Returns
A completion envelope. Successful completion should lead to projection repair; duplicate completions must not trigger projection repair.
ReconcileProjectionAsync
ValueTask<DurableWorkerEnvelope<TProjection>> ReconcileProjectionAsync(TWork work, TResult result, DurableWorkerCorrelation correlation, CancellationToken cancellationToken = default)
Source
Repairs the visible projection for one terminal execution fact.
Parameters
workTyped work payload associated with the terminal fact.resultTerminal result used to derive the visible projection.correlationCorrelation identifiers for the repair attempt.cancellationTokenToken that cancels projection repair.
Returns
A projection envelope describing repaired, noop, stale, conflict, or unrecoverable repair behavior.
ReconcilePendingProjectionsAsync
IAsyncEnumerable<DurableWorkerEnvelope<TProjection>> ReconcilePendingProjectionsAsync(DurableWorkerProjectionRepairRequest request, CancellationToken cancellationToken = default)
Source
Repairs a bounded batch of stale or missing projections from durable terminal facts.
Parameters
requestBounded projection repair request.cancellationTokenToken that cancels projection repair enumeration.
Returns
Projection repair envelopes for the bounded repair pass.
DurableWorkerRetryability
SourceDescribes whether a durable worker outcome should be retried automatically.
Remarks
These values are intended for workflow decisions and diagnostics. They do not execute retries directly; host adapters translate the value into the chosen runtime's retry, timer, or operator-alert behavior.
DurableWorkerUnsafeMetadataException
SourceThrown when durable worker diagnostics or metadata contain values that are unsafe to persist or publish.
Remarks
AppSurface worker metadata is designed for logs, projections, and repair reports. It must use stable identifiers, reason codes, and sanitized values rather than raw source payloads, credentials, OAuth tokens, provider URLs, model output, prompts, message bodies, attachments, or unclassified sensitive text.
DurableWorkerMetadataSafety
SourceValidates the privacy-safe metadata and diagnostic text contract used by durable worker envelopes and diagnostics.
Remarks
The validator intentionally uses conservative name and value checks for the metadata channel. Store raw business payloads in app-owned data stores, not in worker metadata. Metadata should contain opaque ids, reason codes, bounded counts, and classified safe labels that can appear in logs or repair dashboards.
CopySafe
IReadOnlyDictionary<string, string> CopySafe(IReadOnlyDictionary<string, string>? metadata, string paramName = "metadata")
Source
Validates a metadata dictionary and returns a copied read-only dictionary.
Parameters
metadataMetadata to validate. A null value is treated as an empty dictionary.paramNameCaller parameter name used in thrown validation exceptions.
Returns
A read-only copy of the supplied safe metadata.
Exceptions
ArgumentExceptionThrown when a key or value is null, empty, or whitespace.DurableWorkerUnsafeMetadataExceptionThrown when a key or value appears unsafe.
EnsureSafe
void EnsureSafe(IReadOnlyDictionary<string, string>? metadata, string paramName = "metadata")
Source
Validates that metadata is safe for diagnostics, logs, durable facts, and projection repair reports.
Parameters
metadataMetadata to validate. A null value is treated as an empty dictionary.paramNameCaller parameter name used in thrown validation exceptions.
Exceptions
ArgumentExceptionThrown when a key or value is null, empty, or whitespace.DurableWorkerUnsafeMetadataExceptionThrown when a key or value appears unsafe.
CopySafeDiagnosticText
string CopySafeDiagnosticText(string value, string label, string paramName)
Source
Validates diagnostic text and returns a trimmed safe value.
Parameters
valueDiagnostic text to validate.labelHuman-readable field label used in validation messages.paramNameCaller parameter name used in thrown validation exceptions.
Returns
The trimmed diagnostic text.
Exceptions
ArgumentExceptionThrown whenvalueis null, empty, or whitespace.DurableWorkerUnsafeMetadataExceptionThrown whenvalueappears unsafe.
DurableWorkerProjectionRepairRequest
SourceDescribes a bounded projection repair pass over durable worker completion facts.
Remarks
Repair requests are intentionally bounded. Hosts should use small batches and repeatable cursors rather than unbounded background scans. The contract repairs projections only; it must not re-run executor side effects.
Now
DateTimeOffset Now { get; }
Source
Gets the clock value used to evaluate stale projections.
MaxStaleness
TimeSpan MaxStaleness { get; }
Source
Gets the maximum acceptable projection staleness before repair is attempted.
MaxItems
int MaxItems { get; }
Source
Gets the maximum number of pending projection repairs to inspect or return.
DurableWorkerCorrelation
SourceCorrelates one durable worker operation across claims, executor activity, completion facts, and projection repair.
Remarks
Correlation values should be stable safe identifiers. Do not use provider URLs, raw payload ids that expose private content, credentials, email bodies, prompts, or model output as correlation values.
RequireText
string RequireText(string value, string paramName)
Source
Validates and trims a durable worker identifier.
Parameters
valueIdentifier value to validate.paramNameCaller parameter name used in thrown validation exceptions.
Returns
The trimmed identifier value.
Exceptions
ArgumentExceptionThrown whenvalueis null, empty, or whitespace.
WorkerName
string WorkerName { get; }
Source
Gets the stable worker or chain name.
WorkId
string WorkId { get; }
Source
Gets the stable app-owned work identifier.
InstanceId
string InstanceId { get; }
Source
Gets the durable runtime instance identifier.
AttemptId
string AttemptId { get; }
Source
Gets the attempt, fence, or generation identifier.
DurableWorkerDiagnostic
SourcePrivacy-safe diagnostic details for a durable worker outcome.
Remarks
Diagnostics are suitable for logs, repair dashboards, and durable records. Keep them explanatory but sanitized: include stable codes, cause and fix guidance, safe counts, and opaque ids. Do not include raw provider payloads, tokens, credentials, prompts, model output, email bodies, attachments, or unclassified sensitive values.
Code
string Code { get; }
Source
Gets the stable machine-readable diagnostic code.
Problem
string Problem { get; }
Source
Gets the safe problem description.
Cause
string Cause { get; }
Source
Gets the safe cause description.
Fix
string Fix { get; }
Source
Gets the safe fix guidance.
Retryability
DurableWorkerRetryability Retryability { get; }
Source
Gets the retry classification for this diagnostic.
Metadata
IReadOnlyDictionary<string, string> Metadata { get; }
Source
Gets sanitized diagnostic metadata.