TemporalCommunity.DurableObjects 0.3.2

TemporalCommunity.Extensions

Community-built extensions and compile-time guardrails for the Temporal .NET SDK.

This repository contains a durable-actor programming model, general Temporal workflow analyzers, Durable Objects analyzers and source generators, and their IDE code fixes. Each package is opt-in; using the analyzers does not require adopting Durable Objects.

Packages

The analyzer packages contain both the compiler-safe analyzer and the IDE code-fix assembly. There are no separate code-fix packages to install.

Temporal workflow analyzers

Add compile-time checks to any Temporal .NET workflow project:

dotnet add package TemporalCommunity.Extensions.Analyzers

The package currently detects workflow use of ConfigureAwait(false), Task.Delay, and system clock reads, with code fixes for each rule. These diagnostics also work in projects that do not reference the Durable Objects runtime.

See Temporal .NET Analyzers for installation details, the full rule catalog, code-fix behavior, limitations, and Durable Objects generator requirements.

Durable Objects

TemporalCommunity.DurableObjects is for entity-style workflows such as accounts, carts, devices, sessions, and counters. It adds atomic activation, serialized updates, contained update failures, typed state across Continue-as-New, managed lifecycle behavior, visibility metadata, reminders, and generated clients.

Use a plain Temporal workflow when the execution represents a process with a defined end or needs signals, child workflows, orchestration-heavy control flow, or unrestricted SDK behavior. See Durable Objects concepts for the detailed comparison and lifecycle model.

Install

dotnet add package TemporalCommunity.DurableObjects
dotnet add package TemporalCommunity.Extensions.Analyzers
dotnet add package TemporalCommunity.DurableObjects.Analyzers

Requires Temporal Server v1.28.0 or later for Update-with-Start. The runtime targets .NET 10, .NET 8, and .NET Standard 2.1. .NET Standard does not support visibility-listing APIs.

Minimal example

Define a contract and implementation:

using Temporalio.Workflows;
using TemporalCommunity.DurableObjects;

[Workflow]
public interface ICounter : IDurableObject
{
    [WorkflowUpdate] Task<int> IncrementAsync(int amount);
    [WorkflowQuery] int GetCount();
}

[Workflow]
public sealed class Counter : DurableObjectBase<int>, ICounter
{
    [WorkflowInit]
    public Counter(DurableObjectSnapshot<int>? snapshot = null) : base(snapshot, 0) { }

    [WorkflowRun]
    public Task RunAsync(DurableObjectSnapshot<int>? snapshot = null) => DurableObjectRunAsync();

    [WorkflowUpdate]
    public Task<int> IncrementAsync(int amount)
    {
        State += amount;
        return Task.FromResult(State);
    }

    [WorkflowQuery]
    public int GetCount() => State;
}

Register the client factory and worker types:

services.AddTemporalClient(options => options.TargetHost = "localhost:7233");
services.AddDurableObjects("my-task-queue");
services.AddHostedTemporalWorker("my-task-queue")
    .AddDurableObjectWorkflows(typeof(Counter).Assembly);

Use the concrete client generated by TemporalCommunity.DurableObjects.Analyzers:

var counter = factory.GetCounterClient("counter-42");
await counter.IncrementAsync(5);
var current = await counter.GetCountAsync();

The first update starts the object atomically. Its state is rebuilt from Temporal history after worker restarts and carried through Continue-as-New by DurableObjectBase<TState>.

Start with the runnable getting-started sample and the Durable Objects guide for validators, activities, lifecycle behavior, failure handling, and production guidance.

Samples

Six runnable Durable Objects samples cover generated clients, validation, scheduling and reminders, object-to-object calls through activities, observability, and testing. See the samples index.

temporal server start-dev
just run-sample

Documentation

Maintainer-facing implementation plans live in plans/, separate from user documentation.

Building from source

Prerequisites: .NET 10 SDK and just.

dotnet tool restore
just build
just test
just pack-verify

Run just to list all recipes. Integration tests use an embedded Temporal test server; samples require a server at localhost:7233.

Contributing

1. Fork and clone the repository.
2. Run dotnet tool restore once.
3. Run just ci before opening a pull request.
4. Add or update meaningful tests and user documentation when behavior changes.
5. Record architectural decisions and compatibility constraints in adr/.

License

MIT — see LICENSE.