Orchestrator function code constraints
Durable Functions is an extension of Azure Functions that lets you build stateful apps. You can use an orchestrator function to orchestrate the execution of other durable functions within a function app. Orchestrator functions are stateful, reliable, and potentially long-running.
Orchestrator code constraints
Orchestrator functions use event sourcing to ensure reliable execution and to maintain local variable state. The replay behavior of orchestrator code creates constraints on the type of code that you can write in an orchestrator function. For example, orchestrator functions must be deterministic: an orchestrator function will be replayed multiple times, and it must produce the same result each time.
Using deterministic APIs
This section provides some simple guidelines that help ensure your code is deterministic.
Orchestrator functions can call any API in their target languages. However, it's important that orchestrator functions call only deterministic APIs. A deterministic API is an API that always returns the same value given the same input, no matter when or how often it's called.
The following table shows examples of APIs that you should avoid because they are not deterministic. These restrictions apply only to orchestrator functions. Other function types don't have such restrictions.
|Dates and times||APIs that return the current date or time are nondeterministic because the returned value is different for each replay.||Use the
|GUIDs and UUIDs||APIs that return a random GUID or UUID are nondeterministic because the generated value is different for each replay.||Use
|Random numbers||APIs that return random numbers are nondeterministic because the generated value is different for each replay.||Use an activity function to return random numbers to an orchestration. The return values of activity functions are always safe for replay.|
|Bindings||Input and output bindings typically do I/O and are nondeterministic. An orchestrator function must not directly use even the orchestration client and entity client bindings.||Use input and output bindings inside client or activity functions.|
|Network||Network calls involve external systems and are nondeterministic.||Use activity functions to make network calls. If you need to make an HTTP call from your orchestrator function, you also can use the durable HTTP APIs.|
|Blocking APIs||Blocking APIs like
||Use alternatives to blocking APIs when they're available. For example, use
|Async APIs||Orchestrator code must never start any async operation except by using the
||An orchestrator function should make only durable async calls. Activity functions should make any other async API calls.|
|Threading APIs||The Durable Task Framework runs orchestrator code on a single thread and can't interact with any other threads. Introducing new threads into an orchestration's execution can result in nondeterministic execution or deadlocks.||Orchestrator functions should almost never use threading APIs. If such APIs are necessary, limit their use to only activity functions.|
|Static variables||Avoid using nonconstant static variables in orchestrator functions because their values can change over time, resulting in nondeterministic runtime behavior.||Use constants, or limit the use of static variables to activity functions.|
|Environment variables||Don't use environment variables in orchestrator functions. Their values can change over time, resulting in nondeterministic runtime behavior.||Environment variables must be referenced only from within client functions or activity functions.|
|Infinite loops||Avoid infinite loops in orchestrator functions. Because the Durable Task Framework saves execution history as the orchestration function progresses, an infinite loop can cause an orchestrator instance to run out of memory.||For infinite loop scenarios, use APIs like
Although applying these constraints might seem difficult at first, in practice they're easy to follow.
The Durable Task Framework attempts to detect violations of the preceding rules. If it finds a violation, the framework throws a NonDeterministicOrchestrationException exception. However, this detection behavior won't catch all violations, and you shouldn't depend on it.
A durable orchestration might run continuously for days, months, years, or even eternally. Any code updates made to Durable Functions apps that affect unfinished orchestrations might break the orchestrations' replay behavior. That's why it's important to plan carefully when making updates to code. For a more detailed description of how to version your code, see the versioning article.
This section describes internal implementation details of the Durable Task Framework. You can use durable functions without knowing this information. It is intended only to help you understand the replay behavior.
Tasks that can safely wait in orchestrator functions are occasionally referred to as durable tasks. The Durable Task Framework creates and manages these tasks. Examples are the tasks returned by CallActivityAsync, WaitForExternalEvent, and CreateTimer in .NET orchestrator functions.
These durable tasks are internally managed by a list of
TaskCompletionSource objects in .NET. During replay, these tasks are created as part of orchestrator code execution. They're finished as the dispatcher enumerates the corresponding history events.
The tasks are executed synchronously using a single thread until all the history has been replayed. Durable tasks that aren't finished by the end of history replay have appropriate actions carried out. For example, a message might be enqueued to call an activity function.
This section's description of runtime behavior should help you understand why an orchestrator function can't use
yield in a nondurable task. There are two reasons: the dispatcher thread can't wait for the task to finish, and any callback by that task might potentially corrupt the tracking state of the orchestrator function. Some runtime checks are in place to help detect these violations.
To learn more about how the Durable Task Framework executes orchestrator functions, consult the Durable Task source code on GitHub. In particular, see TaskOrchestrationExecutor.cs and TaskOrchestrationContext.cs.