v1.0 API redesign: annotation-based config, client library, and OTel integration by ElanHasson · Pull Request #289 · InfinityFlowApp/aspire-temporal

ElanHasson · 2026-03-07T18:52:30Z

Summary

Complete v1.0 API redesign of InfinityFlow.Aspire.Temporal:

Annotation-based configuration replacing the old lambda callback builder pattern
New client library (InfinityFlow.Aspire.Temporal.Client) with AddTemporalClient, AddTemporalWorker, health checks, and automatic OpenTelemetry
OTel export from the Temporal container to the Aspire dashboard
All 18 temporal server start-dev CLI flags supported
95 tests (84 unit + 11 integration with real Aspire hosts)

Breaking Changes

Hosting API

Before (lambda callback):

builder.AddTemporalServerContainer("temporal", x => x
    .WithPort(7233)
    .WithLogFormat(LogFormat.Json)
    .WithNamespace("ns1"));

After (fluent extension methods):

builder.AddTemporalServerContainer("temporal")
    .WithServicePort(7233)
    .WithLogFormat(LogFormat.Json)
    .WithNamespace("ns1");

TemporalServerResourceBuilder and TemporalServerResourceArguments removed
Configuration now stored as Aspire annotations on the resource
CLI args built dynamically from annotations via TemporalServerArgsBuilder

New Client Library

// Worker project
builder.AddTemporalWorker("temporal", "my-task-queue", opts =>
{
    opts.Namespace = "my-namespace";
})
.AddWorkflow<MyWorkflow>()
.AddScopedActivities<MyActivities>();

// API project
builder.AddTemporalClient("temporal", opts =>
{
    opts.Namespace = "my-namespace";
});

// Service defaults
builder.Services.AddTemporalServiceDefaults();

Both methods automatically resolve connection strings, add TracingInterceptor, configure CustomMetricMeter, and register health checks.

Architecture

Configuration is now stored as IResourceAnnotation types:

TemporalNamespaceAnnotation, TemporalLogFormatAnnotation, TemporalLogLevelAnnotation, etc.
TemporalServerArgsBuilder reads all annotations and builds CLI args
ITemporalServerResource interface shared by container and executable resources

Configuration Reference

All temporal server start-dev flags are supported:

builder.AddTemporalServerContainer("temporal")
    .WithDbFileName("/path/to/db")           // --db-filename
    .WithNamespace("ns1", "ns2")             // --namespace
    .WithServicePort(7233)                   // --port (external only, internal is always 7233)
    .WithHttpPort()                          // --http-port
    .WithMetricsEndpoint()                   // --metrics-port
    .WithUiPort(8233)                        // --ui-port (external only, internal is always 8233)
    .WithHeadlessUi()                        // --headless
    .WithIp("127.0.0.1")                     // --ip
    .WithUiIp("127.0.0.1")                   // --ui-ip
    .WithUiAssetPath("/path")                // --ui-asset-path
    .WithUiCodecEndpoint("http://...")        // --ui-codec-endpoint
    .WithUiPublicPath("/temporal")           // --ui-public-path
    .WithLogFormat(LogFormat.Pretty)         // --log-format
    .WithLogLevel(LogLevel.Info)             // --log-level
    .WithLogConfig(true)                     // --log-config
    .WithSQLitePragma(SQLitePragma.JournalMode) // --sqlite-pragma
    .WithDynamicConfigValue("key", value)    // --dynamic-config-value
    .WithSearchAttribute("Key", SearchAttributeType.Keyword) // --search-attribute
    .WithImageTag("latest");                 // custom image tag

Other Changes

Docker image updated to temporalio/admin-tools:1.30.1
.WithOtlpExporter() added to container resource for Aspire dashboard telemetry
Package version bumped to 1.0.0
Sample apps updated to new API
Dependency versions updated (Aspire 13.1.2, Temporalio 1.9.0)
Container WithServicePort/WithUiPort only set external host port, internal container port stays fixed

Test Plan

84 unit tests covering annotations, args builder, fluent API, endpoints, client extensions
2 integration tests: search attributes and namespace creation via Temporal APIs
9 client library integration tests: AddTemporalClient, AddTemporalWorker (scoped/transient/singleton/instance activities), ConfigureOptions, health check, end-to-end workflow execution
All tests run against real Temporal dev server containers via Aspire hosting

Passed! - Failed: 0, Passed: 95, Skipped: 0

Supersedes #273.

Generated with Claude Code