docs: add per-protocol mock matching reference#878
Open
slayerjain wants to merge 2 commits into
Open
Conversation
Users debugging a replay failure had no single page answering: what does Keploy actually compare when it matches an outgoing call to a recorded Mock, per protocol? What happens to my application on a mock miss for HTTP vs MySQL vs MongoDB? Which fields are ignored automatically, when do I need noise configuration, and what do the new mock-miss reports and fuzzy-match policy mean? This page documents, per protocol (HTTP, gRPC, MySQL, PostgreSQL, MongoDB, DNS, generic TCP): what is matched, what is ignored by default, and the app-visible failure mode on a miss. It also documents the shared noise vocabulary (body.<path> / header.<name>) across response assertions and mock matching, learned request-body noise (--schema-noise-detection / --schema-noise-strict), the fuzzyMatch policy (warn/on/off deterministic replay), and the four places a mock miss is reported (miss log, MOCKS MISMATCH SUMMARY, report yaml unmatched_calls, keploy report). Behavior references keploy/keploy PRs #4271 and #4272. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: slayerjain <shubhamkjain@outlook.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new v4.0.0 “Mock Matching Reference” doc page explaining how Keploy matches recorded mocks per protocol during replay, including mock-miss behavior and configuration knobs relevant to replay debugging.
Changes:
- Registers a new doc entry
running-keploy/mock-matchingin the v4.0.0 sidebar under “Running Keploy”. - Adds a new reference page documenting per-protocol matching inputs, default ignores/noise behavior, fuzzy matching controls, and where to find mismatch reporting details.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| versioned_sidebars/version-4.0.0-sidebars.json | Adds the new “mock-matching” page to the v4.0.0 navigation sidebar under Running Keploy. |
| versioned_docs/version-4.0.0/running-keploy/mock-matching.md | Introduces the new “How Keploy Matches Mocks per Protocol” reference page with protocol matching tables and debugging guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Replace 'charset' with 'character set', 'regexes' with 'regular expressions', and lowercase 'yaml' with 'YAML file' in prose; add 'Jaccard' (proper noun, the similarity coefficient referenced with its thresholds) to the accepted vocabulary. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds a new reference page "How Keploy Matches Mocks per Protocol" under Running Keploy (
running-keploy/mock-matching), registered in the v4.0.0 sidebar after Custom Mocks.There was no single page answering the questions every replay-debugging session starts with:
KP001vs Mongo reconnect)?--schema-noise-detection/--schema-noise-strict), and the fuzzy-match policy (--fuzzy-match warn|on|off, deterministic replay) fit together?MOCKS MISMATCH SUMMARY, report yamlunmatched_calls,keploy report)?The page documents current behavior plus the controls landing in keploy/keploy#4271 (unified noise vocabulary + universal mismatch reporting) and keploy/keploy#4272 (fuzzy-match policy + deterministic replay) — it should merge alongside/after those.
Checks
yarn build— passes locally (Docusaurus compiles, sidebar reference valid)prettier@2.8.8 --check— clean on both changed filesdocs:) with sign-off🤖 Generated with Claude Code