Best Practices for the Dapr .NET SDK on Dapr Docs

Error Model in the Dapr .NET SDK

Mon, 01 Jan 0001 00:00:00 +0000

The Dapr .NET SDK supports the richer error model, implemented by the Dapr runtime. This model provides a way for applications to enrich their errors with added context, allowing consumers of the application to better understand the issue and resolve it faster. You can read more about the richer error model here, and you can find the Dapr proto file implementing these errors here.

The Dapr .NET SDK implements all details supported by the Dapr runtime, implemented in the Dapr.Common.Exceptions namespace, and is accessible through the DaprException extension method TryGetExtendedErrorInfo. Currently, this detail extraction is only supported for RpcExceptions where the details are present.

Experimental Attributes

Mon, 01 Jan 0001 00:00:00 +0000

Experimental Attributes

Introduction to Experimental Attributes

With the release of .NET 8, C# 12 introduced the [Experimental] attribute, which provides a standardized way to mark APIs that are still in development or experimental. This attribute is defined in the System.Diagnostics.CodeAnalysis namespace and requires a diagnostic ID parameter used to generate compiler warnings when the experimental API is used.

In the Dapr .NET SDK, we now use the [Experimental] attribute instead of [Obsolete] to mark building blocks and components that have not yet passed the stable lifecycle certification. This approach provides a clearer distinction between:

Integration testing with Dapr.Testcontainers

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Dapr.Testcontainers is a helper package for writing integration tests against real Dapr runtime components using containers. It wraps the Testcontainers library to spin up Dapr sidecars, control plane services (placement and scheduler), and the infrastructure needed by specific Dapr building blocks.

Important

Dapr.Testcontainers is an initial release. The API is still evolving and may change in future versions. We aim to keep changes minimal, but you should expect potential breaking changes while the package matures.

Packages

Dapr.Testcontainers (core harnesses and infrastructure)
Dapr.Testcontainers.Xunit (optional xUnit helpers)

Prerequisites

A container runtime (Docker Desktop, Podman, or equivalent).
Network access to pull Dapr and dependency images.

Core concepts

Dapr.Testcontainers models tests around environments and harnesses:

Dapr source code analyzers and generators

Mon, 01 Jan 0001 00:00:00 +0000

Dapr supports a growing collection of optional Roslyn analyzers and code fix providers that inspect your code for code quality issues. Starting with the release of v1.16, developers have the opportunity to install additional projects from NuGet alongside each of the standard capability packages to enable these analyzers in their solutions.

Note

A future release of the Dapr .NET SDK will include these analyzers by default without requiring a separate package install.

Rule violations will typically be marked as Info or Warning so that if the analyzer identifies an issue, it won’t necessarily break builds. All code analysis violations appear with the prefix “DAPR” and are uniquely distinguished by a number following this prefix.