Skip to content

docs: remove topic#94

Merged
muratkeremozcan merged 1 commit intomainfrom
docs/pactjs-concurrency-knowledge-update
Apr 24, 2026
Merged

docs: remove topic#94
muratkeremozcan merged 1 commit intomainfrom
docs/pactjs-concurrency-knowledge-update

Conversation

@muratkeremozcan
Copy link
Copy Markdown
Collaborator

No description provided.

@muratkeremozcan muratkeremozcan merged commit 275ef35 into main Apr 24, 2026
5 checks passed
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

These documentation updates refactor Pact consumer testing guidance by eliminating the determinism-check wrapper script and moving determinism validation from pre-publish gates to publish-time interaction normalization. Test scripts are simplified to run Vitest directly, and file organization requirements are clarified to prevent FFI handle collisions.

Changes

Cohort / File(s) Summary
Core Framework & Contract Testing Guidance
src/agents/bmad-tea/resources/knowledge/contract-testing.md, src/agents/bmad-tea/resources/knowledge/pact-consumer-framework-setup.md
Removes determinism check script wrapper and test:pact:consumer:run script. Simplifies test:pact:consumer to directly run Vitest. Shifts determinism handling to publish-time jq normalization. Updates CI workflow descriptions and clarifies one .pacttest.ts file per consumer+provider pair requirement.
Utility Documentation Updates
src/agents/bmad-tea/resources/knowledge/pactjs-utils-consumer-helpers.md, src/agents/bmad-tea/resources/knowledge/pactjs-utils-provider-verifier.md
Removes references to automatic determinism gates and CI wiring. Redefines determinism rule as four stacked constraints: fileParallelism: false, pool: 'forks' + singleFork: true, file organization, and one interaction per it(). Updates cross-references and simplifies explanations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The PR title 'docs: remove topic' is vague and does not clearly describe the actual changes, which involve refactoring Pact testing documentation and removing determinism gate concepts. Use a more descriptive title that reflects the actual changes, such as 'docs: refactor Pact testing guidance and remove determinism gate concept' or similar.
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether the intent and rationale are documented. Add a meaningful description explaining the motivation behind removing the determinism gate concept and how the testing workflow is being refactored.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/pactjs-concurrency-knowledge-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented Apr 24, 2026

🤖 Augment PR Summary

Summary: This PR updates the Pact consumer contract-testing documentation to remove the “determinism gate” topic and simplify how consumer pact tests are run and published.

Changes:

  • Simplified package.json examples by collapsing test:pact:consumer into a single vitest run --config vitest.config.pact.ts command (removing the separate inner run + determinism wrapper pattern).
  • Replaced the prior “run N-times determinism gate” guidance with publish-time normalization: publish-pact.sh uses jq to sort interactions before publishing for byte-stable payloads.
  • Expanded consumer test organization guidance: enforce one .pacttest.ts per consumer+provider pair to avoid Pact Rust FFI handle collisions, with ✅/❌ examples.
  • Updated CI workflow snippet wording to describe step (1) as “run consumer contract tests” rather than a determinism gate.
  • Updated related fragments (pactjs-utils-consumer-helpers, provider verifier docs, and contract-testing overview) to remove references to the gate and point to the new rules.

Technical Notes: Publish-time normalization is positioned as the mechanism for handling ordering drift; determinism-gate scripting and the test:pact:consumer:run script are removed from these fragments.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 1 suggestion posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

"scripts": {
"test:pact:consumer": "./scripts/check-pact-determinism.sh 'npm run test:pact:consumer:run' 3 ./pacts",
"test:pact:consumer:run": "vitest run --config vitest.config.pact.ts",
"test:pact:consumer": "vitest run --config vitest.config.pact.ts",
Copy link
Copy Markdown

@augmentcode augmentcode Bot Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fragment removes the determinism-gate approach (check-pact-determinism.sh / test:pact:consumer:run), but there are still workflow-scoped copies under src/workflows/testarch/**/resources/knowledge/ that reference the old scripts, which can lead to conflicting guidance depending on which knowledge base is loaded. Other locations where this applies: src/workflows/testarch/bmad-testarch-automate/resources/knowledge/contract-testing.md:170, src/workflows/testarch/bmad-testarch-framework/resources/knowledge/pact-consumer-framework-setup.md:641.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

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