[JENKINS-42584] Fix upstream job priority retrieval

jenkinsci · Mar 22, 2017 · 685c572 · 685c572
1 parent 20af6e4
commit 685c572
Show file tree

Hide file tree

Showing 4 changed files with 161 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ work
 *.iml
 .settings
 .project
-.classpath
+.classpath
+/bin/
diff --git a/src/main/java/jenkins/advancedqueue/priority/strategy/UpstreamCauseStrategy.java b/src/main/java/jenkins/advancedqueue/priority/strategy/UpstreamCauseStrategy.java
@@ -33,6 +33,7 @@
 import jenkins.advancedqueue.PrioritySorterConfiguration;
 import jenkins.advancedqueue.sorter.ItemInfo;
 import jenkins.advancedqueue.sorter.QueueItemCache;
+import jenkins.advancedqueue.sorter.StartedJobItemCache;
 
 import org.kohsuke.stapler.DataBoundConstructor;
 
@@ -64,8 +65,10 @@ private UpstreamCause getUpstreamCause(Queue.Item item) {
 	}
 
 	public int getPriority(Queue.Item item) {
-		int upstreamBuildId = getUpstreamCause(item).getUpstreamBuild();
-		ItemInfo upstreamItem = QueueItemCache.get().getItem(upstreamBuildId);
+		UpstreamCause upstreamCause = getUpstreamCause(item);
+		String upstreamProject = upstreamCause.getUpstreamProject();
+		int upstreamBuildId = upstreamCause.getUpstreamBuild();
+		ItemInfo upstreamItem = StartedJobItemCache.get().getStartedItem(upstreamProject, upstreamBuildId);
 		// Upstream Item being null should be very very rare
 		if (upstreamItem != null) {
 			return upstreamItem.getPriority();

diff --git a/src/main/java/jenkins/advancedqueue/sorter/AdvancedQueueSorter.java b/src/main/java/jenkins/advancedqueue/sorter/AdvancedQueueSorter.java
@@ -117,7 +117,7 @@ public int compare(BuildableItem o1, BuildableItem o2) {
 	 * Returned the calculated, cached, weight or calculates the weight if missing. Should only be
 	 * called when the value should already be there, if the item is new {@link #onNewItem(Item)} is
 	 * the method to call.
-	 * 
+	 *
 	 * @param item the item to get the weight for
 	 * @return the calculated weight
 	 */
@@ -147,6 +147,7 @@ public void onLeft(LeftItem li) {
 			prioritySorterStrategy.onCanceledItem(li);
 			logCanceledItem(itemInfo);
 		} else {
+			StartedJobItemCache.get().addItem(itemInfo, li.outcome.getPrimaryWorkUnit());
 			prioritySorterStrategy.onStartedItem(li, weight);
 			logStartedItem(itemInfo);
 		}

diff --git a/src/main/java/jenkins/advancedqueue/sorter/StartedJobItemCache.java b/src/main/java/jenkins/advancedqueue/sorter/StartedJobItemCache.java
@@ -0,0 +1,152 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2013, Ronny Schuetz
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package jenkins.advancedqueue.sorter;
+
+import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.concurrent.TimeUnit;
+
+import com.google.common.base.Objects;
+import com.google.common.cache.Cache;
+import com.google.common.cache.CacheBuilder;
+
+import hudson.model.Run;
+import hudson.model.queue.WorkUnit;
+
+/**
+ * Keeps track of the Queue.Items seen by the Sorter, but removed from the queue
+ * to become jobs, for UpstreamCauseStrategy.
+ *
+ * @author Ronny Schuetz
+ * @since 2.3
+ */
+public class StartedJobItemCache {
+
+	private static final int RETENTION_COUNT = 10000;
+	private static final int RETENTION_TIME_HOURS = 12;
+
+	private static StartedJobItemCache startedJobItemCache = null;
+
+	static {
+		startedJobItemCache = new StartedJobItemCache();
+	}
+
+	public static StartedJobItemCache get() {
+		return startedJobItemCache;
+	}
+
+	private static class PendingItem {
+		final long startTime;
+		final ItemInfo itemInfo;
+		final WorkUnit workUnit;
+
+		public PendingItem(final ItemInfo itemInfo, final WorkUnit workUnit) {
+			this.startTime = System.currentTimeMillis();
+			this.itemInfo = itemInfo;
+			this.workUnit = workUnit;
+		}
+	}
+
+	private static class StartedItem {
+		final String projectName;
+		final int buildNumber;
+
+		public StartedItem(final String projectName, final int buildNumber) {
+			this.projectName = projectName;
+			this.buildNumber = buildNumber;
+		}
+
+		@Override
+		public int hashCode() {
+			return Objects.hashCode(projectName, buildNumber);
+		}
+
+		@Override
+		public boolean equals(Object obj) {
+			if (obj == null)
+				return false;
+			if (getClass() != obj.getClass())
+				return false;
+			final StartedItem other = (StartedItem) obj;
+			return Objects.equal(this.projectName, other.projectName) && this.buildNumber == other.buildNumber;
+		}
+	}
+
+	private LinkedList<PendingItem> pendingItems = new LinkedList<PendingItem>();
+
+	private final Cache<StartedItem, ItemInfo> startedItems = CacheBuilder.newBuilder()
+			.expireAfterWrite(RETENTION_TIME_HOURS, TimeUnit.HOURS).maximumSize(RETENTION_COUNT).build();
+
+	private StartedJobItemCache() {
+	}
+
+	/**
+	 * Gets the Item for a started job, already removed from the queue
+	 *
+	 * @param projectName
+	 *            the project name
+	 * @param buildNumber
+	 *            the build number
+	 * @return the {@link ItemInfo} for the provided id or <code>null</code> if
+	 *         projectName/buildNumber combination is unknown
+	 */
+	public synchronized ItemInfo getStartedItem(String projectName, int buildNumber) {
+		maintainCache();
+		return startedItems.getIfPresent(new StartedItem(projectName, buildNumber));
+	}
+
+	public synchronized void addItem(ItemInfo itemInfo, WorkUnit primaryWorkUnit) {
+		pendingItems.addLast(new PendingItem(itemInfo, primaryWorkUnit));
+		maintainCache();
+	}
+
+	private void maintainCache() {
+		// Collect job information from pending items to drop WorkUnit reference
+
+		for (final Iterator<PendingItem> it = pendingItems.iterator(); it.hasNext();) {
+			final PendingItem pi = it.next();
+			final Run<?, ?> run = (Run<?, ?>) pi.workUnit.getExecutable();
+
+			if (run != null) {
+				startedItems.put(new StartedItem(pi.itemInfo.getJobName(), run.getNumber()), pi.itemInfo);
+				it.remove();
+			}
+		}
+
+		// Cleanup pendingItems
+
+		if (pendingItems.size() > RETENTION_COUNT) {
+			pendingItems.subList(0, pendingItems.size() - RETENTION_COUNT).clear();
+		}
+
+		for (final Iterator<PendingItem> it = pendingItems.iterator(); it.hasNext();) {
+			final PendingItem pi = it.next();
+			if (pi.startTime < System.currentTimeMillis() - RETENTION_TIME_HOURS * 60 * 60 * 1000) {
+				it.remove();
+			} else {
+				break;
+			}
+		}
+	}
+}