Implement plugin data versioning #390
Merged
Conversation
This file contains 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
nikita-tkachenko-datadog
added
the
changelog/Fixed
drodriguezhdez
previously approved these changes
Feb 2, 2024
| return GitCommitAction.class == type; | ||
| public static final class ConverterV1 extends VersionedConverter<GitCommitAction> { | ||
| public ConverterV1() { | ||
| super(1); |
There was a problem hiding this comment.
Nit: super(1) can be a constant to avoid magic numbers super(VERSION)
There was a problem hiding this comment.
Makes sense, added constants
| String versionString = reader.getAttribute(VERSION_ATTRIBUTE); | ||
| if (versionString == null) { | ||
| // no attribute, data was written by an old version of the plugin | ||
| return null; |
There was a problem hiding this comment.
I guess we're checking null every time we get an action, right?
There was a problem hiding this comment.
Yes, these checks already exist: even before adding these changes it was possible to get a null simply because an action was never added to a run/node (e.g. if CI Visibility was enabled while the run was already in progress, or if whitelist of tracked jobs changed, etc)
drodriguezhdez
approved these changes
Feb 2, 2024
nikita-tkachenko-datadog
deleted the
nikita-tkachenko/plugin-data-versioning
branch
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?
Implements versioning mechanism for plugin data that is serialized to disk.
This helps to avoid deserializing data written by older versions of the plugin in a format that we do not support anymore (currently trying to do so may result in deserializing builds partially - as the result some of the data is not displayed properly in Jenkins UI).
Also, going forward it will be easy to change the data format by adding new converter versions (while ensuring the data written by older versions remains readable).
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.