Merge pull request #56 from invertase/firestore

feat: add support for Firestore 2nd gen triggers

Author: taeold

.github/workflows/ci.yaml

@@ -25,8 +25,7 @@ jobs:
           python3.10 -m venv venv
           source venv/bin/activate 
           pip3 install --upgrade pip 
-          python3.10 -m pip install -r requirements.txt
-          python3.10 setup.py install
+          python3.10 -m pip install -e ".[dev]"
       - name: Test with pytest & coverage
         run: |
           source venv/bin/activate
@@ -48,8 +47,7 @@ jobs:
           python3.10 -m venv venv
           source venv/bin/activate 
           pip3 install --upgrade pip 
-          python3.10 -m pip install -r requirements.txt
-          python3.10 setup.py install
+          python3.10 -m pip install -e ".[dev]"
       - name: Lint with pylint
         run: |
           source venv/bin/activate
@@ -72,8 +70,7 @@ jobs:
           python3.10 -m venv venv
           source venv/bin/activate 
           pip3 install --upgrade pip 
-          python3.10 -m pip install -r requirements.txt
-          python3.10 setup.py install
+          python3.10 -m pip install -e ".[dev]"
       - name: Generate Reference Docs
         run: |
           source venv/bin/activate
@@ -98,8 +95,7 @@ jobs:
           python3.10 -m venv venv
           source venv/bin/activate 
           pip3 install --upgrade pip 
-          python3.10 -m pip install -r requirements.txt
-          python3.10 setup.py install
+          python3.10 -m pip install -e ".[dev]"
       - name: Check Formatting
         run: |
           source venv/bin/activate

requirements.txt

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

samples/basic_firestore/.firebaserc

@@ -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_firestore/.gitignore

@@ -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_firestore/__init__.py

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

samples/basic_firestore/firebase.json

@@ -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_firestore/functions/.gitignore

@@ -0,0 +1,31 @@
+"""
+Example Firebase Functions for Firestore written in Python
+"""
+from firebase_functions import firestore_fn, options
+from firebase_admin import initialize_app
+
+initialize_app()
+
+options.set_global_options(region=options.SupportedRegion.EUROPE_WEST1)
+
+
+@firestore_fn.on_document_written(document="hello/{world}")
+def onfirestoredocumentwritten(
+        event: firestore_fn.Event[firestore_fn.Change]) -> None:
+    print("Hello from Firestore document write event:", event)
+
+
+@firestore_fn.on_document_created(document="hello/world")
+def onfirestoredocumentcreated(event: firestore_fn.Event) -> None:
+    print("Hello from Firestore document create event:", event)
+
+
+@firestore_fn.on_document_deleted(document="hello/world")
+def onfirestoredocumentdeleted(event: firestore_fn.Event) -> None:
+    print("Hello from Firestore document delete event:", event)
+
+
+@firestore_fn.on_document_updated(document="hello/world")
+def onfirestoredocumentupdated(
+        event: firestore_fn.Event[firestore_fn.Change]) -> None:
+    print("Hello from Firestore document updated event:", event)

samples/basic_firestore/functions/main.py

@@ -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

samples/basic_firestore/functions/requirements.txt

@@ -6,3 +6,4 @@
 # git+https://github.com/firebase/firebase-functions-python.git@main#egg=firebase-functions
 
 firebase-admin >= 6.0.1
+google-cloud-tasks >= 2.13.1