Add support for EventGrid bindings

Author: elprans

azure/functions/__init__.py

@@ -1,5 +1,6 @@
 from ._abc import HttpRequest, TimerRequest, InputStream, Context, Out  # NoQA
 from ._abc import EventHubEvent  # NoQA
+from ._abc import EventGridEvent  # NoQA
 from ._cosmosdb import Document, DocumentList  # NoQA
 from ._http import HttpResponse  # NoQA
 from ._queue import QueueMessage  # NoQA

azure/functions/_abc.py

@@ -199,6 +199,42 @@ def pop_receipt(self) -> typing.Optional[str]:
         pass
 
 
+class EventGridEvent(abc.ABC):
+    @property
+    @abc.abstractmethod
+    def id(self) -> str:
+        pass
+
+    @abc.abstractmethod
+    def get_json(self) -> typing.Any:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def topic(self) -> str:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def subject(self) -> str:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def event_type(self) -> str:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def event_time(self) -> datetime.datetime:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def data_version(self) -> str:
+        pass
+
+
 class Document(abc.ABC):
 
     @classmethod

azure/functions_worker/bindings/__init__.py

@@ -9,6 +9,7 @@
 # to get them registered and available:
 from . import blob  # NoQA
 from . import cosmosdb  # NoQA
+from . import eventgrid  # NoQA
 from . import eventhub  # NoQA
 from . import http  # NoQA
 from . import queue  # NoQA

azure/functions_worker/bindings/eventgrid.py

@@ -0,0 +1,97 @@
+import datetime
+import json
+import typing
+
+from azure.functions import _abc as azf_abc
+
+from . import meta
+from .. import protos
+
+
+class EventGridEvent(azf_abc.EventGridEvent):
+    """An EventGrid event message."""
+
+    def __init__(self, *,
+                 id: str,
+                 data: typing.Dict[str, object],
+                 topic: str,
+                 subject: str,
+                 event_type: str,
+                 event_time: datetime.datetime,
+                 data_version: str) -> None:
+        self.__id = id
+        self.__data = data
+        self.__subject = subject
+        self.__topic = topic
+        self.__event_type = event_type
+        self.__event_time = event_time
+        self.__data_version = data_version
+
+    @property
+    def id(self) -> str:
+        return self.__id
+
+    def get_json(self) -> typing.Any:
+        return self.__data
+
+    @property
+    def topic(self) -> str:
+        return self.__topic
+
+    @property
+    def subject(self) -> str:
+        return self.__subject
+
+    @property
+    def event_type(self) -> str:
+        return self.__event_type
+
+    @property
+    def event_time(self) -> datetime.datetime:
+        return self.__event_time
+
+    @property
+    def data_version(self) -> str:
+        return self.__data_version
+
+    def __repr__(self) -> str:
+        return (
+            f'<azure.EventGridEvent id={self.id} '
+            f'topic={self.topic} '
+            f'subject={self.subject} '
+            f'at 0x{id(self):0x}>'
+        )
+
+
+class EventGridEventInConverter(meta.InConverter,
+                                binding='eventGridTrigger', trigger=True):
+
+    @classmethod
+    def check_input_type_annotation(cls, pytype: type) -> bool:
+        return issubclass(pytype, azf_abc.EventGridEvent)
+
+    @classmethod
+    def from_proto(cls, data: protos.TypedData, *,
+                   pytype: typing.Optional[type],
+                   trigger_metadata) -> typing.Any:
+        data_type = data.WhichOneof('data')
+
+        if data_type == 'json':
+            body = json.loads(data.json)
+        else:
+            raise NotImplementedError(
+                f'unsupported event grid payload type: {data_type}')
+
+        if trigger_metadata is None:
+            raise NotImplementedError(
+                f'missing trigger metadata for event grid input')
+
+        return EventGridEvent(
+            id=body.get('id'),
+            topic=body.get('topic'),
+            subject=body.get('subject'),
+            event_type=body.get('eventType'),
+            event_time=cls._parse_datetime(body.get('eventTime')),
+            data=body.get('data'),
+            data_version=body.get('dataVersion'),
+        )

azure/functions_worker/bindings/meta.py

