Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
webhooks/heroku: Replace Deploy webhooks with App webhooks.
sathwikshetty33b378b551ea84
diff --git a/static/images/integrations/heroku/001.png b/static/images/integrations/heroku/001.pngindex dfba584f68a..bcf1b9d0bee 100644Binary files a/static/images/integrations/heroku/001.png and b/static/images/integrations/heroku/001.png differdiff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.pyindex 4e3a4d2c10c..35c715d6e1f 100644--- a/zerver/lib/integrations.py+++ b/zerver/lib/integrations.py@@ -768,7 +768,9 @@ INCOMING_WEBHOOK_INTEGRATIONS: list[IncomingWebhookIntegration] = [IncomingWebhookIntegration("helloworld", ["misc"], [WebhookScreenshotConfig("hello.json")], display_name="Hello World"),- IncomingWebhookIntegration("heroku", ["deployment"], [WebhookScreenshotConfig("deploy.txt")]),+ IncomingWebhookIntegration(+ "heroku", ["deployment"], [WebhookScreenshotConfig("build_create.json")]+ ),IncomingWebhookIntegration("homeassistant",["misc"],diff --git a/zerver/webhooks/heroku/fixtures/build_create.json b/zerver/webhooks/heroku/fixtures/build_create.jsonnew file mode 100644index 00000000000..8f9f500e463--- /dev/null+++ b/zerver/webhooks/heroku/fixtures/build_create.json@@ -0,0 +1,55 @@+{+ "id": "2d8d723d-1024-42f1-9cd3-ff5799fb7eac",+ "data": {+ "id": "b6d5ff62-08db-4044-b96c-b8e9e41f1191",+ "app": {+ "id": "4335bcdb-5f6f-41f8-a31b-84697ec96475",+ "name": "Example Project"+ },+ "slug": null,+ "user": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "stack": "heroku-24",+ "status": "pending",+ "release": null,+ "metadata": {},+ "buildpacks": [],+ "created_at": "2025-05-17T11:37:36Z",+ "updated_at": "2025-05-17T11:37:36Z",+ "source_blob": {+ "url": "https://codeload.github.com/theofficialvedantjoshi/media-recommender/legacy.tar.gz/1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "version": "1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "checksum": null+ },+ "output_stream_url": "https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113737Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=b2f0cac0426f4898d9bdcd214401027af128935b9e9618eeb6f83a3546b142d2"+ },+ "actor": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "action": "create",+ "version": "application/vnd.heroku+json; version=3",+ "resource": "build",+ "sequence": null,+ "created_at": "2025-05-17T11:37:37+00:00",+ "updated_at": "2025-05-17T11:37:37+00:00",+ "published_at": "2025-05-17T11:37:37Z",+ "previous_data": {},+ "webhook_metadata": {+ "attempt": {+ "id": "761b853a-315c-43a2-abe5-cbd01bdf6914"+ },+ "delivery": {+ "id": "5483911a-8230-4d10-a835-e7bc07a5fa94"+ },+ "event": {+ "id": "2d8d723d-1024-42f1-9cd3-ff5799fb7eac",+ "include": "api:build"+ },+ "webhook": {+ "id": "e1020099-2147-45d9-b7a1-bf1422851eea"+ }+ }+}diff --git a/zerver/webhooks/heroku/fixtures/build_update.json b/zerver/webhooks/heroku/fixtures/build_update.jsonnew file mode 100644index 00000000000..0e4e4aa7a6c--- /dev/null+++ b/zerver/webhooks/heroku/fixtures/build_update.json@@ -0,0 +1,66 @@+{+ "id": "aab185d0-2611-4f40-817c-caba2ad7d2de",+ "data": {+ "id": "b6d5ff62-08db-4044-b96c-b8e9e41f1191",+ "app": {+ "id": "4335bcdb-5f6f-41f8-a31b-84697ec96475",+ "name": "Example Project"+ },+ "slug": {+ "id": "e7cb552a-e840-48cb-9164-081d1e6da274",+ "commit": "1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "commit_description": ""+ },+ "user": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "stack": "heroku-24",+ "status": "succeeded",+ "release": {+ "id": "6be9012f-1c42-4f2d-bb99-af152aad07d8",+ "version": 3+ },+ "metadata": {},+ "buildpacks": [+ {+ "url": "https://buildpack-registry.s3.amazonaws.com/buildpacks/heroku/python.tgz"+ }+ ],+ "created_at": "2025-05-17T11:37:36Z",+ "updated_at": "2025-05-17T11:38:03Z",+ "source_blob": {+ "url": "https://codeload.github.com/theofficialvedantjoshi/media-recommender/legacy.tar.gz/1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "version": "1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "checksum": null+ },+ "output_stream_url": "https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113803Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0aa7c17cbf2fb161feec2da740e6956a39c25b8c55fbce6ebec5b6d4e01ade7c"+ },+ "actor": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "action": "update",+ "version": "application/vnd.heroku+json; version=3",+ "resource": "build",+ "sequence": null,+ "created_at": "2025-05-17T11:38:03+00:00",+ "updated_at": "2025-05-17T11:38:03+00:00",+ "published_at": "2025-05-17T11:38:04Z",+ "previous_data": {},+ "webhook_metadata": {+ "attempt": {+ "id": "94b94f6c-82ff-4c84-a4d9-49def759e768"+ },+ "delivery": {+ "id": "4dad5178-4bf5-4937-82c8-e89a83a499b4"+ },+ "event": {+ "id": "aab185d0-2611-4f40-817c-caba2ad7d2de",+ "include": "api:build"+ },+ "webhook": {+ "id": "e1020099-2147-45d9-b7a1-bf1422851eea"+ }+ }+}diff --git a/zerver/webhooks/heroku/fixtures/deploy.txt b/zerver/webhooks/heroku/fixtures/deploy.txtdeleted file mode 100644index 74cf354c786..00000000000--- a/zerver/webhooks/heroku/fixtures/deploy.txt+++ /dev/null@@ -1 +0,0 @@-app=sample-project&app_uuid=f46ffea9-d6be-4293-ae6e-4449fa5ae29a&user=user%40example.com&url=http%3A%2F%2Fsample-project.herokuapp.com&head=3eb5f44&head_long=3eb5f447a2f6bcf254e63fbf2426b8e6738608eb&prev_head=32d184c097b04182483999046e91c32328c07562&git_log=%20%20*%20Example%20User%3A%20Test%20commit%20for%20Deploy%20Hook%202&release=v9diff --git a/zerver/webhooks/heroku/fixtures/deploy_multiple_commits.txt b/zerver/webhooks/heroku/fixtures/deploy_multiple_commits.txtdeleted file mode 100644index aad974085de..00000000000--- a/zerver/webhooks/heroku/fixtures/deploy_multiple_commits.txt+++ /dev/null@@ -1 +0,0 @@-app=sample-project&app_uuid=f46ffea9-d6be-4293-ae6e-4449fa5ae29a&user=user%40example.com&url=http%3A%2F%2Fsample-project.herokuapp.com&head=3eb5f44&head_long=3eb5f447a2f6bcf254e63fbf2426b8e6738608eb&prev_head=32d184c097b04182483999046e91c32328c07562&git_log=%20%20*%20Example%20User%3A%20Test%20commit%20for%20Deploy%20Hook%0A%20%20*%20Example%20User%3A%20Second%20test%20commit%20for%20Deploy%20Hook%202&release=v9diff --git a/zerver/webhooks/heroku/fixtures/release_create.json b/zerver/webhooks/heroku/fixtures/release_create.jsonnew file mode 100644index 00000000000..fadadd56494--- /dev/null+++ b/zerver/webhooks/heroku/fixtures/release_create.json@@ -0,0 +1,64 @@+{+ "id": "55fa9c58-68ae-4183-86df-29a7b27cdf84",+ "data": {+ "id": "6be9012f-1c42-4f2d-bb99-af152aad07d8",+ "app": {+ "id": "4335bcdb-5f6f-41f8-a31b-84697ec96475",+ "name": "Example Project",+ "process_tier": "basic"+ },+ "slug": {+ "id": "e7cb552a-e840-48cb-9164-081d1e6da274",+ "commit": "1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "commit_description": ""+ },+ "user": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "stack": "heroku-24",+ "status": "succeeded",+ "current": true,+ "pstable": {},+ "version": 3,+ "artifacts": [+ {+ "id": "e7cb552a-e840-48cb-9164-081d1e6da274",+ "type": "slug"+ }+ ],+ "created_at": "2025-05-17T11:37:58Z",+ "updated_at": "2025-05-17T11:37:58Z",+ "description": "Deploy 1a5f89db",+ "addon_plan_names": [],+ "output_stream_url": null,+ "eligible_for_rollback": true+ },+ "actor": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "action": "create",+ "version": "application/vnd.heroku+json; version=3",+ "resource": "release",+ "sequence": null,+ "created_at": "2025-05-17T11:37:58.404020Z",+ "updated_at": "2025-05-17T11:37:58.404024Z",+ "published_at": "2025-05-17T11:37:58Z",+ "previous_data": {},+ "webhook_metadata": {+ "attempt": {+ "id": "e1d38e49-586a-4b53-aa5f-ad8abad73ba8"+ },+ "delivery": {+ "id": "7e99cb52-1369-4507-be9e-32309898462d"+ },+ "event": {+ "id": "55fa9c58-68ae-4183-86df-29a7b27cdf84",+ "include": "api:release"+ },+ "webhook": {+ "id": "e1020099-2147-45d9-b7a1-bf1422851eea"+ }+ }+}diff --git a/zerver/webhooks/heroku/fixtures/release_update.json b/zerver/webhooks/heroku/fixtures/release_update.jsonnew file mode 100644index 00000000000..3d8ffdccfa1--- /dev/null+++ b/zerver/webhooks/heroku/fixtures/release_update.json@@ -0,0 +1,64 @@+{+ "id": "d5d2fb1d-f086-41bf-b054-1d349d4c4ce2",+ "data": {+ "id": "6be9012f-1c42-4f2d-bb99-af152aad07d8",+ "app": {+ "id": "4335bcdb-5f6f-41f8-a31b-84697ec96475",+ "name": "Example Project",+ "process_tier": "basic"+ },+ "slug": {+ "id": "e7cb552a-e840-48cb-9164-081d1e6da274",+ "commit": "1a5f89db9a6a62f29689b6eeea65e6b6eb0879cd",+ "commit_description": ""+ },+ "user": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "stack": "heroku-24",+ "status": "succeeded",+ "current": true,+ "pstable": {},+ "version": 3,+ "artifacts": [+ {+ "id": "e7cb552a-e840-48cb-9164-081d1e6da274",+ "type": "slug"+ }+ ],+ "created_at": "2025-05-17T11:37:58Z",+ "updated_at": "2025-05-17T11:37:58Z",+ "description": "Deploy 1a5f89db",+ "addon_plan_names": [],+ "output_stream_url": null,+ "eligible_for_rollback": true+ },+ "actor": {+ "id": "9126ad9a-9950-46df-857f-6970ebf8a480",+ "email": "[email protected]"+ },+ "action": "update",+ "version": "application/vnd.heroku+json; version=3",+ "resource": "release",+ "sequence": null,+ "created_at": "2025-05-17T11:37:58.562518Z",+ "updated_at": "2025-05-17T11:37:58.562524Z",+ "published_at": "2025-05-17T11:37:58Z",+ "previous_data": {},+ "webhook_metadata": {+ "attempt": {+ "id": "6085f041-b991-4610-bc7f-0af82e04667f"+ },+ "delivery": {+ "id": "09f411b3-fefa-44d1-9508-e3c43e0fd46e"+ },+ "event": {+ "id": "d5d2fb1d-f086-41bf-b054-1d349d4c4ce2",+ "include": "api:release"+ },+ "webhook": {+ "id": "e1020099-2147-45d9-b7a1-bf1422851eea"+ }+ }+}diff --git a/zerver/webhooks/heroku/tests.py b/zerver/webhooks/heroku/tests.pyindex 8e97dfd1b13..9db3c9a8e9e 100644--- a/zerver/webhooks/heroku/tests.py+++ b/zerver/webhooks/heroku/tests.py@@ -1,49 +1,48 @@-from typing_extensions import override+import orjsonfrom zerver.lib.test_classes import WebhookTestCase+from zerver.webhooks.fixtureless_integrations import BO_EMAIL, PROJECT_NAME+from zerver.webhooks.heroku.view import IGNORED_ENTITIESclass HerokuHookTests(WebhookTestCase):- def test_deployment(self) -> None:- expected_topic_name = "sample-project"- expected_message = """[email protected] deployed version 3eb5f44 of [sample-project](http://sample-project.herokuapp.com):--``` quote- * Example User: Test commit for Deploy Hook 2-```-""".strip()- self.check_webhook(- "deploy",- expected_topic_name,- expected_message,- content_type="application/x-www-form-urlencoded",+ TOPIC_NAME = PROJECT_NAME++ def test_build_create(self) -> None:+ expected_message = f"{BO_EMAIL} triggered a [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113737Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=b2f0cac0426f4898d9bdcd214401027af128935b9e9618eeb6f83a3546b142d2)."+ self.check_webhook("build_create", self.TOPIC_NAME, expected_message)++ def test_build_update(self) -> None:+ expected_message = f"The [build](https://build-output.heroku.com/streams/43/4335bcdb-5f6f-41f8-a31b-84697ec96475/logs/b6/b6d5ff62-08db-4044-b96c-b8e9e41f1191.log?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZSXS6CXK3PQ5Y6GY%2F20250517%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250517T113803Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=0aa7c17cbf2fb161feec2da740e6956a39c25b8c55fbce6ebec5b6d4e01ade7c) triggered by {BO_EMAIL} **succeeded**."+ self.check_webhook("build_update", self.TOPIC_NAME, expected_message)++ def test_ignored_entities(self) -> None:+ for entity in IGNORED_ENTITIES:+ with self.subTest(entity=entity):+ payload = {"resource": entity, "action": "create", "data": {}}+ last_message_id = self.get_last_message().id+ result = self.client_post(+ self.url, orjson.dumps(payload), content_type="application/json"+ )+ self.assert_json_success(result)+ self.assertEqual(self.get_last_message().id, last_message_id)++ def test_release_create(self) -> None:+ expected_message = f"{BO_EMAIL} triggered a release(v3): Deploy 1a5f89db."+ self.check_webhook("release_create", self.TOPIC_NAME, expected_message)++ def test_release_update(self) -> None:+ expected_message = (+ f"The release(v3): Deploy 1a5f89db triggered by {BO_EMAIL} **succeeded**.")-- def test_deployment_multiple_commits(self) -> None:- expected_topic_name = "sample-project"- expected_message = """[email protected] deployed version 3eb5f44 of \-[sample-project](http://sample-project.herokuapp.com)-``` quote- * Example User: Test commit for Deploy Hook- * Example User: Second test commit for Deploy Hook 2-```"""-- expected_message = """[email protected] deployed version 3eb5f44 of [sample-project](http://sample-project.herokuapp.com):--``` quote- * Example User: Test commit for Deploy Hook- * Example User: Second test commit for Deploy Hook 2-```-""".strip()- self.check_webhook(- "deploy_multiple_commits",- expected_topic_name,- expected_message,- content_type="application/x-www-form-urlencoded",- )-- @override- def get_body(self, fixture_name: str) -> str:- return self.webhook_fixture_data("heroku", fixture_name, file_type="txt")+ self.check_webhook("release_update", self.TOPIC_NAME, expected_message)++ def test_release_phase_update(self) -> None:+ self.subscribe(self.test_user, self.channel_name)+ payload = self.webhook_fixture_data(self.webhook_dir_name, "release_update")+ data = orjson.loads(payload)+ data["data"]["current"] = False+ last_message_id = self.get_last_message().id+ result = self.client_post(self.url, orjson.dumps(data), content_type="application/json")+ self.assert_json_success(result)+ self.assertEqual(self.get_last_message().id, last_message_id)diff --git a/zerver/webhooks/heroku/view.py b/zerver/webhooks/heroku/view.pyindex 092213784bb..8da51e5c804 100644--- a/zerver/webhooks/heroku/view.py+++ b/zerver/webhooks/heroku/view.py@@ -1,34 +1,96 @@-# Webhooks for external integrations.from django.http import HttpRequest, HttpResponsefrom zerver.decorator import webhook_view+from zerver.lib.exceptions import UnsupportedWebhookEventTypeErrorfrom zerver.lib.response import json_success-from zerver.lib.typed_endpoint import typed_endpoint+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint+from zerver.lib.validator import WildValue, check_bool, check_int, check_none_or, check_stringfrom zerver.lib.webhooks.common import check_send_webhook_messagefrom zerver.models import UserProfile-TEMPLATE = """-{user} deployed version {head} of [{app}]({url}):+ENTITY_CREATED_MESSAGE = "{actor} triggered a {entity}."+ENTITY_UPDATED_MESSAGE = "The {entity} triggered by {actor} **{status}**."-``` quote-{git_log}-```-""".strip()+# The events here are ignored not because they are noisy.+# But we do not have accurate fixtures for them.+# The fixtures documented in https://devcenter.heroku.com/articles/webhook-events+# have been reported to drift from actual payloads.+# Heroku does not provide a free trial account.+IGNORED_ENTITIES = [+ "addon-attachment",+ "addon",+ "app",+ "collaborator",+ "domain",+ "dyno",+ "formation",+ "sni-endpoint",+]-@webhook_view("Heroku", notify_bot_owner_on_invalid_json=False)+def get_body(payload: WildValue, entity: str) -> str:+ data = payload["data"]+ actor = payload["actor"]["email"].tame(check_string)++ entity_url = data["output_stream_url"].tame(check_none_or(check_string))+ display_entity = f"[{entity}]({entity_url})" if entity_url else entity++ if entity == "release":+ version = data["version"].tame(check_int)+ description = data["description"].tame(check_string)+ display_entity = f"{display_entity}(v{version}): {description}"++ action = payload["action"].tame(check_string)+ status = data["status"].tame(check_string)++ template = ENTITY_UPDATED_MESSAGE if action == "update" else ENTITY_CREATED_MESSAGE+ body = template.format(entity=display_entity, actor=actor, status=status)++ return body+++def should_ignore_event(entity: str, event_type: str, payload: WildValue) -> bool:+ if entity in IGNORED_ENTITIES:+ return True++ # Ignore release phase update events, for now, to avoid duplicate notifications.+ # https://devcenter.heroku.com/articles/release-phase+ # 1. Release started: action="create" data.status="pending" data.current=false+ # 2. Release phase(s) finished: action="update" data.status="succeeded" data.current=false+ # 3. Release live: action="update" data.status="succeeded" data.current=true+ status = payload["data"]["status"].tame(check_string)+ if (+ event_type == "release.update"+ and status in {"succeeded", "failed"}+ and not payload["data"]["current"].tame(check_bool)+ ):+ return True++ return False+++ALL_EVENT_TYPES = ["build.create", "build.update", "release.create", "release.update"]+++@webhook_view("Heroku", all_event_types=ALL_EVENT_TYPES)@typed_endpointdef api_heroku_webhook(request: HttpRequest,user_profile: UserProfile,*,- head: str,- app: str,- user: str,- url: str,- git_log: str,+ payload: JsonBodyPayload[WildValue],) -> HttpResponse:- content = TEMPLATE.format(user=user, head=head, app=app, url=url, git_log=git_log)+ entity = payload["resource"].tame(check_string)+ event = payload["action"].tame(check_string)+ event_type = f"{entity}.{event}"++ if should_ignore_event(entity, event_type, payload):+ return json_success(request)++ if event_type not in ALL_EVENT_TYPES:+ raise UnsupportedWebhookEventTypeError(event_type)+ topic_name = payload["data"]["app"]["name"].tame(check_string)+ body = get_body(payload, entity)- check_send_webhook_message(request, user_profile, app, content)+ check_send_webhook_message(request, user_profile, topic_name, body, event_type)return json_success(request)