Merge pull request #17 from jglick/logs-JENKINS-38381

[JEP-210] Log handling rewrite

Author: jglick

.mvn/extensions.xml

@@ -2,6 +2,6 @@
   <extension>
     <groupId>io.jenkins.tools.incrementals</groupId>
     <artifactId>git-changelist-maven-extension</artifactId>
-    <version>1.0-beta-3</version>
+    <version>1.0-beta-4</version>
   </extension>
 </extensions>

pom.xml

@@ -28,7 +28,7 @@
     <parent>
         <groupId>org.jenkins-ci.plugins</groupId>
         <artifactId>plugin</artifactId>
-        <version>3.14</version>
+        <version>3.21</version>
         <relativePath />
     </parent>
     <groupId>org.jenkins-ci.plugins.workflow</groupId>

src/main/java/org/jenkinsci/plugins/workflow/flow/FlowExecutionOwner.java

@@ -35,6 +35,7 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 import jenkins.model.TransientActionFactory;
+import org.jenkinsci.plugins.workflow.log.LogStorage;
 import org.jenkinsci.plugins.workflow.steps.StepContext;
 
 /**
@@ -121,9 +122,15 @@ public String getUrlOfExecution() throws IOException {
     /**
      * Gets a listener to which we may print general messages.
      * Normally {@link StepContext#get} should be used, but in some cases there is no associated step.
+     * <p>The listener should be remotable: if sent to an agent, messages printed to it should still appear in the log.
+     * The same will then apply to calls to {@link StepContext#get} on {@link TaskListener}.
      */
     public @Nonnull TaskListener getListener() throws IOException {
-        return TaskListener.NULL;
+        try {
+            return LogStorage.of(this).overallListener();
+        } catch (InterruptedException x) {
+            throw new IOException(x);
+        }
     }
 
     /**
@@ -167,6 +174,9 @@ private static class DummyOwner extends FlowExecutionOwner {
         @Override public int hashCode() {
             return 0;
         }
+        @Override public TaskListener getListener() throws IOException {
+            return TaskListener.NULL;
+        }
     }
 
 }

src/main/java/org/jenkinsci/plugins/workflow/log/BrokenLogStorage.java

@@ -0,0 +1,86 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2018 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 org.jenkinsci.plugins.workflow.log;
+
+import hudson.Functions;
+import hudson.console.AnnotatedLargeText;
+import hudson.model.BuildListener;
+import hudson.model.TaskListener;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner;
+import org.jenkinsci.plugins.workflow.graph.FlowNode;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.Beta;
+import org.kohsuke.stapler.framework.io.ByteBuffer;
+
+/**
+ * Placeholder for storage broken by some kind of access error.
+ */
+@Restricted(Beta.class)
+public final class BrokenLogStorage implements LogStorage {
+
+    private final Throwable x;
+
+    public BrokenLogStorage(Throwable x) {
+        this.x = x;
+    }
+    
+    @Override public BuildListener overallListener() throws IOException, InterruptedException {
+        throw new IOException(x);
+    }
+    
+    @Override public TaskListener nodeListener(FlowNode node) throws IOException, InterruptedException {
+        throw new IOException(x);
+    }
+    
+    @Override public AnnotatedLargeText<FlowExecutionOwner.Executable> overallLog(FlowExecutionOwner.Executable build, boolean complete) {
+        return new BrokenAnnotatedLargeText<>();
+    }
+    
+    @Override public AnnotatedLargeText<FlowNode> stepLog(FlowNode node, boolean complete) {
+        return new BrokenAnnotatedLargeText<>();
+    }
+
+    private class BrokenAnnotatedLargeText<T> extends AnnotatedLargeText<T> {
+
+        BrokenAnnotatedLargeText() {
+            super(makeByteBuffer(), StandardCharsets.UTF_8, true, null);
+        }
+
+    }
+
+    private ByteBuffer makeByteBuffer() {
+        ByteBuffer buf = new ByteBuffer();
+        byte[] stack = Functions.printThrowable(x).getBytes(StandardCharsets.UTF_8);
+        try {
+            buf.write(stack, 0, stack.length);
+        } catch (IOException x2) {
+            assert false : x2;
+        }
+        return buf;
+    }
+
+}

