Merge pull request #510 from leepeuker/move-webhook-endpoints-to-api

Move webhook endpoints to the REST API
leepeuker · Oct 1, 2023 · 31aeca5 · 31aeca5
2 parents 5bd1b99 + c0b3e7f
commit 31aeca5
Show file tree

Hide file tree

Showing 10 changed files with 220 additions and 3 deletions.
diff --git a/docs/openapi.json b/docs/openapi.json
@@ -964,6 +964,87 @@
           }
         ]
       }
+    },
+    "/webhook/plex/{uuid}": {
+      "post": {
+        "tags": [
+          "Webhooks"
+        ],
+        "description": "Endpoint to scrobble your Plex watches to Movary.",
+        "parameters": [
+          {
+            "name": "UUID",
+            "in": "query",
+            "description": "An UUID that is generated by the user in the Plex settings.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "404": {
+            "$ref": "#/components/responses/404"
+          }
+        }
+      }
+    },
+    "/webhook/jellyfin/{uuid}": {
+      "post": {
+        "tags": [
+          "Webhooks"
+        ],
+        "description": "Endpoint to scrobble your Jellyfin watches to Movary.",
+        "parameters": [
+          {
+            "name": "UUID",
+            "in": "query",
+            "description": "An UUID that is generated by the user in the Jellyfin settings.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "404": {
+            "$ref": "#/components/responses/404"
+          }
+        }
+      }
+    },
+    "/webhook/emby/{uuid}": {
+      "post": {
+        "tags": [
+          "Webhooks"
+        ],
+        "description": "Endpoint to scrobble your Emby watches to Movary.",
+        "parameters": [
+          {
+            "name": "UUID",
+            "in": "query",
+            "description": "An UUID that is generated by the user in the Emby settings.",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "404": {
+            "$ref": "#/components/responses/404"
+          }
+        }
+      }
     }
   },
   "components": {

diff --git a/settings/routes.php b/settings/routes.php
@@ -35,7 +35,7 @@ function addWebRoutes(RouterService $routerService, FastRoute\RouteCollector $ro
     $routes->add('GET', '/docs/api', [Web\OpenApiController::class, 'renderPage']);
 
     #####################
-    # Webhook listeners #
+    # Webhook listeners # !!! Deprecated use new api routes
     #####################
     $routes->add('POST', '/plex/{id:.+}', [Web\PlexController::class, 'handlePlexWebhook']);
     $routes->add('POST', '/jellyfin/{id:.+}', [Web\JellyfinController::class, 'handleJellyfinWebhook']);
@@ -216,6 +216,10 @@ function addApiRoutes(RouterService $routerService, FastRoute\RouteCollector $ro
 
     $routes->add('GET', '/movies/search', [Api\MovieSearchController::class, 'search'], [Api\Middleware\IsAuthenticated::class]);
 
+    $routes->add('POST', '/webhook/plex/{id:.+}', [Api\PlexController::class, 'handlePlexWebhook']);
+    $routes->add('POST', '/webhook/jellyfin/{id:.+}', [Api\JellyfinController::class, 'handleJellyfinWebhook']);
+    $routes->add('POST', '/webhook/emby/{id:.+}', [Api\EmbyController::class, 'handleEmbyWebhook']);
+
     $routes->add('GET', '/feed/radarr/{id:.+}', [Api\RadarrController::class, 'renderRadarrFeed']);
 
     $routerService->addRoutesToRouteCollector($routeCollector, $routes);

diff --git a/src/HttpController/Api/EmbyController.php b/src/HttpController/Api/EmbyController.php
@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+namespace Movary\HttpController\Api;
+
+use Movary\Domain\User\UserApi;
+use Movary\Service\Emby\EmbyScrobbler;
+use Movary\Util\Json;
+use Movary\ValueObject\Http\Request;
+use Movary\ValueObject\Http\Response;
+use Psr\Log\LoggerInterface;
+
+class EmbyController
+{
+    public function __construct(
+        private readonly UserApi $userApi,
+        private readonly EmbyScrobbler $embyScrobbler,
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+
+    public function handleEmbyWebhook(Request $request) : Response
+    {
+        $webhookId = $request->getRouteParameters()['id'];
+
+        $userId = $this->userApi->findUserIdByEmbyWebhookId($webhookId);
+        if ($userId === null) {
+            return Response::createNotFound();
+        }
+
+        $requestPayload = $request->getPostParameters()['data'];
+
+        $this->logger->debug('Emby: Webhook triggered with payload: ' . $requestPayload);
+
+        $this->embyScrobbler->processEmbyWebhook($userId, Json::decode($requestPayload));
+
+        return Response::createOk();
+    }    
+}
diff --git a/src/HttpController/Api/JellyfinController.php b/src/HttpController/Api/JellyfinController.php
@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+namespace Movary\HttpController\Api;
+
+use Movary\Domain\User\UserApi;
+use Movary\Service\Jellyfin\JellyfinScrobbler;
+use Movary\Util\Json;
+use Movary\ValueObject\Http\Request;
+use Movary\ValueObject\Http\Response;
+use Psr\Log\LoggerInterface;
+
+class JellyfinController
+{
+    public function __construct(
+        private readonly UserApi $userApi,
+        private readonly JellyfinScrobbler $jellyfinScrobbler,
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+    public function handleJellyfinWebhook(Request $request) : Response
+    {
+        $webhookId = $request->getRouteParameters()['id'];
+
+        $userId = $this->userApi->findUserIdByJellyfinWebhookId($webhookId);
+        if ($userId === null) {
+            return Response::createNotFound();
+        }
+
+        $requestPayload = $request->getBody();
+
+        $this->logger->debug('Jellyfin: Webhook triggered with payload: ' . $requestPayload);
+
+        $this->jellyfinScrobbler->processJellyfinWebhook($userId, Json::decode($requestPayload));
+
+        return Response::createOk();
+    }
+}
diff --git a/src/HttpController/Api/PlexController.php b/src/HttpController/Api/PlexController.php
@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace Movary\HttpController\Api;
+
+use Movary\Domain\User\UserApi;
+use Movary\Service\Plex\PlexScrobbler;
+use Movary\Util\Json;
+use Movary\ValueObject\Http\Request;
+use Movary\ValueObject\Http\Response;
+use Psr\Log\LoggerInterface;
+
+class PlexController
+{
+    public function __construct(
+        private readonly UserApi $userApi,
+        private readonly PlexScrobbler $plexScrobbler,
+        private readonly LoggerInterface $logger,
+    ) {
+    }
+
+    public function handlePlexWebhook(Request $request) : Response
+    {
+        $webhookId = $request->getRouteParameters()['id'];
+
+        $userId = $this->userApi->findUserIdByPlexWebhookId($webhookId);
+        if ($userId === null) {
+            return Response::createNotFound();
+        }
+
+        $requestPayload = $request->getPostParameters()['payload'] ?? null;
+        if ($requestPayload === null) {
+            return Response::createOk();
+        }
+
+        $this->logger->debug('Plex: Webhook triggered with payload: ' . $requestPayload);
+
+        $this->plexScrobbler->processPlexWebhook($userId, Json::decode((string)$requestPayload));
+
+        return Response::createOk();
+    }
+}
diff --git a/src/HttpController/Web/EmbyController.php b/src/HttpController/Web/EmbyController.php
@@ -29,6 +29,10 @@ public function deleteEmbyWebhookUrl() : Response
         return Response::createOk();
     }
 
+    /**
+     * @deprecated
+     * @see \Movary\HttpController\Api\EmbyController::handleEmbyWebhook()
+     */
     public function handleEmbyWebhook(Request $request) : Response
     {
         $webhookId = $request->getRouteParameters()['id'];
@@ -41,6 +45,7 @@ public function handleEmbyWebhook(Request $request) : Response
         $requestPayload = $request->getPostParameters()['data'];
 
         $this->logger->debug('Emby: Webhook triggered with payload: ' . $requestPayload);
+        $this->logger->warning('This emby webhook url is deprecated and will stop to work soon, regenerate the url');
 
         $this->embyScrobbler->processEmbyWebhook($userId, Json::decode($requestPayload));
 

diff --git a/src/HttpController/Web/JellyfinController.php b/src/HttpController/Web/JellyfinController.php
@@ -66,6 +66,11 @@ public function deleteJellyfinWebhookUrl() : Response
         return Response::createOk();
     }
 
+
+    /**
+     * @deprecated
+     * @see \Movary\HttpController\Api\JellyfinController::handleJellyfinWebhook()
+     */
     public function handleJellyfinWebhook(Request $request) : Response
     {
         $webhookId = $request->getRouteParameters()['id'];
@@ -78,6 +83,7 @@ public function handleJellyfinWebhook(Request $request) : Response
         $requestPayload = $request->getBody();
 
         $this->logger->debug('Jellyfin: Webhook triggered with payload: ' . $requestPayload);
+        $this->logger->warning('This jellyfin webhook url is deprecated and will stop to work soon, regenerate the url');
 
         $this->jellyfinScrobbler->processJellyfinWebhook($userId, Json::decode($requestPayload));
 

diff --git a/src/HttpController/Web/PlexController.php b/src/HttpController/Web/PlexController.php
@@ -53,6 +53,10 @@ public function generatePlexAuthenticationUrl() : Response
         return Response::createJson(Json::encode(['authenticationUrl' => $plexAuthenticationUrl]));
     }
 
+    /**
+     * @deprecated
+     * @see \Movary\HttpController\Api\PlexController::handlePlexWebhook()
+     */
     public function handlePlexWebhook(Request $request) : Response
     {
         $webhookId = $request->getRouteParameters()['id'];
@@ -68,6 +72,7 @@ public function handlePlexWebhook(Request $request) : Response
         }
 
         $this->logger->debug('Plex: Webhook triggered with payload: ' . $requestPayload);
+        $this->logger->warning('This plex webhook url is deprecated and will stop to work soon, regenerate the url');
 
         $this->plexScrobbler->processPlexWebhook($userId, Json::decode((string)$requestPayload));
 

diff --git a/src/Service/WebhookUrlBuilder.php b/src/Service/WebhookUrlBuilder.php
@@ -36,6 +36,6 @@ private function buildUrl(string $webhookType, string $webhookId) : ?string
             return null;
         }
 
-        return rtrim($applicationUrl, '/') . '/' . $webhookType . '/' . $webhookId;
+        return rtrim($applicationUrl, '/') . '/api/webhook/' . $webhookType . '/' . $webhookId;
     }
 }
diff --git a/tests/rest/web/plex-scrobble.http b/tests/rest/web/plex-scrobble.http
@@ -1,4 +1,4 @@
-POST http://127.0.0.1/plex/16914287-329d-4f3b-ba57-4a092f13058d
+POST http://127.0.0.1/api/webhook/plex/14f14d6b-695f-41b9-a856-5ba401bcc040
 Accept: */*
 Cache-Control: no-cache
 Content-Type: application/x-www-form-urlencoded