@@ -143,10 +143,29 @@ def _parse_datetime_metadata(
         if datetime_str is None:
             return None
         else:
-            # UTC ISO 8601 assumed
-            dt = datetime.datetime.strptime(
-                datetime_str, '%Y-%m-%dT%H:%M:%S+00:00')
-            return dt.replace(tzinfo=datetime.timezone.utc)
+            return cls._parse_datetime(datetime_str)
+
+    @classmethod
+    def _parse_datetime(
+            cls, datetime_str: str) -> datetime.datetime:
+        # UTC ISO 8601 assumed
+        formats = [
+            '%Y-%m-%dT%H:%M:%S+00:00',
+            '%Y-%m-%dT%H:%M:%S.%f+00:00',
+            '%Y-%m-%dT%H:%M:%SZ',
+            '%Y-%m-%dT%H:%M:%S.%fZ',
+        ]
+        dt = None
+        for fmt in formats:
+            try:
+                dt = datetime.datetime.strptime(datetime_str, fmt)
+            except ValueError as e:
+                last_error = e
+
+        if dt is None:
+            raise last_error
+
+        return dt.replace(tzinfo=datetime.timezone.utc)
 
 
 class InConverter(_BaseConverter, binding=None):

azure/functions_worker/testutils.py

@@ -574,7 +574,7 @@ def start_webhost(*, script_dir=None, stdout=None):
                              params={'code': 'testFunctionKey'})
             if 200 <= r.status_code < 300:
                 # Give the host a bit more time to settle
-                time.sleep(1)
+                time.sleep(2)
                 break
         except requests.exceptions.ConnectionError:
             pass
@@ -594,13 +594,26 @@ def _main():
 
     args = parser.parse_args()
 
+    extensions = pathlib.Path(args.scriptroot) / 'bin'
+
+    if not extensions.exists():
+        if extensions.is_symlink():
+            extensions.unlink()
+
+        extensions.symlink_to(EXTENSIONS_PATH, target_is_directory=True)
+        linked_extensions = True
+    else:
+        linked_extensions = False
+
     host = popen_webhost(
         stdout=sys.stdout, stderr=sys.stderr,
         script_root=os.path.abspath(args.scriptroot))
     try:
         host.wait()
     finally:
         host.terminate()
+        if linked_extensions:
+            extensions.unlink()
 
 
 if __name__ == '__main__':

setup.py

@@ -28,6 +28,10 @@
         "id": "Microsoft.Azure.WebJobs.Extensions.EventHubs",
         "version": "3.0.0-beta5"
     },
+    {
+        "id": "Microsoft.Azure.WebJobs.Extensions.EventGrid",
+        "version": "2.0.0-beta1"
+    },
 ]
 
 

tests/eventgrid_functions/eventgrid_trigger/__init__.py

@@ -0,0 +1,15 @@
+import json
+
+import azure.functions as func
+
+
+def main(event: func.EventGridEvent) -> str:
+    result = json.dumps({
+        'id': event.id,
+        'data': event.get_json(),
+        'topic': event.topic,
+        'subject': event.subject,
+        'event_type': event.event_type,
+    })
+
+    return result

tests/eventgrid_functions/eventgrid_trigger/function.json

@@ -0,0 +1,19 @@
+{
+  "scriptFile": "__init__.py",
+  "disabled": false,
+
+  "bindings": [
+    {
+      "type": "eventGridTrigger",
+      "direction": "in",
+      "name": "event",
+    },
+    {
+      "type": "blob",
+      "direction": "out",
+      "name": "$return",
+      "connection": "AzureWebJobsStorage",
+      "path": "python-worker-tests/test-eventgrid-triggered.txt"
+    }
+  ]
+}

tests/eventgrid_functions/get_eventgrid_triggered/function.json

@@ -0,0 +1,23 @@
+{
+  "scriptFile": "main.py",
+  "disabled": false,
+  "bindings": [
+    {
+      "type": "httpTrigger",
+      "direction": "in",
+      "name": "req"
+    },
+    {
+      "type": "blob",
+      "direction": "in",
+      "name": "file",
+      "connection": "AzureWebJobsStorage",
+      "path": "python-worker-tests/test-eventgrid-triggered.txt"
+    },
+    {
+      "type": "http",
+      "direction": "out",
+      "name": "$return",
+    }
+  ]
+}