[JENKINS-54133] Pregenerating console notes sent to agents for some common cases #128
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -3,12 +3,16 @@ | |
| import hudson.console.ConsoleLogFilter; | ||
| import hudson.console.LineTransformationOutputStream; | ||
| import hudson.model.AbstractBuild; | ||
| import java.io.ByteArrayOutputStream; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.OutputStream; | ||
| import java.io.Serializable; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import jenkins.util.JenkinsJVM; | ||
|
|
||
| /** | ||
| * {@link ConsoleLogFilter} that adds a {@link SimpleHtmlNote} to each line. | ||
|
|
@@ -20,10 +24,40 @@ public final class AnsiColorConsoleLogFilter extends ConsoleLogFilter implements | |
| private static final Logger LOG = Logger.getLogger(AnsiColorConsoleLogFilter.class.getName()); | ||
|
|
||
| private AnsiColorMap colorMap; | ||
| private final Map<String, byte[]> notes; | ||
|
|
||
| public AnsiColorConsoleLogFilter(AnsiColorMap colorMap) { | ||
| super(); | ||
| this.colorMap = colorMap; | ||
| this.notes = new HashMap<>(); | ||
| // some cases of AnsiHtmlOutputStream.setForegroundColor: | ||
| for (AnsiColorMap.Color color : AnsiColorMap.Color.values()) { | ||
| pregenerateNote(new AnsiAttributeElement(AnsiAttributeElement.AnsiAttrType.FG, "span", "style=\"color: " + colorMap.getNormal(color.ordinal()) + ";\"")); | ||
| } | ||
| // TODO other cases, and other methods | ||
|
Member
Author
There was a problem hiding this comment. The tedious part. Handling bright colors, |
||
| LOG.log(Level.FINE, "Notes pregenerated for {0}", notes.keySet()); | ||
| } | ||
|
|
||
| private void pregenerateNote(AnsiAttributeElement element) { | ||
| element.emitOpen(html -> pregenerateNote(html)); | ||
| element.emitClose(html -> pregenerateNote(html)); | ||
| } | ||
|
|
||
| private void pregenerateNote(String html) { | ||
| if (!notes.containsKey(html)) { | ||
| JenkinsJVM.checkJenkinsJVM(); | ||
|
Member
Author
There was a problem hiding this comment. See jenkinsci/ant-plugin#32 for a simpler patch that illustrates the idiom. |
||
| ByteArrayOutputStream baos = new ByteArrayOutputStream(); | ||
| try { | ||
| new SimpleHtmlNote(html).encodeTo(baos); | ||
| } catch (IOException x) { // should be impossible | ||
| throw new RuntimeException(x); | ||
| } | ||
| notes.put(html, baos.toByteArray()); | ||
| } | ||
| } | ||
|
|
||
| private Object readResolve() { // handle old program.dat | ||
| return notes == null ? new AnsiColorConsoleLogFilter(colorMap) : this; | ||
| } | ||
|
|
||
| @SuppressWarnings("rawtypes") | ||
|
|
@@ -39,7 +73,12 @@ public OutputStream decorateLogger(AbstractBuild build, final OutputStream logge | |
| @Override | ||
| public void emitHtml(String html) { | ||
| try { | ||
| byte[] pregenerated = notes.get(html); | ||
| if (pregenerated != null) { | ||
| logger.write(pregenerated); | ||
| } else { | ||
| new SimpleHtmlNote(html).encodeTo(logger); | ||
| } | ||
| } catch (IOException e) { | ||
| LOG.log(Level.WARNING, "Failed to add HTML markup '" + html + "'", e); | ||
| } | ||
|
|
||
This file contains hidden or 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
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.
According to stats this is not a big deal, even if there are active trunk releases of this plugin for unrelated changes.
But, if baseline is an obstacle, the POM changes could be reverted. In that case the only
src/main/change would be to convert some uses of lambdas to inner classes, pretty simple; thesrc/test/code could remain, but would no longer reproduce the problem unless run underplugin-compat-tester.