Test Update/Delete/List for webhooks

Author: ChrisPenner

src/Share/Notifications/Ops.hs

@@ -159,9 +159,13 @@ deleteProjectWebhook projectId subscriptionId = do
   let owner = ProjectSubscriptionOwner projectId
   -- First fetch the webhook id associated with this subscription
   webhooks <- PG.runTransaction $ do NotifQ.webhooksForSubscription subscriptionId
+  -- Next delete the subscription, which cascades to delete the webhook rows.
+  PG.runTransaction $ do NotifQ.deleteNotificationSubscription owner subscriptionId
+  -- Now delete the webhook configs in Vault, it's possible that this fails, but
+  -- it's okay if there are dangling webhooks in vault, we can't be fully transactional here,
+  -- and it's better than having rows that point to missing secrets.
   for_ webhooks \webhookId -> do
     deleteWebhookDeliveryMethod owner webhookId
-  PG.runTransaction $ do NotifQ.deleteNotificationSubscription owner subscriptionId
 
 updateProjectWebhook :: SubscriptionOwner -> NotificationSubscriptionId -> Maybe URIParam -> (Maybe ProjectWebhookTopics) -> WebApp ()
 updateProjectWebhook subscriptionOwner subscriptionId mayURIUpdate webhookTopics = do

transcripts/share-apis/notifications/delete-project-webhook.json

@@ -0,0 +1,8 @@
+{
+  "body": [],
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
+}

transcripts/share-apis/notifications/list-project-webhooks-after-delete.json

@@ -0,0 +1,10 @@
+{
+  "body": {
+    "webhooks": []
+  },
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
+}

transcripts/share-apis/notifications/list-project-webhooks-after-update.json

@@ -0,0 +1,23 @@
+{
+  "body": {
+    "webhooks": [
+      {
+        "createdAt": "<TIMESTAMP>",
+        "notificationSubscriptionId": "NS-<UUID>",
+        "topics": {
+          "topics": [
+            "project:contribution:created"
+          ],
+          "type": "selected"
+        },
+        "updatedAt": "<TIMESTAMP>",
+        "uri": "http://<HOST>:9999/good-webhook-updated"
+      }
+    ]
+  },
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
+}

transcripts/share-apis/notifications/list-project-webhooks.json

@@ -0,0 +1,20 @@
+{
+  "body": {
+    "webhooks": [
+      {
+        "createdAt": "<TIMESTAMP>",
+        "notificationSubscriptionId": "NS-<UUID>",
+        "topics": {
+          "type": "all"
+        },
+        "updatedAt": "<TIMESTAMP>",
+        "uri": "http://<HOST>:9999/good-webhook"
+      }
+    ]
+  },
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
+}

transcripts/share-apis/notifications/run.zsh

@@ -16,6 +16,8 @@ fetch "$test_user" POST add-project-webhook "/users/test/projects/publictestproj
   \"topics\": {\"type\": \"all\"}
 }"
 
+fetch "$test_user" GET list-project-webhooks "/users/test/projects/publictestproject/webhooks"
+
 # Subscribe the transcripts user to notifications for a project in the test user.
 fetch "$transcripts_user" PUT subscribe-to-other-user-project '/users/test/projects/publictestproject/subscription' '{
   "isSubscribed": true
@@ -132,3 +134,18 @@ echo "Successful webhooks: $successful_webhooks\nUnsuccessful webhooks: $unsucce
 fetch "$test_user" PUT unsubscribe-from-project '/users/test/projects/publictestproject/subscription' '{
   "isSubscribed": false
 }'
+
+# Get the project webhook id.
+project_webhook_id=$(fetch_data_jq "$test_user" GET project-webhooks-fetch '/users/test/projects/publictestproject/webhooks' '.webhooks[0].notificationSubscriptionId')
+
+# Can update project webhooks
+fetch "$test_user" PATCH update-project-webhook "/users/test/projects/publictestproject/webhooks/$project_webhook_id" "{
+  \"uri\": \"${echo_server}/good-webhook-updated\",
+  \"topics\": {\"type\": \"selected\", \"topics\": [\"project:contribution:created\"]}
+}"
+
+fetch "$test_user" GET list-project-webhooks-after-update "/users/test/projects/publictestproject/webhooks"
+
+fetch "$test_user" DELETE delete-project-webhook "/users/test/projects/publictestproject/webhooks/$project_webhook_id"
+
+fetch "$test_user" GET list-project-webhooks-after-delete "/users/test/projects/publictestproject/webhooks"

transcripts/share-apis/notifications/update-project-webhook.json

@@ -0,0 +1,21 @@
+{
+  "body": {
+    "webhook": {
+      "createdAt": "<TIMESTAMP>",
+      "notificationSubscriptionId": "NS-<UUID>",
+      "topics": {
+        "topics": [
+          "project:contribution:created"
+        ],
+        "type": "selected"
+      },
+      "updatedAt": "<TIMESTAMP>",
+      "uri": "http://<HOST>:9999/good-webhook-updated"
+    }
+  },
+  "status": [
+    {
+      "status_code": 200
+    }
+  ]
+}