feat(data_privacy)!: introduce data_privacy_core by Vaiz · Pull Request #427 · microsoft/oxidizer

Vaiz · 2026-05-18T12:39:27Z

Breaking changes in data_privacy crate can lead to cascading breaking changes across all consumer crates. This PR decouples redaction engines from basic data_privacy types so we can have more stable crate for classification, and have more freedom when we do breaking changes in redaction itself.

github-actions · 2026-05-18T12:49:40Z

⚠️ Breaking Changes Detected

error: failed to retrieve local crate data from git revision

Caused by:
    0: failed to retrieve manifest file from git revision source
    1: possibly due to errors: [
         failed to parse /home/runner/work/oxidizer/oxidizer/target/semver-checks/git-origin_main/f9447bfeb39865bee39a1c1c1b56930ee9f92b8c/Cargo.toml: no `package` table,
         failed when reading /home/runner/work/oxidizer/oxidizer/target/semver-checks/git-origin_main/f9447bfeb39865bee39a1c1c1b56930ee9f92b8c/scripts/crate-template/Cargo.toml: TOML parse error at line 9, column 26
         |
       9 | keywords = ["oxidizer", {{CRATE_KEYWORDS}}]
         |                          ^
       missing key for inline table element, expected key
       : TOML parse error at line 9, column 26
         |
       9 | keywords = ["oxidizer", {{CRATE_KEYWORDS}}]
         |                          ^
       missing key for inline table element, expected key
       ,
       ]
    2: package `data_privacy_core` not found in /home/runner/work/oxidizer/oxidizer/target/semver-checks/git-origin_main/f9447bfeb39865bee39a1c1c1b56930ee9f92b8c

Stack backtrace:
   0: anyhow::error::<impl anyhow::Error>::msg
   1: cargo_semver_checks::rustdoc_gen::RustdocFromProjectRoot::get_crate_source
   2: cargo_semver_checks::rustdoc_gen::StatefulRustdocGenerator<cargo_semver_checks::rustdoc_gen::CoupledState>::prepare_generator
   3: cargo_semver_checks::Check::check_release::{{closure}}
   4: cargo_semver_checks::Check::check_release
   5: cargo_semver_checks::exit_on_error
   6: cargo_semver_checks::main
   7: std::sys::backtrace::__rust_begin_short_backtrace
   8: main
   9: <unknown>
  10: __libc_start_main
  11: _start

If the breaking changes are intentional then everything is fine - this message is merely informative.

Remember to apply a version number bump with the correct severity when publishing a version with breaking changes (1.x.x -> 2.x.x or 0.1.x -> 0.2.x).

codecov · 2026-05-18T12:49:56Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (43d51a5) to head (9bd92a8).

Additional details and impacted files

@@           Coverage Diff            @@
##             main     #427    +/-   ##
========================================
  Coverage   100.0%   100.0%            
========================================
  Files         305      305            
  Lines       23698    23542   -156     
========================================
- Hits        23698    23542   -156

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR introduces a new data_privacy_core crate that owns the core classification/redaction traits and types, and refactors the existing data_privacy crate to re-export those core APIs while keeping RedactionEngine and built-in redaction strategies. The change also updates dependent crates/macros to use the new Redactor-based interfaces and adjusts CI/scripts to include the new crate.

Changes:

Add crates/data_privacy_core and move core types/traits (e.g., Sensitive, DataClass, Redactor, redacted formatting traits) into it.
Refactor data_privacy to re-export data_privacy_core, implement Redactor for RedactionEngine, and update redactor implementations/tests accordingly.
Update macros and templated_uri integration to use Redactor (&dyn Redactor) rather than RedactionEngine in redacted formatting, and update snapshots/metadata.

Reviewed changes

