Feat(hub): Rename the Last-Event-ID query parameter to lastEventID (#33)

Signed-off-by: azjezz <azjezz@protonmail.com> Co-authored-by: azjezz <azjezz@protonmail.com>
bpolaszek · Mar 20, 2024 · 4219fff · 4219fff
1 parent 7104712
commit 4219fff
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 10 deletions.
diff --git a/composer.json b/composer.json
@@ -24,6 +24,7 @@
         "react/promise-timer": "^1.10",
         "rize/uri-template": "^0.3.4",
         "symfony/console": "^5.4.0|^6.0.0|^7.0.0",
+        "symfony/deprecation-contracts": "^3.1",
         "symfony/dotenv": "^5.4.0|^6.0.0|^7.0.0",
         "symfony/flex": "^1.17|^2",
         "symfony/framework-bundle": "^5.4.0|^6.0.0|^7.0.0",

diff --git a/src/functions.php b/src/functions.php
@@ -47,13 +47,23 @@ function nullify(mixed $value, ?string $cast = null): mixed
 function extract_last_event_id(ServerRequestInterface $request): ?string
 {
     $qs = query_string($request->getUri(), new FlatQueryParser());
+    $lastEventId = nullify($request->getHeaderLine('Last-Event-ID')) ?? $qs->getParam('lastEventID');
+    if (null === $lastEventId) {
+        $lastEventId = $qs->getParam('Last-Event-ID') ??
+            $qs->getParam('Last-Event-Id') ??
+            $qs->getParam('last-event-id') ??
+            $qs->getParam('LAST-EVENT-ID');
 
-    return nullify($request->getHeaderLine('Last-Event-ID'))
-        ?? $qs->getParam('Last-Event-ID')
-        ?? $qs->getParam('Last-Event-Id')
-        ?? $qs->getParam('last-event-id')
-        ?? $qs->getParam('LAST-EVENT-ID')
-        ?? null;
+        if ($lastEventId !== null) {
+            trigger_deprecation(
+                'freddie/mercure-x',
+                '1.0',
+                'Using "Last-Event-ID" query parameter is deprecated, use "lastEventID" instead.',
+            );
+        }
+    }
+
+    return $lastEventId;
 }
 
 /**

diff --git a/tests/Unit/FunctionsTest.php b/tests/Unit/FunctionsTest.php
@@ -75,6 +75,20 @@
         'request' => new ServerRequest('GET', '/.well-known/mercure', ['LAST-EVENT-ID' => 'foo']),
         'expected' => 'foo',
     ];
+    yield [
+        'request' => new ServerRequest('GET', '/.well-known/mercure?lastEventID=foo'),
+        'expected' => 'foo',
+    ];
+    yield [
+        'request' => new ServerRequest('GET', '/.well-known/mercure'),
+        'expected' => null,
+    ];
+});
+
+it(
+    'extracts Last-Event-ID from request using deprecated query parameter.',
+    fn (ServerRequestInterface $request, ?string $expected) => expect(extract_last_event_id($request))->toBe($expected)
+)->with(function () {
     yield [
         'request' => new ServerRequest('GET', '/.well-known/mercure?Last-Event-ID=foo'),
         'expected' => 'foo',
@@ -91,8 +105,4 @@
         'request' => new ServerRequest('GET', '/.well-known/mercure?LAST-EVENT-ID=foo'),
         'expected' => 'foo',
     ];
-    yield [
-        'request' => new ServerRequest('GET', '/.well-known/mercure'),
-        'expected' => null,
-    ];
 });