Mark deprecated config fields as transient#498
Merged
nikita-tkachenko-datadog merged 2 commits intoJan 21, 2025
Merged
Conversation
nikita-tkachenko-datadog
marked this pull request as ready for review
January 21, 2025 16:32
drodriguezhdez
approved these changes
Jan 21, 2025
nikita-tkachenko-datadog
deleted the
nikita-tkachenko/make-deprecated-config-values-transient
branch
January 21, 2025 17:11
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.
Requirements for Contributing to this repository
What does this PR do?
Marks deprecated config values with
transientmodifier.As the result these values will not be written to disk when the configuration is persisted.
The goal is to read these values when the configuration is loaded from an older XML (which still happens despite them being transient), but not write them when serializing the config to a v2 XML (which is exactly what
transientdoes).Otherwise they will be read each time a config is being loaded, and the logic that maintains backward compatibility would have to account for this (avoiding using them if the new fields are populated), which would complicate things.
Description of the Change
Alternate Designs
Possible Drawbacks
Verification Process
Additional Notes
Release Notes
Review checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.