Merge pull request #462 from Bala-Sakabattula/pypandoc-format-fix

pypandoc tex format fix

Author: Bala-Sakabattula

sync2jira/downstream_issue.py

@@ -1521,6 +1521,33 @@ def sync_with_jira(issue, config):
         retry = True
 
 
+def convert_content(content: str) -> str:
+    """Convert GitHub Flavored Markdown to Jira format via pypandoc.
+
+    Falls back to disabling TeX math extensions if the initial conversion
+    fails (e.g. content misinterpreted as LaTeX).  Returns the original
+    content unchanged if both attempts fail.
+
+    :param str content: GitHub Flavored Markdown text
+    :returns: Jira-formatted text, or the original content on failure
+    :rtype: str
+    """
+    try:
+        content = pypandoc.convert_text(content, "jira", format="gfm")
+    except Exception as e:
+        log.warning("pypandoc conversion failed, retrying with TeX disabled: %s", e)
+        try:
+            sanitized = content.replace("\\", "\\\\").replace("$", "\\$")
+            content = pypandoc.convert_text(
+                sanitized,
+                "jira",
+                format="gfm-tex_math_dollars-tex_math_single_backslash",
+            )
+        except Exception as e2:
+            log.warning("pypandoc fallback also failed; using raw content: %s", e2)
+    return content
+
+
 def update_jira(client, config, issue):
     # Check the status of the JIRA client
     if not config["sync2jira"]["develop"] and not check_jira_status(client):
@@ -1533,7 +1560,7 @@ def update_jira(client, config, issue):
             and issue.content
             and "github_markdown" in issue.downstream["issue_updates"]
         ):
-            issue.content = pypandoc.convert_text(issue.content, "jira", format="gfm")
+            issue.content = convert_content(issue.content)
 
     # First, check to see if we have a matching issue using the new method.
     # If we do, then bail out.  No sync needed.

sync2jira/downstream_pr.py

@@ -23,7 +23,6 @@
 from jira import JIRAError
 from jira.client import Issue as JIRAIssue
 from jira.client import ResultList
-import pypandoc
 
 # Local Modules
 import sync2jira.downstream_issue as d_issue
@@ -266,7 +265,7 @@ def _create_jira_issue_from_pr(client, pr, config):
             and pr_content
             and "github_markdown" in pr.downstream["issue_updates"]
         ):
-            pr_content = pypandoc.convert_text(pr_content, "jira", format="gfm")
+            pr_content = d_issue.convert_content(pr_content)
 
     # Convert PR to Issue-like object for creation
     # PR and Issue share similar structure, but we need to adapt it

tests/test_downstream_issue.py

@@ -1110,6 +1110,49 @@ def test_sync_with_jira_no_matching(
         )
         mock_existing_jira_issue_legacy.assert_not_called()
 
+    @mock.patch(PATH + "pypandoc")
+    def test_convert_content(self, mock_pypandoc):
+        """convert_content(): normal success, TeX fallback, and double failure."""
+        # Case 1: Normal GFM conversion succeeds
+        mock_pypandoc.convert_text.return_value = "normal markdown"
+
+        result = d.convert_content("normal markdown")
+
+        mock_pypandoc.convert_text.assert_called_once_with(
+            "normal markdown", "jira", format="gfm"
+        )
+        self.assertEqual(result, "normal markdown")
+
+        # Case 2: First call fails (TeX error), fallback succeeds
+        mock_pypandoc.convert_text.reset_mock()
+        mock_pypandoc.convert_text.side_effect = [
+            RuntimeError("Error producing PDF"),
+            "fallback converted",
+        ]
+
+        result = d.convert_content("bad $tex")
+
+        self.assertEqual(mock_pypandoc.convert_text.call_count, 2)
+        first_call = mock_pypandoc.convert_text.call_args_list[0]
+        self.assertEqual(first_call[1]["format"], "gfm")
+
+        fallback_call = mock_pypandoc.convert_text.call_args_list[1]
+        self.assertEqual(
+            fallback_call[1]["format"],
+            "gfm-tex_math_dollars-tex_math_single_backslash",
+        )
+        self.assertEqual(fallback_call[0][0], "bad \\$tex")
+        self.assertEqual(result, "fallback converted")
+
+        # Case 3: Both calls fail, raw content preserved
+        mock_pypandoc.convert_text.reset_mock()
+        mock_pypandoc.convert_text.side_effect = RuntimeError("pandoc broken")
+
+        result = d.convert_content("raw content")
+
+        self.assertEqual(mock_pypandoc.convert_text.call_count, 2)
+        self.assertEqual(result, "raw content")
+
     @mock.patch(PATH + "_update_title")
     @mock.patch(PATH + "_update_description")
     @mock.patch(PATH + "_update_comments")