feat: support ServiceBus SDK-type bindings (#107)

* Initial changes to support sbrm

* missed return

* add test pipeline, start readme

* add to pipelines, update tests, lint

* lint, samples, fix pyproject

* move to pydocs

* Update readme, final samples

* lower version

* feedback + run all  tests as part of public build

* feedback

---------

Co-authored-by: Victoria Hall <[email protected]>

Author: hallvictoria

azurefunctions-extensions-bindings-servicebus/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

azurefunctions-extensions-bindings-servicebus/MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include azure *.py *.pyi
+recursive-include tests *.py
+include LICENSE README.md

azurefunctions-extensions-bindings-servicebus/README.md

@@ -0,0 +1,102 @@
+# Azure Functions Extensions Bindings ServiceBus library for Python
+This library allows ServiceBus Triggers in Python Function Apps to recognize and bind to client types from the
+Azure ServiceBus sdk.
+
+The SDK types can be generated from:
+
+* ServiceBus Triggers
+
+The supported ServiceBus SDK types include:
+
+* ServiceBusReceivedMessage
+
+[Source code](https://github.com/Azure/azure-functions-python-extensions/tree/dev/azurefunctions-extensions-bindings-servicebus)
+| 
+[Package (PyPi)](https://pypi.org/project/azurefunctions-extensions-bindings-servicebus/)
+| [Samples](https://github.com/Azure/azure-functions-python-extensions/tree/dev/azurefunctions-extensions-bindings-servicebus/samples)
+
+
+## Getting started
+
+### Prerequisites
+* Python 3.9 or later is required to use this package. For more details, please read our page on [Python Functions version support policy](https://learn.microsoft.com/en-us/azure/azure-functions/functions-versions?tabs=isolated-process%2Cv4&pivots=programming-language-python#languages).
+
+* You must have an [Azure subscription](https://azure.microsoft.com/free/) and a
+[ServiceBus Resource](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-service-bus?tabs=isolated-process%2Cextensionv5%2Cextensionv3&pivots=programming-language-python) to use this package.
+
+### Install the package
+Install the Azure Functions Extensions Bindings ServiceBus library for Python with pip:
+
+```bash
+pip install azurefunctions-extensions-bindings-servicebus
+```
+
+
+### Bind to the SDK-type
+The Azure Functions Extensions Bindings ServiceBus library for Python allows you to create a function app with a ServiceBus Trigger
+and define the type as a ServiceBusReceivedMessage. Instead of receiving
+a ServiceBusMessage, when the function is executed, the type returned will be the defined SDK-type and have all the
+properties and methods available as seen in the Azure ServiceBus library for Python.
+
+
+```python
+import logging
+import azure.functions as func
+import azurefunctions.extensions.bindings.servicebus as servicebus
+
+app = func.FunctionApp(http_auth_level=func.AuthLevel.FUNCTION)
+
+@app.service_bus_queue_trigger(arg_name="receivedmessage",
+                               queue_name="QUEUE_NAME",
+                               connection="SERVICEBUS_CONNECTION")
+def servicebus_queue_trigger(receivedmessage: servicebus.ServiceBusReceivedMessage):
+    logging.info("Python ServiceBus queue trigger processed message.")
+    logging.info("Receiving: %s\n"
+                 "Body: %s\n"
+                 "Enqueued time: %s\n"
+                 "Lock Token: %s\n"
+                 "Locked until : %s\n"
+                 "Message ID: %s\n"
+                 "Sequence number: %s\n",
+                 receivedmessage,
+                 receivedmessage.body,
+                 receivedmessage.enqueued_time_utc,
+                 receivedmessage.lock_token,
+                 receivedmessage.locked_until,
+                 receivedmessage.message_id,
+                 receivedmessage.sequence_number)
+```
+
+## Troubleshooting
+### General
+The SDK-types raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md).
+
+This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use the `error_code` attribute, i.e, `exception.error_code`.
+
+## Next steps
+
+### More sample code
+
+Get started with our [ServiceBus samples](https://github.com/Azure/azure-functions-python-extensions/tree/dev/azurefunctions-extensions-bindings-servicebus/samples).
+
+Several samples are available in this GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Azure ServiceBus:
+
+* [servicebus_samples_single](https://github.com/Azure/azure-functions-python-extensions/tree/dev/azurefunctions-extensions-bindings-servicebus/samples/servicebus_samples_single)  - Examples for using the ServiceBusReceivedMessage type:
+    * From ServiceBus Queue Trigger (Single Message)
+    * From ServiceBus Topic Trigger (Single Message)
+
+* [servicebus_samples_batch](https://github.com/Azure/azure-functions-python-extensions/tree/dev/azurefunctions-extensions-bindings-servicebus/samples/service_samples_batch) - Examples for interacting with batches:
+    * From ServiceBus Queue Trigger (Batch)
+    * From ServiceBus Topic Trigger (Batch)
+
+
+### Additional documentation
+For more information on the Azure ServiceBus SDK, see the [Azure ServiceBus SDK documentation](https://learn.microsoft.com/en-us/python/api/overview/azure/servicebus-readme?view=azure-python) on docs.microsoft.com
+and the [Azure ServiceBus README](https://github.com/Azure/azure-sdk-for-python/blob/azure-servicebus_7.14.1/sdk/servicebus/azure-servicebus/README.md).
+
+## Contributing
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

azurefunctions-extensions-bindings-servicebus/azurefunctions/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

azurefunctions-extensions-bindings-servicebus/azurefunctions/extensions/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

azurefunctions-extensions-bindings-servicebus/azurefunctions/extensions/bindings/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

azurefunctions-extensions-bindings-servicebus/azurefunctions/extensions/bindings/servicebus/__init__.py

@@ -0,0 +1,12 @@
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+
+from .serviceBusReceivedMessage import ServiceBusReceivedMessage
+from .serviceBusConverter import ServiceBusConverter
+
+__all__ = [
+    "ServiceBusReceivedMessage",
+    "ServiceBusConverter",
+]
+
+__version__ = '1.0.0a1'

azurefunctions-extensions-bindings-servicebus/azurefunctions/extensions/bindings/servicebus/serviceBusConverter.py

@@ -0,0 +1,74 @@
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+
+import collections.abc
+from typing import Any, get_args, get_origin
+
+from azurefunctions.extensions.base import Datum, InConverter
+from .serviceBusReceivedMessage import ServiceBusReceivedMessage
+
+
+class ServiceBusConverter(
+    InConverter,
+    binding='serviceBusTrigger', trigger=True
+):
+    @classmethod
+    def check_input_type_annotation(cls, pytype: type) -> bool:
+        if pytype is None:
+            return False
+
+        # The annotation is a class/type (not an object) - not iterable
+        if (isinstance(pytype, type)
+                and issubclass(pytype, ServiceBusReceivedMessage)):
+            return True
+
+        # An iterable who only has one inner type and is a subclass of SdkType
+        return cls._is_iterable_supported_type(pytype)
+
+    @classmethod
+    def _is_iterable_supported_type(cls, annotation: type) -> bool:
+        # Check base type from type hint. Ex: List from List[SdkType]
+        base_type = get_origin(annotation)
+        if (base_type is None
+                or not issubclass(base_type, collections.abc.Iterable)):
+            return False
+
+        inner_types = get_args(annotation)
+        if inner_types is None or len(inner_types) != 1:
+            return False
+
+        inner_type = inner_types[0]
+
+        return (isinstance(inner_type, type)
+                and issubclass(inner_type, ServiceBusReceivedMessage))
+
+    @classmethod
+    def decode(cls, data: Datum, *, trigger_metadata, pytype) -> Any:
+        """
+        ServiceBus allows for batches to be sent. The cardinality can be one or many.
+        When the cardinality is one:
+            - The data is of type "model_binding_data" - each event is an independent
+              function invocation
+        When the cardinality is many:
+            - The data is of type "collection_model_binding_data" - all events are sent
+              in a single function invocation
+            - collection_model_binding_data has 1 or more model_binding_data objects
+        """
+        if data is None or data.type is None:
+            return None
+
+        data_type = data.type
+
+        if data_type == "model_binding_data":
+            return ServiceBusReceivedMessage(data=data.value).get_sdk_type()
+        elif data_type == "collection_model_binding_data":
+            try:
+                return [ServiceBusReceivedMessage(data=mbd).get_sdk_type()
+                        for mbd in data.value.model_binding_data]
+            except Exception as e:
+                raise ValueError("Failed to decode incoming ServiceBus batch: "
+                                 + repr(e)) from e
+        else:
+            raise ValueError(
+                "Unexpected type of data received for the 'servicebus' binding: "
+                + repr(data.type))

azurefunctions-extensions-bindings-servicebus/azurefunctions/extensions/bindings/servicebus/serviceBusReceivedMessage.py

@@ -0,0 +1,33 @@
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+
+from azure.servicebus import ServiceBusReceivedMessage as ServiceBusReceivedMessageSdk
+from azurefunctions.extensions.base import Datum, SdkType
+from .utils import get_decoded_message
+
+
+class ServiceBusReceivedMessage(SdkType):
+    def __init__(self, *, data: Datum) -> None:
+        # model_binding_data properties
+        self._data = data
+        self._version = None
+        self._source = None
+        self._content_type = None
+        self._content = None
+        self._decoded_message = None
+        if self._data:
+            self._version = data.version
+            self._source = data.source
+            self._content_type = data.content_type
+            self._content = data.content
+            self._decoded_message = get_decoded_message(self._content)
+
+    def get_sdk_type(self):
+        """
+        Returns a ServiceBusReceivedMessage.
+        Message settling is not yet supported.
+        """
+        if self._decoded_message:
+            return ServiceBusReceivedMessageSdk(self._decoded_message, receiver=None)
+        else:
+            return None

azurefunctions-extensions-bindings-servicebus/azurefunctions/extensions/bindings/servicebus/utils.py

@@ -0,0 +1,53 @@
+#  Copyright (c) Microsoft Corporation. All rights reserved.
+#  Licensed under the MIT License.
+
+import uamqp
+import uuid
+
+
+_X_OPT_LOCK_TOKEN = b"x-opt-lock-token"
+
+
+def get_lock_token(message: bytes, index: int) -> str:
+    # Get the lock token from the message
+    lock_token_encoded = message[:index]
+
+    # Convert the lock token to a UUID using the first 16 bytes
+    lock_token_uuid = uuid.UUID(bytes=lock_token_encoded[:16])
+
+    return lock_token_uuid
+
+
+def get_amqp_message(message: bytes, index: int):
+    """
+    Get the amqp message from the model_binding_data content
+    and create the message.
+    """
+    amqp_message = message[index + len(_X_OPT_LOCK_TOKEN):]
+    decoded_message = uamqp.Message().decode_from_bytes(amqp_message)
+
+    return decoded_message
+
+
+def get_decoded_message(content: bytes):
+    """
+    First, find the end of the lock token. Then,
+    get the lock token UUID and create the delivery
+    annotations dictionary. Finally, get the amqp message
+    and set the delivery annotations. Once the delivery
+    annotations have been set, the amqp message is ready to
+    return.
+    """
+    if content:
+        try:
+            index = content.find(_X_OPT_LOCK_TOKEN)
+
+            lock_token = get_lock_token(content, index)
+            delivery_anno_dict = {_X_OPT_LOCK_TOKEN: lock_token}
+
+            decoded_message = get_amqp_message(content, index)
+            decoded_message.delivery_annotations = delivery_anno_dict
+            return decoded_message
+        except Exception as e:
+            raise ValueError(f"Failed to decode ServiceBus content: {e}") from e
+    return None