-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for background to CloudEvent conversion (#116)
- Loading branch information
Showing
13 changed files
with
624 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Copyright 2021 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. | ||
|
|
||
|
|
||
| class BackgroundEvent(object): | ||
| """BackgroundEvent is an event passed to GCF background event functions. | ||
| Background event functions take data and context as parameters, both of | ||
| which this class represents. By contrast, CloudEvent functions take a | ||
| single CloudEvent object as their parameter. This class does not represent | ||
| CloudEvents. | ||
| """ | ||
|
|
||
| # Supports v1beta1, v1beta2, and v1 event formats. | ||
| def __init__( | ||
| self, | ||
| context=None, | ||
| data="", | ||
| eventId="", | ||
| timestamp="", | ||
| eventType="", | ||
| resource="", | ||
| **kwargs, | ||
| ): | ||
| self.context = context | ||
| if not self.context: | ||
| self.context = { | ||
| "eventId": eventId, | ||
| "timestamp": timestamp, | ||
| "eventType": eventType, | ||
| "resource": resource, | ||
| } | ||
| self.data = data |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| # Copyright 2021 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. | ||
| import re | ||
|
|
||
| from typing import Tuple | ||
|
|
||
| from cloudevents.http import CloudEvent | ||
|
|
||
| from functions_framework.background_event import BackgroundEvent | ||
| from functions_framework.exceptions import EventConversionException | ||
| from google.cloud.functions.context import Context | ||
|
|
||
| _CLOUDEVENT_SPEC_VERSION = "1.0" | ||
|
|
||
| # Maps background/legacy event types to their equivalent CloudEvent types. | ||
| # For more info on event mappings see | ||
| # https://github.com/GoogleCloudPlatform/functions-framework-conformance/blob/master/docs/mapping.md | ||
| _BACKGROUND_TO_CE_TYPE = { | ||
| "google.pubsub.topic.publish": "google.cloud.pubsub.topic.v1.messagePublished", | ||
| "providers/cloud.pubsub/eventTypes/topic.publish": "google.cloud.pubsub.topic.v1.messagePublished", | ||
| "google.storage.object.finalize": "google.cloud.storage.object.v1.finalized", | ||
| "google.storage.object.delete": "google.cloud.storage.object.v1.deleted", | ||
| "google.storage.object.archive": "google.cloud.storage.object.v1.archived", | ||
| "google.storage.object.metadataUpdate": "google.cloud.storage.object.v1.metadataUpdated", | ||
| "providers/cloud.firestore/eventTypes/document.write": "google.cloud.firestore.document.v1.written", | ||
| "providers/cloud.firestore/eventTypes/document.create": "google.cloud.firestore.document.v1.created", | ||
| "providers/cloud.firestore/eventTypes/document.update": "google.cloud.firestore.document.v1.updated", | ||
| "providers/cloud.firestore/eventTypes/document.delete": "google.cloud.firestore.document.v1.deleted", | ||
| "providers/firebase.auth/eventTypes/user.create": "google.firebase.auth.user.v1.created", | ||
| "providers/firebase.auth/eventTypes/user.delete": "google.firebase.auth.user.v1.deleted", | ||
| "providers/google.firebase.analytics/eventTypes/event.log": "google.firebase.analytics.log.v1.written", | ||
| "providers/google.firebase.database/eventTypes/ref.create": "google.firebase.database.document.v1.created", | ||
| "providers/google.firebase.database/eventTypes/ref.write": "google.firebase.database.document.v1.written", | ||
| "providers/google.firebase.database/eventTypes/ref.update": "google.firebase.database.document.v1.updated", | ||
| "providers/google.firebase.database/eventTypes/ref.delete": "google.firebase.database.document.v1.deleted", | ||
| "providers/cloud.storage/eventTypes/object.change": "google.cloud.storage.object.v1.finalized", | ||
| } | ||
|
|
||
| # CloudEvent service names. | ||
| _FIREBASE_AUTH_CE_SERVICE = "firebaseauth.googleapis.com" | ||
| _FIREBASE_CE_SERVICE = "firebase.googleapis.com" | ||
| _FIREBASE_DB_CE_SERVICE = "firebasedatabase.googleapis.com" | ||
| _FIRESTORE_CE_SERVICE = "firestore.googleapis.com" | ||
| _PUBSUB_CE_SERVICE = "pubsub.googleapis.com" | ||
| _STORAGE_CE_SERVICE = "storage.googleapis.com" | ||
|
|
||
| # Maps background event services to their equivalent CloudEvent services. | ||
| _SERVICE_BACKGROUND_TO_CE = { | ||
| "providers/cloud.firestore/": _FIRESTORE_CE_SERVICE, | ||
| "providers/google.firebase.analytics/": _FIREBASE_CE_SERVICE, | ||
| "providers/firebase.auth/": _FIREBASE_AUTH_CE_SERVICE, | ||
| "providers/google.firebase.database/": _FIREBASE_DB_CE_SERVICE, | ||
| "providers/cloud.pubsub/": _PUBSUB_CE_SERVICE, | ||
| "providers/cloud.storage/": _STORAGE_CE_SERVICE, | ||
| "google.pubsub": _PUBSUB_CE_SERVICE, | ||
| "google.storage": _STORAGE_CE_SERVICE, | ||
| } | ||
|
|
||
| # Maps CloudEvent service strings to regular expressions used to split a background | ||
| # event resource string into CloudEvent resource and subject strings. Each regex | ||
| # must have exactly two capture groups: the first for the resource and the second | ||
| # for the subject. | ||
| _CE_SERVICE_TO_RESOURCE_RE = { | ||
| _FIREBASE_CE_SERVICE: re.compile(r"^(projects/[^/]+)/(events/[^/]+)$"), | ||
| _FIREBASE_DB_CE_SERVICE: re.compile(r"^(projects/[^/]/instances/[^/]+)/(refs/.+)$"), | ||
| _FIRESTORE_CE_SERVICE: re.compile( | ||
| r"^(projects/[^/]+/databases/\(default\))/(documents/.+)$" | ||
| ), | ||
| _STORAGE_CE_SERVICE: re.compile(r"^(projects/[^/]/buckets/[^/]+)/(objects/.+)$"), | ||
| } | ||
|
|
||
| # Maps Firebase Auth background event metadata field names to their equivalent | ||
| # CloudEvent field names. | ||
| _FIREBASE_AUTH_METADATA_FIELDS_BACKGROUND_TO_CE = { | ||
| "createdAt": "createTime", | ||
| "lastSignedInAt": "lastSignInTime", | ||
| } | ||
|
|
||
|
|
||
| def background_event_to_cloudevent(request) -> CloudEvent: | ||
| """Converts a background event represented by the given HTTP request into a CloudEvent. """ | ||
| event_data = request.get_json() | ||
| if not event_data: | ||
| raise EventConversionException("Failed to parse JSON") | ||
|
|
||
| event_object = BackgroundEvent(**event_data) | ||
| data = event_object.data | ||
| context = Context(**event_object.context) | ||
|
|
||
| if context.event_type not in _BACKGROUND_TO_CE_TYPE: | ||
| raise EventConversionException( | ||
| f'Unable to find CloudEvent equivalent type for "{context.event_type}"' | ||
| ) | ||
| new_type = _BACKGROUND_TO_CE_TYPE[context.event_type] | ||
|
|
||
| service, resource, subject = _split_resource(context) | ||
|
|
||
| # Handle Pub/Sub events. | ||
| if service == _PUBSUB_CE_SERVICE: | ||
| data = {"message": data} | ||
|
|
||
| # Handle Firebase Auth events. | ||
| if service == _FIREBASE_AUTH_CE_SERVICE: | ||
| if "metadata" in data: | ||
| for old, new in _FIREBASE_AUTH_METADATA_FIELDS_BACKGROUND_TO_CE.items(): | ||
| if old in data["metadata"]: | ||
| data["metadata"][new] = data["metadata"][old] | ||
| del data["metadata"][old] | ||
| if "uid" in data: | ||
| uid = data["uid"] | ||
| subject = f"users/{uid}" | ||
|
|
||
| metadata = { | ||
| "id": context.event_id, | ||
| "time": context.timestamp, | ||
| "specversion": _CLOUDEVENT_SPEC_VERSION, | ||
| "datacontenttype": "application/json", | ||
| "type": new_type, | ||
| "source": f"//{service}/{resource}", | ||
| } | ||
|
|
||
| if subject: | ||
| metadata["subject"] = subject | ||
|
|
||
| return CloudEvent(metadata, data) | ||
|
|
||
|
|
||
| def _split_resource(context: Context) -> Tuple[str, str, str]: | ||
| """Splits a background event's resource into a CloudEvent service, resource, and subject.""" | ||
| service = "" | ||
| resource = "" | ||
| if isinstance(context.resource, dict): | ||
| service = context.resource.get("service", "") | ||
| resource = context.resource["name"] | ||
| else: | ||
| resource = context.resource | ||
|
|
||
| # If there's no service we'll choose an appropriate one based on the event type. | ||
| if not service: | ||
| for b_service, ce_service in _SERVICE_BACKGROUND_TO_CE.items(): | ||
| if context.event_type.startswith(b_service): | ||
| service = ce_service | ||
| break | ||
| if not service: | ||
| raise EventConversionException( | ||
| "Unable to find CloudEvent equivalent service " | ||
| f"for {context.event_type}" | ||
| ) | ||
|
|
||
| # If we don't need to split the resource string then we're done. | ||
| if service not in _CE_SERVICE_TO_RESOURCE_RE: | ||
| return service, resource, "" | ||
|
|
||
| # Split resource into resource and subject. | ||
| match = _CE_SERVICE_TO_RESOURCE_RE[service].fullmatch(resource) | ||
| if not match: | ||
| raise EventConversionException("Resource regex did not match") | ||
|
|
||
| return service, match.group(1), match.group(2) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.