Merge pull request #46107 from nextcloud/feat/webhook_listeners/index-endpoint-by-uri

feat(WebhooksController): Allow querying listeners by URI

Author: marcelklehr

apps/webhook_listeners/lib/Controller/WebhooksController.php

@@ -48,16 +48,21 @@ public function __construct(
 	/**
 	 * List registered webhooks
 	 *
+	 * @param string|null $uri The callback URI to filter by
 	 * @return DataResponse<Http::STATUS_OK, WebhookListenersWebhookInfo[], array{}>
 	 * @throws OCSException Other internal error
 	 *
 	 * 200: Webhook registrations returned
 	 */
 	#[ApiRoute(verb: 'GET', url: '/api/v1/webhooks')]
 	#[AuthorizedAdminSetting(settings:Admin::class)]
-	public function index(): DataResponse {
+	public function index(?string $uri = null): DataResponse {
 		try {
-			$webhookListeners = $this->mapper->getAll();
+			if ($uri !== null) {
+				$webhookListeners = $this->mapper->getByUri($uri);
+			} else {
+				$webhookListeners = $this->mapper->getAll();
+			}
 
 			return new DataResponse(
 				array_map(

apps/webhook_listeners/lib/Db/WebhookListenerMapper.php

@@ -204,4 +204,17 @@ public function getByEvent(string $event): array {
 
 		return $this->findEntities($qb);
 	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function getByUri(string $uri): array {
+		$qb = $this->db->getQueryBuilder();
+
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('uri', $qb->createNamedParameter($uri, IQueryBuilder::PARAM_STR)));
+
+		return $this->findEntities($qb);
+	}
 }

apps/webhook_listeners/openapi.json

@@ -112,6 +112,15 @@
                     }
                 ],
                 "parameters": [
+                    {
+                        "name": "uri",
+                        "in": "query",
+                        "description": "The callback URI to filter by",
+                        "schema": {
+                            "type": "string",
+                            "nullable": true
+                        }
+                    },
                     {
                         "name": "OCS-APIRequest",
                         "in": "header",

apps/webhook_listeners/tests/Db/WebhookListenerMapperTest.php

@@ -82,6 +82,26 @@ public function testInsertListenerAndGetIt() {
 		$this->assertEquals($listener1, $listener2);
 	}
 
+	public function testInsertListenerAndGetItByUri() {
+		$uri = 'https://webhook.example.com/endpoint';
+		$listener1 = $this->mapper->addWebhookListener(
+			null,
+			'bob',
+			'POST',
+			$uri,
+			NodeWrittenEvent::class,
+			null,
+			null,
+			AuthMethod::None,
+			null,
+		);
+
+		$listeners = $this->mapper->getByUri($uri);
+
+		$listener1->resetUpdatedFields();
+		$this->assertContains($listener1->getId(), array_map(fn ($listener) => $listener->getId(), $listeners));
+	}
+
 	public function testInsertListenerAndGetItWithAuthData() {
 		$listener1 = $this->mapper->addWebhookListener(
 			null,