Copilot reviewed 63 out of 64 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
scripts/run-examples.rs	Comment-only adjustment in excluded examples list.
scripts/publish-gh-release.rs	Comment-only adjustment in changelog parsing logic.
scripts/mutants.rs	Add `data_privacy_core` to mutation test grouping.
justfiles/basic.just	Comment-only adjustment in `examples` recipe docs.
crates/templated_uri/src/uri.rs	Switch redacted formatting to accept `&dyn Redactor`; adjust tests.
crates/templated_uri/src/path_and_query.rs	Switch redacted formatting to accept `&dyn Redactor`.
crates/templated_uri/Cargo.toml	Allow `data_privacy_core::*` types for external-types checking.
crates/templated_uri_macros_impl/src/struct_template.rs	Update generated `RedactedDisplay` signature to take `&dyn Redactor`.
crates/templated_uri_macros_impl/src/enum_template.rs	Update generated `RedactedDisplay` signature to take `&dyn Redactor`.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__templated_uri_impl.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__templated_unredacted_uri_impl.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__template_enum_impl.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__query_param_is_kv_expansion.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__optional_reference_field_codegen.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__optional_field_with_unredacted_codegen.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__optional_field_codegen.snap	Snapshot updates for new `Redactor` signature.
crates/templated_uri_macros_impl/src/snapshots/templated_uri_macros_impl__tests__field_level_unredacted.snap	Snapshot updates for new `Redactor` signature.
crates/data_privacy/tests/xxh3_redactor.rs	Add coverage for new `would_redact` behavior.
crates/data_privacy/tests/rapidhash_redactor.rs	Add coverage for new `would_redact` behavior.
crates/data_privacy/tests/redaction_engine.rs	Update to new `Redactor`-based `redact` call signature.
crates/data_privacy/tests/sensitive.rs	Add additional regression tests for redacted formatting and boundary behavior (with insta).
crates/data_privacy/src/sensitive.rs	Remove old `Sensitive` implementation (moved to core).
crates/data_privacy/src/redactors/xxh3_redactor.rs	Implement new `would_redact` method; adjust test coverage attrs.
crates/data_privacy/src/redactors/rapidhash_redactor.rs	Implement new `would_redact` method.
crates/data_privacy/src/redactors/simple_redactor.rs	Implement new `would_redact` method; import cleanup.
crates/data_privacy/src/redactors/redactor.rs	Remove old `Redactor` trait (moved to core).
crates/data_privacy/src/redactors/mod.rs	Remove local `Redactor` re-export; adjust tests for new trait contract.
crates/data_privacy/src/redaction_engine.rs	Make `RedactionEngine` implement `Redactor`; remove inherent `redact`/`would_redact`.
crates/data_privacy/src/redaction_engine_inner.rs	Update `would_redact` to delegate to the selected redactor/fallback; add tests.
crates/data_privacy/src/macros.rs	Remove local macro re-export module (moved to core re-exports).
crates/data_privacy/src/lib.rs	Re-export `data_privacy_core` APIs; update crate docs and module exports.
crates/data_privacy/README.md	Regenerated README reflecting the new `data_privacy_core` split and links.
crates/data_privacy/Cargo.toml	Bump version, add `data_privacy_core`, wire serde feature through, add insta dev-dep.
crates/data_privacy_macros/Cargo.toml	Version bump aligned with macro changes.
crates/data_privacy_macros_impl/tests/snapshots/taxonomy__success.snap	Snapshot updates to reference `data_privacy_core` paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_display_unit.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_display_single.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_display_multiple.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_display_multiple_named.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_display_enum.snap	Snapshot metadata update.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_debug_unit.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_debug_single.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_debug_multiple.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_debug_multiple_named.snap	Snapshot updates for `&dyn Redactor` and core paths.
crates/data_privacy_macros_impl/tests/snapshots/derive__redacted_debug_enum.snap	Snapshot metadata update.
crates/data_privacy_macros_impl/tests/snapshots/classified__success.snap	Snapshot updates for core paths and `&dyn Redactor` usage.
crates/data_privacy_macros_impl/tests/snapshots/classified__success_named_field.snap	Snapshot updates for core paths and `&dyn Redactor` usage.
crates/data_privacy_macros_impl/src/taxonomy.rs	Use crate-path resolver so generated code targets `data_privacy` or `data_privacy_core`.
crates/data_privacy_macros_impl/src/lib.rs	Export new `crate_path` helper module.
crates/data_privacy_macros_impl/src/derive.rs	Update derive output to use resolved crate path and `&dyn Redactor`.
crates/data_privacy_macros_impl/src/crate_path.rs	New helper to resolve whether to generate `::data_privacy` or `::data_privacy_core` paths.
crates/data_privacy_macros_impl/src/classified.rs	Update classified macro output to use resolved crate path and `&dyn Redactor`.
crates/data_privacy_macros_impl/Cargo.toml	Add `proc-macro-crate` dependency; version bump.
crates/data_privacy_core/src/lib.rs	New core crate root exposing core traits/types and macro re-exports.
crates/data_privacy_core/src/macros.rs	New macro re-export module for core crate.
crates/data_privacy_core/src/redactor.rs	New `Redactor` trait definition (now in core).
crates/data_privacy_core/src/redacted.rs	Update redacted formatting traits to accept `&dyn Redactor`; add tests.
crates/data_privacy_core/src/sensitive.rs	New `Sensitive` implementation moved into core; add tests.
crates/data_privacy_core/src/data_class.rs	Restructure tests; separate serde-gated tests into a dedicated module.
crates/data_privacy_core/src/classified.rs	Update docs and minor trait doc tweaks for core crate.
crates/data_privacy_core/README.md	New crate README describing core responsibilities.
crates/data_privacy_core/Cargo.toml	New crate manifest with serde feature and dev-deps.
Cargo.toml	Add `data_privacy_core` and `proc-macro-crate` to workspace dependencies; bump versions.
Cargo.lock	Lockfile updates for new crate and new dependency versions.

Comments suppressed due to low confidence (1)

crates/data_privacy_core/src/redacted.rs:106

These tests use inline insta snapshots (e.g. assert_snapshot!(result, @"...")). To align with the repository’s usual insta usage (file-backed .snap artifacts), consider converting these to external snapshots or simple assert_eq! (the expected output is short).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 63 out of 64 changed files in this pull request and generated 4 comments.

Copilot

Pull request overview

Copilot reviewed 70 out of 71 changed files in this pull request and generated 5 comments.

