feat: support short-circuiting append operations when there are multiple appends, not just 1 item#153
Merged
ThomasRooney merged 2 commits intomainfrom Feb 14, 2026
Merged
Conversation
…ray item, we do not need to delete and recreate the array
TristanSpeakEasy
approved these changes
Feb 14, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support in the overlay comparison algorithm to emit a single “append” update action when a YAML sequence has multiple new trailing elements (not just one), and validates the behavior with a new unit test.
Changes:
- Generalize the sequence tail-append short-circuit from
+1element to+Nelements inCompare. - Add a regression test ensuring multiple appended items produce a single append action and round-trip correctly.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| overlay/compare.go | Extends the sequence append short-circuit to handle multiple trailing additions by emitting one update action containing the appended tail. |
| overlay/compare_test.go | Adds a test covering multi-element sequence append and verifies the overlay applies cleanly to reproduce the target YAML. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+120
to
127
| if len(y2.Content) > len(y1.Content) && | ||
| yamlEquals(y2.Content[:len(y1.Content)], y1.Content) { | ||
| return []Action{{ | ||
| Target: path.ToJSONPath(), | ||
| Update: yaml.Node{ | ||
| Kind: y1.Kind, | ||
| Content: []*yaml.Node{y2.Content[len(y1.Content)]}, | ||
| Content: y2.Content[len(y1.Content):], | ||
| }, |
There was a problem hiding this comment.
The new short-circuit path now calls yamlEquals(...) for any case where y2 is longer than y1, even when the sequence changes are not a pure tail-append. Since yamlEquals re-encodes each element to YAML strings, this can add noticeable overhead on large arrays/specs. Consider adding a cheaper structural equality check (or an early-exit comparison on Kind/Tag/Value) before falling back to the encoder-based comparison, so non-append cases can skip the expensive work quickly.
Contributor
📊 Test Coverage ReportCurrent Coverage: Coverage Change: ✅ No change Coverage by Package
📋 Detailed Coverage by Function (click to expand)
Generated by GitHub Actions |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.