fix(sources): prevent silent data loss on YAML marshal failure#1334
Closed
RafayKhattak wants to merge 2 commits intocybertec-postgresql:masterfrom
Closed
fix(sources): prevent silent data loss on YAML marshal failure#1334RafayKhattak wants to merge 2 commits intocybertec-postgresql:masterfrom
RafayKhattak wants to merge 2 commits intocybertec-postgresql:masterfrom
Conversation
Previously, if yaml.Marshal failed, the error was discarded and os.WriteFile would silently overwrite the user's config file with zero bytes. This commit checks the error and returns it immediately to prevent data corruption. Added unit tests to verify error propagation on write failures.
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.
Description
While auditing the configuration persistence layer, I identified a potential data-loss scenario in
internal/sources/yaml.go.In the
writeSourcesfunction, the error fromyaml.Marshal(mds)was previously being discarded using the blank identifier (_). Becauseos.WriteFileis called immediately afterward using the result of the marshal operation, any failure in the marshaler would result in an empty byte slice being written to the configuration file. This effectively overwrites the user's entire source configuration with zero bytes without reporting an error.Changes in this PR:
writeSourcesto explicitly check and return the error fromyaml.Marshal.os.WriteFilecall is made.internal/sources/yaml_test.gowith table-driven unit tests. These tests verify:AI & Automation Policy
AI/automation tools used: Issue discovery assisted by Gemini and Claude.
Checklist