Replace instances of deprecated Jinja2.Markup with markupsafe.Markup

changelog.d/12289.misc

@@ -0,0 +1 @@
+Remove uses of the long-deprecated `Jinja2.Markup` which would prevent Synapse from starting with Jinja2 3.1.0 or above installed. This does not affect deployments of Synapse using our Docker images or Debian packages.

synapse/push/mailer.py

@@ -18,6 +18,7 @@
 
 import bleach
 import jinja2
+from markupsafe import Markup
 
 from synapse.api.constants import EventTypes, Membership, RoomTypes
 from synapse.api.errors import StoreError
@@ -867,7 +868,7 @@ def _make_unsubscribe_link(
  )
 
 
-def safe_markup(raw_html: str) -> jinja2.Markup:
+def safe_markup(raw_html: str) -> Markup:
  """
  Sanitise a raw HTML string to a set of allowed tags and attributes, and linkify any bare URLs.
 
@@ -877,7 +878,7 @@ def safe_markup(raw_html: str) -> jinja2.Markup:
  Returns:
  A Markup object ready to safely use in a Jinja template.
  """
- return jinja2.Markup(
+ return Markup(
  bleach.linkify(
  bleach.clean(
  raw_html,
@@ -891,7 +892,7 @@ def safe_markup(raw_html: str) -> jinja2.Markup:
  )
 
 
-def safe_text(raw_text: str) -> jinja2.Markup:
+def safe_text(raw_text: str) -> Markup:
  """
  Sanitise text (escape any HTML tags), and then linkify any bare URLs.
 
@@ -901,7 +902,7 @@ def safe_text(raw_text: str) -> jinja2.Markup:
  Returns:
  A Markup object ready to safely use in a Jinja template.
  """
- return jinja2.Markup(
+ return Markup(
  bleach.linkify(bleach.clean(raw_text, tags=[], attributes=[], strip=False))
  )
 

synapse/python_dependencies.py

@@ -75,6 +75,7 @@
  "attrs>=19.2.0,!=21.1.0",
  "netaddr>=0.7.18",
  "Jinja2>=2.9",
+ "MarkupSafe>=2.0",
  "bleach>=1.4.3",
  # We use `ParamSpec`, which was added in `typing-extensions` 3.10.0.0.
  "typing-extensions>=3.10.0",