fix: robustness of template import for non-UTF8 characters

Author: codescape

docs/changelog.md

@@ -13,6 +13,7 @@ category: Administration
 
 * fix: always open documentation in subtasks dialog in new window
 * feat: ensure compatibility with Jira 9.15.0, 9.12.5, 9.4.18
+* fix: robustness of template import for non-UTF8 characters 
 
 ### [24.01.0] - 2024-01-27
 

src/main/java/de/codescape/jira/plugins/multiplesubtasks/action/SubtaskTemplateImportAction.java

@@ -20,14 +20,17 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
+import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -223,11 +226,11 @@ private long importQuickSubtasksTemplatesForUser(ApplicationUser applicationUser
     /**
      * Returns {@link ShowSubtaskTemplate} objects from the given XML.
      */
-    private List<ShowSubtaskTemplate> extractQuickSubtasksTemplatesFromXml(String templatesXml, boolean isProjectTemplate) {
+    List<ShowSubtaskTemplate> extractQuickSubtasksTemplatesFromXml(String templatesXml, boolean isProjectTemplate) {
         List<ShowSubtaskTemplate> templates = new ArrayList<>();
         try {
             DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
-            Document doc = builder.parse(new ByteArrayInputStream(templatesXml.getBytes()));
+            Document doc = builder.parse(new InputSource(new InputStreamReader(new ByteArrayInputStream(templatesXml.getBytes()))));
             doc.getDocumentElement().normalize();
 
             // templates for users and projects are saved with different element names

src/test/java/de/codescape/jira/plugins/multiplesubtasks/action/SubtaskTemplateImportActionTest.java

@@ -1,11 +1,14 @@
 package de.codescape.jira.plugins.multiplesubtasks.action;
 
+import de.codescape.jira.plugins.multiplesubtasks.model.ShowSubtaskTemplate;
 import org.junit.Rule;
 import org.junit.Test;
 import org.mockito.InjectMocks;
 import org.mockito.junit.MockitoJUnit;
 import org.mockito.junit.MockitoRule;
 
+import java.util.List;
+
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
 
@@ -256,6 +259,22 @@ public void shouldAcceptColonAndQuestionMarkInSummary() {
             "- a test: will it work?\n");
     }
 
+    /* fix: do not fail on uncommon characters */
+
+    @Test
+    public void shouldAcceptUncommonLetters() {
+        String input = "<list>\n" +
+            "      <subtaskTemplate>\n" +
+            "        <text>- Serve a drink in the Café / assignee:&quot;bartender&quot;</text>\n" +
+            "        <title>drinking</title>\n" +
+            "        <id>84634E96-7E97-4490-903E-6C159E3CE590</id>\n" +
+            "      </subtaskTemplate>\n" +
+            "    </list>";
+        List<ShowSubtaskTemplate> templates = subtaskTemplateImportAction.extractQuickSubtasksTemplatesFromXml(input, true);
+        assertThat(templates.size(), is(equalTo(1)));
+        assertThat(templates.get(0).getTemplate(), containsString("Serve a drink in the Café"));
+    }
+
     /* helper methods */
 
     private void assertTransformation(String input, String output) {