Skip to content

Add firebase trigger samples #1651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 30, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions functions/firebase/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# [START functions_firebase_rtdb]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've got the same region tags twice (functions_firebase_rtdb). I don't think this will work...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK they concatenate together, which is the intended effect.

# [START functions_firebase_firestore]
# [START functions_firebase_auth]
import json
# [END functions_firebase_rtdb]
# [END functions_firebase_firestore]
# [END functions_firebase_auth]


# [START functions_firebase_rtdb]
def hello_rtdb(data, context):
""" Triggered by a change to a Firebase RTDB reference.
Args:
data (dict): The event payload.
context (google.cloud.functions.Context): Metadata for the event.
"""
trigger_resource = context.resource

print('Function triggered by change to: %s' % trigger_resource)
print('Admin?: %s' % data.get("admin", False))
print('Delta:')
print(json.dumps(data["delta"]))
# [END functions_firebase_rtdb]


# [START functions_firebase_firestore]
def hello_firestore(data, context):
""" Triggered by a change to a Firestore document.
Args:
data (dict): The event payload.
context (google.cloud.functions.Context): Metadata for the event.
"""
trigger_resource = context.resource

print('Function triggered by change to: %s' % trigger_resource)

print('\nOld value:')
print(json.dumps(data["oldValue"]))

print('\nNew value:')
print(json.dumps(data["value"]))
# [END functions_firebase_firestore]


# [START functions_firebase_auth]
def hello_auth(data, context):
""" Triggered by creation or deletion of a Firebase Auth user object.
Args:
data (dict): The event payload.
context (google.cloud.functions.Context): Metadata for the event.
"""
print('Function triggered by creation/deletion of user: %s' % data["uid"])
print('Created at: %s' % data["metadata"]["createdAt"])

if 'email' in data:
print('Email: %s' % data["email"])
# [END functions_firebase_auth]
85 changes: 85 additions & 0 deletions functions/firebase/main_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from datetime import datetime
import json

import uuid

import main


class Context(object):
pass


def test_rtdb(capsys):
data_id = str(uuid.uuid4())
resource_id = str(uuid.uuid4())

data = {
'admin': True,
'delta': {'id': data_id}
}

context = Context()
context.resource = resource_id

main.hello_rtdb(data, context)

out, _ = capsys.readouterr()

assert ('Function triggered by change to: %s' % resource_id) in out
assert 'Admin?: True' in out
assert data_id in out


def test_firestore(capsys):
resource_id = str(uuid.uuid4())

context = Context()
context.resource = resource_id

data = {
'oldValue': {'uuid': str(uuid.uuid4())},
'value': {'uuid': str(uuid.uuid4())}
}

main.hello_firestore(data, context)

out, _ = capsys.readouterr()

assert ('Function triggered by change to: %s' % resource_id) in out
assert json.dumps(data['oldValue']) in out
assert json.dumps(data['value']) in out


def test_auth(capsys):
user_id = str(uuid.uuid4())
date_string = datetime.now().isoformat()
email_string = '%s@%s.com' % (uuid.uuid4(), uuid.uuid4())

data = {
'uid': user_id,
'metadata': {'createdAt': date_string},
'email': email_string
}

main.hello_auth(data, None)

out, _ = capsys.readouterr()

assert user_id in out
assert date_string in out
assert email_string in out