Skip to content

Add Metadoor workflow story and zigttp:workflow design spec#22

Draft
srdjan wants to merge 1 commit intomainfrom
codex/create-story-and-spec-for-metadoor-workflow
Draft

Add Metadoor workflow story and zigttp:workflow design spec#22
srdjan wants to merge 1 commit intomainfrom
codex/create-story-and-spec-for-metadoor-workflow

Conversation

@srdjan
Copy link
Copy Markdown
Owner

@srdjan srdjan commented Apr 29, 2026

Motivation

  • Lift the Metadoor HAL-typed long-running workflow model into a first-class zigttp virtual module so workflows can be defined, versioned, and executed alongside handlers using existing durable primitives.
  • Capture requirements for deterministic replay, typed step contracts, durable timers/signals, idempotent activity dispatch, and safe version migration in a single design artifact.

Description

  • Add a new design document docs/metadoor-workflow-spec.md that defines the product story and a draft API for zigttp:workflow.
  • The spec includes an API sketch (defineWorkflow, startWorkflow, signalWorkflow, queryWorkflow, cancelWorkflow, continueAsNew), the HAL-typed validation rules, durable execution mapping (event log, checkpoints, timers, signal inbox, activity queue), and determinism contracts.
  • The document defines the workflow state machine, activity model (pure, durable, human tasks), versioning and migration strategies, observability and security considerations, failure semantics, acceptance criteria, a phased implementation plan, and open design questions.

Testing

  • Created and committed the file via git add docs/metadoor-workflow-spec.md && git commit -m 'add metadoor workflow story and zigttp module spec', and verified contents with nl -ba docs/metadoor-workflow-spec.md | sed -n '1,260p'; these commands completed successfully.
  • No automated runtime or unit tests were run because this is a documentation-only change.

Codex Task

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant