feat(redaction): Add JSONPath wildcards and improved redaction API #121
Conversation
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 commit adds support for wildcard paths in the redaction feature,
allowing users to redact multiple values at once (e.g., all IDs in an array).
Key changes:
- Add `serde_json_path` dependency for JSONPath support
- Create `PathSelector` enum supporting both JSON Pointer and JSONPath
- Auto-detect syntax based on path prefix (`$` = JSONPath, `/` = Pointer)
- Add `RedactOptions` for configurable empty match behavior
- Add `redact_replace_with` and `redact_remove_with` methods
- Reorganize redaction code into `redaction/` folder
Example usage:
```rust
.redact_replace("$.observations[*].id", "stable-uuid")?
.redact_replace("$.observations[*].created_at", "2024-01-01T00:00:00Z")?
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Replace `redact_replace` method with unified `redact` method that accepts
any type implementing the `Redactor` trait:
- Static values: `&str`, `String`, `serde_json::Value`
- Closures: `Fn(&str, &Value) -> Value`
The closure receives both the path and current value, allowing for
path-aware transformations (e.g., extracting array indices) or
value-based transformations (ignore path with `_`).
Example usage:
```rust
// Static value
.redact("/id", "stable-uuid")?
// Closure for path-aware transformation
.redact("$.items[*].id", |path, _val| {
let idx = path.split('/').nth(1).unwrap_or("0");
json!(format!("id-{idx}"))
})?
```
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <[email protected]>
…documentation - Update tutorial chapter_6.rs with: - Path syntax auto-detection explanation - JSONPath wildcards section with syntax table and examples - Function-based redaction section (index-aware and value-based) - RedactOptions section for optional fields - Updated key points summary - Update lib.rs crate documentation with: - Path syntax overview - JSONPath wildcards example - Dynamic transformations with closures example - Redactor trait in See Also section - Add closure-based example method to client.rs: - list_observations_with_indexed_ids() demonstrating index-aware IDs - Add integration test for closure-based redaction: - test_closure_based_redaction_with_index verifying obs-0, obs-1, etc. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add a coverage task that uses cargo-llvm-cov with nextest as the test runner. Runs with all features and supports extra args (--open, --html). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Add 72 new unit tests across 4 files: - call_parameters.rs: 18 tests for CallParameters methods (81% → 100%) - result.rs: 23 tests for RawResult and RawBody (72% → 83%) - redaction/mod.rs: 24 tests for RedactOptions and RedactionBuilder (63% → 96%) - test_server.rs: 14 tests for HealthStatus and TestServerConfig (75% → 88%) Total coverage improved from 93.90% to 95.03%. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
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.
Summary
$.items[*].idRedactorAPI supporting static values and closuresRedactOptionsfor configurable behavior (e.g.,allow_empty_match)redact_remove()method to completely remove fieldscargo-llvm-covChanges
Redaction Features
$.users[*].id,$..timestamp|path, value| ...for dynamic, context-aware redactionredact_remove()andredact_remove_with()methodsRedactOptions { allow_empty_match: true }for optional fieldsDeveloper Experience
mise run coveragetask for code coverage reportsTest Coverage
call_parameters.rs: 81% → 100%redaction/mod.rs: 63% → 96%result.rs: 72% → 83%test_server.rs: 75% → 88%Test plan
cargo nextest run --all-features)mise spectral)🤖 Generated with Claude Code