microsoft / microsoft/durabletask-python

Add Durable Task middleware support

Offen
#136 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
40
Forks
33
Ø Merge
2 T. 2 Std.
Gemergte PRs (30 T.)
6

Beschreibung

Summary

Track adding SDK-level Durable Task middleware support to the Python SDK, aligned with the .NET reference implementation.

Reference spec: https://github.com/microsoft/durabletask-dotnet/blob/feature/durable-task-middleware/doc/cross-sdk-middleware.md
.NET user guide: https://github.com/microsoft/durabletask-dotnet/blob/feature/durable-task-middleware/doc/durable-task-middleware.md
Motivation: https://github.com/Azure/azure-functions-durable-extension/issues/3054

The spec may shift until the .NET v1 implementation is merged. This issue is intended to track the Python design and implementation work so it can follow the same durable middleware contract with idiomatic API names.

Proposed shape

Names are illustrative, not final API commitments.

@app.orchestration_middleware
async def orchestration_middleware(ctx, next):
    if not ctx.is_replaying:
        ctx.logger.info("starting orchestration", extra={"instance_id": ctx.instance_id})

    await next(ctx)

@app.activity_middleware
async def activity_middleware(ctx, next):
    cached = await cache.try_get(ctx.name, ctx.input)
    if cached is not None:
        ctx.set_result(cached)
        return

    await next(ctx)

Design points to cover

  • Decorator and/or builder registration APIs that are scoped to a worker/app instance.
  • Registration ordering: first registered middleware runs outermost and unwinds last.
  • Dataclass/protocol-style contexts that expose durable task name, instance ID, version/parent/tags where available, input, raw input where available, replay state for orchestrations, features, and result after next.
  • A feature collection using type keys or well-known keys when runtime type identity is not the right Python abstraction.
  • Orchestration middleware determinism guidance for replay, including replay-safe logging and avoiding datetime.now, uuid.uuid4, random, file/network I/O, arbitrary asyncio awaits, and mutable process state.
  • Activity middleware short-circuiting through an explicit set_result API.
  • Host integration pattern for Azure Functions or other hosts to attach invocation context through features instead of durable middleware depending on host middleware internals.

Acceptance criteria

  • Orchestration and activity middleware APIs are exposed at the durable worker/app level.
  • Middleware executes in registration order and unwinds in reverse order.
  • Orchestration middleware must call next(ctx) exactly once when completing successfully; missing or duplicate calls are rejected where feasible.
  • Activity middleware can call next(ctx) once or short-circuit only through ctx.set_result(...); duplicate next is invalid.
  • Host-specific objects can be passed through features without serialization into durable history.
  • Documentation covers replay determinism and the difference between durable middleware and host/Functions middleware.
  • Tests cover registration ordering, context population, feature access, orchestration next-call validation, and activity short-circuiting.
  • No wire protocol or protobuf changes are required.
  • Entity middleware is out of scope for v1.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem Vergleich der referenzierten .NET cross-SDK middleware specification und des user guide, und ermitteln Sie anschließend die Python durable worker/app registration entry points. Definieren Sie die orchestration- und activity-APIs, contexts, den feature access, die Reihenfolge, die Validierung und das short-circuit-Verhalten, und fügen Sie die Tests und die Dokumentation für die Abnahmekriterien hinzu; entity middleware und wire-Änderungen sind nicht Bestandteil des Umfangs.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
backend-api-design, distributed-systems
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
32/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.