[JENKINS-71715] Allow plugins with alternate build log visualizations to handle console links from core and other plugins

core/src/main/java/hudson/Functions.java

@@ -148,6 +148,7 @@
 import javax.servlet.http.Cookie;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
+import jenkins.console.ConsoleUrlProvider;
 import jenkins.model.GlobalConfiguration;
 import jenkins.model.GlobalConfigurationCategory;
 import jenkins.model.Jenkins;
@@ -1903,6 +1904,16 @@ public static String joinPath(String... components) {
             return joinPath(Stapler.getCurrentRequest().getContextPath() + '/' + itUrl, urlName);
     }
 
+    /**
+     * Computes the link to the console for the specified build, taking {@link ConsoleUrlProvider} into account.
+     * @param run the build
+     * @return the absolute URL for accessing the specified build's console
+     * @since TODO
+     */
+    public static @CheckForNull String getConsoleUrl(Run<?, ?> run) {
+        return ConsoleUrlProvider.getRedirectUrl(run);
+    }
+
     /**
      * Escapes the character unsafe for e-mail address.
      * See <a href="https://en.wikipedia.org/wiki/Email_address">the Wikipedia page</a> for the details,

core/src/main/java/jenkins/console/ConsoleURLProvider.java

@@ -0,0 +1,90 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2023, CloudBees, Inc.
+ *
+ * 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.console;
+
+
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.ExtensionList;
+import hudson.ExtensionPoint;
+import hudson.Functions;
+import hudson.model.Run;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.NoExternalUse;
+import org.kohsuke.stapler.Stapler;
+
+/**
+ * Extension point that allows implementations to redirect build console links to a specified URL.
+ * <p>In order to produce links to console URLs in Jelly templates, use {@link Functions#getConsoleUrl()}.
+ * @see Functions#getConsoleUrl
+ * @since TODO
+ */
+public interface ConsoleUrlProvider extends ExtensionPoint {
+    @Restricted(NoExternalUse.class)
+    Logger LOGGER = Logger.getLogger(ConsoleUrlProvider.class.getName());
+
+    /**
+     * Get a URL relative to the context path of Jenkins which should be used to link to the console for the specified build.
+     * <p>Should only be used in the context of serving an HTTP request.
+     * @param run the build
+     * @return the URL for the console for the specified build, relative to the context of Jenkins, or {@code null}
+     * if this implementation does not want to server a special console view for this build.
+     */
+    @CheckForNull String getConsoleUrl(Run<?, ?> run);
+
+    /**
+     * Get a URL relative to the web server root which should be used to link to the console for the specified build.
+     * <p>Should only be used in the context of serving an HTTP request.
+     * <p>Use {@link Functions#getConsoleUrl} to obtain this link in a Jelly template.
+     * @param run the build
+     * @return the URL for the console for the specified build, relative to the web server root
+     */
+    static @NonNull String getRedirectUrl(Run<?, ?> run) {
+        String url = null;
+        for (ConsoleUrlProvider provider : ExtensionList.lookup(ConsoleUrlProvider.class)) {
+            try {
+                url = provider.getConsoleUrl(run);
+                if (url != null) {
+                    break;
+                }
+            } catch (Exception e) { // Intentionally broad catch clause to guard against broken implementations.
+                LOGGER.log(Level.WARNING, e, () -> "Error looking up console URL for " + run + " from " + provider.getClass());
+            }
+        }
+        if (url == null) {
+            url = run.getUrl() + "console";
+        }
+        // TODO:
+        // * Fail if absolute URL?
+        // * Fail if invalid URI (as above in getActionUrl?).
+        if (url.startsWith("/")) {
+            return Stapler.getCurrentRequest().getContextPath() + url;
+        } else {
+            return Stapler.getCurrentRequest().getContextPath() + '/' + url;
+        }
+    }
+}

core/src/main/resources/hudson/model/AbstractBuild/changes.jelly

@@ -40,7 +40,7 @@ THE SOFTWARE.
           ${%Not yet determined}
         </j:when>
         <j:otherwise>
-          ${%Failed to determine} (<a href="console">${%log}</a>)
+          ${%Failed to determine} (<a href="${h.getConsoleUrl(it)}">${%log}</a>)
         </j:otherwise>
       </j:choose>
     </l:main-panel>

core/src/main/resources/hudson/model/AbstractBuild/index.jelly

@@ -98,7 +98,7 @@ THE SOFTWARE.
               ${%Not yet determined}
             </j:when>
             <j:otherwise>
-              ${%Failed to determine} (<a href="console">${%log}</a>)
+              ${%Failed to determine} (<a href="${h.getConsoleUrl(it)}">${%log}</a>)
             </j:otherwise>
           </j:choose>
         </t:summary>

core/src/main/resources/hudson/widgets/HistoryWidget/entry.jelly

@@ -38,7 +38,7 @@ THE SOFTWARE.
     <td class="build-row-cell">
       <div class="pane build-name">
         <div class="build-icon">
-          <a class="build-status-link" href="${link}console" tooltip="${build.iconColor.description} > ${%Console Output}">
+          <a class="build-status-link" href="${h.getConsoleUrl(build)}" tooltip="${build.iconColor.description} > ${%Console Output}">
             <l:icon class="${build.buildStatusIconClassName} icon-sm" />
           </a>
         </div>