Comments suppressed due to low confidence (1)

crates/data_privacy_core/src/redacted.rs:106

These unit tests use inline insta snapshots (e.g., @"..."). In this repo, snapshot tests are commonly file-backed via .snap files (for example crates/templated_uri_macros_impl/src/lib.rs:199-208). Consider converting to external snapshots to reduce noise in code diffs.

Copilot

Pull request overview

Copilot reviewed 86 out of 87 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 79 out of 80 changed files in this pull request and generated no new comments.

ralfbiedert · 2026-05-28T11:38:50Z

+    /// Implementations may return `false` when no transformation is applied — for
+    /// example, when a strategy operates in pass-through mode, or when redaction has
+    /// been explicitly suppressed for the given class.
+    fn would_redact(&self, data_class: &DataClass) -> bool;


Small nit as you're also releasing a new version, can we rename this to just redacts (in the general theme of shortening names)?

…mentations

Vaiz force-pushed the issue-371-split-data-privacy branch 8 times, most recently from 52a562a to 1cf8061 Compare May 21, 2026 13:24

Vaiz marked this pull request as ready for review May 21, 2026 13:46

Copilot AI review requested due to automatic review settings May 21, 2026 13:46

Copilot started reviewing on behalf of Vaiz May 21, 2026 13:46 View session

Copilot AI reviewed May 21, 2026

View reviewed changes

Comment thread crates/data_privacy_core/src/redactor.rs Outdated

Comment thread crates/data_privacy/src/lib.rs Outdated

Comment thread crates/data_privacy/src/redaction_engine.rs

Comment thread crates/data_privacy/tests/sensitive.rs

Comment thread crates/data_privacy/src/sensitive.rs

Copilot AI review requested due to automatic review settings May 21, 2026 14:28

Vaiz force-pushed the issue-371-split-data-privacy branch from 0b9f929 to 4582bc7 Compare May 21, 2026 14:28

Copilot started reviewing on behalf of Vaiz May 21, 2026 14:29 View session

Copilot AI reviewed May 21, 2026

View reviewed changes

Comment thread crates/data_privacy/src/redactors/mod.rs

Comment thread crates/data_privacy/tests/redaction_engine.rs

Comment thread crates/templated_uri_macros_impl/src/struct_template.rs

Comment thread crates/templated_uri_macros_impl/src/enum_template.rs

ralfbiedert approved these changes May 22, 2026

View reviewed changes

Comment thread crates/data_privacy/src/lib.rs Outdated

Comment thread crates/data_privacy_macros_impl/src/crate_path.rs Outdated

Vaiz force-pushed the issue-371-split-data-privacy branch from 4582bc7 to 0525c8f Compare May 22, 2026 12:54

Copilot AI review requested due to automatic review settings May 22, 2026 13:54

Vaiz force-pushed the issue-371-split-data-privacy branch from 0525c8f to cba397a Compare May 22, 2026 13:54

Copilot started reviewing on behalf of Vaiz May 22, 2026 13:54 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

Vaiz marked this pull request as draft May 25, 2026 04:09

Vaiz added 4 commits May 28, 2026 09:03

squash

b639731

move stuff around

7584530

update docs

616b76f

fmt

968d97a

Vaiz force-pushed the issue-371-split-data-privacy branch from cba397a to 968d97a Compare May 28, 2026 08:12

Vaiz added 5 commits May 28, 2026 10:25

remove snap

5fbd7e2

fixes

51f147e

cargo sort

d1c7e74

rdme

3ae9d61

bump CARGO_DOC2README_VERSION

7db7f63

Vaiz marked this pull request as ready for review May 28, 2026 09:01

Copilot AI review requested due to automatic review settings May 28, 2026 09:01

Copilot started reviewing on behalf of Vaiz May 28, 2026 09:02 View session

Copilot AI reviewed May 28, 2026

View reviewed changes

Comment thread crates/data_privacy_macros/CHANGELOG.md Outdated

Comment thread crates/data_privacy/CHANGELOG.md Outdated

restore changelogs

9b65322

Vaiz marked this pull request as draft May 28, 2026 09:17

Vaiz added 3 commits May 28, 2026 11:26

restore macros crates

368c5f1

update changelogs

ffa712e

Cargo.lock

f8c4393

Vaiz marked this pull request as ready for review May 28, 2026 11:12

Copilot AI review requested due to automatic review settings May 28, 2026 11:12

Copilot started reviewing on behalf of Vaiz May 28, 2026 11:12 View session

Copilot AI reviewed May 28, 2026

View reviewed changes

ralfbiedert reviewed May 28, 2026

View reviewed changes

ralfbiedert approved these changes May 28, 2026

View reviewed changes

refactor: rename would_redact method to redacts in redactor imple…

9bd92a8

…mentations

Conversation

Vaiz commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ Breaking Changes Detected

Uh oh!

codecov Bot commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

ralfbiedert May 28, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Vaiz commented May 18, 2026 •

edited

Loading

github-actions Bot commented May 18, 2026 •

edited

Loading

codecov Bot commented May 18, 2026 •

edited

Loading