Skip to content

Implement v1 show_history status query compatibility #230

Description

@andystaples

Summary

Implement the accepted show_history and show_history_output options on the v1-compatible get_status() API.

Current behavior

DurableFunctionsClient.get_status() accepts both options but explicitly ignores them, and DurableOrchestrationStatus.history always returns None.

The core client now exposes get_orchestration_history(), so the underlying history is available even though the compatibility projection is missing. The limitation is mentioned in CHANGELOG.md, but no repository issue tracks completing it.

Expected behavior

When show_history=True, retrieve orchestration history and project it into the v1 historyEvents response shape. show_history_output should control whether output-bearing fields are included in those history events, matching the Durable Functions HTTP management API behavior.

When show_history=False, avoid the additional history request and preserve current lightweight status-query behavior.

Acceptance criteria

  • get_status(show_history=True) populates DurableOrchestrationStatus.history and serialized historyEvents.
  • show_history_output=False omits event output payloads.
  • show_history_output=True includes event output payloads.
  • show_history=False does not request history.
  • Missing instances and continued-as-new histories are handled consistently with the v1 API.
  • Async tests cover history inclusion, output suppression, and the no-history fast path.
  • Remove the corresponding known-limitation entry when support is complete.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions