fix(reporting): render WhatsApp and SMS links as plain text (#4846)

* fix(reporting): render WhatsApp and SMS links as plain text

WhatsApp and SMS recipients were shown Slack's link markup verbatim — `[<https://grafana...|E1>]` instead of a readable citation. Two Slack-flavoured helpers emitted `<url|label>` through format_slack_link:

- _render_claim_lines (report.py) — evidence citations [E1]
- build_investigation_trace (infrastructure.py) — S3 console links

Telegram already dodges this with its own _render_claim_lines_telegram calling format_html_link. WhatsApp was the only channel with no plain-text path, and ReportMessages.sms_text returns whatsapp_text, so SMS inherited the bug.

The conversion happens at the WhatsApp boundary rather than per-helper. That covers citations, trace links, and any Slack link a future change adds upstream, in one place — the same approach _render_plain_report already takes for terminal output.

`label (url)` keeps the URL rather than dropping it, because WhatsApp and SMS auto-linkify bare URLs.

The slack_links_to_plain_text helper is the inverse of format_slack_link and is now shared with the terminal plain-text renderer, which previously held its own byte-identical copy. The parametrized cases in test_terminal_renderer.py follow the rename and become coverage for the shared helper.

Not touched: integrations/telegram/markdown.py:16 holds a third copy of the regex, but it drives an HTML conversion rather than plain text, so folding it in would change Telegram behavior. Left for a separate change.

Fixes #4695

* refactor(reporting): move SLACK_LINK_RE to config/constants/reporting

Greptile flagged P2: shared static constants belong under config/constants/, not
in a feature module. The regex is now in config/constants/reporting.py and
re-exported via config/constants/__init__.py. Both consumers — formatters/base.py
and renderers/terminal.py — import it from the canonical location.

Fixes the review comment on #4846.

---------

Co-authored-by: nehraa <abhinavnehra2203@gmail.com>

Author: nehraa

config/constants/__init__.py

@@ -252,6 +252,7 @@
     REDIS_SSL_ENV,
     REDIS_USERNAME_ENV,
 )
+from config.constants.reporting import SLACK_LINK_RE
 from config.constants.runtime_metadata import (
     GITHUB_REPO_ENV,
     GITHUB_REPOSITORY_ENV,
@@ -548,6 +549,7 @@
     "SIGNOZ_URL_ENV",
     "SLACK_APP_TOKEN_ENV",
     "SLACK_BOT_TOKEN_ENV",
+    "SLACK_LINK_RE",
     "SMTP_DEFAULT_TO_ENV",
     "SMTP_FROM_ADDRESS_ENV",
     "SMTP_HOST_ENV",

config/constants/reporting.py

@@ -0,0 +1,12 @@
+"""Constants shared across the investigation reporting package."""
+
+from __future__ import annotations
+
+import re
+from typing import Final
+
+# Matches Slack-style links: <url|label> or <url>. Shared between the WhatsApp
+# formatter and the terminal plain-text renderer so both stay in step.
+SLACK_LINK_RE: Final[re.Pattern[str]] = re.compile(r"<(https?://[^|>]+)(?:\|([^>]+))?>")
+
+__all__ = ["SLACK_LINK_RE"]

tests/delivery/test_terminal_renderer.py

@@ -5,10 +5,10 @@
 import pytest
 
 from platform.terminal.theme import DEFAULT_THEME_NAME, set_active_theme
+from tools.investigation.reporting.formatters.base import slack_links_to_plain_text
 from tools.investigation.reporting.renderers.terminal import (
     _rich_line_with_links,
     _strip_mrkdwn,
-    _strip_slack_links,
     render_report,
 )
 
@@ -125,7 +125,7 @@ def test_strip_mrkdwn(raw: str, expected: str) -> None:
             "A (https://a.test) and B (https://b.test)",
         ),
         # No Slack-style link -> passthrough (including bare URLs, which
-        # _strip_slack_links is not responsible for).
+        # slack_links_to_plain_text is not responsible for).
         ("plain text", "plain text"),
         (
             "https://example.com without angle brackets",
@@ -135,8 +135,8 @@ def test_strip_mrkdwn(raw: str, expected: str) -> None:
         ("", ""),
     ],
 )
