Merge pull request #43 from invertase/db-event-fix

fix(db): event payload incorrect

Author: taeold

example/functions/main.py

@@ -1,7 +1,7 @@
 """
 Example Firebase Functions written in Python
 """
-from firebase_functions import db_fn, https_fn, options, params, pubsub_fn
+from firebase_functions import https_fn, options, params, pubsub_fn
 from firebase_admin import initialize_app
 
 initialize_app()
@@ -13,29 +13,6 @@
 )
 
 
-@db_fn.on_value_written(
-    reference="hello",
-    region=options.SupportedRegion.EUROPE_WEST1,
-)
-def onwriteexample(event: db_fn.Event[db_fn.Change[object]]) -> None:
-    print("Hello from db write event:", event)
-
-
-@db_fn.on_value_created(reference="hello/{any_thing_here}/bar")
-def oncreatedexample(event: db_fn.Event[object]) -> None:
-    print("Hello from db create event:", event)
-
-
-@db_fn.on_value_deleted(reference="hello/{any_thing_here}/bar")
-def ondeletedexample(event: db_fn.Event[object]) -> None:
-    print("Hello from db delete event:", event)
-
-
-@db_fn.on_value_updated(reference="hello")
-def onupdatedexample(event: db_fn.Event[db_fn.Change[object]]) -> None:
-    print("Hello from db updated event:", event)
-
-
 @https_fn.on_request()
 def onrequestexample(req: https_fn.Request) -> https_fn.Response:
     print("on request function data:", req.data)

samples/basic_db/.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "python-functions-testing"
+  }
+}

samples/basic_db/.gitignore

@@ -0,0 +1,66 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

samples/basic_db/__init__.py

@@ -0,0 +1,3 @@
+# Required to avoid a 'duplicate modules' mypy error
+# in monorepos that have multiple main.py files.
+# https://github.com/python/mypy/issues/4008

samples/basic_db/firebase.json

@@ -0,0 +1,11 @@
+{
+  "functions": [
+    {
+      "source": "functions",
+      "codebase": "default",
+      "ignore": [
+        "venv"
+      ]
+    }
+  ]
+}

samples/basic_db/functions/.gitignore

@@ -0,0 +1,13 @@
+# pyenv
+.python-version
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Environments
+.env
+.venv
+venv/
+venv.bak/
+__pycache__

samples/basic_db/functions/main.py

@@ -0,0 +1,29 @@
+"""
+Example Firebase Functions for RTDB written in Python
+"""
+from firebase_functions import db_fn, options
+from firebase_admin import initialize_app
+
+initialize_app()
+
+options.set_global_options(region=options.SupportedRegion.EUROPE_WEST1)
+
+
+@db_fn.on_value_written(reference="hello/world")
+def onwriteexample(event: db_fn.Event[db_fn.Change]) -> None:
+    print("Hello from db write event:", event)
+
+
+@db_fn.on_value_created(reference="hello/world")
+def oncreatedexample(event: db_fn.Event) -> None:
+    print("Hello from db create event:", event)
+
+
+@db_fn.on_value_deleted(reference="hello/world")
+def ondeletedexample(event: db_fn.Event) -> None:
+    print("Hello from db delete event:", event)
+
+
+@db_fn.on_value_updated(reference="hello/world")
+def onupdatedexample(event: db_fn.Event[db_fn.Change]) -> None:
+    print("Hello from db updated event:", event)

samples/basic_db/functions/requirements.txt

@@ -0,0 +1,8 @@
+# Not published yet,
+# firebase-functions-python >= 0.0.1
+# so we use a relative path during development:
+./../../../
+# Or switch to git ref for deployment testing:
+# git+https://github.com/firebase/firebase-functions-python.git@main#egg=firebase-functions
+
+firebase-admin >= 6.0.1

src/firebase_functions/db_fn.py

@@ -90,14 +90,19 @@ class Event(_core.CloudEvent[_core.T]):
 
 def _db_endpoint_handler(
     func: _C1 | _C2,
+    event_type: str,
     raw: _ce.CloudEvent,
 ) -> None:
     event_attributes = raw._get_attributes()
     event_data: _typing.Any = raw.get_data()
     # TODO Params are built locally via path pattern which is currently unimplemented
     params: dict[str, str] = {}
-    database_event_data = event_data["data"]
-    if "delta" in event_data:
+    database_event_data = event_data
+    if event_type == _event_type_deleted:
+        database_event_data = database_event_data["data"]
+    if event_type == _event_type_created:
+        database_event_data = database_event_data["delta"]
+    if event_type in (_event_type_written, _event_type_updated):
         before = event_data["data"]
         after = event_data["delta"]
         # Merge delta into data to generate an 'after' view of the data.
@@ -153,7 +158,7 @@ def on_value_written_inner_decorator(func: _C1):
 
         @_functools.wraps(func)
         def on_value_written_wrapped(raw: _ce.CloudEvent):
-            return _db_endpoint_handler(func, raw)
+            return _db_endpoint_handler(func, _event_type_written, raw)
 
         _util.set_func_endpoint_attr(
             on_value_written_wrapped,
@@ -191,7 +196,7 @@ def on_value_updated_inner_decorator(func: _C1):
 
         @_functools.wraps(func)
         def on_value_updated_wrapped(raw: _ce.CloudEvent):
-            return _db_endpoint_handler(func, raw)
+            return _db_endpoint_handler(func, _event_type_updated, raw)
 
         _util.set_func_endpoint_attr(
             on_value_updated_wrapped,
@@ -229,7 +234,7 @@ def on_value_created_inner_decorator(func: _C2):
 
         @_functools.wraps(func)
         def on_value_created_wrapped(raw: _ce.CloudEvent):
-            return _db_endpoint_handler(func, raw)
+            return _db_endpoint_handler(func, _event_type_created, raw)
 
         _util.set_func_endpoint_attr(
             on_value_created_wrapped,
@@ -267,7 +272,7 @@ def on_value_deleted_inner_decorator(func: _C2):
 
         @_functools.wraps(func)
         def on_value_deleted_wrapped(raw: _ce.CloudEvent):
-            return _db_endpoint_handler(func, raw)
+            return _db_endpoint_handler(func, _event_type_deleted, raw)
 
         _util.set_func_endpoint_attr(
             on_value_deleted_wrapped,