Skip to content

Add Nullean.Snapshots.Objects, object-graph snapshots - #114

Merged
Mpdreamz merged 1 commit into
mainfrom
feature/objects-package
Nov 17, 2026
Merged

Mpdreamz merged 1 commit into
mainfrom
feature/objects-package

Conversation

@Mpdreamz

Copy link
Copy Markdown
Contributor

Why

Agents migrating docs-builder tests wrote reflection-based dumpers (ModelDump in elastic/docs-builder#4879 and another in #4877) so that a property added to a record shows up as a diff. `MatchJsonSnapshot` needs System.Text.Json to be able to write the type: a cycle or a `System.Type` throws, and a set comes out in hash order.

What

A new package, `Nullean.Snapshots.Objects`: `Should().MatchObjectSnapshot()` and `ObjectSnapshot.Dump`. Public properties and fields are dumped as YAML and compared through the YAML format, so a new property is an added path.

  • Cycles are `"<cycle to $.Path>"`; `HashSet` is sorted by rendering; a throwing property is `""` with no message (it differs per OS).
  • `ObjectDumpOptions`: `IgnoreMember`, `IgnoreType`, `Render`, `Include`, `SortAsSet`, `MaxDepth`, `MaxItems`.
  • Public API snapshot for the package, README, core skill for the package, docs page, DECISIONS.md section, solution and test project.

AOT: checked, not assumed

Reflection is not automatically out of native AOT. I published a native AOT app (osx-arm64, .NET 11 SDK) dumping a nested graph and compared it with the JIT run:

  • Without help, the AOT dump lost the members of every type reached only through another object (`Inner: {}`), and a `HashSet` came out unsorted, because trimming removes `ISet<>` from `GetInterfaces()`.
  • So sets are found by type, never by interface (same text in both runs); `Include()` carries `[DynamicallyAccessedMembers]` so the trimmer keeps a type; and under AOT a member-less type that was not included throws with a message naming the fix, instead of dumping `{}`.
  • With every type included, the AOT output was identical to the JIT's. The package keeps `IsAotCompatible` with the analyzers on; the calls are `[RequiresUnreferencedCode]`.
  • Not verified: other RIDs, and trimmed (non-AOT) publishes.

Tests: 15, including CsCheck properties (set order is independent of insertion order; any string round-trips through the YAML parser). Mutating set sorting fails 2, mutating cycle detection fails 1.

Independent of #110 to #113. #113 can link here once this merges.

🤖 Generated with Claude Code

@Mpdreamz Mpdreamz added the feature A new capability (minor bump) label Nov 17, 2026
@Mpdreamz
Mpdreamz force-pushed the feature/objects-package branch from 868b5a5 to f8ca81c Compare November 17, 2026 11:08
@Mpdreamz
Mpdreamz merged commit bd068b9 into main Nov 17, 2026
13 checks passed
@Mpdreamz
Mpdreamz deleted the feature/objects-package branch November 17, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature A new capability (minor bump)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant