groundswell 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/commands/subtask-planning/prp-base-create.md +120 -0
- package/.claude/commands/subtask-planning/prp-base-execute.md +65 -0
- package/.claude/commands/task-breakdown.md +94 -0
- package/.claude/system_prompts/task-breakdown.md +1 -0
- package/CHANGELOG.md +188 -0
- package/PRD.md +543 -0
- package/README.md +99 -5
- package/examples/README.md +15 -1
- package/examples/examples/11-reparenting-workflows.ts +269 -0
- package/examples/index.ts +4 -0
- package/package-lock.json +2398 -0
- package/package.json +3 -1
- package/plan/001_d3bb02af4886/TEST_RESULTS.md +259 -0
- package/plan/001_d3bb02af4886/bug_fix_tasks.json +484 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M1T1S1/PRP.md +488 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M1T1S2/PRP.md +581 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M1T1S3/PRP.md +687 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T1S1/PRP.md +492 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T1S3/PRP.md +932 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T1S3/research/concurrent_error_testing_patterns.md +1109 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T1S3/research/vitest_concurrent_testing.md +802 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T1S3/research/workflow_engine_test_references.md +603 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T2S1/PRP.md +564 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T2S3/PRP.md +518 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T2S4/PRP.md +1252 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T3S1/PRP.md +364 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T3S1/research/CODEBASE_INVENTORY.md +114 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T3S1/research/DECORATOR_DOCUMENTATION_PATTERNS.md +205 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T3S1/research/PRD_LOCATION_ANALYSIS.md +199 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M2T3S1/research/ULTRATHINK_PRP_PLAN.md +134 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T1S1/PRP.md +495 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T1S1/research/console_error_inventory.md +435 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T1S2/PRP.md +506 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T1S3/PRP.md +612 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T2S2/PRP.md +558 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T2S2/research/external_research.md +788 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T3S2/PRP.md +460 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T3S3/PRP.md +454 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T4S1/PRP.md +520 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T4S1/RECOMMENDATION.md +417 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T4S1/research/external_workflow_engines_research.md +760 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T4S1/research/security_implications_analysis.md +245 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M3T4S2/PRP.md +792 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S1/PRP.md +535 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S1/TEST_EXECUTION_REPORT.md +190 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S2/PRP.md +654 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S2/TEST_FIX_REPORT.md +227 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S2/research/KEY_FINDINGS.md +345 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S2/research/QUICK_REFERENCE.md +193 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T1S2/research/test_maintenance_research.md +1323 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T3S1/BREAKING_CHANGES_AUDIT.md +1011 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T3S1/PRP.md +927 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/P1M4T3S2/PRP.md +505 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/architecture/logger_child_signature_analysis.md +401 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S3/child_implementation_research.md +142 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S3/test_patterns_research.md +112 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S3/vitest_patterns_research.md +159 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S4/PRP.md +549 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S4/VERIFICATION_REPORT.md +368 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S4/edge_case_analysis.md +172 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M1T1S4/usage_inventory.md +175 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T1S2/PRP.md +696 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T1S4/PRP.md +860 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/PRP.md +1066 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/01-testing-aggregated-errors.md +1103 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/01_typescript_error_aggregation_patterns.md +789 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/02-error-merge-strategy-testing-guide.md +1098 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/02_aggregate_error_patterns.md +1037 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/03-promise-allsettled-testing-patterns.md +916 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/03_error_merging_strategies.md +1045 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/04_github_stackoverflow_examples.md +890 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/05_comprehensive_summary.md +822 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/INDEX.md +668 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/QUICK_REFERENCE.md +706 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/README.md +265 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S2/research/RESEARCH_REPORT.md +655 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T2S4/research/vitest_testing_patterns.md +1103 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M2T3S2/PRP.md +426 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T1S2/PRP.md +506 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T1S2/research/QUICK_REFERENCE.md +114 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T1S2/research/RESEARCH_SUMMARY.md +316 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T1S2/research/vitest_observer_error_logging_best_practices.md +754 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T1S3/PRP.md +612 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T2S1/PRP.md +719 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T2S1/README.md +215 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T2S1/analysis.md +765 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T2S3/PRP.md +718 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T3S1/DECISION.md +149 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T3S1/PRP.md +470 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T3S1/research/ULTRATHINK_PLAN.md +332 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T3S1/research/codebase_workflow_name_analysis.md +167 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T3S1/research/external_best_practices.md +265 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T3S1/research/validation_patterns.md +273 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T4S1/workflow_engine_ancestry_api_research.md +760 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M3T4S3-PRP.md +434 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M4T2S1/PRP.md +717 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M4T2S2/PRP.md +472 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M4T2S2/VALIDATION_REPORT.md +125 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/P1M4T2S2/research/ULTRATHINK_PRP_PLAN.md +301 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/error-logging-best-practices.md +1170 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/research_typescript_partial_and_overloads.md +940 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/vitest-quick-reference.md +151 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/docs/vitest-research.md +650 -0
- package/plan/001_d3bb02af4886/bugfix/001_e8e04329daf3/prd_snapshot.md +259 -0
- package/plan/001_d3bb02af4886/bugfix/P1M1T1S1/PRP.md +457 -0
- package/plan/001_d3bb02af4886/bugfix/RESEARCH_SUMMARY.md +346 -0
- package/plan/001_d3bb02af4886/bugfix/architecture/codebase_structure.md +311 -0
- package/plan/001_d3bb02af4886/bugfix/architecture/concurrent_execution_best_practices.md +1565 -0
- package/plan/001_d3bb02af4886/bugfix/architecture/error_handling_patterns.md +288 -0
- package/plan/001_d3bb02af4886/bugfix/architecture/promise_all_analysis.md +741 -0
- package/plan/001_d3bb02af4886/docs/PRP/P1M1T1S4-functional-workflow-error-state-capture-test.md +652 -0
- package/plan/001_d3bb02af4886/docs/PRP/PRP.md +527 -0
- package/plan/001_d3bb02af4886/docs/PRP/bugfix/P1M1T2S1-PRP.md +415 -0
- package/plan/001_d3bb02af4886/docs/PRP/bugfix/P1M1T2S2-PRP.md +378 -0
- package/plan/001_d3bb02af4886/docs/PRP/bugfix/P1M1T2S4-PRP.md +713 -0
- package/plan/001_d3bb02af4886/docs/PRP/bugfix/P1M2T1S4-PRP.md +370 -0
- package/plan/001_d3bb02af4886/docs/PRP_P1M3T1S3.md +499 -0
- package/plan/001_d3bb02af4886/docs/TEST_RESULTS.md +230 -0
- package/plan/001_d3bb02af4886/docs/bugfix/ANALYSIS_PRD_VS_IMPLEMENTATION.md +1134 -0
- package/plan/001_d3bb02af4886/docs/bugfix/GAP_ANALYSIS_SUMMARY.md +179 -0
- package/plan/001_d3bb02af4886/docs/bugfix/P1M4T2S1/PRP.md +629 -0
- package/plan/001_d3bb02af4886/docs/bugfix/P1M4T2S1/validation-report.md +214 -0
- package/plan/001_d3bb02af4886/docs/bugfix/PRP_P1M4T2S3.md +629 -0
- package/plan/001_d3bb02af4886/docs/bugfix/bugfix_PRP.md +529 -0
- package/plan/001_d3bb02af4886/docs/bugfix/bugfix_QUICK_REFERENCE.md +142 -0
- package/plan/001_d3bb02af4886/docs/bugfix/bugfix_README.md +304 -0
- package/plan/001_d3bb02af4886/docs/bugfix/bugfix_TEST_RESULTS.md +558 -0
- package/plan/001_d3bb02af4886/docs/bugfix/bugfix_VALIDATION_SUMMARY.md +256 -0
- package/plan/001_d3bb02af4886/docs/bugfix/system_context.md +346 -0
- package/plan/001_d3bb02af4886/docs/bugfix-architecture/bug_analysis.md +415 -0
- package/plan/001_d3bb02af4886/docs/bugfix-architecture/implementation_patterns.md +489 -0
- package/plan/001_d3bb02af4886/docs/bugfix-architecture/system_context.md +218 -0
- package/plan/001_d3bb02af4886/docs/bugfix_INITIATION_SUMMARY.md +380 -0
- package/plan/001_d3bb02af4886/docs/research/CYCLE_DETECTION_PATTERNS.md +1923 -0
- package/plan/001_d3bb02af4886/docs/research/CYCLE_DETECTION_QUICK_REF.md +319 -0
- package/plan/001_d3bb02af4886/docs/research/P1M1T2S1/codebase-context.md +115 -0
- package/plan/001_d3bb02af4886/docs/research/P1M1T2S1/cycle-detection-algorithms.md +134 -0
- package/plan/001_d3bb02af4886/docs/research/P1M1T2S1/test-patterns.md +153 -0
- package/plan/001_d3bb02af4886/docs/research/P1M1T2S1/workflow-class.md +132 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/DECORATOR_DOCUMENTATION_BEST_PRACTICES.md +716 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/DECORATOR_DOCUMENTATION_QUICK_REF.md +186 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/GROUNDSWELL_DECORATOR_EXAMPLES.md +604 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/INDEX.md +213 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/codebase_structure.md +30 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/existing_test_pattern.md +56 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/getRootObservers_implementation.md +53 -0
- package/plan/001_d3bb02af4886/docs/research/P1M2T1S4/test_conventions.md +49 -0
- package/plan/001_d3bb02af4886/docs/research/P1M3T1S4/PRP.md +958 -0
- package/plan/001_d3bb02af4886/docs/research/P1M3T1S4/QUICK_REFERENCE.md +339 -0
- package/plan/001_d3bb02af4886/docs/research/P1M3T1S4/README.md +305 -0
- package/plan/001_d3bb02af4886/docs/research/P1M3T1S4/SUMMARY.md +433 -0
- package/plan/001_d3bb02af4886/docs/research/P1M3T1S4/bidirectional-tree-consistency-testing.md +1574 -0
- package/plan/001_d3bb02af4886/docs/research/P1M3T1S4/test-pattern-examples.md +1014 -0
- package/plan/001_d3bb02af4886/docs/research/PROMISE_ALLSETTLED_QUICK_REF.md +376 -0
- package/plan/001_d3bb02af4886/docs/research/PROMISE_ALLSETTLED_RESEARCH.md +1507 -0
- package/plan/001_d3bb02af4886/docs/research/bugfix_typescript_patterns.md +949 -0
- package/plan/001_d3bb02af4886/docs/research/error-testing-research.md +619 -0
- package/plan/001_d3bb02af4886/docs/research/error_handling_patterns.md +723 -0
- package/plan/{research → 001_d3bb02af4886/docs/research/general}/introspection-security-guide.md +56 -0
- package/plan/001_d3bb02af4886/docs/research/incremental-tree-map-updates/PRP_TEMPLATE.md +460 -0
- package/plan/001_d3bb02af4886/docs/research/incremental-tree-map-updates/QUICK_REFERENCE.md +324 -0
- package/plan/001_d3bb02af4886/docs/research/incremental-tree-map-updates/README.md +175 -0
- package/plan/001_d3bb02af4886/docs/research/incremental-tree-map-updates/RESEARCH_REPORT.md +499 -0
- package/plan/001_d3bb02af4886/docs/research/incremental-tree-map-updates/SUMMARY.md +163 -0
- package/plan/bugfix/BUG_FIX_SUMMARY.md +961 -0
- package/src/__tests__/adversarial/attachChild-performance.test.ts +216 -0
- package/src/__tests__/adversarial/circular-reference.test.ts +101 -0
- package/src/__tests__/adversarial/complex-circular-reference.test.ts +139 -0
- package/src/__tests__/adversarial/concurrent-task-failures.test.ts +571 -0
- package/src/__tests__/adversarial/deep-analysis.test.ts +729 -0
- package/src/__tests__/adversarial/deep-hierarchy-stress.test.ts +213 -0
- package/src/__tests__/adversarial/e2e-prd-validation.test.ts +448 -0
- package/src/__tests__/adversarial/edge-case.test.ts +703 -0
- package/src/__tests__/adversarial/error-merge-strategy.test.ts +760 -0
- package/src/__tests__/adversarial/incremental-performance.test.ts +140 -0
- package/src/__tests__/adversarial/node-map-update-benchmarks.test.ts +457 -0
- package/src/__tests__/adversarial/observer-propagation.test.ts +487 -0
- package/src/__tests__/adversarial/parent-validation.test.ts +143 -0
- package/src/__tests__/adversarial/prd-12-2-compliance.test.ts +611 -0
- package/src/__tests__/adversarial/prd-compliance.test.ts +731 -0
- package/src/__tests__/compatibility/backward-compatibility.test.ts +1572 -0
- package/src/__tests__/helpers/index.ts +18 -0
- package/src/__tests__/helpers/tree-verification.ts +257 -0
- package/src/__tests__/integration/bidirectional-consistency.test.ts +847 -0
- package/src/__tests__/integration/observer-logging.test.ts +643 -0
- package/src/__tests__/integration/tree-mirroring.test.ts +37 -0
- package/src/__tests__/integration/workflow-reparenting.test.ts +303 -0
- package/src/__tests__/unit/context.test.ts +79 -0
- package/src/__tests__/unit/logger.test.ts +293 -0
- package/src/__tests__/unit/observable.test.ts +321 -0
- package/src/__tests__/unit/tree-debugger-incremental.test.ts +170 -0
- package/src/__tests__/unit/utils/workflow-error-utils.test.ts +209 -0
- package/src/__tests__/unit/workflow-detachChild.test.ts +100 -0
- package/src/__tests__/unit/workflow-emitEvent-childDetached.test.ts +153 -0
- package/src/__tests__/unit/workflow-isDescendantOf.test.ts +180 -0
- package/src/__tests__/unit/workflow.test.ts +277 -1
- package/src/core/agent.ts +21 -1
- package/src/core/logger.ts +27 -2
- package/src/core/workflow-context.ts +6 -4
- package/src/core/workflow.ts +252 -14
- package/src/debugger/tree-debugger.ts +52 -7
- package/src/decorators/task.ts +65 -2
- package/src/index.ts +4 -2
- package/src/types/decorators.ts +8 -1
- package/src/types/events.ts +1 -0
- package/src/utils/index.ts +1 -0
- package/src/utils/observable.ts +32 -3
- package/src/utils/workflow-error-utils.ts +56 -0
- package/tsconfig.json +1 -1
- package/llms_full.txt +0 -5890
- package/tasks.json +0 -0
- /package/plan/{backlog.json → 001_d3bb02af4886/backlog.json} +0 -0
- /package/plan/{P1P2/PRP.md → 001_d3bb02af4886/docs/PRP/P1P2-PRP.md} +0 -0
- /package/plan/{P3P4/PRP.md → 001_d3bb02af4886/docs/PRP/P3P4-PRP.md} +0 -0
- /package/plan/{P4P5/PRP.md → 001_d3bb02af4886/docs/PRP/P4P5-PRP.md} +0 -0
- /package/plan/{architecture → 001_d3bb02af4886/docs/architecture}/external_deps.md +0 -0
- /package/plan/{architecture → 001_d3bb02af4886/docs/architecture}/system_context.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/LRU_CACHE_BEST_PRACTICES.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/LRU_CACHE_CODE_PATTERNS.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/LRU_CACHE_INTEGRATION_GUIDE.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/LRU_CACHE_RESEARCH_INDEX.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/REFLECTION_INDEX.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/REFLECTION_RESEARCH_REPORT.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/RESEARCH_SUMMARY.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/anthropic-sdk.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/async-local-storage.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/reflection-code-patterns.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/reflection-decision-matrix.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/reflection-implementation-guide.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/reflection-integration-guide.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/reflection-patterns.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/reflection-quick-reference.md +0 -0
- /package/plan/{P1P2/research → 001_d3bb02af4886/docs/research/P1P2}/zod-schema.md +0 -0
- /package/plan/{P3P4/research → 001_d3bb02af4886/docs/research/P3P4}/caching-lru.md +0 -0
- /package/plan/{P3P4/research → 001_d3bb02af4886/docs/research/P3P4}/introspection-tools.md +0 -0
- /package/plan/{P3P4/research → 001_d3bb02af4886/docs/research/P3P4}/reflection-patterns.md +0 -0
- /package/plan/{P4P5/research → 001_d3bb02af4886/docs/research/P4P5}/RESEARCH_SUMMARY.md +0 -0
- /package/plan/{research → 001_d3bb02af4886/docs/research/general}/INTROSPECTION_RESEARCH_SUMMARY.md +0 -0
- /package/plan/{research → 001_d3bb02af4886/docs/research/general}/README-INTROSPECTION.md +0 -0
- /package/plan/{research → 001_d3bb02af4886/docs/research/general}/agent-introspection-patterns.md +0 -0
- /package/plan/{research → 001_d3bb02af4886/docs/research/general}/introspection-tool-examples.md +0 -0
- /package/{PRPs/PRDs/001-hierarchical-workflow-engine.md → plan/001_d3bb02af4886/prd_snapshot.md} +0 -0
|
@@ -0,0 +1,958 @@
|
|
|
1
|
+
name: "PRP: Bidirectional Consistency Tests for Dual Tree Structure"
|
|
2
|
+
description: |
|
|
3
|
+
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Goal
|
|
7
|
+
|
|
8
|
+
**Feature Goal**: Create a comprehensive test suite that validates the 1:1 mirror invariant between the Workflow instance tree and the WorkflowNode tree after all tree mutation operations (attachChild, detachChild, reparenting).
|
|
9
|
+
|
|
10
|
+
**Deliverable**:
|
|
11
|
+
1. Helper functions library at `src/__tests__/helpers/tree-verification.ts`
|
|
12
|
+
2. Comprehensive test file at `src/__tests__/integration/bidirectional-consistency.test.ts`
|
|
13
|
+
|
|
14
|
+
**Success Definition**:
|
|
15
|
+
- Tests verify `child.parent === parent` AND `child.node.parent === parent.node` after attachChild()
|
|
16
|
+
- Tests verify `child.parent === null` AND `parent.node.children` does NOT contain `child.node` after detachChild()
|
|
17
|
+
- Tests cover multiple children, deep hierarchies, and reparenting scenarios
|
|
18
|
+
- All helper functions work correctly with both Workflow and WorkflowNode trees
|
|
19
|
+
- No regression in existing test suite
|
|
20
|
+
- Tests enforce the bidirectional consistency invariant as specified in PRD Section 12.2
|
|
21
|
+
|
|
22
|
+
## User Persona (if applicable)
|
|
23
|
+
|
|
24
|
+
**Target User**: Developer / QA Engineer ensuring tree integrity in the hierarchical workflow engine
|
|
25
|
+
|
|
26
|
+
**Use Case**: Validating that the dual tree structure (Workflow instances + WorkflowNode data structures) maintains perfect 1:1 correspondence during all tree operations
|
|
27
|
+
|
|
28
|
+
**User Journey**:
|
|
29
|
+
1. Developer runs the test suite with `npm test`
|
|
30
|
+
2. Bidirectional consistency tests execute as part of integration test suite
|
|
31
|
+
3. Tests pass, confirming the workflow tree and node tree remain synchronized
|
|
32
|
+
4. Developer gains confidence that tree operations won't create inconsistencies
|
|
33
|
+
|
|
34
|
+
**Pain Points Addressed**:
|
|
35
|
+
- Risk of workflow tree and node tree becoming out of sync
|
|
36
|
+
- Potential for subtle bugs where observer propagation fails due to tree inconsistency
|
|
37
|
+
- Difficulty validating the 1:1 mirror invariant required by PRD Section 12.2
|
|
38
|
+
- No automated way to detect when manual tree mutations corrupt state
|
|
39
|
+
|
|
40
|
+
## Why
|
|
41
|
+
|
|
42
|
+
- **Business value**: Ensures workflow engine reliability by enforcing the critical 1:1 tree mirror invariant from PRD Section 12.2. Without this invariant, observer propagation fails and state snapshots become inconsistent.
|
|
43
|
+
- **Integration with existing features**: Complements the reparenting functionality (P1.M2) by validating tree integrity after detach/attach operations
|
|
44
|
+
- **Problems this solves**:
|
|
45
|
+
- Catches bugs where attachChild() or detachChild() only update one tree
|
|
46
|
+
- Detects manual tree mutations that bypass validation
|
|
47
|
+
- Validates the core architectural constraint that enables observer propagation
|
|
48
|
+
- Provides regression protection for future tree operation changes
|
|
49
|
+
|
|
50
|
+
## What
|
|
51
|
+
|
|
52
|
+
Create a comprehensive test suite that validates bidirectional consistency between the Workflow instance tree and the WorkflowNode tree:
|
|
53
|
+
|
|
54
|
+
1. **Helper Functions Library**: Reusable functions for tree validation
|
|
55
|
+
- `verifyBidirectionalLink(parent, child)` - Verifies parent-child links in BOTH trees
|
|
56
|
+
- `verifyTreeMirror(root)` - Validates complete 1:1 correspondence
|
|
57
|
+
- `validateTreeConsistency(root)` - Returns array of inconsistency descriptions
|
|
58
|
+
- `verifyOrphaned(child)` - Confirms complete detachment
|
|
59
|
+
- `verifyNoCycles(root)` - Detects circular references
|
|
60
|
+
- `collectAllNodes(root)` - BFS traversal with cycle detection
|
|
61
|
+
- `getDepth(node)` - Calculates node depth
|
|
62
|
+
|
|
63
|
+
2. **Test Coverage**:
|
|
64
|
+
- attachChild() consistency (single child, multiple children)
|
|
65
|
+
- detachChild() consistency (single child, middle child, last child)
|
|
66
|
+
- Reparenting consistency (single reparent, multiple cycles, deep hierarchy)
|
|
67
|
+
- Adversarial scenarios (manual mutation detection, stress tests)
|
|
68
|
+
- Invariant validation (acyclicity, tree mirror, single root, connectedness)
|
|
69
|
+
|
|
70
|
+
### Success Criteria
|
|
71
|
+
|
|
72
|
+
- [ ] Helper functions file created at `src/__tests__/helpers/tree-verification.ts`
|
|
73
|
+
- [ ] Test file created at `src/__tests__/integration/bidirectional-consistency.test.ts`
|
|
74
|
+
- [ ] Tests verify BOTH workflow tree AND node tree after every operation
|
|
75
|
+
- [ ] Tests verify parent→child AND child→parent directions
|
|
76
|
+
- [ ] Tests cover attachChild(), detachChild(), and reparenting
|
|
77
|
+
- [ ] Tests include adversarial scenarios (manual mutation, deep hierarchies)
|
|
78
|
+
- [ ] All tests pass with `npm test`
|
|
79
|
+
- [ ] No regression in existing test suite
|
|
80
|
+
|
|
81
|
+
## All Needed Context
|
|
82
|
+
|
|
83
|
+
### Context Completeness Check
|
|
84
|
+
|
|
85
|
+
_This PRP provides everything needed for one-pass implementation:_
|
|
86
|
+
|
|
87
|
+
- Complete dual tree architecture understanding from system_context.md
|
|
88
|
+
- Exact file locations and naming conventions
|
|
89
|
+
- Existing test patterns to follow (with specific line references)
|
|
90
|
+
- External best practices documentation (with URLs)
|
|
91
|
+
- Ready-to-copy helper function implementations
|
|
92
|
+
- Complete test pattern templates
|
|
93
|
+
- Critical gotchas and anti-patterns to avoid
|
|
94
|
+
|
|
95
|
+
### Documentation & References
|
|
96
|
+
|
|
97
|
+
```yaml
|
|
98
|
+
# CRITICAL: PRD Requirement for 1:1 Tree Mirror
|
|
99
|
+
- docfile: plan/docs/bugfix-architecture/system_context.md
|
|
100
|
+
why: Defines the 1:1 tree mirror invariant from PRD Section 12.2
|
|
101
|
+
section: Lines 26-28 (Critical Invariant) and Lines 185-193 (PRD Requirements)
|
|
102
|
+
critical: "Both trees must maintain perfect 1:1 mirroring as specified in PRD Section 12.2"
|
|
103
|
+
|
|
104
|
+
# CRITICAL: Implementation Patterns for Tree Integrity
|
|
105
|
+
- docfile: plan/docs/bugfix-architecture/implementation_patterns.md
|
|
106
|
+
why: Pattern 3 (Bidirectional Tree Synchronization) and Pattern 7 (Tree Integrity Test Suite)
|
|
107
|
+
section: Lines 105-136 (Pattern 3) and Lines 270-400 (Pattern 7)
|
|
108
|
+
critical: Shows exactly how attachChild() and detachChild() must update both trees
|
|
109
|
+
|
|
110
|
+
# MUST READ: Workflow Class Dual Tree Structure
|
|
111
|
+
- file: src/core/workflow.ts
|
|
112
|
+
why: Understanding how Workflow class maintains both workflow tree and node tree
|
|
113
|
+
pattern: Lines 48-52 (parent/children properties) and Lines 98-108 (node initialization)
|
|
114
|
+
gotcha: Both trees MUST be updated atomically - see attachChild() lines 216-255 and detachChild() lines 279-308
|
|
115
|
+
critical: "child.node.parent = this.node;" (line 243) and "child.node.parent = null;" (line 300) show node tree updates
|
|
116
|
+
|
|
117
|
+
# MUST READ: WorkflowNode Interface Definition
|
|
118
|
+
- file: src/types/workflow.ts
|
|
119
|
+
why: Understanding the WorkflowNode structure that mirrors Workflow class
|
|
120
|
+
pattern: Lines 20-37 define WorkflowNode interface with parent and children properties
|
|
121
|
+
critical: WorkflowNode.parent is WorkflowNode | null (line 26)
|
|
122
|
+
critical: WorkflowNode.children is WorkflowNode[] (line 28)
|
|
123
|
+
|
|
124
|
+
# MUST READ: Existing Bidirectional Consistency Pattern
|
|
125
|
+
- file: src/__tests__/integration/workflow-reparenting.test.ts
|
|
126
|
+
why: Lines 280-302 show the exact 1:1 Tree Mirror Invariant validation pattern to follow
|
|
127
|
+
pattern: CRITICAL VALIDATION section shows explicit verification of both trees
|
|
128
|
+
pattern: "Workflow tree state" vs "Node tree state" assertions (lines 285-297)
|
|
129
|
+
critical: This is the GOLD STANDARD pattern for bidirectional consistency testing
|
|
130
|
+
|
|
131
|
+
# MUST READ: Existing Test Patterns for Reference
|
|
132
|
+
- file: src/__tests__/adversarial/deep-hierarchy-stress.test.ts
|
|
133
|
+
why: Pattern for creating deep hierarchies and testing tree operations
|
|
134
|
+
pattern: Lines 57-79 show loop-based hierarchy creation
|
|
135
|
+
pattern: Lines 92-109 show protected method access with (current as any).getRoot()
|
|
136
|
+
|
|
137
|
+
- file: src/__tests__/adversarial/parent-validation.test.ts
|
|
138
|
+
why: Console mocking pattern and test structure
|
|
139
|
+
pattern: Lines 33-37 (beforeEach console mocking)
|
|
140
|
+
pattern: Lines 43-45 (afterEach vi.restoreAllMocks())
|
|
141
|
+
|
|
142
|
+
- file: src/__tests__/adversarial/complex-circular-reference.test.ts
|
|
143
|
+
why: Multi-level hierarchy test pattern
|
|
144
|
+
pattern: Lines 119-138 show deep hierarchy creation with multiple levels
|
|
145
|
+
|
|
146
|
+
# MUST READ: WorkflowTreeDebugger for Tree Inspection
|
|
147
|
+
- file: src/debugger/tree-debugger.ts
|
|
148
|
+
why: Provides tree traversal and node lookup capabilities
|
|
149
|
+
pattern: Lines 52-58 show buildNodeMap() recursive pattern for BFS traversal
|
|
150
|
+
pattern: Lines 98-100 show getNode() lookup via Map
|
|
151
|
+
gotcha: debugger rebuilds nodeMap on onTreeChanged() - useful for validation
|
|
152
|
+
|
|
153
|
+
# RESEARCH: External Best Practices (with URLs)
|
|
154
|
+
- url: https://dom.spec.whatwg.org/#concept-tree-parent
|
|
155
|
+
why: DOM Tree API is the authoritative reference for tree mutation semantics
|
|
156
|
+
section: Concept of "tree" and parent-child relationships
|
|
157
|
+
critical: Validates our approach to bidirectional consistency
|
|
158
|
+
|
|
159
|
+
- url: https://github.com/facebook/react/blob/main/packages/react-reconciler/src/ReactFiber.js
|
|
160
|
+
why: React Fiber architecture maintains dual trees (current + workInProgress)
|
|
161
|
+
section: Fiber node structure with return, child, sibling properties
|
|
162
|
+
critical: Shows production dual-tree pattern similar to our Workflow/WorkflowNode
|
|
163
|
+
|
|
164
|
+
- url: https://vitest.dev/guide/
|
|
165
|
+
why: Official Vitest documentation for test syntax and assertions
|
|
166
|
+
section: Test API reference for expect() and describe() patterns
|
|
167
|
+
|
|
168
|
+
# RESEARCH DOCUMENTS (Created during research phase)
|
|
169
|
+
- docfile: plan/bugfix/P1M3T1S4/research/QUICK_REFERENCE.md
|
|
170
|
+
why: Quick reference for helper functions and test templates
|
|
171
|
+
section: Essential Helper Functions (lines 21-54) and Test Template (lines 58-86)
|
|
172
|
+
|
|
173
|
+
- docfile: plan/bugfix/P1M3T1S4/research/test-pattern-examples.md
|
|
174
|
+
why: Complete ready-to-copy implementations of all helper functions
|
|
175
|
+
section: Lines 10-211 contain complete helper function implementations
|
|
176
|
+
critical: All 7 helper functions are fully implemented and ready to copy
|
|
177
|
+
|
|
178
|
+
- docfile: plan/bugfix/P1M3T1S4/research/bidirectional-tree-consistency-testing.md
|
|
179
|
+
why: Comprehensive testing methodology and external best practices
|
|
180
|
+
section: Core Testing Patterns and Test Pattern Catalog
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Current Codebase Tree (relevant sections)
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
src/
|
|
187
|
+
├── __tests__/
|
|
188
|
+
│ ├── helpers/ # NEW DIRECTORY TO CREATE
|
|
189
|
+
│ │ └── tree-verification.ts # NEW: Helper functions for tree validation
|
|
190
|
+
│ ├── integration/
|
|
191
|
+
│ │ ├── workflow-reparenting.test.ts # Lines 280-302: 1:1 Tree Mirror pattern
|
|
192
|
+
│ │ ├── tree-mirroring.test.ts # Tree mirror validation
|
|
193
|
+
│ │ └── bidirectional-consistency.test.ts # NEW: Main test file
|
|
194
|
+
│ ├── adversarial/
|
|
195
|
+
│ │ ├── deep-hierarchy-stress.test.ts # Pattern for deep hierarchies
|
|
196
|
+
│ │ ├── parent-validation.test.ts # Console mocking pattern
|
|
197
|
+
│ │ └── complex-circular-reference.test.ts
|
|
198
|
+
│ └── unit/
|
|
199
|
+
├── core/
|
|
200
|
+
│ ├── workflow.ts # Lines 48-52: parent/children, Lines 98-108: node
|
|
201
|
+
│ └── ...
|
|
202
|
+
├── types/
|
|
203
|
+
│ ├── workflow.ts # Lines 20-37: WorkflowNode interface
|
|
204
|
+
│ └── ...
|
|
205
|
+
└── debugger/
|
|
206
|
+
└── tree-debugger.ts # Lines 52-58: BFS traversal pattern
|
|
207
|
+
|
|
208
|
+
plan/bugfix/P1M3T1S4/
|
|
209
|
+
├── PRP.md # This file
|
|
210
|
+
└── research/
|
|
211
|
+
├── QUICK_REFERENCE.md # Helper function quick reference
|
|
212
|
+
├── test-pattern-examples.md # Complete implementation examples
|
|
213
|
+
├── bidirectional-tree-consistency-testing.md # Full methodology
|
|
214
|
+
└── SUMMARY.md # Research summary
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### Desired Codebase Tree with Files to be Added
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
src/
|
|
221
|
+
├── __tests__/
|
|
222
|
+
│ ├── helpers/ # NEW DIRECTORY
|
|
223
|
+
│ │ ├── index.ts # NEW: Barrel export for helpers
|
|
224
|
+
│ │ └── tree-verification.ts # NEW: 7 helper functions for tree validation
|
|
225
|
+
│ └── integration/
|
|
226
|
+
│ └── bidirectional-consistency.test.ts # NEW: Comprehensive test suite
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Known Gotchas of our codebase & Library Quirks
|
|
230
|
+
|
|
231
|
+
```typescript
|
|
232
|
+
// CRITICAL: The Dual Tree Structure
|
|
233
|
+
// Workflow class maintains TWO trees that must be kept in sync:
|
|
234
|
+
// 1. Workflow instance tree: parent (Workflow), children (Workflow[])
|
|
235
|
+
// 2. Node tree: node.parent (WorkflowNode), node.children (WorkflowNode[])
|
|
236
|
+
// BOTH must be updated on every attachChild() and detachChild() operation
|
|
237
|
+
|
|
238
|
+
// CRITICAL: 1:1 Tree Mirror Invariant (from PRD Section 12.2)
|
|
239
|
+
// For every relationship in the workflow tree, there MUST be an equivalent relationship in the node tree:
|
|
240
|
+
// If child.parent === parent, then child.node.parent MUST equal parent.node
|
|
241
|
+
// If parent.children includes child, then parent.node.children MUST include child.node
|
|
242
|
+
|
|
243
|
+
// CRITICAL: Accessing protected/private methods in tests
|
|
244
|
+
// getRoot() is protected - cast to 'any' for testing
|
|
245
|
+
const root = (child as any).getRoot();
|
|
246
|
+
|
|
247
|
+
// CRITICAL: Workflow constructor auto-attaches when parent is provided
|
|
248
|
+
// Pattern from workflow.ts:113-116
|
|
249
|
+
const child = new Workflow('Child', parent);
|
|
250
|
+
// This automatically calls parent.attachChild(this) - no need to call attachChild() separately
|
|
251
|
+
|
|
252
|
+
// CRITICAL: Console methods must be mocked in adversarial tests
|
|
253
|
+
// Pattern from src/__tests__/adversarial/parent-validation.test.ts:33-37
|
|
254
|
+
beforeEach(() => {
|
|
255
|
+
vi.spyOn(console, 'log').mockImplementation(() => {});
|
|
256
|
+
vi.spyOn(console, 'error').mockImplementation(() => {});
|
|
257
|
+
vi.spyOn(console, 'warn').mockImplementation(() => {});
|
|
258
|
+
});
|
|
259
|
+
|
|
260
|
+
// CRITICAL: Always restore mocks in afterEach
|
|
261
|
+
afterEach(() => {
|
|
262
|
+
vi.restoreAllMocks();
|
|
263
|
+
});
|
|
264
|
+
|
|
265
|
+
// CRITICAL: Test file naming and placement
|
|
266
|
+
// - Integration tests go in src/__tests__/integration/
|
|
267
|
+
// - Helper functions go in src/__tests__/helpers/
|
|
268
|
+
// - Test file names end with .test.ts
|
|
269
|
+
// - Test names use "should" pattern: "should maintain consistency after attach"
|
|
270
|
+
|
|
271
|
+
// CRITICAL: Import patterns for tests
|
|
272
|
+
// Use .js extension for all imports (this is a TypeScript project with ES modules)
|
|
273
|
+
import { Workflow } from '../../index.js';
|
|
274
|
+
import { verifyBidirectionalLink } from '../helpers/tree-verification.js';
|
|
275
|
+
|
|
276
|
+
// CRITICAL: Helper functions throw errors, don't return booleans
|
|
277
|
+
// verifyBidirectionalLink() throws if inconsistency found
|
|
278
|
+
// validateTreeConsistency() returns string[] (empty if valid)
|
|
279
|
+
|
|
280
|
+
// CRITICAL: Cycle detection in BFS traversal
|
|
281
|
+
// When collecting all nodes, must detect cycles to prevent infinite loops
|
|
282
|
+
// Use Set<Workflow> to track visited nodes
|
|
283
|
+
|
|
284
|
+
// CRITICAL: Reference equality for WorkflowNode comparison
|
|
285
|
+
// WorkflowNode is an interface - use reference equality (===) not deep equality
|
|
286
|
+
expect(parent.node.children[0]).toBe(child.node); // Correct - same reference
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
## Implementation Blueprint
|
|
290
|
+
|
|
291
|
+
### Data models and structure
|
|
292
|
+
|
|
293
|
+
No new data models needed - using existing Workflow class, WorkflowNode interface, and testing infrastructure.
|
|
294
|
+
|
|
295
|
+
### Implementation Tasks (ordered by dependencies)
|
|
296
|
+
|
|
297
|
+
```yaml
|
|
298
|
+
Task 1: CREATE src/__tests__/helpers/ directory
|
|
299
|
+
- IMPLEMENT: New helpers directory for test utilities
|
|
300
|
+
- CREATE: index.ts barrel export file
|
|
301
|
+
- NAMING: All helper files use kebab-case naming
|
|
302
|
+
- PLACEMENT: src/__tests__/helpers/
|
|
303
|
+
|
|
304
|
+
Task 2: CREATE src/__tests__/helpers/tree-verification.ts
|
|
305
|
+
- IMPLEMENT: collectAllNodes(root: Workflow): Workflow[] function
|
|
306
|
+
- IMPLEMENT: validateTreeConsistency(root: Workflow): string[] function
|
|
307
|
+
- IMPLEMENT: verifyBidirectionalLink(parent: Workflow, child: Workflow): void function
|
|
308
|
+
- IMPLEMENT: verifyOrphaned(child: Workflow): void function
|
|
309
|
+
- IMPLEMENT: verifyNoCycles(root: Workflow): void function
|
|
310
|
+
- IMPLEMENT: verifyTreeMirror(workflowRoot: Workflow): void function
|
|
311
|
+
- IMPLEMENT: getDepth(node: Workflow): number function
|
|
312
|
+
- COPY implementation from: plan/bugfix/P1M3T1S4/research/test-pattern-examples.md (lines 10-211)
|
|
313
|
+
- EXPORT: All functions with named exports
|
|
314
|
+
- PLACEMENT: src/__tests__/helpers/tree-verification.ts
|
|
315
|
+
|
|
316
|
+
Task 3: CREATE src/__tests__/helpers/index.ts
|
|
317
|
+
- IMPLEMENT: Barrel export for all helper functions
|
|
318
|
+
- EXPORT * from './tree-verification.js'
|
|
319
|
+
- PLACEMENT: src/__tests__/helpers/index.ts
|
|
320
|
+
|
|
321
|
+
Task 4: CREATE src/__tests__/integration/bidirectional-consistency.test.ts
|
|
322
|
+
- IMPLEMENT: describe block "Bidirectional Consistency: Basic Operations"
|
|
323
|
+
- IMPLEMENT: describe block "Bidirectional Consistency: Reparenting"
|
|
324
|
+
- IMPLEMENT: describe block "Bidirectional Consistency: Invariants"
|
|
325
|
+
- IMPLEMENT: describe block "Bidirectional Consistency: Adversarial Tests"
|
|
326
|
+
- FOLLOW pattern: src/__tests__/integration/workflow-reparenting.test.ts (lines 280-302)
|
|
327
|
+
- COPY test templates from: plan/bugfix/P1M3T1S4/research/test-pattern-examples.md (lines 215-845)
|
|
328
|
+
- IMPORT: Workflow from '../../index.js'
|
|
329
|
+
- IMPORT: Helper functions from '../helpers/tree-verification.js'
|
|
330
|
+
- PLACEMENT: src/__tests__/integration/bidirectional-consistency.test.ts
|
|
331
|
+
|
|
332
|
+
Task 5: IMPLEMENT attachChild() Consistency Tests
|
|
333
|
+
- IMPLEMENT: Test "should maintain bidirectional links in both trees"
|
|
334
|
+
- IMPLEMENT: Test "should maintain consistency when attaching multiple children"
|
|
335
|
+
- VERIFY: child.parent === parent AND child.node.parent === parent.node
|
|
336
|
+
- VERIFY: parent.children contains child AND parent.node.children contains child.node
|
|
337
|
+
- USE: verifyBidirectionalLink(parent, child) after attachChild()
|
|
338
|
+
- USE: verifyTreeMirror(parent) to validate entire tree
|
|
339
|
+
- USE: validateTreeConsistency(parent) to check for hidden issues
|
|
340
|
+
|
|
341
|
+
Task 6: IMPLEMENT detachChild() Consistency Tests
|
|
342
|
+
- IMPLEMENT: Test "should remove bidirectional links from both trees"
|
|
343
|
+
- IMPLEMENT: Test "should maintain consistency when detaching middle child"
|
|
344
|
+
- VERIFY: child.parent === null AND child.node.parent === null
|
|
345
|
+
- VERIFY: parent.children does NOT contain child
|
|
346
|
+
- VERIFY: parent.node.children does NOT contain child.node
|
|
347
|
+
- USE: verifyOrphaned(child) after detachChild()
|
|
348
|
+
|
|
349
|
+
Task 7: IMPLEMENT Reparenting Consistency Tests
|
|
350
|
+
- IMPLEMENT: Test "should maintain consistency during single reparenting"
|
|
351
|
+
- IMPLEMENT: Test "should maintain consistency during multiple reparenting cycles"
|
|
352
|
+
- IMPLEMENT: Test "should maintain consistency with deep hierarchy reparenting"
|
|
353
|
+
- VERIFY: Old parent no longer references child in BOTH trees
|
|
354
|
+
- VERIFY: New parent correctly references child in BOTH trees
|
|
355
|
+
- VERIFY: Both trees (old parent and new parent) maintain mirror invariant
|
|
356
|
+
- FOLLOW pattern: src/__tests__/integration/workflow-reparenting.test.ts (lines 129-186)
|
|
357
|
+
|
|
358
|
+
Task 8: IMPLEMENT Invariant Tests
|
|
359
|
+
- IMPLEMENT: Test for acyclicity invariant (no circular references)
|
|
360
|
+
- IMPLEMENT: Test for tree mirror invariant (1:1 correspondence)
|
|
361
|
+
- IMPLEMENT: Test for single root invariant
|
|
362
|
+
- IMPLEMENT: Test for connectedness invariant (all nodes reachable from root)
|
|
363
|
+
- USE: verifyNoCycles(root) for acyclicity
|
|
364
|
+
- USE: verifyTreeMirror(root) for mirror invariant
|
|
365
|
+
|
|
366
|
+
Task 9: IMPLEMENT Adversarial Tests
|
|
367
|
+
- IMPLEMENT: Test "should detect inconsistency from manual parent mutation"
|
|
368
|
+
- IMPLEMENT: Test "should maintain consistency with deep hierarchies"
|
|
369
|
+
- IMPLEMENT: Test "should maintain consistency with wide hierarchies"
|
|
370
|
+
- IMPLEMENT: Test "should maintain consistency during rapid attach/detach cycles"
|
|
371
|
+
- VERIFY: validateTreeConsistency() detects manual mutations
|
|
372
|
+
- CREATE: Deep hierarchy (100+ levels) for stress testing
|
|
373
|
+
- CREATE: Wide hierarchy (100+ children) for stress testing
|
|
374
|
+
|
|
375
|
+
Task 10: VALIDATE Full Test Suite
|
|
376
|
+
- RUN: npm test or vitest run
|
|
377
|
+
- VERIFY: New bidirectional-consistency.test.ts tests pass
|
|
378
|
+
- VERIFY: All existing tests still pass (no regression)
|
|
379
|
+
- CHECK: Test count increases appropriately
|
|
380
|
+
- VALIDATE: No TypeScript errors with npx tsc --noEmit
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### Implementation Patterns & Key Details
|
|
384
|
+
|
|
385
|
+
```typescript
|
|
386
|
+
// ============================================================================
|
|
387
|
+
// HELPER FUNCTIONS IMPLEMENTATION
|
|
388
|
+
// File: src/__tests__/helpers/tree-verification.ts
|
|
389
|
+
// ============================================================================
|
|
390
|
+
|
|
391
|
+
import type { Workflow } from '../../index.js';
|
|
392
|
+
|
|
393
|
+
/**
|
|
394
|
+
* Collect all nodes in tree via BFS
|
|
395
|
+
* Throws if circular reference detected
|
|
396
|
+
* Pattern from: tree-debugger.ts:52-58 (buildNodeMap)
|
|
397
|
+
*/
|
|
398
|
+
export function collectAllNodes(root: Workflow): Workflow[] {
|
|
399
|
+
const nodes: Workflow[] = [];
|
|
400
|
+
const queue: Workflow[] = [root];
|
|
401
|
+
const visited = new Set<Workflow>();
|
|
402
|
+
|
|
403
|
+
while (queue.length > 0) {
|
|
404
|
+
const node = queue.shift()!;
|
|
405
|
+
|
|
406
|
+
// CRITICAL: Cycle detection
|
|
407
|
+
if (visited.has(node)) {
|
|
408
|
+
throw new Error(`Circular reference detected at ${node.node.name}`);
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
visited.add(node);
|
|
412
|
+
nodes.push(node);
|
|
413
|
+
queue.push(...node.children);
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
return nodes;
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* Validate tree-wide bidirectional consistency
|
|
421
|
+
* Returns array of inconsistency descriptions (empty if valid)
|
|
422
|
+
*
|
|
423
|
+
* This is the comprehensive validation that checks:
|
|
424
|
+
* 1. Parent → child links in workflow tree
|
|
425
|
+
* 2. Child → parent links in workflow tree
|
|
426
|
+
* 3. Node tree mirrors workflow tree (parent relationship)
|
|
427
|
+
* 4. Node tree mirrors workflow tree (children relationship)
|
|
428
|
+
*/
|
|
429
|
+
export function validateTreeConsistency(root: Workflow): string[] {
|
|
430
|
+
const errors: string[] = [];
|
|
431
|
+
const allNodes = collectAllNodes(root);
|
|
432
|
+
|
|
433
|
+
allNodes.forEach(node => {
|
|
434
|
+
// Check parent→child link in workflow tree
|
|
435
|
+
if (node.parent) {
|
|
436
|
+
if (!node.parent.children.includes(node)) {
|
|
437
|
+
errors.push(
|
|
438
|
+
`[WORKFLOW TREE] Orphaned child: "${node.node.name}" not in parent "${node.parent.node.name}"'s children list`
|
|
439
|
+
);
|
|
440
|
+
}
|
|
441
|
+
} else {
|
|
442
|
+
// Root node - should not be in anyone's children
|
|
443
|
+
const parentClaimants = allNodes.filter(n => n.children.includes(node));
|
|
444
|
+
if (parentClaimants.length > 0) {
|
|
445
|
+
errors.push(
|
|
446
|
+
`[WORKFLOW TREE] Root node "${node.node.name}" claimed as child by [${parentClaimants.map(n => n.node.name).join(', ')}]`
|
|
447
|
+
);
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
// Check child→parent links
|
|
452
|
+
node.children.forEach(child => {
|
|
453
|
+
// Workflow tree check
|
|
454
|
+
if (child.parent !== node) {
|
|
455
|
+
errors.push(
|
|
456
|
+
`[WORKFLOW TREE] Mismatched parent: "${child.node.name}".parent is "${child.parent?.node.name ?? 'null'}", expected "${node.node.name}"`
|
|
457
|
+
);
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
// CRITICAL: Check node tree mirrors workflow tree - parent relationship
|
|
461
|
+
if (child.node.parent !== node.node) {
|
|
462
|
+
errors.push(
|
|
463
|
+
`[NODE TREE] Mismatched parent: "${child.node.name}".node.parent is "${child.node.parent?.name ?? 'null'}", expected "${node.node.name}"`
|
|
464
|
+
);
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
// CRITICAL: Check node tree mirrors workflow tree - children relationship
|
|
468
|
+
if (!node.node.children.includes(child.node)) {
|
|
469
|
+
errors.push(
|
|
470
|
+
`[NODE TREE] Orphaned child: "${child.node.name}".node not in parent "${node.node.name}"'s node.children array`
|
|
471
|
+
);
|
|
472
|
+
}
|
|
473
|
+
});
|
|
474
|
+
});
|
|
475
|
+
|
|
476
|
+
return errors;
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
/**
|
|
480
|
+
* Verify bidirectional link between parent and child in BOTH trees
|
|
481
|
+
* Throws if inconsistency found
|
|
482
|
+
*
|
|
483
|
+
* This is the primary assertion helper for testing attachChild() operations
|
|
484
|
+
* Usage: parent.attachChild(child); verifyBidirectionalLink(parent, child);
|
|
485
|
+
*/
|
|
486
|
+
export function verifyBidirectionalLink(parent: Workflow, child: Workflow): void {
|
|
487
|
+
// Workflow tree checks
|
|
488
|
+
if (child.parent !== parent) {
|
|
489
|
+
throw new Error(
|
|
490
|
+
`[WORKFLOW TREE] Bidirectional link broken: "${child.node.name}".parent is "${child.parent?.node.name ?? 'null'}", expected "${parent.node.name}"`
|
|
491
|
+
);
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
if (!parent.children.includes(child)) {
|
|
495
|
+
throw new Error(
|
|
496
|
+
`[WORKFLOW TREE] Bidirectional link broken: "${parent.node.name}".children does not contain "${child.node.name}"`
|
|
497
|
+
);
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
// CRITICAL: Node tree checks (must mirror workflow tree)
|
|
501
|
+
if (child.node.parent !== parent.node) {
|
|
502
|
+
throw new Error(
|
|
503
|
+
`[NODE TREE] Bidirectional link broken: "${child.node.name}".node.parent is "${child.node.parent?.name ?? 'null'}", expected "${parent.node.name}"`
|
|
504
|
+
);
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
if (!parent.node.children.includes(child.node)) {
|
|
508
|
+
throw new Error(
|
|
509
|
+
`[NODE TREE] Bidirectional link broken: "${parent.node.name}".node.children does not contain "${child.node.name}"`
|
|
510
|
+
);
|
|
511
|
+
}
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
/**
|
|
515
|
+
* Verify complete orphaning after detach
|
|
516
|
+
* Usage: parent.detachChild(child); verifyOrphaned(child);
|
|
517
|
+
*/
|
|
518
|
+
export function verifyOrphaned(child: Workflow): void {
|
|
519
|
+
if (child.parent !== null) {
|
|
520
|
+
throw new Error(
|
|
521
|
+
`Child "${child.node.name}" not orphaned: parent is "${child.parent.node.name}"`
|
|
522
|
+
);
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
if (child.node.parent !== null) {
|
|
526
|
+
throw new Error(
|
|
527
|
+
`Child "${child.node.name}" not orphaned in node tree: parent is "${child.node.parent.name}"`
|
|
528
|
+
);
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* Verify no circular references exist
|
|
534
|
+
* Usage: verifyNoCycles(root);
|
|
535
|
+
*/
|
|
536
|
+
export function verifyNoCycles(root: Workflow): void {
|
|
537
|
+
const visited = new Set<Workflow>();
|
|
538
|
+
const allNodes = collectAllNodes(root);
|
|
539
|
+
|
|
540
|
+
allNodes.forEach(node => {
|
|
541
|
+
if (visited.has(node)) {
|
|
542
|
+
throw new Error(`Circular reference detected: node "${node.node.name}" visited twice`);
|
|
543
|
+
}
|
|
544
|
+
visited.add(node);
|
|
545
|
+
});
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
/**
|
|
549
|
+
* Verify tree mirror invariant (1:1 correspondence)
|
|
550
|
+
* This is the CRITICAL invariant from PRD Section 12.2
|
|
551
|
+
* Usage: verifyTreeMirror(root);
|
|
552
|
+
*/
|
|
553
|
+
export function verifyTreeMirror(workflowRoot: Workflow): void {
|
|
554
|
+
const allNodes = collectAllNodes(workflowRoot);
|
|
555
|
+
|
|
556
|
+
allNodes.forEach(wfNode => {
|
|
557
|
+
const node = wfNode.node;
|
|
558
|
+
|
|
559
|
+
// Verify parent relationship mirrors
|
|
560
|
+
if (wfNode.parent) {
|
|
561
|
+
if (node.parent !== wfNode.parent.node) {
|
|
562
|
+
throw new Error(
|
|
563
|
+
`[MIRROR] Parent mismatch: "${wfNode.node.name}".parent is "${node.parent?.name}", expected "${wfNode.parent.node.name}"`
|
|
564
|
+
);
|
|
565
|
+
}
|
|
566
|
+
} else {
|
|
567
|
+
if (node.parent !== null) {
|
|
568
|
+
throw new Error(
|
|
569
|
+
`[MIRROR] Parent mismatch: "${wfNode.node.name}".parent is "${node.parent.name}", expected null`
|
|
570
|
+
);
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
// Verify children relationship mirrors
|
|
575
|
+
if (node.children.length !== wfNode.children.length) {
|
|
576
|
+
throw new Error(
|
|
577
|
+
`[MIRROR] Children count mismatch: "${wfNode.node.name}" has ${wfNode.children.length} workflow children but ${node.children.length} node children`
|
|
578
|
+
);
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
wfNode.children.forEach((childWf, index) => {
|
|
582
|
+
if (node.children[index] !== childWf.node) {
|
|
583
|
+
throw new Error(
|
|
584
|
+
`[MIRROR] Child mismatch at index ${index}: expected "${childWf.node.name}", got "${node.children[index].name}"`
|
|
585
|
+
);
|
|
586
|
+
}
|
|
587
|
+
});
|
|
588
|
+
});
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* Get depth of node in tree
|
|
593
|
+
*/
|
|
594
|
+
export function getDepth(node: Workflow): number {
|
|
595
|
+
let depth = 0;
|
|
596
|
+
let current: Workflow | null = node;
|
|
597
|
+
|
|
598
|
+
while (current !== null) {
|
|
599
|
+
depth++;
|
|
600
|
+
current = current.parent;
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
return depth - 1; // Subtract 1 for the node itself
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
// ============================================================================
|
|
607
|
+
// TEST IMPLEMENTATION PATTERN
|
|
608
|
+
// File: src/__tests__/integration/bidirectional-consistency.test.ts
|
|
609
|
+
// ============================================================================
|
|
610
|
+
|
|
611
|
+
import { describe, it, expect } from 'vitest';
|
|
612
|
+
import { Workflow } from '../../index.js';
|
|
613
|
+
import {
|
|
614
|
+
verifyBidirectionalLink,
|
|
615
|
+
verifyTreeMirror,
|
|
616
|
+
validateTreeConsistency,
|
|
617
|
+
} from '../helpers/tree-verification.js';
|
|
618
|
+
|
|
619
|
+
/**
|
|
620
|
+
* SimpleWorkflow class for testing
|
|
621
|
+
* Pattern from: src/__tests__/adversarial/circular-reference.test.ts:20-26
|
|
622
|
+
*/
|
|
623
|
+
class SimpleWorkflow extends Workflow {
|
|
624
|
+
async run(): Promise<string> {
|
|
625
|
+
this.setStatus('running');
|
|
626
|
+
this.setStatus('completed');
|
|
627
|
+
return 'done';
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
|
|
631
|
+
describe('Bidirectional Consistency: Basic Operations', () => {
|
|
632
|
+
describe('attachChild() consistency', () => {
|
|
633
|
+
it('should maintain bidirectional links in both trees', () => {
|
|
634
|
+
// ARRANGE
|
|
635
|
+
const parent = new SimpleWorkflow('Parent');
|
|
636
|
+
const child = new SimpleWorkflow('Child'); // No parent
|
|
637
|
+
|
|
638
|
+
// ACT
|
|
639
|
+
parent.attachChild(child);
|
|
640
|
+
|
|
641
|
+
// ASSERT - Verify bidirectional links
|
|
642
|
+
verifyBidirectionalLink(parent, child);
|
|
643
|
+
|
|
644
|
+
// ASSERT - Verify tree mirror invariant
|
|
645
|
+
verifyTreeMirror(parent);
|
|
646
|
+
|
|
647
|
+
// ASSERT - Verify no inconsistencies detected
|
|
648
|
+
const errors = validateTreeConsistency(parent);
|
|
649
|
+
expect(errors).toEqual([]);
|
|
650
|
+
});
|
|
651
|
+
|
|
652
|
+
it('should maintain consistency when attaching multiple children', () => {
|
|
653
|
+
// ARRANGE
|
|
654
|
+
const parent = new SimpleWorkflow('Parent');
|
|
655
|
+
const child1 = new SimpleWorkflow('Child1');
|
|
656
|
+
const child2 = new SimpleWorkflow('Child2');
|
|
657
|
+
const child3 = new SimpleWorkflow('Child3');
|
|
658
|
+
|
|
659
|
+
// ACT
|
|
660
|
+
parent.attachChild(child1);
|
|
661
|
+
parent.attachChild(child2);
|
|
662
|
+
parent.attachChild(child3);
|
|
663
|
+
|
|
664
|
+
// ASSERT - Verify each child
|
|
665
|
+
verifyBidirectionalLink(parent, child1);
|
|
666
|
+
verifyBidirectionalLink(parent, child2);
|
|
667
|
+
verifyBidirectionalLink(parent, child3);
|
|
668
|
+
|
|
669
|
+
// ASSERT - Verify entire tree
|
|
670
|
+
verifyTreeMirror(parent);
|
|
671
|
+
|
|
672
|
+
const errors = validateTreeConsistency(parent);
|
|
673
|
+
expect(errors).toEqual([]);
|
|
674
|
+
});
|
|
675
|
+
});
|
|
676
|
+
|
|
677
|
+
describe('detachChild() consistency', () => {
|
|
678
|
+
it('should remove bidirectional links from both trees', () => {
|
|
679
|
+
// ARRANGE
|
|
680
|
+
const parent = new SimpleWorkflow('Parent');
|
|
681
|
+
const child = new SimpleWorkflow('Child', parent);
|
|
682
|
+
|
|
683
|
+
// ACT
|
|
684
|
+
parent.detachChild(child);
|
|
685
|
+
|
|
686
|
+
// ASSERT - Verify orphaning in BOTH trees
|
|
687
|
+
expect(child.parent).toBeNull();
|
|
688
|
+
expect(child.node.parent).toBeNull();
|
|
689
|
+
expect(parent.children).not.toContain(child);
|
|
690
|
+
expect(parent.node.children).not.toContain(child.node);
|
|
691
|
+
|
|
692
|
+
// ASSERT - Verify tree mirror
|
|
693
|
+
verifyTreeMirror(parent);
|
|
694
|
+
|
|
695
|
+
const errors = validateTreeConsistency(parent);
|
|
696
|
+
expect(errors).toEqual([]);
|
|
697
|
+
});
|
|
698
|
+
});
|
|
699
|
+
});
|
|
700
|
+
|
|
701
|
+
describe('Bidirectional Consistency: Reparenting', () => {
|
|
702
|
+
it('should maintain consistency during single reparenting', () => {
|
|
703
|
+
// ARRANGE
|
|
704
|
+
const parent1 = new SimpleWorkflow('Parent1');
|
|
705
|
+
const parent2 = new SimpleWorkflow('Parent2');
|
|
706
|
+
const child = new SimpleWorkflow('Child', parent1);
|
|
707
|
+
|
|
708
|
+
// ASSERT - Verify initial state
|
|
709
|
+
verifyBidirectionalLink(parent1, child);
|
|
710
|
+
|
|
711
|
+
// ACT - Reparent
|
|
712
|
+
parent1.detachChild(child);
|
|
713
|
+
parent2.attachChild(child);
|
|
714
|
+
|
|
715
|
+
// ASSERT - Verify new state
|
|
716
|
+
verifyBidirectionalLink(parent2, child);
|
|
717
|
+
|
|
718
|
+
// ASSERT - Verify old parent no longer has child in BOTH trees
|
|
719
|
+
expect(parent1.children).not.toContain(child);
|
|
720
|
+
expect(parent1.node.children).not.toContain(child.node);
|
|
721
|
+
|
|
722
|
+
// ASSERT - Verify new parent has child in BOTH trees
|
|
723
|
+
expect(parent2.children).toContain(child);
|
|
724
|
+
expect(parent2.node.children).toContain(child.node);
|
|
725
|
+
|
|
726
|
+
// ASSERT - Verify both trees are valid
|
|
727
|
+
verifyTreeMirror(parent1);
|
|
728
|
+
verifyTreeMirror(parent2);
|
|
729
|
+
|
|
730
|
+
const errors1 = validateTreeConsistency(parent1);
|
|
731
|
+
const errors2 = validateTreeConsistency(parent2);
|
|
732
|
+
expect(errors1).toEqual([]);
|
|
733
|
+
expect(errors2).toEqual([]);
|
|
734
|
+
});
|
|
735
|
+
});
|
|
736
|
+
|
|
737
|
+
describe('Bidirectional Consistency: Invariants', () => {
|
|
738
|
+
describe('Tree mirror invariant', () => {
|
|
739
|
+
it('should maintain 1:1 correspondence after operations', () => {
|
|
740
|
+
// ARRANGE
|
|
741
|
+
const root = new SimpleWorkflow('Root');
|
|
742
|
+
const child1 = new SimpleWorkflow('Child1', root);
|
|
743
|
+
const child2 = new SimpleWorkflow('Child2', root);
|
|
744
|
+
|
|
745
|
+
// ASSERT - Verify mirror after creation
|
|
746
|
+
verifyTreeMirror(root);
|
|
747
|
+
|
|
748
|
+
// ACT - Detach and reattach
|
|
749
|
+
root.detachChild(child1);
|
|
750
|
+
verifyTreeMirror(root);
|
|
751
|
+
|
|
752
|
+
root.attachChild(child1);
|
|
753
|
+
verifyTreeMirror(root);
|
|
754
|
+
|
|
755
|
+
// ASSERT - Verify both trees have same structure
|
|
756
|
+
expect(root.children.length).toBe(root.node.children.length);
|
|
757
|
+
expect(root.children[0].node).toBe(root.node.children[0]);
|
|
758
|
+
expect(root.children[1].node).toBe(root.node.children[1]);
|
|
759
|
+
});
|
|
760
|
+
});
|
|
761
|
+
});
|
|
762
|
+
|
|
763
|
+
describe('Bidirectional Consistency: Adversarial Tests', () => {
|
|
764
|
+
describe('Manual mutation detection', () => {
|
|
765
|
+
it('should detect inconsistency from manual parent mutation', () => {
|
|
766
|
+
// ARRANGE
|
|
767
|
+
const parent1 = new SimpleWorkflow('Parent1');
|
|
768
|
+
const parent2 = new SimpleWorkflow('Parent2');
|
|
769
|
+
const child = new SimpleWorkflow('Child', parent1);
|
|
770
|
+
|
|
771
|
+
// ACT - Manually mutate parent (bypassing attachChild)
|
|
772
|
+
(child as any).parent = parent2;
|
|
773
|
+
|
|
774
|
+
// ASSERT - Should detect inconsistency
|
|
775
|
+
const errors = validateTreeConsistency(parent1);
|
|
776
|
+
expect(errors.length).toBeGreaterThan(0);
|
|
777
|
+
expect(errors.some(e => e.includes('Mismatched parent'))).toBe(true);
|
|
778
|
+
});
|
|
779
|
+
});
|
|
780
|
+
|
|
781
|
+
describe('Stress testing', () => {
|
|
782
|
+
it('should maintain consistency with deep hierarchies', () => {
|
|
783
|
+
// ARRANGE
|
|
784
|
+
const root = new SimpleWorkflow('Root');
|
|
785
|
+
let current = root;
|
|
786
|
+
|
|
787
|
+
// ACT - Create 100 levels deep
|
|
788
|
+
for (let i = 0; i < 100; i++) {
|
|
789
|
+
const child = new SimpleWorkflow(`Level-${i}`);
|
|
790
|
+
current.attachChild(child);
|
|
791
|
+
current = child;
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
// ASSERT - Verify consistency at each level
|
|
795
|
+
verifyTreeMirror(root);
|
|
796
|
+
verifyNoCycles(root);
|
|
797
|
+
|
|
798
|
+
const errors = validateTreeConsistency(root);
|
|
799
|
+
expect(errors).toEqual([]);
|
|
800
|
+
});
|
|
801
|
+
});
|
|
802
|
+
});
|
|
803
|
+
```
|
|
804
|
+
|
|
805
|
+
### Integration Points
|
|
806
|
+
|
|
807
|
+
```yaml
|
|
808
|
+
TEST_FRAMEWORK:
|
|
809
|
+
- command: "npm test" or "vitest run"
|
|
810
|
+
- pattern: All tests in src/__tests__/**/*.test.ts are auto-discovered
|
|
811
|
+
- config: vitest.config.ts with globals: true
|
|
812
|
+
|
|
813
|
+
EXISTING_TESTS:
|
|
814
|
+
- file: src/__tests__/integration/workflow-reparenting.test.ts
|
|
815
|
+
reference: Lines 280-302 (CRITICAL VALIDATION: 1:1 Tree Mirror Invariant)
|
|
816
|
+
note: This is the GOLD STANDARD pattern to follow
|
|
817
|
+
|
|
818
|
+
- file: src/__tests__/adversarial/deep-hierarchy-stress.test.ts
|
|
819
|
+
reference: Deep hierarchy creation pattern (lines 57-79)
|
|
820
|
+
note: Shows loop-based pattern for building deep trees
|
|
821
|
+
|
|
822
|
+
CODE_UNDER_TEST:
|
|
823
|
+
- file: src/core/workflow.ts
|
|
824
|
+
methods: attachChild() (lines 216-255), detachChild() (lines 279-308)
|
|
825
|
+
properties: parent (line 49), children (line 52), node (line 61)
|
|
826
|
+
gotcha: Both workflow tree AND node tree must be updated
|
|
827
|
+
|
|
828
|
+
TYPES:
|
|
829
|
+
- file: src/types/workflow.ts
|
|
830
|
+
interface: WorkflowNode (lines 20-37)
|
|
831
|
+
properties: parent (WorkflowNode | null), children (WorkflowNode[])
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
## Validation Loop
|
|
835
|
+
|
|
836
|
+
### Level 1: Syntax & Style (Immediate Feedback)
|
|
837
|
+
|
|
838
|
+
```bash
|
|
839
|
+
# Run TypeScript compiler check
|
|
840
|
+
npx tsc --noEmit
|
|
841
|
+
|
|
842
|
+
# Expected: Zero TypeScript errors. If errors exist, READ output and fix before proceeding.
|
|
843
|
+
# Common issues:
|
|
844
|
+
# - Missing .js extensions in imports
|
|
845
|
+
# - Incorrect type annotations
|
|
846
|
+
# - Missing exports
|
|
847
|
+
```
|
|
848
|
+
|
|
849
|
+
### Level 2: Unit Tests (Component Validation)
|
|
850
|
+
|
|
851
|
+
```bash
|
|
852
|
+
# Run new test file specifically
|
|
853
|
+
npm test bidirectional-consistency
|
|
854
|
+
|
|
855
|
+
# Run integration test suite
|
|
856
|
+
npm test -- src/__tests__/integration/
|
|
857
|
+
|
|
858
|
+
# Full test suite for regression check
|
|
859
|
+
npm test
|
|
860
|
+
|
|
861
|
+
# Expected: All tests pass. If failing, debug root cause and fix implementation.
|
|
862
|
+
# Expected output: Test count increases (from ~250 to ~270+)
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
### Level 3: Integration Testing (System Validation)
|
|
866
|
+
|
|
867
|
+
```bash
|
|
868
|
+
# Verify test file is discovered by Vitest
|
|
869
|
+
npm test -- --listTests 2>&1 | grep bidirectional-consistency
|
|
870
|
+
|
|
871
|
+
# Verify helper file can be imported
|
|
872
|
+
npm test -- --reporter=verbose 2>&1 | grep tree-verification
|
|
873
|
+
|
|
874
|
+
# Expected: bidirectional-consistency.test.ts appears in test list
|
|
875
|
+
# Expected: tree-verification.ts can be imported successfully
|
|
876
|
+
```
|
|
877
|
+
|
|
878
|
+
### Level 4: Creative & Domain-Specific Validation
|
|
879
|
+
|
|
880
|
+
```bash
|
|
881
|
+
# Manual invariant validation (if needed)
|
|
882
|
+
node -e "
|
|
883
|
+
const { Workflow } = require('./dist/index.js');
|
|
884
|
+
|
|
885
|
+
class TestWF extends Workflow {
|
|
886
|
+
async run() { return 'done'; }
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
const parent = new TestWF('Parent');
|
|
890
|
+
const child = new TestWF('Child');
|
|
891
|
+
parent.attachChild(child);
|
|
892
|
+
|
|
893
|
+
// Check 1:1 mirror invariant
|
|
894
|
+
console.log('child.parent === parent:', child.parent === parent);
|
|
895
|
+
console.log('child.node.parent === parent.node:', child.node.parent === parent.node);
|
|
896
|
+
console.log('parent.children includes child:', parent.children.includes(child));
|
|
897
|
+
console.log('parent.node.children includes child.node:', parent.node.children.includes(child.node));
|
|
898
|
+
"
|
|
899
|
+
|
|
900
|
+
# Expected: All checks return true
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
## Final Validation Checklist
|
|
904
|
+
|
|
905
|
+
### Technical Validation
|
|
906
|
+
|
|
907
|
+
- [ ] All 4 validation levels completed successfully
|
|
908
|
+
- [ ] All tests pass: `npm test`
|
|
909
|
+
- [ ] No TypeScript errors: `npx tsc --noEmit`
|
|
910
|
+
- [ ] Helper functions file created at: `src/__tests__/helpers/tree-verification.ts`
|
|
911
|
+
- [ ] Test file created at: `src/__tests__/integration/bidirectional-consistency.test.ts`
|
|
912
|
+
- [ ] Barrel export created at: `src/__tests__/helpers/index.ts`
|
|
913
|
+
|
|
914
|
+
### Feature Validation
|
|
915
|
+
|
|
916
|
+
- [ ] Tests verify BOTH workflow tree AND node tree after attachChild()
|
|
917
|
+
- [ ] Tests verify BOTH workflow tree AND node tree after detachChild()
|
|
918
|
+
- [ ] Tests verify parent→child AND child→parent directions
|
|
919
|
+
- [ ] Tests cover single child, multiple children scenarios
|
|
920
|
+
- [ ] Tests cover reparenting scenarios
|
|
921
|
+
- [ ] Tests cover deep hierarchy stress testing (100+ levels)
|
|
922
|
+
- [ ] Tests detect manual tree mutations
|
|
923
|
+
- [ ] All helper functions work correctly
|
|
924
|
+
|
|
925
|
+
### Code Quality Validation
|
|
926
|
+
|
|
927
|
+
- [ ] Follows existing test patterns from workflow-reparenting.test.ts
|
|
928
|
+
- [ ] File placement matches desired codebase tree structure
|
|
929
|
+
- [ ] Test naming consistent with "should" convention
|
|
930
|
+
- [ ] Proper use of Vitest globals (describe, it, expect)
|
|
931
|
+
- [ ] All imports use .js extension (ES module requirement)
|
|
932
|
+
- [ ] Helper functions have JSDoc comments
|
|
933
|
+
|
|
934
|
+
### Documentation & Deployment
|
|
935
|
+
|
|
936
|
+
- [ ] Code is self-documenting with clear test descriptions
|
|
937
|
+
- [ ] Test comments explain the invariant being validated
|
|
938
|
+
- [ ] Helper function comments explain purpose and usage
|
|
939
|
+
- [ ] Research documents linked in PRP for reference
|
|
940
|
+
- [ ] No new environment variables or configuration needed
|
|
941
|
+
|
|
942
|
+
---
|
|
943
|
+
|
|
944
|
+
## Anti-Patterns to Avoid
|
|
945
|
+
|
|
946
|
+
- ❌ Don't check only workflow tree - ALWAYS check both workflow tree AND node tree
|
|
947
|
+
- ❌ Don't check only one direction - ALWAYS verify parent→child AND child→parent
|
|
948
|
+
- ❌ Don't use boolean returns for validation - use throws or string[] for detailed errors
|
|
949
|
+
- ❌ Don't skip console mocking in adversarial tests - follow existing patterns
|
|
950
|
+
- ❌ Don't forget .js extension in imports - required for ES modules
|
|
951
|
+
- ❌ Don't use deep equality for WorkflowNode - use reference equality (===)
|
|
952
|
+
- ❌ Don't skip cycle detection in BFS traversal - use Set<Workflow> to track visited
|
|
953
|
+
- ❌ Don't test at extreme depth (10000+) - test at reasonable depth (100-1000)
|
|
954
|
+
- ❌ Don't forget to verify state after error cases - validate no corruption occurred
|
|
955
|
+
- ❌ Don't manually mutate tree properties in tests - use attachChild/detachChild
|
|
956
|
+
- ❌ Don't create test workflows without run() method - SimpleWorkflow pattern includes this
|
|
957
|
+
- ❌ Don't mix workflow and node tree references - keep them clear and separate
|
|
958
|
+
- ❌ Don't use expect().toThrow() for validateTreeConsistency - it returns string[], not throws
|