core/src/main/resources/lib/hudson/buildProgressBar.jelly

@@ -26,6 +26,7 @@ THE SOFTWARE.
   <st:documentation>
     Progress bar for a build in progress.
 
+    <!-- TODO: Do Functions.getConsoleUrl and ConsoleUrlProvider need to be adapted to use Queue.Executable instead of Run? -->
     <st:attribute name="build" use="required" type="hudson.model.Queue.Executable">
       Build in progress. Must have a url property.
     </st:attribute>
@@ -36,5 +37,5 @@ THE SOFTWARE.
   <j:set var="executor" value="${executor?:build.executor}" /> <!-- TODO use Executor.of -->
   <t:progressBar tooltip="${%text(executor.timestampString,executor.estimatedRemainingTime)}"
                  red="${executor.isLikelyStuck()}"
-                 pos="${executor.progress}" href="${rootURL}/${build.url}console"/>
+                 pos="${executor.progress}" href="${h.getConsoleUrl(build)}"/>
 </j:jelly>

core/src/main/resources/lib/hudson/project/console-link.jelly

@@ -28,11 +28,11 @@ THE SOFTWARE.
     <j:choose>
         <j:when test="${it.logFile.length() > 200000}">
             <!-- Show raw link directly so user need not click through live console page, though this is not so bad now as they would just see: Skipping nnn KB.. Full Log. -->
-            <l:task href="${buildUrl.baseUrl}/console" icon="icon-terminal icon-md" title="${%Console Output}"/>
+            <l:task href="${h.getConsoleUrl(it)}" icon="icon-terminal icon-md" title="${%Console Output}"/>
             <l:task href="${buildUrl.baseUrl}/consoleText" icon="icon-document icon-md" title="${%View as plain text}"/>
         </j:when>
         <j:otherwise>
-            <l:task icon="images/svgs/terminal.svg" href="${buildUrl.baseUrl}/console" title="${%Console Output}">
+            <l:task icon="images/svgs/terminal.svg" href="${h.getConsoleUrl(it)}" title="${%Console Output}">
                 <l:task href="${buildUrl.baseUrl}/consoleText" icon="icon-document icon-md" title="${%View as plain text}"/>
             </l:task>
         </j:otherwise>

test/src/test/java/jenkins/console/ConsoleUrlProviderTest.java

@@ -0,0 +1,93 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2023 CloudBees, Inc.
+ *
+ * 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.console;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.empty;
+import static org.hamcrest.Matchers.not;
+
+import hudson.model.FreeStyleBuild;
+import hudson.model.FreeStyleProject;
+import hudson.model.Run;
+import org.htmlunit.html.DomElement;
+import org.htmlunit.html.HtmlPage;
+import org.junit.ClassRule;
+import org.junit.Rule;
+import org.junit.Test;
+import org.jvnet.hudson.test.BuildWatcher;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.TestExtension;
+
+public class ConsoleUrlProviderTest {
+    @ClassRule
+    public static BuildWatcher watcher = new BuildWatcher();
+
+    @Rule
+    public JenkinsRule r = new JenkinsRule();
+
+    @Test
+    public void getConsoleUrl() throws Exception {
+        FreeStyleProject p = r.createProject(FreeStyleProject.class);
+        // Default URL
+        FreeStyleBuild b1 = r.buildAndAssertSuccess(p);
+        assertCustomConsoleUrl(r.contextPath + '/' + b1.getUrl() + "console", b1);
+        // Custom URL without leading slash
+        FreeStyleBuild b2 = r.buildAndAssertSuccess(p);
+        b2.setDescription("custom my/build/console");
+        assertCustomConsoleUrl(r.contextPath + "/my/build/console", b2);
+        // Custom URL with leading slash
+        FreeStyleBuild b3 = r.buildAndAssertSuccess(p);
+        b3.setDescription("custom /my/build/console");
+        assertCustomConsoleUrl(r.contextPath + "/my/build/console", b3);
+        // Default URL is used when extensions throw exceptions.
+        FreeStyleBuild b4 = r.buildAndAssertSuccess(p);
+        b4.setDescription("NullPointerException");
+        assertCustomConsoleUrl(r.contextPath + '/' + b4.getUrl() + "console", b4);
+    }
+
+    // Awkward, but we can only call Functions.getConsoleUrl in the context of an HTTP request.
+    public void assertCustomConsoleUrl(String expectedUrl, Run<?, ?> run) throws Exception {
+        HtmlPage page = r.createWebClient().getPage(run.getParent());
+        DomElement buildHistoryDiv = page.getElementById("buildHistory");
+        assertThat("Console link for " + run + " should be " + expectedUrl,
+                buildHistoryDiv.getByXPath("//a[@href='" + expectedUrl + "']"), not(empty()));
+    }
+
+    @TestExtension("getConsoleUrl")
+    public static class CustomConsoleUrlProvider implements ConsoleUrlProvider {
+        @Override
+        public String getConsoleUrl(Run<?, ?> run) {
+            String description = run.getDescription();
+            if (description == null) {
+                return null;
+            } else if (description.startsWith("custom ")) {
+                return description.substring("custom ".length());
+            } else {
+                throw new NullPointerException("getConsoleUrl should be robust against runtime errors");
+            }
+        }
+    }
+
+}