src/main/java/org/jenkinsci/plugins/workflow/log/ConsoleAnnotators.java

@@ -0,0 +1,107 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2018 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 org.jenkinsci.plugins.workflow.log;
+
+import com.jcraft.jzlib.GZIPInputStream;
+import com.jcraft.jzlib.GZIPOutputStream;
+import com.trilead.ssh2.crypto.Base64;
+import hudson.console.AnnotatedLargeText;
+import hudson.console.ConsoleAnnotationOutputStream;
+import hudson.console.ConsoleAnnotator;
+import hudson.remoting.ClassFilter;
+import hudson.remoting.ObjectInputStreamEx;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import static java.lang.Math.abs;
+import java.util.concurrent.TimeUnit;
+import javax.crypto.Cipher;
+import javax.crypto.CipherInputStream;
+import javax.crypto.CipherOutputStream;
+import jenkins.model.Jenkins;
+import jenkins.security.CryptoConfidentialKey;
+import org.apache.commons.io.output.ByteArrayOutputStream;
+import org.kohsuke.accmod.Restricted;
+import org.kohsuke.accmod.restrictions.Beta;
+import org.kohsuke.stapler.Stapler;
+import org.kohsuke.stapler.StaplerRequest;
+import org.kohsuke.stapler.StaplerResponse;
+
+/**
+ * Some utility code extracted from {@link AnnotatedLargeText} which probably belongs in {@link ConsoleAnnotator} or {@link ConsoleAnnotationOutputStream}.
+ */
+@Restricted(Beta.class)
+public class ConsoleAnnotators {
+
+    private static final CryptoConfidentialKey PASSING_ANNOTATOR = new CryptoConfidentialKey(ConsoleAnnotators.class, "consoleAnnotator");
+
+    /**
+     * What to pass to {@link ConsoleAnnotationOutputStream#ConsoleAnnotationOutputStream} when overriding {@link AnnotatedLargeText#writeHtmlTo}.
+     */
+    public static <T> ConsoleAnnotator<T> createAnnotator(T context) throws IOException {
+        StaplerRequest req = Stapler.getCurrentRequest();
+        try {
+            String base64 = req != null ? req.getHeader("X-ConsoleAnnotator") : null;
+            if (base64 != null) {
+                @SuppressWarnings("deprecation") // TODO still used in the AnnotatedLargeText version
+                Cipher sym = PASSING_ANNOTATOR.decrypt();
+                try (ObjectInputStream ois = new ObjectInputStreamEx(new GZIPInputStream(
+                        new CipherInputStream(new ByteArrayInputStream(Base64.decode(base64.toCharArray())), sym)),
+                        Jenkins.get().pluginManager.uberClassLoader,
+                        ClassFilter.DEFAULT)) {
+                    long timestamp = ois.readLong();
+                    if (TimeUnit.HOURS.toMillis(1) > abs(System.currentTimeMillis() - timestamp)) {
+                        @SuppressWarnings("unchecked") ConsoleAnnotator<T> annotator = (ConsoleAnnotator) ois.readObject();
+                        return annotator;
+                    }
+                }
+            }
+        } catch (ClassNotFoundException e) {
+            throw new IOException(e);
+        }
+        return ConsoleAnnotator.initial(context);
+    }
+
+    /**
+     * What to call at the end of an override of {@link AnnotatedLargeText#writeHtmlTo}.
+     */
+    public static void setAnnotator(ConsoleAnnotator<?> annotator) throws IOException {
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        @SuppressWarnings("deprecation") // TODO still used in the AnnotatedLargeText version
+        Cipher sym = PASSING_ANNOTATOR.encrypt();
+        try (ObjectOutputStream oos = new ObjectOutputStream(new GZIPOutputStream(new CipherOutputStream(baos, sym)))) {
+            oos.writeLong(System.currentTimeMillis());
+            oos.writeObject(annotator);
+        }
+        StaplerResponse rsp = Stapler.getCurrentResponse();
+        if (rsp != null) {
+            rsp.setHeader("X-ConsoleAnnotator", new String(Base64.encode(baos.toByteArray())));
+        }
+    }
+
+    private ConsoleAnnotators() {}
+
+}