Fix: make Policy.IncludeChildren and Policy.Global tri-state (*bool) so explicit false is serialized#52
Open
ottramst wants to merge 1 commit intoDependencyTrack:mainfrom
Open
Conversation
…so explicit false is serialized
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Pull Request Overview
This PR changes the Policy struct's IncludeChildren and Global fields from bool to *bool (boolean pointers), allowing them to be explicitly set to true, false, or omitted (nil). This enables proper JSON serialization/deserialization with the omitempty tag, so these fields are only included in the JSON when explicitly set rather than always including their zero values.
- Changed field types from
boolto*boolin thePolicystruct - Added comprehensive test coverage for JSON encoding, decoding, and round-trip scenarios
- Tests verify proper handling of nil, true, and false values for both fields
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| policy.go | Modified IncludeChildren and Global fields in Policy struct from bool to *bool |
| policy_test.go | Added comprehensive test suite covering JSON marshaling/unmarshaling with nil and explicit boolean values, including usage of OptionalBoolOf helper function |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
This PR changes two Policy fields in the Go client.
Rationale: with omitempty on non-pointer booleans, an explicit false is dropped from JSON, which prevents API callers from intentionally setting false. Moving to *bool enables proper tri-state behavior:
This unblocks providers/clients (e.g., Terraform providers) from sending deterministic values and avoids “inconsistent result after apply” diffs caused by server defaults overriding omitted fields.
Problem
When a caller sets:
The JSON encoder omits both fields due to
omitempty+ zero value:Servers may default these flags (e.g.,
global=true), so a subsequent read returns:Infra tooling (Terraform) then reports:
This makes it impossible to reliably set false.
Solution
Change
Policy.IncludeChildrenandPolicy.Globalto pointers:nil.