Skip to content

docs: comprehensive durable execution documentation#3335

Open
promptless-for-oss wants to merge 1 commit intohatchet-dev:mainfrom
Promptless:promptless/consolidated-durable-execution
Open

docs: comprehensive durable execution documentation#3335
promptless-for-oss wants to merge 1 commit intohatchet-dev:mainfrom
Promptless:promptless/consolidated-durable-execution

Conversation

@promptless-for-oss
Copy link

@promptless-for-oss promptless-for-oss commented Mar 19, 2026

Open this suggestion in Promptless to view citations and reasoning process

Summary

Adds comprehensive documentation for Hatchet's durable execution features, covering eviction policies, determinism requirements, DurableContext methods, and more.

Conceptual docs

  • Eviction policies — TTL, capacity-based eviction, and priority configuration in task-eviction.mdx
  • Server-initiated eviction — Stale invocation detection and split-brain prevention
  • Determinism requirements — What causes NonDeterminismError, how to handle it, and best practices
  • Replaying from checkpointsreset_durable_task / aio_reset_durable_task for programmatic replay
  • Slot types — Regular vs durable slot pools and deadlock prevention in workers.mdx

SDK reference docs

  • Python DurableContextaio_wait_for, aio_sleep_for (with correct Duration param type and SleepResult return), aio_wait_for_event with payload_validator support
  • TypeScript DurableContextsleepFor, sleepUntil, waitForEvent, waitFor, now(), SleepResult type
  • EvictionPolicy class reference with correct import path (hatchet_sdk.runnables.eviction)
  • reset_durable_task — Added branch_id parameter, corrected return type to V1BranchDurableTaskResponse
  • NonDeterminismError — Properties and handling guidance for both SDKs

Fixes

  • Fixed broken /v1/durable-workflows links → /v1/durable-workflows-overview
  • Fixed eviction TTL default from 5 min → 15 min
  • Fixed NonDeterminismError import path in TypeScript (@hatchet-dev/typescript-sdk/v1)

Generated by Promptless

Adds documentation for durable execution features including:
- Eviction policies (TTL, capacity-based, priority) in task-eviction.mdx and SDK references
- Server-initiated eviction and stale invocation detection
- NonDeterminismError handling with SDK-specific documentation
- Determinism requirements and best practices for durable tasks
- Reset/replay durable tasks from specific checkpoints
- Slot types (regular vs durable) and their role in preventing deadlocks
- DurableContext methods: sleepFor, sleepUntil, waitForEvent, waitFor, now()
- aio_wait_for_event with payload_validator support (Python)
- SleepResult return type documentation

Also fixes broken links from the docs refactor (/v1/durable-workflows → /v1/durable-workflows-overview).

Subsumes suggestions: document-eviction-policy, document-memo-durable-context,
document-nondeterminism-error, document-reset-durable-task,
document-slot-types-architecture, document-server-initiated-eviction,
document-aio-wait-for-event-method, document-duration-milliseconds-and-nondeterminism-errors,
document-durable-otel-spans, document-durable-bulk-spawn,
fix-broken-links-after-docs-refactor, document-durable-execution-features,
document-typescript-durable-context-methods
@vercel
Copy link

vercel bot commented Mar 19, 2026

@promptless-for-oss is attempting to deploy a commit to the Hatchet Team on Vercel.

A member of the Team first needs to authorize it.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant