Introduce HistoricalBuild interface

core/src/main/java/hudson/model/Job.java

@@ -89,6 +89,7 @@
 import jenkins.model.BuildDiscarder;
 import jenkins.model.BuildDiscarderProperty;
 import jenkins.model.DirectlyModifiableTopLevelItemGroup;
+import jenkins.model.HistoricalBuild;
 import jenkins.model.Jenkins;
 import jenkins.model.JenkinsLocationConfiguration;
 import jenkins.model.ModelObjectWithChildren;
@@ -632,9 +633,9 @@ protected HistoryWidget createHistoryWidget() {
         throw new IllegalStateException("HistoryWidget is now created via WidgetFactory implementation");
     }
 
-    public static final HistoryWidget.Adapter<Run> HISTORY_ADAPTER = new Adapter<>() {
+    public static final HistoryWidget.Adapter<HistoricalBuild> HISTORY_ADAPTER = new Adapter<>() {
         @Override
-        public int compare(Run record, String key) {
+        public int compare(HistoricalBuild record, String key) {
             try {
                 int k = Integer.parseInt(key);
                 return record.getNumber() - k;
@@ -644,12 +645,12 @@ public int compare(Run record, String key) {
         }
 
         @Override
-        public String getKey(Run record) {
+        public String getKey(HistoricalBuild record) {
             return String.valueOf(record.getNumber());
         }
 
         @Override
-        public boolean isBuilding(Run record) {
+        public boolean isBuilding(HistoricalBuild record) {
             return record.isBuilding();
         }
 

core/src/main/java/hudson/model/Run.java

@@ -112,6 +112,7 @@
 import jenkins.model.ArtifactManagerConfiguration;
 import jenkins.model.ArtifactManagerFactory;
 import jenkins.model.BuildDiscarder;
+import jenkins.model.HistoricalBuild;
 import jenkins.model.Jenkins;
 import jenkins.model.JenkinsLocationConfiguration;
 import jenkins.model.RunAction2;
@@ -153,23 +154,14 @@
  */
 @ExportedBean
 public abstract class Run<JobT extends Job<JobT, RunT>, RunT extends Run<JobT, RunT>>
-        extends Actionable implements ExtensionPoint, Comparable<RunT>, AccessControlled, PersistenceRoot, DescriptorByNameOwner, OnMaster, StaplerProxy {
+        extends Actionable implements ExtensionPoint, Comparable<RunT>, AccessControlled, PersistenceRoot, DescriptorByNameOwner, OnMaster, StaplerProxy, HistoricalBuild {
 
     /**
      * The original {@link Queue.Item#getId()} has not yet been mapped onto the {@link Run} instance.
      * @since 1.601
      */
     public static final long QUEUE_ID_UNKNOWN = -1;
 
-    /**
-     * Target size limit for truncated {@link #description}s in the Build History Widget.
-     * This is applied to the raw, unformatted description. Especially complex formatting
-     * like hyperlinks can result in much less text being shown than this might imply.
-     * Negative values will disable truncation, {@code 0} will enforce empty strings.
-     * @since 2.223
-     */
-    private static /* non-final for Groovy */ int TRUNCATED_DESCRIPTION_LIMIT = SystemProperties.getInteger("historyWidget.descriptionLimit", 100);
-
     protected final transient @NonNull JobT project;
 
     /**
@@ -457,12 +449,12 @@ public int compareTo(@NonNull RunT that) {
     }
 
     /**
-     * Get the {@link Queue.Item#getId()} of the original queue item from where this Run instance
-     * originated.
-     * @return The queue item ID.
+     * {@inheritDoc}
+     *
      * @since 1.601
      */
     @Exported
+    @Override
     public long getQueueId() {
         return queueId;
     }
@@ -478,15 +470,8 @@ public void setQueueId(long queueId) {
         this.queueId = queueId;
     }
 
-    /**
-     * Returns the build result.
-     *
-     * <p>
-     * When a build is {@link #isBuilding() in progress}, this method
-     * returns an intermediate result.
-     * @return The status of the build, if it has completed or some build step has set a status; may be null if the build is ongoing.
-     */
     @Exported
+    @Override
     public @CheckForNull Result getResult() {
         return result;
     }
@@ -514,6 +499,7 @@ public void setResult(@NonNull Result r) {
     /**
      * Gets the subset of {@link #getActions()} that consists of {@link BuildBadgeAction}s.
      */
+    @Override
     public @NonNull List<BuildBadgeAction> getBadgeActions() {
         List<BuildBadgeAction> r = getActions(BuildBadgeAction.class);
         if (isKeepLog()) {
@@ -523,11 +509,8 @@ public void setResult(@NonNull Result r) {
         return r;
     }
 
-    /**
-     * Returns true if the build is not completed yet.
-     * This includes "not started yet" state.
-     */
     @Exported
+    @Override
     public boolean isBuilding() {
         return state.compareTo(State.POST_PRODUCTION) < 0;
     }
@@ -646,11 +629,11 @@ public final boolean isKeepLog() {
     }
 
     /**
-     * When the build is scheduled.
-     *
+     * {@inheritDoc}
      * @see #getStartTimeInMillis()
      */
     @Exported
+    @Override
     public @NonNull Calendar getTimestamp() {
         GregorianCalendar c = new GregorianCalendar();
         c.setTimeInMillis(timestamp);
@@ -685,73 +668,12 @@ public final long getStartTimeInMillis() {
     }
 
     @Exported
+    @Override
     @CheckForNull
     public String getDescription() {
         return description;
     }
 
-
-    /**
-     * Returns the length-limited description.
-     * The method tries to take HTML tags within the description into account, but it is a best-effort attempt.
-     * Also, the method will likely not work properly if a non-HTML {@link hudson.markup.MarkupFormatter} is used.
-     * @return The length-limited description.
-     * @deprecated truncated description based on the {@link #TRUNCATED_DESCRIPTION_LIMIT} setting.
-     */
-    @Deprecated
-    public @CheckForNull String getTruncatedDescription() {
-        if (TRUNCATED_DESCRIPTION_LIMIT < 0) { // disabled
-            return description;
-        }
-        if (TRUNCATED_DESCRIPTION_LIMIT == 0) { // Someone wants to suppress descriptions, why not?
-            return "";
-        }
-
-        final int maxDescrLength = TRUNCATED_DESCRIPTION_LIMIT;
-        final String localDescription = description;
-        if (localDescription == null || localDescription.length() < maxDescrLength) {
-            return localDescription;
-        }
-
-        final String ending = "...";
-        final int sz = localDescription.length(), maxTruncLength = maxDescrLength - ending.length();
-
-        boolean inTag = false;
-        int displayChars = 0;
-        int lastTruncatablePoint = -1;
-
-        for (int i = 0; i < sz; i++) {
-            char ch = localDescription.charAt(i);
-            if (ch == '<') {
-                inTag = true;
-            } else if (ch == '>') {
-                inTag = false;
-                if (displayChars <= maxTruncLength) {
-                    lastTruncatablePoint = i + 1;
-                }
-            }
-            if (!inTag) {
-                displayChars++;
-                if (displayChars <= maxTruncLength && ch == ' ') {
-                    lastTruncatablePoint = i;
-                }
-            }
-        }
-
-        String truncDesc = localDescription;
-
-        // Could not find a preferred truncatable index, force a trunc at maxTruncLength
-        if (lastTruncatablePoint == -1)
-            lastTruncatablePoint = maxTruncLength;
-
-        if (displayChars >= maxDescrLength) {
-            truncDesc = truncDesc.substring(0, lastTruncatablePoint) + ending;
-        }
-
-        return truncDesc;
-
-    }
-
     /**
      * Gets the string that says how long since this build has started.
      *
@@ -770,9 +692,7 @@ public String getDescription() {
         return Util.XS_DATETIME_FORMATTER2.format(Instant.ofEpochMilli(timestamp));
     }
 
-    /**
-     * Gets the string that says how long the build took to run.
-     */
+    @Override
     public @NonNull String getDurationString() {
         if (hasntStartedYet()) {
             return Messages.Run_NotStartedYet();
@@ -791,9 +711,7 @@ public long getDuration() {
         return duration;
     }
 
-    /**
-     * Gets the icon color for display.
-     */
+    @Override
     public @NonNull BallColor getIconColor() {
         if (!isBuilding()) {
             // already built
@@ -828,6 +746,7 @@ public String toString() {
     }
 
     @Exported
+    @Override
     public String getFullDisplayName() {
         return project.getFullDisplayName() + ' ' + getDisplayName();
     }
@@ -853,6 +772,7 @@ public void setDisplayName(String value) throws IOException {
     }
 
     @Exported(visibility = 2)
+    @Override
     public int getNumber() {
         return number;
     }
@@ -1030,14 +950,8 @@ protected void dropLinks() {
         return nextBuild;
     }
 
-    /**
-     * Returns the URL of this {@link Run}, relative to the context root of Hudson.
-     *
-     * @return
-     *      String like "job/foo/32/" with trailing slash but no leading slash.
-     */
-    // I really messed this up. I'm hoping to fix this some time
-    // it shouldn't have trailing '/', and instead it should have leading '/'
+
+    @Override
     public @NonNull String getUrl() {
 
         // RUN may be accessed using permalinks, as "/lastSuccessful" or other, so try to retrieve this base URL
@@ -1093,6 +1007,12 @@ protected void dropLinks() {
         return new File(project.getBuildDir(), Integer.toString(number));
     }
 
+    @Override
+    public List<ParameterValue> getParameterValues() {
+        ParametersAction a = getAction(ParametersAction.class);
+        return a != null ? a.getParameters() : List.of();
+    }
+
     /**
      * Gets an object responsible for storing and retrieving build artifacts.
      * If {@link #pickArtifactManager} has previously been called on this build,
@@ -2161,14 +2081,6 @@ public void doBuildStatus(StaplerRequest req, StaplerResponse rsp) throws IOExce
         rsp.sendRedirect2(req.getContextPath() + "/images/48x48/" + getBuildStatusUrl());
     }
 
-    public @NonNull String getBuildStatusUrl() {
-        return getIconColor().getImage();
-    }
-
-    public String getBuildStatusIconClassName() {
-        return getIconColor().getIconClassName();
-    }
-
     public static class Summary {
         /**
          * Is this build worse or better, compared to the previous build?

core/src/main/java/hudson/widgets/BuildHistoryWidget.java

@@ -33,6 +33,7 @@
 import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
+import jenkins.model.HistoricalBuild;
 import jenkins.model.Jenkins;
 import jenkins.model.queue.QueueItem;
 import jenkins.widgets.HistoryPageFilter;
@@ -47,7 +48,7 @@
  * <p>
  * This widget enhances {@link HistoryWidget} by groking the notion
  * that {@link #owner} can be in the queue toward the next build.
- *
+ * @param <T> typically {@link HistoricalBuild}
  * @author Kohsuke Kawaguchi
  */
 public class BuildHistoryWidget<T> extends HistoryWidget<Task, T> {
@@ -84,7 +85,6 @@ public HistoryPageFilter getHistoryPageFilter() {
         final HistoryPageFilter<T> historyPageFilter = newPageFilter();
 
         historyPageFilter.add(baseList, getQueuedItems());
-        historyPageFilter.widget = this;
 
         return updateFirstTransientBuildKey(historyPageFilter);
     }

core/src/main/java/hudson/widgets/HistoryWidget.java

@@ -31,7 +31,6 @@
 import hudson.model.Job;
 import hudson.model.ModelObject;
 import hudson.model.Queue;
-import hudson.model.Run;
 import hudson.util.AlternativeUiTextProvider;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -40,6 +39,7 @@
 import java.util.Iterator;
 import java.util.List;
 import javax.servlet.ServletException;
+import jenkins.model.HistoricalBuild;
 import jenkins.util.SystemProperties;
 import jenkins.widgets.HistoryPageEntry;
 import jenkins.widgets.HistoryPageFilter;
@@ -53,12 +53,12 @@
 import org.kohsuke.stapler.StaplerResponse;
 
 /**
- * Displays the history of records (normally {@link Run}s) on the side panel.
+ * Displays the history of records on the side panel.
  *
  * @param <O>
- *      Owner of the widget.
+ *      Owner of the widget, typically {@link Job}
  * @param <T>
- *      Type individual record.
+ *      Type individual record, typically {@link HistoricalBuild}
  * @author Kohsuke Kawaguchi
  */
 public class HistoryWidget<O extends ModelObject, T> extends Widget {
@@ -142,7 +142,7 @@ public String getFirstTransientBuildKey() {
      * @return
      *      The history page filter that was passed in.
      */
-    @SuppressWarnings("unchecked")
+    @SuppressWarnings("unchecked") // TODO actually not type-safe
     protected HistoryPageFilter updateFirstTransientBuildKey(HistoryPageFilter historyPageFilter) {
         updateFirstTransientBuildKey(historyPageFilter.runs);
         return historyPageFilter;
@@ -195,7 +195,7 @@ private List<HistoryPageEntry<T>> toPageEntries(Iterable<T> historyItemList) {
     /**
      * Get a {@link jenkins.widgets.HistoryPageFilter} for rendering a page of queue items.
      */
-    public HistoryPageFilter getHistoryPageFilter() {
+    public HistoryPageFilter<T> getHistoryPageFilter() {
         HistoryPageFilter<T> historyPageFilter = newPageFilter();
 
         historyPageFilter.add(baseList);
@@ -205,6 +205,7 @@ public HistoryPageFilter getHistoryPageFilter() {
 
     protected HistoryPageFilter<T> newPageFilter() {
         HistoryPageFilter<T> historyPageFilter = new HistoryPageFilter<>(THRESHOLD);
+        historyPageFilter.widget = this;
 
         if (newerThan != null) {
             historyPageFilter.setNewerThan(newerThan);