feat: add support for json data

Author: exaby73

src/firebase_functions/logger.py

@@ -11,7 +11,7 @@
 
 class LogSeverity(str, _enum.Enum):
     """
-    `LogSeverity` indicates the detailed severity of the log entry. See 
+    `LogSeverity` indicates the detailed severity of the log entry. See
     [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).
     """
 
@@ -35,18 +35,26 @@ class LogEntry(_typing.TypedDict):
     message: _typing_extensions.NotRequired[str]
 
 
-def _entry_from_args(severity: LogSeverity, **kwargs) -> LogEntry:
+def _entry_from_args(severity: LogSeverity, *args, **kwargs) -> LogEntry:
     """
     Creates a `LogEntry` from the given arguments.
     """
 
     message: str = " ".join([
         value
         if isinstance(value, str) else _json.dumps(_remove_circular(value))
-        for value in kwargs.values()
+        for value in args
     ])
 
-    return {"severity": severity, "message": message}
+    object: _typing.Dict[str, _typing.Any] = {
+        key: value if isinstance(value, str) else _remove_circular(value)
+        for key, value in kwargs.items()}
+
+    entry = {"severity": severity, **object}
+    if message:
+        entry["message"] = message
+
+    return _typing.cast(LogEntry, entry)
 
 
 def _remove_circular(obj: _typing.Any,
@@ -65,7 +73,8 @@ def _remove_circular(obj: _typing.Any,
         refs.add(id(obj))
 
     if isinstance(obj, dict):
-        return {key: _remove_circular(value, refs) for key, value in obj.items()}
+        return {
+            key: _remove_circular(value, refs) for key, value in obj.items()}
     elif isinstance(obj, list):
         return [_remove_circular(value, refs) for _, value in enumerate(obj)]
     elif isinstance(obj, tuple):
@@ -86,36 +95,36 @@ def write(entry: LogEntry) -> None:
     print(_json.dumps(_remove_circular(entry)), file=write_file)
 
 
-def debug(**kwargs) -> None:
+def debug(*args, **kwargs) -> None:
     """
     Logs a debug message.
     """
-    write(_entry_from_args(LogSeverity.DEBUG, **kwargs))
+    write(_entry_from_args(LogSeverity.DEBUG, *args, **kwargs))
 
 
-def log(**kwargs) -> None:
+def log(*args, **kwargs) -> None:
     """
     Logs a log message.
     """
-    write(_entry_from_args(LogSeverity.NOTICE, **kwargs))
+    write(_entry_from_args(LogSeverity.NOTICE, *args, **kwargs))
 
 
-def info(**kwargs) -> None:
+def info(*args, **kwargs) -> None:
     """
     Logs an info message.
     """
-    write(_entry_from_args(LogSeverity.INFO, **kwargs))
+    write(_entry_from_args(LogSeverity.INFO, *args, **kwargs))
 
 
-def warn(**kwargs) -> None:
+def warn(*args, **kwargs) -> None:
     """
     Logs a warning message.
     """
-    write(_entry_from_args(LogSeverity.WARNING, **kwargs))
+    write(_entry_from_args(LogSeverity.WARNING, *args, **kwargs))
 
 
-def error(**kwargs) -> None:
+def error(*args, **kwargs) -> None:
     """
     Logs an error message.
     """
-    write(_entry_from_args(LogSeverity.ERROR, **kwargs))
+    write(_entry_from_args(LogSeverity.ERROR, *args,  **kwargs))

tests/test_logger.py

@@ -65,9 +65,15 @@ def test_log_should_have_message(self, capsys: pytest.CaptureFixture[str]):
         log_output = json.loads(raw_log_output)
         assert "message" in log_output
 
+    def test_log_should_have_other_keys(self, capsys: pytest.CaptureFixture[str]):
+        logger.log(foo="bar")
+        raw_log_output = capsys.readouterr().out
+        log_output = json.loads(raw_log_output)
+        assert "foo" in log_output
+
     def test_message_should_be_space_separated(
             self, capsys: pytest.CaptureFixture[str]):
-        logger.log(foo="bar", baz="qux")
+        logger.log("bar", "qux")
         expected_message = "bar qux"
         raw_log_output = capsys.readouterr().out
         log_output = json.loads(raw_log_output)