chore(go.d/pkg/logs): make CSVConfig.CheckField unexported - #21525
Closed
ilyam8 wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the CSVConfig struct by making its CheckField field unexported (renamed to checkField) and introducing a SetCheckField setter method. This change allows the omitempty YAML tag on the parent ParserConfig.CSV field to work correctly, preventing empty csv_config: {} from appearing in YAML output when all configuration fields are empty.
Key Changes:
- Made CSVConfig.CheckField unexported (checkField)
- Added SetCheckField() setter method for external configuration
- Updated all usages across test files and collectors to use the setter method
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file| File | Description |
|---|---|
| src/go/plugin/go.d/pkg/logs/csv.go | Renamed CheckField to checkField and added SetCheckField setter method |
| src/go/plugin/go.d/pkg/logs/csv_test.go | Updated test to directly assign to unexported checkField |
| src/go/plugin/go.d/collector/weblog/collector.go | Refactored to use SetCheckField after struct initialization |
| src/go/plugin/go.d/collector/weblog/parser_test.go | Updated test to use SetCheckField method |
| src/go/plugin/go.d/collector/weblog/collector_test.go | Updated multiple test functions to use SetCheckField method |
| src/go/plugin/go.d/collector/squidlog/collector.go | Refactored to use SetCheckField after struct initialization |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
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
Reviewers
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.
The CSVConfig struct was always being marshaled as csv_config: {} in YAML output, even when all configuration fields were empty. This prevented the omitempty tag on the parent ParserConfig.CSV field from working correctly.
The issue was caused by the exported CheckField function field, which cannot be marshaled to YAML but still prevented the struct from being considered "empty" for omitempty purposes.
Summary
Test Plan
Additional Information
For users: How does this change affect me?Summary by cubic
Fix YAML marshaling of CSVConfig so empty configs are omitted from output. Made the function field internal and added a setter to keep it out of serialization.
Written for commit e7ed7a2. Summary will update on new commits.