Skip to content

[5/n] custom Debug impl for change to reduce review noise #16

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.

Sign up for GitHub

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
sunshowers merged 6 commits into from
May 12, 2026
Merged

[5/n] custom Debug impl for change to reduce review noise #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ce3c3f3
[spr] changes to main this commit is based on
sunshowers Feb 6, 2026
4d1c65e
[spr] initial version
sunshowers Feb 6, 2026
4f2f5ef
[spr] changes introduced through rebase
sunshowers Feb 6, 2026
16c9061
copyright year
sunshowers Feb 6, 2026
656b22c
rebase on main
sunshowers May 12, 2026
b0bfe42
update output for new tests
sunshowers May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 65 additions & 3 deletions src/change.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
// Copyright 2025 Oxide Computer Company
// Copyright 2026 Oxide Computer Company

use std::fmt;

use crate::JsonPathStack;

// Describes any change detected between two OpenAPI documents.
#[derive(Debug)]
pub struct Change {
/// Human-readable message describing the nature of the change.
pub message: String,
Expand All @@ -18,10 +19,71 @@ pub struct Change {
/// Classification of the change compatibility.
pub class: ChangeClass,

/// Details on the kind of change
/// Details on the kind of change.
pub details: ChangeDetails,
}

// Format `Change` in the nested `paths`/`changes` layout that will be
// introduced when the type is restructured into `Change`, `ChangePath`, and
// `ChangeInfo`. Doing this ahead of time keeps the restructuring commit free
// of test-output noise.
impl fmt::Debug for Change {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
/// Wrapper that formats as `ChangePath { old, new, comparison }`.
struct PathFmt<'a> {
old: &'a JsonPathStack,
new: &'a JsonPathStack,
comparison: &'a ChangeComparison,
}

impl fmt::Debug for PathFmt<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ChangePath")
.field("old", self.old)
.field("new", self.new)
.field("comparison", self.comparison)
.finish()
}
}

/// Wrapper that formats as `ChangeInfo { old_subpath, new_subpath,
/// message, class, details }`.
struct InfoFmt<'a> {
message: &'a str,
class: &'a ChangeClass,
details: &'a ChangeDetails,
}

impl fmt::Debug for InfoFmt<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ChangeInfo")
.field("old_subpath", &"")
.field("new_subpath", &"")
Comment thread
sunshowers marked this conversation as resolved.
.field("message", &self.message)
.field("class", self.class)
.field("details", self.details)
.finish()
}
}

let path = PathFmt {
old: &self.old_path,
new: &self.new_path,
comparison: &self.comparison,
};
let info = InfoFmt {
message: &self.message,
class: &self.class,
details: &self.details,
};

f.debug_struct("Change")
.field("paths", &[path])
.field("changes", &[info])
.finish()
}
}

impl Change {
pub fn new(
message: impl ToString,
Expand Down
34 changes: 22 additions & 12 deletions tests/cases/cycle-detection/output/add-property-to-mutual-recursion.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,29 @@
Result for patch:
[
Change {
message: "object properties changed",
old_path: [
"#/components/schemas/Person",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/Person",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/Person",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/Person",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "object properties changed",
class: Unhandled,
details: UnknownDifference,
},
],
comparison: Output,
class: Unhandled,
details: UnknownDifference,
},
]
98 changes: 64 additions & 34 deletions tests/cases/cycle-detection/output/asymmetric-unroll-with-property-change.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,49 +34,79 @@
Result for patch:
[
Change {
message: "schema metadata changed",
old_path: [
"#/components/schemas/DirectLoop",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/DirectLoop",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/LoopIndirect",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/LoopIndirect",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "schema metadata changed",
class: Trivial,
details: Metadata,
},
],
comparison: Output,
class: Trivial,
details: Metadata,
},
Change {
message: "object properties changed",
old_path: [
"#/components/schemas/DirectLoop",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/DirectLoop",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/LoopIndirect",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/LoopIndirect",
"#/components/schemas/DirectLoop/properties/next/$ref",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "object properties changed",
class: Unhandled,
details: UnknownDifference,
},
],
comparison: Output,
class: Unhandled,
details: UnknownDifference,
},
Change {
message: "schema types changed",
old_path: [
"#/components/schemas/DirectLoop/properties/value",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/DirectLoop/properties/value",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/DirectLoop/properties/value",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/DirectLoop/properties/value",
"#/paths/~1direct-loop/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "schema types changed",
class: Incompatible,
details: UnknownDifference,
},
],
comparison: Output,
class: Incompatible,
details: UnknownDifference,
},
]
34 changes: 22 additions & 12 deletions tests/cases/cycle-detection/output/change-item-value-type.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,29 @@
Result for patch:
[
Change {
message: "schema types changed",
old_path: [
"#/components/schemas/Item/properties/value",
"#/components/schemas/ItemPage/properties/items/items/$ref",
"#/paths/~1items/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/Item/properties/value",
"#/components/schemas/ItemPage/properties/items/items/$ref",
"#/paths/~1items/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/Item/properties/value",
"#/components/schemas/ItemPage/properties/items/items/$ref",
"#/paths/~1items/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/Item/properties/value",
"#/components/schemas/ItemPage/properties/items/items/$ref",
"#/paths/~1items/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "schema types changed",
class: Incompatible,
details: UnknownDifference,
},
],
comparison: Output,
class: Incompatible,
details: UnknownDifference,
},
]
34 changes: 22 additions & 12 deletions tests/cases/cycle-detection/output/change-mutual-recursion-property.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,29 @@
Result for patch:
[
Change {
message: "schema types changed",
old_path: [
"#/components/schemas/Person/properties/name",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/Person/properties/name",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/Person/properties/name",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/Person/properties/name",
"#/components/schemas/Company/properties/ceo/$ref",
"#/paths/~1companies/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "schema types changed",
class: Incompatible,
details: UnknownDifference,
},
],
comparison: Output,
class: Incompatible,
details: UnknownDifference,
},
]
34 changes: 22 additions & 12 deletions tests/cases/cycle-detection/output/change-three-cycle-property.out
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,29 @@
Result for patch:
[
Change {
message: "schema types changed",
old_path: [
"#/components/schemas/NodeB/properties/label",
"#/components/schemas/NodeA/properties/next/$ref",
"#/paths/~1three-cycle/get/responses/200/content/application~1json/schema/$ref",
paths: [
ChangePath {
old: [
"#/components/schemas/NodeB/properties/label",
"#/components/schemas/NodeA/properties/next/$ref",
"#/paths/~1three-cycle/get/responses/200/content/application~1json/schema/$ref",
],
new: [
"#/components/schemas/NodeB/properties/label",
"#/components/schemas/NodeA/properties/next/$ref",
"#/paths/~1three-cycle/get/responses/200/content/application~1json/schema/$ref",
],
comparison: Output,
},
],
new_path: [
"#/components/schemas/NodeB/properties/label",
"#/components/schemas/NodeA/properties/next/$ref",
"#/paths/~1three-cycle/get/responses/200/content/application~1json/schema/$ref",
changes: [
ChangeInfo {
old_subpath: "",
new_subpath: "",
message: "schema types changed",
class: Incompatible,
details: UnknownDifference,
},
],
comparison: Output,
class: Incompatible,
details: UnknownDifference,
},
]
Loading
Loading