-def test_strip_slack_links(raw: str, expected: str) -> None:
-    assert _strip_slack_links(raw) == expected
+def test_slack_links_to_plain_text(raw: str, expected: str) -> None:
+    assert slack_links_to_plain_text(raw) == expected
 
 
 @pytest.mark.parametrize(

tests/delivery/test_whatsapp_plain_text.py

@@ -0,0 +1,68 @@
+"""WhatsApp and SMS are plain-text channels: no Slack link markup may reach them."""
+
+from __future__ import annotations
+
+from tools.investigation.reporting.context import build_report_context
+from tools.investigation.reporting.formatters.messages import build_report_messages
+from tools.investigation.reporting.formatters.report import format_whatsapp_message
+
+
+def _make_state() -> dict:
+    return {
+        "alert_name": "Checkout latency spike",
+        "severity": "critical",
+        "root_cause": "Checkout service was throttled by the upstream API cluster.",
+        "validated_claims": [
+            {
+                "claim": "Grafana logs show repeated 500 responses.",
+                "evidence_sources": ["grafana_logs"],
+            }
+        ],
+        "available_sources": {
+            "grafana": {
+                "grafana_endpoint": "https://myorg.grafana.net",
+                "service_name": "checkout-api",
+            },
+        },
+        "evidence": {
+            "grafana_logs": [{"message": "service unavailable"}],
+            "grafana_logs_query": '{service="checkout-api"}',
+        },
+    }
+
+
+def test_whatsapp_message_renders_evidence_links_as_plain_text() -> None:
+    body = format_whatsapp_message(build_report_context(_make_state()))
+
+    assert "<https://" not in body
+    assert "E1 (https://myorg.grafana.net" in body
+
+
+def test_whatsapp_message_renders_s3_trace_links_as_plain_text() -> None:
+    state = _make_state()
+    state["raw_alert"] = {
+        "annotations": {
+            "landing_bucket": "tracer-landing",
+            "s3_key": "runs/checkout/input.json",
+        },
+    }
+
+    body = format_whatsapp_message(build_report_context(state))
+
+    assert "<https://" not in body
+    assert "S3 object (https://" in body
+
+
+def test_sms_body_carries_no_slack_link_markup() -> None:
+    messages = build_report_messages(build_report_context(_make_state()))
+
+    assert messages.sms_text == messages.whatsapp_text
+    assert "<https://" not in messages.sms_text
+
+
+def test_slack_and_telegram_keep_their_own_link_syntax() -> None:
+    """The plain-text conversion must not bleed into the other channels."""
+    messages = build_report_messages(build_report_context(_make_state()))
+
+    assert "<https://myorg.grafana.net" in messages.slack_text
+    assert '<a href="https://myorg.grafana.net' in messages.telegram_html

tools/investigation/reporting/formatters/base.py

@@ -1,6 +1,13 @@
 """Base formatting utilities for report generation."""
 
+from __future__ import annotations
+
 import html
+import re
+
+from config.constants import SLACK_LINK_RE
+
+__all__ = ["format_html_link", "format_slack_link", "shorten_text", "slack_links_to_plain_text"]
 
 
 def shorten_text(text: str, max_chars: int = 120, suffix: str = "...") -> str:
@@ -32,6 +39,22 @@ def format_slack_link(label: str, url: str | None) -> str:
     return f"<{url}|{safe_label}>"
 
 
+def slack_links_to_plain_text(text: str) -> str:
+    """Convert Slack ``<url|label>`` links to plain ``label (url)``.
+
+    The inverse of :func:`format_slack_link`, for channels that render no markup
+    (WhatsApp, SMS, terminal plain-text mode). The URL is kept because
+    plain-text clients auto-linkify bare URLs.
+    """
+
+    def _repl(match: re.Match[str]) -> str:
+        url = str(match.group(1))
+        label = match.group(2)
+        return f"{label} ({url})" if label else url
+
+    return SLACK_LINK_RE.sub(_repl, text)
+
+
 def format_html_link(label: str, url: str | None) -> str:
     """Return a Telegram HTML <a> tag, or escaped plain label without a URL."""
     if not url:

tools/investigation/reporting/formatters/report.py

@@ -7,6 +7,7 @@
 from tools.investigation.reporting.formatters.base import (
     format_html_link,
     format_slack_link,
+    slack_links_to_plain_text,
 )
 from tools.investigation.reporting.formatters.evidence import (
     format_cited_evidence_section,
@@ -716,7 +717,9 @@ def format_whatsapp_message(ctx: ReportContext) -> str:
     if meta_bits:
         parts.append(" | ".join(meta_bits))
 
-    return "\n\n".join(p for p in parts if p)
+    # Shared helpers emit Slack <url|label> links; WhatsApp and SMS render no
+    # markup, so convert at this boundary to plain `label (url)` form.
+    return slack_links_to_plain_text("\n\n".join(p for p in parts if p))
 
 
 # ---------------------------------------------------------------------------

tools/investigation/reporting/renderers/terminal.py

@@ -8,24 +8,24 @@
 from rich.console import Console
 from rich.text import Text
 
+from config.constants import SLACK_LINK_RE
 from platform.observability import get_output_format
 from platform.terminal.theme import BRAND, DIM, HIGHLIGHT, WARNING
+from tools.investigation.reporting.formatters.base import slack_links_to_plain_text
 
 # ─────────────────────────────────────────────────────────────────────────────
 # Helpers
 # ─────────────────────────────────────────────────────────────────────────────
 
 _URL_RE = re.compile(r"https?://\S+")
-# Matches Slack-style links: <url|label> or <url>
-_SLACK_LINK_RE = re.compile(r"<(https?://[^|>]+)(?:\|([^>]+))?>")
 
 
 def _rich_line_with_links(text: str) -> Text:
     """Convert a plain/Slack-mrkdwn string into a Rich Text with blue hyperlinks."""
     result = Text()
     cursor = 0
 
-    for m in _SLACK_LINK_RE.finditer(text):
+    for m in SLACK_LINK_RE.finditer(text):
         # Text before the match
         if m.start() > cursor:
             result.append(text[cursor : m.start()])
@@ -49,17 +49,6 @@ def _rich_line_with_links(text: str) -> Text:
     return result
 
 
-def _strip_slack_links(text: str) -> str:
-    """Convert Slack <url|label> to plain 'label (url)' for plain text mode."""
-
-    def _repl(m: re.Match[str]) -> str:
-        url = str(m.group(1))
-        label = m.group(2)
-        return f"{label} ({url})" if label else url
-
-    return _SLACK_LINK_RE.sub(_repl, text)
-
-
 def _strip_mrkdwn(text: str) -> str:
     """Remove Slack mrkdwn bold markers (*text*) for plain output."""
     return re.sub(r"\*([^*\n]+)\*", r"\1", text)
@@ -251,5 +240,5 @@ def _render_rich_report(slack_message: str) -> str:
 
 
 def _render_plain_report(slack_message: str) -> str:
-    clean = _strip_slack_links(_strip_mrkdwn(slack_message))
+    clean = slack_links_to_plain_text(_strip_mrkdwn(slack_message))
     return f"\n{clean}\n"