README: add a 'Testing your callback endpoint' section - #7
Merged
Conversation
Documents the intended test pattern: a real CallbackHandler with a made-up test key, forging authentic signatures via $handler->validator()->sign() - which is why validator() is public. Explains why mocking the (deliberately final) handler is a bad idea: the checksum is over the raw byte-for-byte body, and only a real round-trip catches frameworks re-encoding or consuming that body.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 1.x #7 +/- ##
=========================================
Coverage 98.50% 98.50%
Complexity 146 146
=========================================
Files 24 24
Lines 401 401
=========================================
Hits 395 395
Misses 6 6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Follow-up to the
CallbackValidator/CallbackHandlerdesign discussion: the classes deliberately have no interfaces and arefinal, which means consumers cannot mock them — and shouldn't. This section documents the intended pattern instead:CallbackHandlerwith a made-up test key (verification is deterministic, no I/O)$handler->validator()->sign($body)— this is the reasonvalidator()is public, and it's the same pattern the SDK's own test suite usesInvalidChecksumException)Docs only — no code changes.