-
Notifications
You must be signed in to change notification settings - Fork 0
test: added some hardening/regression coverage #285
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Hardening Regression Tests | ||
|
|
||
| ## Approach | ||
|
|
||
| Add behavior-preserving regression coverage for edge cases identified in the | ||
| post-v1 roadmap before changing matcher or traversal internals. This branch | ||
| documents the current v1 behavior for sensitive Unicode values, deeper object | ||
| graphs, repeated sensitive keys, large arrays, non-plain objects, and symbol | ||
| keys. | ||
|
|
||
| ## Pre-implementation | ||
|
|
||
| Create branch `test/hardening-regression-coverage` from `main` after merging the | ||
| README release-polish branch. | ||
|
|
||
| ## Steps | ||
|
|
||
| 1. `docs/plans/005-hardening-regression-tests.md` - add this plan for the | ||
| hardening regression coverage work. | ||
| 2. `test/replacers.test.ts` - add object and string replacer edge-case coverage | ||
| for recursion, repeated sensitive keys, arrays, symbols, non-plain objects, | ||
| and Unicode sensitive values. | ||
|
|
||
| ## Relevant Files | ||
|
|
||
| - `docs/plans/005-hardening-regression-tests.md` - new plan for this test-only | ||
| hardening slice. | ||
| - `test/replacers.test.ts` - updated replacer regression coverage. | ||
|
|
||
| ## Verification | ||
|
|
||
| 1. Run `yarn test`. | ||
| 2. Run `yarn test:coverage`. | ||
| 3. Run `yarn lint`. | ||
| 4. Run `yarn format:check`. | ||
| 5. Re-run workspace diagnostics for touched test and plan files. | ||
|
|
||
| ## Decisions | ||
|
|
||
| **Test-only branch** - this work documents existing v1 behavior and avoids | ||
| runtime implementation changes so later hardening or matcher cleanup work has a | ||
| clear safety net. | ||
|
|
||
| **Prefer observable behavior over internals** - tests should assert public | ||
| sanitization results and documented helper behavior rather than private | ||
| implementation details. | ||
|
|
||
| **No new API options** - depth limits, non-plain object traversal changes, and | ||
| structured string parsing remain future implementation work after the current | ||
| behavior is covered. | ||
|
|
||
| **Existing coverage boundaries** - current public API and matcher tests already | ||
| cover custom matcher error wrapping and JSON removal edge positions, so this | ||
| branch keeps new assertions at the replacer boundary. |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.