Skip to content

Mark deprecated config fields as transient#498

Merged
nikita-tkachenko-datadog merged 2 commits into
masterfrom
nikita-tkachenko/make-deprecated-config-values-transient
Jan 21, 2025
Merged

Mark deprecated config fields as transient#498
nikita-tkachenko-datadog merged 2 commits into
masterfrom
nikita-tkachenko/make-deprecated-config-values-transient

Conversation

@nikita-tkachenko-datadog

@nikita-tkachenko-datadog nikita-tkachenko-datadog commented Jan 21, 2025

Copy link
Copy Markdown
Collaborator

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Marks deprecated config values with transient modifier.
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 transient does).

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)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Fixed Fixed features results into a bug fix version bump label Jan 21, 2025
@nikita-tkachenko-datadog
nikita-tkachenko-datadog marked this pull request as ready for review January 21, 2025 16:32
@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit dcba8aa into master Jan 21, 2025
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/make-deprecated-config-values-transient branch January 21, 2025 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/Fixed Fixed features results into a bug fix version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants