internal: add structdiff.IsEqual() #4203
Merged
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
denik
requested review from
andrewnester,
anton-107,
pietern and
shreyas-goenka
as code owners
| zero1 := v1Field.IsZero() | ||
| zero2 := v2Field.IsZero() | ||
|
|
||
| if zero1 || zero2 { |
Contributor
There was a problem hiding this comment.
What about the other way around? Fields that are nil but are present in ForceSendFields should be set to their zero value.
Contributor
Author
There was a problem hiding this comment.
not sure what you mean, can you post an example testcase?
Contributor
There was a problem hiding this comment.
consider:
a = foo{
myfield: nil,
ForceSendFields: []{"myfield"}
}
b = foo{
myfield: "",
ForceSendFields: []{"myfield"}
}
a and b should be equal in this case, regardless of the omitempty annotation.
Contributor
Author
There was a problem hiding this comment.
what type is myfield? it's not a string, right?
Contributor
Author
There was a problem hiding this comment.
In Go SDK ForceSendFields is only meaningful on "basic" types https://github.com/databricks/databricks-sdk-go/blob/main/marshal/types.go#L5
in cli repo libs/structs and libs/dyn we also apply on maps and slices. However, AFAIK it is never applied it to pointers.
pietern
approved these changes
Jan 6, 2026
Collaborator
|
Commit: 091ee38
26 interesting tests: 21 KNOWN, 2 flaky, 2 FAIL, 1 SKIP
Top 50 slowest tests (at least 2 minutes):
|
andrewnester
reviewed
Jan 6, 2026
| return false | ||
| } | ||
|
|
||
| return equalValues(v1, v2) |
Contributor
There was a problem hiding this comment.
Can't we just use reflect.DeepEqual here?
Contributor
Author
There was a problem hiding this comment.
no, see the comment about ForceSendFields
Contributor
Author
There was a problem hiding this comment.
This PR is prompted by a real issue btw where I did use reflect.DeepEqual but it did not do what's expected because ForceSendFields in one case was set but not in the other.
SDK always adds fields to ForceSendFields regardless of whether they are needed there or not. Our code in many places only adds it if the value is zero.
Collaborator
|
Commit: 2f558af
65 interesting tests: 23 MISS, 21 KNOWN, 16 FAIL, 3 flaky, 1 PANIC, 1 SKIP
Top 50 slowest tests (at least 2 minutes):
|
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.
Changes
New function structdiff.IsEqual() which follows the same logic as structdiff.GetStructDiff() but does not build a diff.
Why
Need this in #4201
reflect.DeepEqual() does not work for types with ForceSendFields because ForceSendFields can have more or less fields in it without changing the actual value.
Tests
Unit tests.