Fix #139: Handle non-ASCII characters correctly when annotating text

CHANGELOG.md

@@ -2,6 +2,7 @@
 ============
 
 * Your contribution here.
+* [#139](https://github.com/jenkinsci/ansicolor-plugin/issues/139)/[#143](https://github.com/jenkinsci/ansicolor-plugin/pull/143): Prevent an `IndexOutOfBoundsException` from being thrown when two or more non-ASCII-compatible characters are present in colored text - [@dwnusbaum](https://github.com/dwnusbaum).
 
 0.6.0 (11/14/2018)
 ============

src/main/java/hudson/plugins/ansicolor/ColorConsoleAnnotator.java

@@ -66,29 +66,33 @@ public ConsoleAnnotator<Object> annotate(Object context, MarkupText text) {
             CountingOutputStream outgoing = new CountingOutputStream(new NullOutputStream());
             class EmitterImpl implements AnsiAttributeElement.Emitter {
                 CountingOutputStream incoming;
-                int adjustment;
+                int multiByteCharAdjustment;
+                int hiddenCharAdjustment;
                 int lastPoint = -1; // multiple HTML tags may be emitted for one control sequence
                 @Override
                 public void emitHtml(String html) {
-                    LOGGER.finest("emitting " + html + " @" + incoming.getCount());
-                    text.addMarkup(incoming.getCount(), html);
-                    if (incoming.getCount() != lastPoint) {
-                        lastPoint = incoming.getCount();
-                        int hide = incoming.getCount() - outgoing.getCount() - adjustment;
-                        LOGGER.finest("hiding " + hide + " @" + (outgoing.getCount() + adjustment));
-                        text.addMarkup(outgoing.getCount() + adjustment, outgoing.getCount() + adjustment + hide, "<!--", "-->");
-                        adjustment += hide;
+                    int inCount = incoming.getCount() - multiByteCharAdjustment;
+                    int outCount = outgoing.getCount() - multiByteCharAdjustment + hiddenCharAdjustment;
+                    LOGGER.log(Level.FINEST, "emitting {0} @{1}/{2}", new Object[] { html, inCount, s.length() });
+                    text.addMarkup(inCount, html);
+                    if (inCount != lastPoint) {
+                        lastPoint = inCount;
+                        int hide = inCount - outCount;
+                        LOGGER.log(Level.FINEST, "hiding {0} @{1}", new Object[] { hide, outCount });
+                        text.addMarkup(outCount, outCount + hide, "<!--", "-->");
+                        hiddenCharAdjustment += hide;
                     }
                 }
             }
             EmitterImpl emitter = new EmitterImpl();
             CountingOutputStream incoming = new CountingOutputStream(new AnsiHtmlOutputStream(outgoing, colorMap, emitter));
             emitter.incoming = incoming;
             try {
-                byte[] data = s.getBytes(charset);
-                for (int i = 0; i < data.length; i++) {
-                    // Do not use write(byte[]) as offsets in incoming would not be accurate.
-                    incoming.write(data[i]);
+                for (int i = 0; i < s.length(); i++) {
+                    // We write one UTF-16 code unit at a time so that our counting methods can handle multibyte characters correctly.
+                    byte[] chars = String.valueOf(s.charAt(i)).getBytes(charset);
+                    emitter.multiByteCharAdjustment += chars.length - 1;
+                    incoming.write(chars);
                 }
             } catch (IOException x) {
                 LOGGER.log(Level.WARNING, null, x);

src/test/java/hudson/plugins/ansicolor/AnsiColorBuildWrapperTest.java

@@ -116,4 +116,29 @@ public void evaluate() throws Throwable {
             }
         });
     }
+
+    @Test
+    public void testNonAscii() throws Exception {
+        story.then(r -> {
+            FreeStyleProject p = r.createFreeStyleProject();
+            p.getBuildWrappersList().add(new AnsiColorBuildWrapper(null));
+            p.getBuildersList().add(new TestBuilder() {
+                @Override
+                public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException {
+                    listener.getLogger().println("\033[94;1m[ INFO ] Récupération du numéro de version de l'application\033[0m");
+                    listener.getLogger().println("\033[94;1m[ INFO ] ビルドのコンソール出力を取得します。\033[0m");
+                    return true;
+                }
+            });
+            FreeStyleBuild b = r.buildAndAssertSuccess(p);
+            StringWriter writer = new StringWriter();
+            b.getLogText().writeHtmlTo(0L, writer);
+            String html = writer.toString();
+            System.out.print(html);
+            assertThat(html.replaceAll("<!--.+?-->", ""),
+                allOf(
+                    containsString("<span style=\"color: #4682B4;\"><b>[ INFO ] Récupération du numéro de version de l'application</b></span>"),
+                    containsString("<span style=\"color: #4682B4;\"><b>[ INFO ] ビルドのコンソール出力を取得します。</b></span>")));
+        });
+    }
 }