Do not cast integer as string ids + Fix Zero ID + PHP Coduo (#93)

* Do not cast integer as string ids

* Replace PHPUnit exact match with PHP-coduo

* Allow for zero IDs; notifications are only NULL

* Fix #94

---------

Co-authored-by: Brad Jones <brad.jones@fruition.net>

Author: yoanm

composer.json

@@ -36,6 +36,7 @@
   },
   "require-dev": {
     "behat/behat": "^3.9.0",
+    "coduo/php-matcher": "^6.0",
     "dvdoug/behat-code-coverage": "^5.0",
     "phpspec/prophecy": "^1.15",
     "phpspec/prophecy-phpunit": "^2.0",

features/bootstrap/FeatureContext.php

@@ -4,7 +4,7 @@
 use Behat\Behat\Context\Environment\InitializedContextEnvironment;
 use Behat\Behat\Hook\Scope\BeforeScenarioScope;
 use Behat\Gherkin\Node\PyStringNode;
-use DemoApp\Dispatcher\BehatRequestLifecycleDispatcher;
+use Coduo\PHPMatcher\PHPUnit\PHPMatcherAssertions;
 use PHPUnit\Framework\Assert;
 use Tests\Functional\BehatContext\Helper\FakeEndpointCreator;
 
@@ -13,6 +13,8 @@
  */
 class FeatureContext extends AbstractContext
 {
+    use PHPMatcherAssertions;
+
     const KEY_JSON_RPC = 'jsonrpc';
     const KEY_ID = 'id';
     const KEY_RESULT = 'result';
@@ -75,8 +77,7 @@ public function thenLastResponseShouldBeAValidJsonRpcError()
      */
     public function thenIShouldHaveTheFollowingResponse(PyStringNode $expectedResult)
     {
-        // Decode content to get rid of any indentation/spacing/... issues
-        Assert::assertEquals(
+        $this->assertMatchesPattern(
             $this->jsonDecode($expectedResult->getRaw()),
             $this->getLastResponseDecoded()
         );

src/App/Creator/ResponseCreator.php

@@ -26,7 +26,8 @@ public function createEmptyResponse(JsonRpcRequest $fromRequest = null) : JsonRp
                 ->setIsNotification($fromRequest->isNotification())
         ;
 
-        if ($fromRequest->getId()) {
+        // Notification response doesn't have any ID defined (notification request doesn't either)
+        if (!$fromRequest->isNotification()) {
             $response->setId($fromRequest->getId());
         }
 

src/App/Serialization/JsonRpcRequestDenormalizer.php

@@ -50,11 +50,7 @@ protected function bindIdIfProvided(JsonRpcRequest $request, array $item) : void
     {
         /** If no id defined => request is a notification */
         if (isset($item[self::KEY_ID])) {
-            $request->setId(
-                $item[self::KEY_ID] == (string)((int)$item[self::KEY_ID])
-                    ? (int)$item[self::KEY_ID] // Convert it in case it's a string containing an int
-                    : (string)$item[self::KEY_ID] // Convert to string in all other cases
-            );
+            $request->setId($item[self::KEY_ID]);
         }
     }
 

tests/Functional/App/Creator/ResponseCreator/CreateResultResponseTest.php

@@ -40,4 +40,16 @@ public function testShouldBindResultAndRequestParamToResponse()
         $this->assertSame($result, $response->getResult());
         $this->assertFromRequestBinding($fromRequest, $response);
     }
+
+    /**
+     * Bug fix: https://github.com/yoanm/php-jsonrpc-server-sdk/issues/94
+     */
+    public function testShouldConvertRequestWithZeroIdToResponseWithZeroId()
+    {
+        $fromRequest = $this->createRequest(self::DEFAULT_METHOD, self::DEFAULT_JSONRPC, 0);
+
+        $response = $this->responseCreator->createEmptyResponse($fromRequest);
+
+        $this->assertSame(0, $response->getId());
+    }
 }

tests/Technical/App/Serialization/JsonRpcRequestDenormalizerTest.php

@@ -24,35 +24,6 @@ protected function setUp(): void
         $this->requestDenormalizer = new JsonRpcRequestDenormalizer();
     }
 
-    /**
-     * @dataProvider integerRequestIdProvider
-     * @param mixed $requestId
-     */
-    public function testDenormalizeShouldCastIdToIntWhenIdIs($requestId)
-    {
-        $item = [
-            'jsonrpc' => 'fake-json-rpc-version',
-            'method' => 'fake-method',
-            'id' => $requestId,
-        ];
-
-        $result = $this->requestDenormalizer->denormalize($item);
-
-        $this->assertSame((int) $result->getId(), $result->getId());
-    }
-
-    public function integerRequestIdProvider()
-    {
-        return [
-            'real integer' => [
-                'requestId' => 321,
-            ],
-            'integer stored as string' => [
-                'requestId' => '321',
-            ],
-        ];
-    }
-
     /**
      * @dataProvider invalidParamListProvider
      *