You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
feat: add specify workflow definition for run-scoped definitions - #4912
Adds specify workflow definition <run_id> --json, a read-only command that
returns the workflow definition a run was started with. It reads only the
persisted run snapshot and frozen definitions for workflow calls that were
actually bound during execution, so output does not drift after installed
workflows are edited, overlaid, or removed.
definition is the persisted, overlay-composed root definition, passed
through without filling defaults or restructuring fields.
workflow_scopes is always present and contains each bound workflow call's scope_path, workflow ID, and frozen definition. Its paths and workflow IDs
match workflow status --json.
RunState.definition_path, load_definition(), and load_workflow_scopes() make the snapshot read surface explicit; resume and
definition share the same persisted snapshot path.
--json is required. Successful output is one JSON object on stdout; errors
are one {"error": ...} object on stderr.
Strict JSON output stringifies YAML-native values, non-string mapping keys,
and non-finite floats, and rejects recursive YAML aliases with the same
strict JSON error contract.
Decisions that diverge from the original issue
Output mirrors the persisted workflow structure rather than defining a new,
normalized definition model. schema_version therefore versions the exposed
definition shape; the JSON envelope is additive-only. This avoids partially
applying engine defaults and preserves the definition that was executed.
The command is JSON-only for now. It requires --json and exits 2 without it;
a human text renderer is intentionally deferred rather than introducing a
second output contract.
A composed run includes only definitions that are already bound in its
execution tree. Unreached calls are not resolved from current installed
workflows, because doing so would reintroduce definition drift.
The root definition remains authored: call steps are not expanded inline.
Frozen callees appear separately in workflow_scopes, which also supports a
call invoked more than once through loops or fan-out.
Errors follow the established artifact strict-JSON contract, including
project-resolution and unsafe-workflow-storage failures. workflow status --json intentionally retains its existing Rich error rendering.
Dynamically generated steps are out of scope. Steps that a custom step type
produces at run time through StepResult.next_steps are persisted in the
execution state but are not exported; definition and workflow_scopes
cover only the authored definition and bound workflow calls. The
documentation states this limit.
Follow-ups
[Bug]: Harden persisted workflow run artifact access against symlinks #4914 will harden persisted workflow-run artifact access at the shared
storage boundary. The symlink concern predates this command: resume already
reads the same persisted snapshot and run-state loading reads sibling files.
A command-local check would leave those consumers inconsistent.
Ran focused workflow, overlay, preset, extension, and engine tests: 1996 passed, 1 skipped.
Ran uvx ruff@0.15.0 check src tests.
Ran git diff --check.
Ran the primary workflow suites again: 850 passed.
Ran tests/specify_cli/workflows/test_command_definition.py: 36 passed,
including recursive YAML alias rejection.
Manually tested the working-tree CLI in /tmp/test-workflow-run-definition:
initialized a project, ran root and composed paused workflows, verified the
persisted snapshot and JSON envelope, checked workflow_scopes parity with status --json, exercised required-flag and unknown-run errors, and confirmed
unchanged output after editing then removing the installed child workflow.
The full suite was attempted twice. Both runs showed the known pre-existing
failure tests/integration/test_preset_update_workflow.py::test_preset_update_cli_contract,
which expects an older Typer missing-argument string; the isolated test still
fails unchanged. The second full run continued cleanly through 83% before the
available execution timeout.
AI Disclosure
I did not use AI assistance for this contribution
I did use AI assistance (fill in the disclosure below)
AI disclosure: Implemented and updated with OpenCode using gpt-5.6-terra
(github-copilot/gpt-5.6-terra) in autonomous mode with default reasoning.
The agent generated implementation, tests, documentation, follow-up issues, and
review responses from the reviewed issue plan and review decisions, and ran the
listed automated and manual checks. No claim of human line-by-line review is
made.
Add a strict JSON command for inspecting the definition persisted with a workflow run, including frozen definitions for bound workflow calls.\n\nCloses github#4792.\n\nAssisted-by: OpenCode (model: gpt-5.6-terra, autonomous)
Manual validation completed after opening this PR. Using the working-tree CLI in a disposable initialized project, I verified root and composed paused runs, persisted snapshots, definition/status scope parity, required-flag and unknown-run errors, and stable definition output after editing and removing the installed child workflow.
AI disclosure: Posted by Markus Wondrak with OpenCode (github-copilot/gpt-5.6-terra), default reasoning, autonomous mode; the agent performed and summarized the manual CLI validation.
Fixed the recursive YAML-alias finding. Strict workflow JSON conversion now rejects cyclic mappings, lists, and tuples, while allowing non-recursive aliases reused across separate branches. workflow definition --json reports this through its single JSON stderr error envelope.
Added a command-level regression test covering snapshot persistence of a recursive YAML alias and the strict error contract.
Validation: 36 passed for tests/specify_cli/workflows/test_command_definition.py; 133 passed across definition, run, resume, and status command suites; Ruff and git diff --check passed.
AI disclosure: Posted by Markus Wondrak with OpenCode (github-copilot/gpt-5.6-terra), default reasoning, autonomous mode. The agent implemented the fix, tests, follow-up issues, and this review summary, and ran the stated automated checks; no claim of human line-by-line review is made.
Stringified mapping keys can silently overwrite existing keys
src/specify_cli/workflows/_commands.py:1082
Stringifying a non-string mapping key inside this comprehension can silently overwrite an existing string key. For example, YAML containing both an unquoted 2026-01-01 key (loaded as date) and a quoted "2026-01-01" key has two entries before this code and only the latter afterward, so the advertised persisted definition is returned with data missing. Normalize keys explicitly and reject collisions (with a negative test) rather than allowing the comprehension to drop an entry.
Scope rendering adds avoidable traversal and per-node memory
src/specify_cli/workflows/_execution.py:368
This refactor turns scope rendering from one tree walk into two and retains an additional entry for every execution node in nodes_by_path. Since workflow trees grow with loop iterations and fan-out items and status is commonly polled, this adds avoidable O(nodes) memory and a full traversal even when there are few or no bound scopes. Iterate the nodes directly (as before), or make the shared iterator yield the node together with the path and binding.
Canonicalize every mapping key to the JSON property name json.dumps emits
before inserting it, and raise when two keys collapse to the same name.
Previously the definition command could emit duplicate JSON properties for
keys such as 1 and "1", and json.loads then silently dropped an entry.
Assisted-by: OpenCode (model: deepseek-v4.1-flash, autonomous)
Addressed the duplicate-canonical-key finding in a08f50e.
_emit_workflow_json now canonicalizes every mapping key to the JSON property name json.dumps emits before insertion, and raises ValueError when two keys collapse to the same name (e.g. 1/"1", true/"true", or a date and its string form). That routes through the existing strict-JSON error path (stdout empty, exit 1) instead of emitting duplicate properties that json.loads silently truncates. Added a parametrized regression test for int/string, bool/string and date/string collisions, and documented the behavior in docs/reference/workflows.md.
AI disclosure: posted by OpenCode (model: deepseek-v4.1-flash, autonomous) on behalf of @markuswondrak. The human selected and directed the fix and reviewed the plan; the code was not line-by-line human-reviewed before commit.
YAML alias DAG expansion causes exponential resource usage
src/specify_cli/workflows/_commands.py:1109
active_containers rejects cycles but forgets each container after returning, so a non-recursive YAML alias DAG is expanded independently at every reference. A linear-size definition such as xN: &xN [*xN-1, *xN-1] therefore causes exponential CPU, memory, and stdout growth; the repository already treats this exact pattern as a regression hazard in tests/test_resolve_template_python_parity.py:1088-1095. Reject repeated container identities or enforce a bounded expansion/output policy, and add a negative test for a deep non-cyclic alias graph.
`_emit_workflow_json` rejected recursive YAML aliases but re-expanded a
non-recursive alias DAG independently at every reference, so a linear-size
definition such as `xN: &xN [*xN-1, *xN-1]` produced exponential CPU,
memory, and stdout. Add a node budget that raises the existing strict-JSON
error instead of rejecting every reused alias, and cover both a bounded
shared alias and a deep non-cyclic DAG.
Assisted-by: opencode (model: deepseek-v4.1-flash, autonomous)
Addresses the alias-expansion finding from review 5494817862.
_emit_workflow_json now enforces a node budget in plain_json, so a non-recursive YAML alias DAG raises the strict-JSON error instead of expanding exponentially. The budget bounds expansion rather than rejecting every reused alias, so legitimate shared anchors still emit.
Added a negative test (deep non-cyclic DAG) and a positive test (bounded shared alias).
Regression evidence: the negative test fails on the parent commit (exit_code 0, ~31s emitting the exponential payload at depth 20) and passes after.
Updated docs/reference/workflows.md (Plain JSON and Errors).
100000 still leaves >1000x headroom over the largest shipped workflow
definition (~67 nodes) while capping worst-case memory and stdout.
Assisted-by: opencode (model: deepseek-v4.1-flash, autonomous)
…inition reference
Document that an omitted schema_version in the verbatim definition output defaults to "1.0" and that validation compares str(schema_version), and state that the additive-only guarantee applies to the top-level response envelope.
Assisted-by: Google Antigravity (model: Gemini 4 Argon Medium, autonomous)
Clarified in docs/reference/workflows.md (7a794456) that because definition is emitted as authored, an omitted schema_version defaults to "1.0" and the engine compares str(schema_version) (so unquoted schema_version: 1.0 in YAML appears as the JSON number 1.0), and scoped the additive-only key guarantee to the top-level response envelope (run_id, definition, workflow_scopes).
Validated in src/specify_cli/workflows/_execution.py (54cbadae) that bound workflow records include a non-empty string workflow ID before bound_scopes callers index binding["workflow"], with regression coverage in tests/specify_cli/workflows/test_command_definition.py.
AI disclosure: Posted on behalf of @markuswondrak by Google Antigravity (model: Gemini 4 Argon Medium, autonomous). The human reviewed the findings and directed the fix; the agent authored the documentation edit, commit, and review comments.
Check the complete serialized JSON length (including brackets, whitespace, and non-string scalars emitted by json.dumps(..., indent=2)) at the end of _plain_workflow_json when max_nodes is active, while keeping the incremental string byte budget during traversal. Add a regression test for a shared 150-level nested list referenced 150 times and verify per-definition byte budgeting across workflow_scopes.
Assisted-by: Google Antigravity (model: Gemini 4 Argon Medium, autonomous)
_plain_workflow_json now checks len(json.dumps(plain, indent=2)) > _MAX_JSON_BYTES when max_nodes is enabled, while retaining the incremental string byte budget during traversal. Because workflow_definition calls _plain_workflow_json for the root definition and each workflow_scopes entry separately, the serialized size limit continues to apply per definition.
Added TestNegative.test_byte_budget_stops_nested_alias_indentation_expansion for a 150-level nested list referenced 150 times via YAML alias and extended TestComposition.test_budget_applies_per_definition_not_to_the_whole_response to cover _MAX_JSON_BYTES.
AI disclosure: Posted on behalf of @markuswondrak by Google Antigravity (model: Gemini 4 Argon Medium, autonomous); the agent implemented the fix, ran the test suite, pushed commit 3b218665, and drafted this comment.
…oded size
- Convert RecursionError from yaml/json parsing into ValueError in
WorkflowDefinition.from_yaml/from_string and RunState.load, so
RunState.load_definition keeps its documented ValueError contract.
- Enforce the JSON byte budget by streaming the encoded output instead of
charging per value type, so aliased integers (and any future type) cannot
bypass it.
- Cover `workflow status` text and --json for unparseable run state.
Assisted-by: GitHub Copilot (model: Claude Sonnet 5.5, autonomous)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
AI disclosure: posted on behalf of @markuswondrak by GitHub Copilot CLI (model: Claude Sonnet 5.5, autonomous, default settings). The code change and this comment are AI-generated; the contributor directed the work and has not line-by-line reviewed it.
Changes:
RecursionError from YAML/JSON parsing is now converted to ValueError in WorkflowDefinition.from_yaml/from_string and RunState.load (state.json, inputs.json), so RunState.load_definition() keeps its documented ValueError contract.
The JSON byte budget is now measured by streaming the encoded output, replacing per-type charging and the final full json.dumps. Aliased integers and any other scalar type are covered, and memory stays bounded. This supersedes the end-of-traversal json.dumps check from 3b21866, which allocated the whole document before comparing.
Added workflow status tests (text and --json) for unparseable and over-nested run state, plus tests for nested YAML/JSON parsing and an aliased 4000-digit integer.
Evidence: the new parsing and byte-budget tests fail on the previous source and pass now. The full suite passes (12881 passed, 435 skipped) before the rebase; the workflow suites pass after it.
AI disclosure: posted on behalf of @markuswondrak by GitHub Copilot CLI (model: Claude Sonnet 5.5, autonomous, default settings). The code change, tests and this comment are AI-generated; the contributor directed the work and has not line-by-line reviewed it.
Changes:
Merged upstream/main (conflict in workflows/_commands.py). The branch now uses the shared validate_workflow_storage and drops its own storage-error helpers.
Mapping keys of type bytes/bytearray are now emitted as the <binary: N bytes> placeholder instead of str(key), so aliases no longer retain a new long key string per visit before the byte budget runs. Other keys that safe_load can produce (int, float, bool, null, dates) are short.
Validation: the new regression test (200 aliases of a 16 KiB !!binary key) fails before the change and passes after it. After the merge, tests/specify_cli/workflows and tests/test_workflows.py gave 1733 passed, 30 skipped; after the fix, test_command_definition.py gave 62 passed. ruff is clean. No PowerShell code changed, so no Windows PowerShell checks were run.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
author-awaitingWaiting on author responsetriage-can-waitVerdict: valid and in-scope but deprioritized; held behind the evidence gate
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #4792.
Adds
specify workflow definition <run_id> --json, a read-only command thatreturns the workflow definition a run was started with. It reads only the
persisted run snapshot and frozen definitions for workflow calls that were
actually bound during execution, so output does not drift after installed
workflows are edited, overlaid, or removed.
definitionis the persisted, overlay-composed root definition, passedthrough without filling defaults or restructuring fields.
workflow_scopesis always present and contains each bound workflow call'sscope_path, workflow ID, and frozen definition. Its paths and workflow IDsmatch
workflow status --json.RunState.definition_path,load_definition(), andload_workflow_scopes()make the snapshot read surface explicit; resume anddefinition share the same persisted snapshot path.
--jsonis required. Successful output is one JSON object on stdout; errorsare one
{"error": ...}object on stderr.and non-finite floats, and rejects recursive YAML aliases with the same
strict JSON error contract.
Decisions that diverge from the original issue
Output mirrors the persisted workflow structure rather than defining a new,
normalized definition model.
schema_versiontherefore versions the exposeddefinition shape; the JSON envelope is additive-only. This avoids partially
applying engine defaults and preserves the definition that was executed.
The command is JSON-only for now. It requires
--jsonand exits 2 without it;a human text renderer is intentionally deferred rather than introducing a
second output contract.
A composed run includes only definitions that are already bound in its
execution tree. Unreached calls are not resolved from current installed
workflows, because doing so would reintroduce definition drift.
The root definition remains authored: call steps are not expanded inline.
Frozen callees appear separately in
workflow_scopes, which also supports acall invoked more than once through loops or fan-out.
Errors follow the established artifact strict-JSON contract, including
project-resolution and unsafe-workflow-storage failures.
workflow status --jsonintentionally retains its existing Rich error rendering.Dynamically generated steps are out of scope. Steps that a custom step type
produces at run time through
StepResult.next_stepsare persisted in theexecution state but are not exported;
definitionandworkflow_scopescover only the authored definition and bound workflow calls. The
documentation states this limit.
Follow-ups
storage boundary. The symlink concern predates this command: resume already
reads the same persisted snapshot and run-state loading reads sibling files.
A command-local check would leave those consumers inconsistent.
coverage. A
workflow.definition-only disposition would leave every existingworkflow leaf unaccounted for.
Testing
1996 passed, 1 skipped.uvx ruff@0.15.0 check src tests.git diff --check.850 passed.tests/specify_cli/workflows/test_command_definition.py:36 passed,including recursive YAML alias rejection.
/tmp/test-workflow-run-definition:initialized a project, ran root and composed paused workflows, verified the
persisted snapshot and JSON envelope, checked
workflow_scopesparity withstatus --json, exercised required-flag and unknown-run errors, and confirmedunchanged output after editing then removing the installed child workflow.
The full suite was attempted twice. Both runs showed the known pre-existing
failure
tests/integration/test_preset_update_workflow.py::test_preset_update_cli_contract,which expects an older Typer missing-argument string; the isolated test still
fails unchanged. The second full run continued cleanly through 83% before the
available execution timeout.
AI Disclosure
AI disclosure: Implemented and updated with OpenCode using
gpt-5.6-terra(
github-copilot/gpt-5.6-terra) in autonomous mode with default reasoning.The agent generated implementation, tests, documentation, follow-up issues, and
review responses from the reviewed issue plan and review decisions, and ran the
listed automated and manual checks. No claim of human line-by-line review is
made.