-
Notifications
You must be signed in to change notification settings - Fork 14.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create ChimeWebhook Hook to send messages to chime room from Airflow. --------- Co-authored-by: Beata Kossakowska <[email protected]> Co-authored-by: Beata Kossakowska <[email protected]> Co-authored-by: eladkal <[email protected]> Co-authored-by: Jarek Potiuk <[email protected]>
- Loading branch information
5 people
authored
Jun 27, 2023
1 parent
e4eb198
commit 10df743
Showing
8 changed files
with
302 additions
and
7 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you 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. | ||
|
|
||
| """This module contains a web hook for Chime.""" | ||
| from __future__ import annotations | ||
|
|
||
| import json | ||
| import re | ||
| from typing import Any | ||
|
|
||
| from airflow.exceptions import AirflowException | ||
| from airflow.providers.http.hooks.http import HttpHook | ||
|
|
||
|
|
||
| class ChimeWebhookHook(HttpHook): | ||
| """Interact with Chime Web Hooks to create notifications. | ||
| .. warning:: This hook is only designed to work with web hooks and not chat bots. | ||
| :param chime_conn_id: Chime connection ID with Endpoint as "https://hooks.chime.aws" and | ||
| the webhook token in the form of ```{webhook.id}?token{webhook.token}``` | ||
| """ | ||
|
|
||
| conn_name_attr = "chime_conn_id" | ||
| default_conn_name = "chime_default" | ||
| conn_type = "chime" | ||
| hook_name = "Chime Web Hook" | ||
|
|
||
| def __init__( | ||
| self, | ||
| chime_conn_id: str, | ||
| *args: Any, | ||
| **kwargs: Any, | ||
| ) -> None: | ||
| super().__init__(*args, **kwargs) | ||
| self.webhook_endpoint = self._get_webhook_endpoint(chime_conn_id) | ||
|
|
||
| def _get_webhook_endpoint(self, conn_id: str) -> str: | ||
| """ | ||
| Given a Chime conn_id return the default webhook endpoint. | ||
| :param conn_id: The provided connection ID. | ||
| :return: Endpoint(str) for chime webhook. | ||
| """ | ||
| conn = self.get_connection(conn_id) | ||
| token = conn.get_password() | ||
| if token is None: | ||
| raise AirflowException("Webhook token field is missing and is required.") | ||
| url = conn.schema + "://" + conn.host | ||
| endpoint = url + token | ||
| # Check to make sure the endpoint matches what Chime expects | ||
| if not re.match(r"^[a-zA-Z0-9_-]+\?token=[a-zA-Z0-9_-]+$", token): | ||
| raise AirflowException( | ||
| "Expected Chime webhook token in the form of '{webhook.id}?token={webhook.token}'." | ||
| ) | ||
|
|
||
| return endpoint | ||
|
|
||
| def _build_chime_payload(self, message: str) -> str: | ||
| """ | ||
| Builds payload for Chime and ensures messages do not exceed max length allowed. | ||
| :param message: The message you want to send to your Chime room. | ||
| (max 4096 characters) | ||
| """ | ||
| payload: dict[str, Any] = {} | ||
| # We need to make sure that the message does not exceed the max length for Chime | ||
| if len(message) > 4096: | ||
| raise AirflowException("Chime message must be 4096 characters or less.") | ||
|
|
||
| payload["Content"] = message | ||
| return json.dumps(payload) | ||
|
|
||
| def send_message(self, message: str) -> None: | ||
| """Execute calling the Chime webhook endpoint. | ||
| :param message: The message you want to send to your Chime room. | ||
| (max 4096 characters) | ||
| """ | ||
| chime_payload = self._build_chime_payload(message) | ||
| self.run( | ||
| endpoint=self.webhook_endpoint, data=chime_payload, headers={"Content-type": "application/json"} | ||
| ) | ||
|
|
||
| @classmethod | ||
| def get_ui_field_behaviour(cls) -> dict[str, Any]: | ||
| """Returns custom field behaviour to only get what is needed for Chime webhooks to function.""" | ||
| return { | ||
| "hidden_fields": ["login", "port", "extra"], | ||
| "relabeling": { | ||
| "host": "Chime Webhook Endpoint", | ||
| "password": "Webhook Token", | ||
| }, | ||
| "placeholders": { | ||
| "schema": "https", | ||
| "host": "hooks.chime.aws/incomingwebhook/", | ||
| "password": "T00000000?token=XXXXXXXXXXXXXXXXXXXXXXXX", | ||
| }, | ||
| } |
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 |
|---|---|---|
|
|
@@ -61,6 +61,7 @@ versions: | |
| dependencies: | ||
| - apache-airflow>=2.4.0 | ||
| - apache-airflow-providers-common-sql>=1.3.1 | ||
| - apache-airflow-providers-http | ||
| - boto3>=1.24.0 | ||
| - asgiref | ||
| # watchtower 3 has been released end Jan and introduced breaking change across the board that might | ||
|
|
@@ -84,6 +85,10 @@ integrations: | |
| how-to-guide: | ||
| - /docs/apache-airflow-providers-amazon/operators/athena.rst | ||
| tags: [aws] | ||
| - integration-name: Amazon Chime | ||
| external-doc-url: https://aws.amazon.com/chime/ | ||
| logo: /integration-logos/aws/Amazon-Chime-light-bg.png | ||
| tags: [aws] | ||
| - integration-name: Amazon CloudFormation | ||
| external-doc-url: https://aws.amazon.com/cloudformation/ | ||
| logo: /integration-logos/aws/[email protected] | ||
|
|
@@ -407,6 +412,9 @@ hooks: | |
| - integration-name: Amazon Athena | ||
| python-modules: | ||
| - airflow.providers.amazon.aws.hooks.athena | ||
| - integration-name: Amazon Chime | ||
| python-modules: | ||
| - airflow.providers.amazon.aws.hooks.chime | ||
| - integration-name: Amazon DynamoDB | ||
| python-modules: | ||
| - airflow.providers.amazon.aws.hooks.dynamodb | ||
|
|
@@ -624,11 +632,14 @@ extra-links: | |
| connection-types: | ||
| - hook-class-name: airflow.providers.amazon.aws.hooks.base_aws.AwsGenericHook | ||
| connection-type: aws | ||
| - hook-class-name: airflow.providers.amazon.aws.hooks.chime.ChimeWebhookHook | ||
| connection-type: chime | ||
| - hook-class-name: airflow.providers.amazon.aws.hooks.emr.EmrHook | ||
| connection-type: emr | ||
| - hook-class-name: airflow.providers.amazon.aws.hooks.redshift_sql.RedshiftSQLHook | ||
| connection-type: redshift | ||
|
|
||
|
|
||
| secrets-backends: | ||
| - airflow.providers.amazon.aws.secrets.secrets_manager.SecretsManagerBackend | ||
| - airflow.providers.amazon.aws.secrets.systems_manager.SystemsManagerParameterStoreBackend | ||
|
|
||
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
60 changes: 60 additions & 0 deletions
60
docs/apache-airflow-providers-amazon/connections/chime.rst
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,60 @@ | ||
| .. Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you 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. | ||
| .. _howto/connection:chime: | ||
|
|
||
| Amazon Chime Connection | ||
| ========================== | ||
|
|
||
| The Chime connection works with calling Chime webhooks to send messages to a chime room. | ||
|
|
||
| Authenticating to Amazon Chime | ||
| --------------------------------- | ||
| When a webhook is created in a Chime room a token will be included in the url for authentication. | ||
|
|
||
|
|
||
| Default Connection IDs | ||
| ---------------------- | ||
|
|
||
| The default connection ID is ``chime_default``. | ||
|
|
||
| Configuring the Connection | ||
| -------------------------- | ||
| Chime Webhook Endpoint: | ||
| Specify the entire url or the base of the url for the service. | ||
|
|
||
|
|
||
| Chime Webhook token: | ||
| The token for authentication including the webhook ID. | ||
|
|
||
| Schema: | ||
| Whether or not the endpoint should be http or https | ||
|
|
||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| **Connection** | ||
|
|
||
| * **Chime Webhook Endpoint**: hooks.chime.aws | ||
| * **Chime Webhook Token**: | ||
|
|
||
| .. code-block:: text | ||
| abceasd-3423-a1237-ffff-000cccccccc?token=somechimetoken | ||
| * **Schema**: https |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.