[FIXED JENKINS-28843] Stored the unique value in the job configuration #1
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| /target/ | ||
| /.classpath | ||
| /.project | ||
| /.settings |
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| package org.jenkinsci.plugins.uniqueid.impl; | ||
|
|
||
| import hudson.Extension; | ||
| import hudson.init.InitMilestone; | ||
| import hudson.init.Initializer; | ||
| import hudson.model.Item; | ||
| import hudson.model.PersistenceRoot; | ||
| import hudson.model.Job; | ||
| import hudson.model.Run; | ||
| import hudson.util.RunList; | ||
|
|
||
| import jenkins.model.Jenkins; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
|
|
||
| import org.jenkinsci.plugins.uniqueid.implv2.PersistenceRootIdStore; | ||
| import org.kohsuke.accmod.Restricted; | ||
| import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
|
||
| /** | ||
| * Converts legacy UniqueIDs that are stored inside a Folder/Job/Run configuration to UniqueIDs that are stored alongside the Folder/Job/Run. | ||
| * | ||
| */ | ||
| @Restricted(NoExternalUse.class) | ||
| @Extension | ||
| public class IdStoreMigratorV1ToV2 { | ||
|
|
||
| private static Logger LOGGER = Logger.getLogger(IdStoreMigratorV1ToV2.class.getName()); | ||
|
|
||
| /** | ||
| * Migrates any IDs stored in Folder/Job/Run configuration | ||
| * @throws IOException | ||
| */ | ||
|
|
||
| @Initializer(after=InitMilestone.JOB_LOADED, before=InitMilestone.COMPLETED, fatal=true) | ||
| public static void migrateIdStore() throws IOException { | ||
| Jenkins jenkins = Jenkins.getInstance(); | ||
| if (jenkins == null) { | ||
| throw new IllegalStateException("Jenkins is null, so it is impossible to migrate the IDs"); | ||
| } | ||
| File marker = new File(jenkins.getRootDir(), "unique-id-migration.txt"); | ||
| if (marker.exists()) { | ||
|
|
||
| LOGGER.log(Level.INFO, "Migration of IDStore already perfomed, so skipping migration."); | ||
| return; | ||
| } | ||
| LOGGER.log(Level.INFO, "Starting migration of IDs"); | ||
|
|
||
| performMigration(jenkins); | ||
|
|
||
| LOGGER.log(Level.INFO, "Finished migration of IDs"); | ||
| if (!marker.createNewFile()) { | ||
| throw new IOException("Failed to record the completion of the IDStore Migration. " + | ||
| "This will cause performance issues on subsequent startup. " + | ||
| "Please create an empty file at '" + marker.getCanonicalPath() + "'"); | ||
| } | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| static void performMigration(@Nonnull Jenkins jenkins) { | ||
| List<Item> allItems = jenkins.getAllItems(); | ||
|
|
||
| for (Item item : allItems) { | ||
| // can only be Folder or Job here (not a run) - and these both implement PersistenceRoot | ||
| if (item instanceof PersistenceRoot) { | ||
| migrate((PersistenceRoot) item); | ||
| } | ||
| else { | ||
| LOGGER.log(Level.WARNING, "Expected item of type Folder or Job which implement PersistenceRoot, but got a {0} so can not migrate the IdStore for this item", | ||
| item.getClass().getName()); | ||
| } | ||
|
|
||
| if (item instanceof Job) { | ||
| // need to migrate the RunIDs if they exist. | ||
| Job<? extends Job, ? extends Run> job = (Job<? extends Job, ? extends Run>) item; | ||
| RunList<? extends Run> builds = job.getBuilds(); | ||
| for (Run build : builds) { | ||
| migrate(build); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static void migrate(PersistenceRoot pr) { | ||
| LOGGER.log(Level.FINE, "migrating {0}" , pr.toString()); | ||
|
|
||
| try { | ||
| String id = LegacyIdStore.getId(pr); | ||
| if (id != null) { | ||
| PersistenceRootIdStore.create(pr, id); | ||
| LegacyIdStore.removeId(pr); | ||
| } | ||
| } catch (IOException ex) { | ||
| // need to rethrow (but add some context first) otherwise the migration will continue to run | ||
|
There was a problem hiding this comment. I'm not sure what behavior is preferable. Probably it's better to continue the migration. There was a problem hiding this comment. If we continue that the user can end up with a broken analytics system... and mutilple Items that contain non-unique ID |
||
| // and it will not have migrated everything :-( | ||
| throw new IDStoreMigrationException("Failure whilst migrating " + pr.toString(), ex); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Exception to indicate a failure to migrate the IDStore. | ||
| */ | ||
| private static class IDStoreMigrationException extends RuntimeException { | ||
|
|
||
| public IDStoreMigrationException(String message, Throwable cause) { | ||
| super(message,cause); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It causes a binary compatibility issue, but I doubt anybody uses the plugin's API actively. Let's bump the major version digit BTW
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes - but the alternative is to make this return a
booleanand have callers check.Neither are good in my opinion - I could change this to be
IOException(but that is specific to our implementation )