add authcontxt params to the Event class for Realtime Database

Author: kushalpalesha

src/firebase_functions/db_fn.py

@@ -34,6 +34,8 @@
 _event_type_updated = "google.firebase.database.ref.v1.updated"
 _event_type_deleted = "google.firebase.database.ref.v1.deleted"
 
+AuthType = _typing.Literal["app_user", "admin", "unauthenticated", "unknown"]
+
 
 @_dataclass.dataclass(frozen=True)
 class Event(_core.CloudEvent[T]):
@@ -67,6 +69,16 @@ class Event(_core.CloudEvent[T]):
     Only named capture groups are populated - {key}, {key=*}, {key=**}
     """
 
+    auth_type: AuthType
+    """
+    The type of principal that triggered the event.
+    """
+
+    auth_id: str
+    """
+    The unique identifier for the principal.
+    """
+
 
 _E1 = Event[Change[_typing.Any | None]]
 _E2 = Event[_typing.Any | None]
@@ -104,6 +116,10 @@ def _db_endpoint_handler(
         **ref_pattern.extract_matches(event_ref),
         **instance_pattern.extract_matches(event_instance),
     }
+
+    event_auth_type = event_attributes["authtype"]
+    event_auth_id = event_attributes["authid"]
+
     database_event = Event(
         firebase_database_host=event_attributes["firebasedatabasehost"],
         instance=event_instance,
@@ -120,6 +136,8 @@ def _db_endpoint_handler(
         data=database_event_data,
         subject=event_attributes["subject"],
         params=params,
+        auth_type=event_auth_type,
+        auth_id=event_auth_id,
     )
     _core._with_init(func)(database_event)
 

tests/test_db.py

@@ -38,10 +38,18 @@ def init():
                 "ref": "ref",
                 "firebasedatabasehost": "firebasedatabasehost",
                 "location": "location",
+                "authtype": "app_user",
+                "authid": "auth-id",
             },
             data={"delta": "delta"},
         )
 
         decorated_func(event)
 
+        func.assert_called_once()
+        event = func.call_args.args[0]
+        self.assertIsNotNone(event)
+        self.assertEqual(event.auth_type, "app_user")
+        self.assertEqual(event.auth_id, "auth-id")
+
         self.assertEqual(hello, "world")