Escape newlines in LogfmtRenderer (#592)

* Escape newlines in LogfmtRenderer * Update tests/test_processors.py --------- Co-authored-by: Hynek Schlawack <[email protected]>
hynek · Jan 29, 2024 · b93037f · b93037f
1 parent 5c3bc79
commit b93037f
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,10 @@ You can find our backwards-compatibility policy [here](https://github.com/hynek/
 
 ## [Unreleased](https://github.com/hynek/structlog/compare/24.1.0...HEAD)
 
+### Changed
+
+- `structlog.processors.LogfmtRenderer` now escapes newlines.
+  [#592](https://github.com/hynek/structlog/pull/592)
 
 ## [24.1.0](https://github.com/hynek/structlog/compare/23.3.0...24.1.0) - 2024-01-08
 

diff --git a/src/structlog/processors.py b/src/structlog/processors.py
@@ -170,7 +170,7 @@ def __call__(
                     continue
                 value = "true" if value else "false"
 
-            value = f"{value}".replace('"', '\\"')
+            value = f"{value}".replace('"', '\\"').replace("\n", "\\n")
 
             if " " in value or "=" in value:
                 value = f'"{value}"'

diff --git a/tests/test_processors.py b/tests/test_processors.py
@@ -290,6 +290,16 @@ def test_invalid_key(self):
         with pytest.raises(ValueError, match='Invalid key: "invalid key"'):
             LogfmtRenderer()(None, None, event_dict)
 
+    def test_newline_in_value(self):
+        """
+        Newlines in values are escaped.
+        """
+        event_dict = {"with_newline": "some\nvalue"}
+
+        rv = LogfmtRenderer()(None, None, event_dict)
+
+        assert r"with_newline=some\nvalue" == rv
+
 
 class TestJSONRenderer:
     def test_renders_json(self, event_dict):