dpgaspar commented on code in PR #30044: URL: https://github.com/apache/superset/pull/30044#discussion_r1756604027
########## superset/reports/notifications/webhook.py: ########## @@ -0,0 +1,139 @@ +# 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. + +import hmac +import logging +from typing import Dict, Optional + +import requests + +from superset import app +from superset.reports.models import ReportRecipientType +from superset.reports.notifications.base import BaseNotification +from superset.reports.notifications.exceptions import NotificationError +from superset.utils import json +from superset.utils.decorators import statsd_gauge + +logger = logging.getLogger(__name__) + + +class WebhookNotification(BaseNotification): # pylint: disable=too-few-public-methods + """ + Sends webhook notification to client host. + """ + + type = ReportRecipientType.WEBHOOK + + @staticmethod + def _get_secret_token() -> str: + """ + Retrieves the secret token for HMAC signature from the application configuration. + """ + with app.app_context(): + return app.config.get("WEBHOOK_SECRET") + + def _get_host(self) -> str: + """ + Retrieves the target host from the recipient configuration. + """ + return json.loads(self._recipient.recipient_config_json)["target"] + + def _generate_signature( + self, data: Dict[str, Optional[str | None | int]] Review Comment: we still support python 3.9, in order to use the new union type annotation we need to import: ``` from __future__ import annotations ``` ########## superset/reports/notifications/webhook.py: ########## @@ -0,0 +1,139 @@ +# 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. + +import hmac +import logging +from typing import Dict, Optional + +import requests + +from superset import app +from superset.reports.models import ReportRecipientType +from superset.reports.notifications.base import BaseNotification +from superset.reports.notifications.exceptions import NotificationError +from superset.utils import json +from superset.utils.decorators import statsd_gauge + +logger = logging.getLogger(__name__) + + +class WebhookNotification(BaseNotification): # pylint: disable=too-few-public-methods + """ + Sends webhook notification to client host. + """ + + type = ReportRecipientType.WEBHOOK + + @staticmethod + def _get_secret_token() -> str: + """ + Retrieves the secret token for HMAC signature from the application configuration. + """ + with app.app_context(): Review Comment: do we need to create a new app_context here? ########## superset/reports/notifications/webhook.py: ########## @@ -0,0 +1,139 @@ +# 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. + +import hmac +import logging +from typing import Dict, Optional + +import requests + +from superset import app +from superset.reports.models import ReportRecipientType +from superset.reports.notifications.base import BaseNotification +from superset.reports.notifications.exceptions import NotificationError +from superset.utils import json +from superset.utils.decorators import statsd_gauge + +logger = logging.getLogger(__name__) + + +class WebhookNotification(BaseNotification): # pylint: disable=too-few-public-methods + """ + Sends webhook notification to client host. + """ + + type = ReportRecipientType.WEBHOOK + + @staticmethod + def _get_secret_token() -> str: + """ + Retrieves the secret token for HMAC signature from the application configuration. + """ + with app.app_context(): + return app.config.get("WEBHOOK_SECRET") + + def _get_host(self) -> str: + """ + Retrieves the target host from the recipient configuration. + """ + return json.loads(self._recipient.recipient_config_json)["target"] + + def _generate_signature( + self, data: Dict[str, Optional[str | None | int]] + ) -> str | None: + """ + Generates an HMAC SHA256 signature for the given data. + """ + if secret := self._get_secret_token(): + return hmac.new( + secret.encode("utf-8"), + json.dumps(data).encode("utf-8"), + digestmod="sha256", + ).hexdigest() + return None + + def _get_header( + self, data: Dict[str, Optional[str | None | int]] Review Comment: if using `from __future__ import annotations` let's change this to: ``` python def _get_header( self, data: dict[str, Optional[str | None | int]] ... ``` ########## superset/reports/notifications/webhook.py: ########## @@ -0,0 +1,139 @@ +# 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. + +import hmac +import logging +from typing import Dict, Optional + +import requests + +from superset import app +from superset.reports.models import ReportRecipientType +from superset.reports.notifications.base import BaseNotification +from superset.reports.notifications.exceptions import NotificationError +from superset.utils import json +from superset.utils.decorators import statsd_gauge + +logger = logging.getLogger(__name__) + + +class WebhookNotification(BaseNotification): # pylint: disable=too-few-public-methods + """ + Sends webhook notification to client host. + """ + + type = ReportRecipientType.WEBHOOK + + @staticmethod + def _get_secret_token() -> str: + """ + Retrieves the secret token for HMAC signature from the application configuration. + """ + with app.app_context(): + return app.config.get("WEBHOOK_SECRET") + + def _get_host(self) -> str: + """ + Retrieves the target host from the recipient configuration. + """ + return json.loads(self._recipient.recipient_config_json)["target"] + + def _generate_signature( + self, data: Dict[str, Optional[str | None | int]] + ) -> str | None: + """ + Generates an HMAC SHA256 signature for the given data. + """ + if secret := self._get_secret_token(): + return hmac.new( + secret.encode("utf-8"), + json.dumps(data).encode("utf-8"), + digestmod="sha256", + ).hexdigest() + return None + + def _get_header( + self, data: Dict[str, Optional[str | None | int]] + ) -> Dict[str, Optional[str]]: + """ + Constructs the header with the generated HMAC signature. + """ + signature = self._generate_signature(data) + return { + "X-Webhook-Signature": signature, + } + + def _get_files(self) -> Optional[Dict[str, bytes]]: + """ + Retrieves the files to be sent with the notification. + """ + if self._content.csv: + return {"csv": self._content.csv} + if self._content.pdf: + return {"pdf": self._content.pdf} + if self._content.screenshots: + return { + f"png_{index}": file + for index, file in enumerate(self._content.screenshots) + } + return None + + def _construct_payload(self) -> Dict[str, Optional[str] | Optional[int]]: + """ + Constructs the payload for the webhook notification. + """ + notification_name, content_name = self._content.name.split(":") + return { + "notification_name": notification_name, + "notification_id": self._content.id, + "notification_type": self._content.header_data.get("notification_type"), + "content_name": content_name.strip(), + "content_type": self._content.header_data.get("notification_source"), + "content_id": ( + self._content.header_data.get("chart_id") + if self._content.header_data.get("chart_id") + else self._content.header_data.get("dashboard_id") + ), + "content_format": self._content.header_data.get("notification_format"), + "metadata": json.loads(self._recipient.recipient_config_json).get( + "JSONData" Review Comment: WDYT about creating a TypeDict to make this payload structure more explicit ########## superset/reports/notifications/webhook.py: ########## @@ -0,0 +1,139 @@ +# 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. + +import hmac +import logging +from typing import Dict, Optional + +import requests + +from superset import app +from superset.reports.models import ReportRecipientType +from superset.reports.notifications.base import BaseNotification +from superset.reports.notifications.exceptions import NotificationError +from superset.utils import json +from superset.utils.decorators import statsd_gauge + +logger = logging.getLogger(__name__) + + +class WebhookNotification(BaseNotification): # pylint: disable=too-few-public-methods + """ + Sends webhook notification to client host. + """ + + type = ReportRecipientType.WEBHOOK + + @staticmethod + def _get_secret_token() -> str: + """ + Retrieves the secret token for HMAC signature from the application configuration. + """ + with app.app_context(): + return app.config.get("WEBHOOK_SECRET") + + def _get_host(self) -> str: + """ + Retrieves the target host from the recipient configuration. + """ + return json.loads(self._recipient.recipient_config_json)["target"] + + def _generate_signature( + self, data: Dict[str, Optional[str | None | int]] + ) -> str | None: + """ + Generates an HMAC SHA256 signature for the given data. + """ + if secret := self._get_secret_token(): + return hmac.new( + secret.encode("utf-8"), + json.dumps(data).encode("utf-8"), + digestmod="sha256", + ).hexdigest() + return None + + def _get_header( + self, data: Dict[str, Optional[str | None | int]] + ) -> Dict[str, Optional[str]]: + """ + Constructs the header with the generated HMAC signature. + """ + signature = self._generate_signature(data) + return { + "X-Webhook-Signature": signature, + } + + def _get_files(self) -> Optional[Dict[str, bytes]]: + """ + Retrieves the files to be sent with the notification. + """ + if self._content.csv: + return {"csv": self._content.csv} + if self._content.pdf: + return {"pdf": self._content.pdf} + if self._content.screenshots: + return { + f"png_{index}": file + for index, file in enumerate(self._content.screenshots) + } + return None + + def _construct_payload(self) -> Dict[str, Optional[str] | Optional[int]]: + """ + Constructs the payload for the webhook notification. + """ + notification_name, content_name = self._content.name.split(":") + return { + "notification_name": notification_name, + "notification_id": self._content.id, + "notification_type": self._content.header_data.get("notification_type"), + "content_name": content_name.strip(), + "content_type": self._content.header_data.get("notification_source"), + "content_id": ( + self._content.header_data.get("chart_id") + if self._content.header_data.get("chart_id") + else self._content.header_data.get("dashboard_id") + ), + "content_format": self._content.header_data.get("notification_format"), + "metadata": json.loads(self._recipient.recipient_config_json).get( + "JSONData" + ), + } + + @statsd_gauge("reports.webhook.send") + def send(self) -> None: + """ + Sends the webhook notification to the configured host. + """ + host = self._get_host() + payload = self._construct_payload() + headers = self._get_header(payload) + files = self._get_files() + + try: + response = requests.post( + url=host, + data={"json": json.dumps(payload)}, + files=files, + headers=headers, + timeout=10, + ) + response.raise_for_status() + logger.info("Report webhook has been successfully sent to {host}") Review Comment: use: ``` logger.info("Report webhook has been successfully sent to %s", host) ``` instead ########## superset/reports/notifications/webhook.py: ########## @@ -0,0 +1,139 @@ +# 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. + +import hmac +import logging +from typing import Dict, Optional + +import requests + +from superset import app +from superset.reports.models import ReportRecipientType +from superset.reports.notifications.base import BaseNotification +from superset.reports.notifications.exceptions import NotificationError +from superset.utils import json +from superset.utils.decorators import statsd_gauge + +logger = logging.getLogger(__name__) + + +class WebhookNotification(BaseNotification): # pylint: disable=too-few-public-methods + """ + Sends webhook notification to client host. + """ + + type = ReportRecipientType.WEBHOOK + + @staticmethod + def _get_secret_token() -> str: + """ + Retrieves the secret token for HMAC signature from the application configuration. + """ + with app.app_context(): + return app.config.get("WEBHOOK_SECRET") + + def _get_host(self) -> str: + """ + Retrieves the target host from the recipient configuration. + """ + return json.loads(self._recipient.recipient_config_json)["target"] + + def _generate_signature( + self, data: Dict[str, Optional[str | None | int]] + ) -> str | None: + """ + Generates an HMAC SHA256 signature for the given data. + """ + if secret := self._get_secret_token(): + return hmac.new( + secret.encode("utf-8"), + json.dumps(data).encode("utf-8"), + digestmod="sha256", Review Comment: digestmod could be a new configuration key -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
