Merge pull request #3611 from soyuka/fix/identifier-encode

Fix/identifier encode

Author: soyuka

CHANGELOG.md

@@ -13,6 +13,7 @@
 * OpenAPI: Add PHP default values to the documentation (#2386)
 * Deprecate using a validation groups generator service not implementing `ApiPlatform\Core\Bridge\Symfony\Validator\ValidationGroupsGeneratorInterface` (#3346)
 * Subresources: subresource resourceClass can now be defined as a container parameter in XML and Yaml definitions
+* IriConverter: Fix IRI url double encoding - may cause breaking change as some characters no longer encoded in output (#3552)
 
 ## 2.5.6
 

features/bootstrap/DoctrineContext.php

@@ -67,6 +67,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\SoMany as SoManyDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\Taxon as TaxonDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\ThirdLevel as ThirdLevelDocument;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\UrlEncodedId as UrlEncodedIdDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Document\User as UserDocument;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Address;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Answer;
@@ -129,6 +130,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\SoMany;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Taxon;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\ThirdLevel;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\UrlEncodedId;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\User;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\UuidIdentifierDummy;
 use Behat\Behat\Context\Context;
@@ -1055,6 +1057,17 @@ public function thereIsAnAnswerToTheQuestion(string $a, string $q)
         $this->manager->clear();
     }
 
+    /**
+     * @Given there is a UrlEncodedId resource
+     */
+    public function thereIsAUrlEncodedIdResource()
+    {
+        $urlEncodedIdResource = ($this->isOrm() ? new UrlEncodedId() : new UrlEncodedIdDocument());
+        $this->manager->persist($urlEncodedIdResource);
+        $this->manager->flush();
+        $this->manager->clear();
+    }
+
     /**
      * @Then the password :password for user :user should be hashed
      */

features/main/table_inheritance.feature

@@ -538,7 +538,7 @@ Feature: Table inheritance
         },
         "@id": {
           "type": "string",
-          "pattern": "^/resource_interfaces/single%2520item$"
+          "pattern": "^/resource_interfaces/single%20item$"
         },
         "@type": {
           "type": "string",

features/main/url_encoded_id.feature

@@ -0,0 +1,26 @@
+Feature: Allowing resource identifiers with characters that should be URL encoded
+  In order to have a resource with an id with special characters
+  As a client software developer
+  I need to be able to set and retrieve these resources with the URL encoded ID
+
+  @createSchema
+  Scenario Outline: Get a resource whether or not the id is URL encoded
+    Given there is a UrlEncodedId resource
+    And I add "Content-Type" header equal to "application/ld+json"
+    When I send a "GET" request to "<url>"
+    Then the response status code should be 200
+    And the JSON should be equal to:
+    """
+    {
+        "@context": "/contexts/UrlEncodedId",
+        "@id": "/url_encoded_ids/%25encode:id",
+        "@type": "UrlEncodedId",
+        "id": "%encode:id"
+    }
+    """
+    Examples:
+      | url                              |
+      | /url_encoded_ids/%encode:id      |
+      | /url_encoded_ids/%25encode%3Aid  |
+      | /url_encoded_ids/%25encode:id    |
+      | /url_encoded_ids/%encode%3Aid    |

src/Bridge/Symfony/Routing/IriConverter.php

@@ -182,7 +182,7 @@ private function generateIdentifiersUrl(array $identifiers, string $resourceClas
         }
 
         if (1 === \count($identifiers)) {
-            return [rawurlencode((string) reset($identifiers))];
+            return [(string) reset($identifiers)];
         }
 
         foreach ($identifiers as $name => $value) {

tests/Fixtures/TestBundle/Document/UrlEncodedId.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Document;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+/**
+ * @author Daniel West <[email protected]>
+ *
+ * Resource with an ID that will be URL encoded
+ *
+ * @ODM\Document
+ *
+ * @ApiResource(
+ *     itemOperations={
+ *         "get"={
+ *             "method"="GET",
+ *             "requirements"={"id"=".+"}
+ *         }
+ *     }
+ * )
+ */
+class UrlEncodedId
+{
+    /**
+     * @ODM\Id(strategy="none")
+     */
+    private $id = '%encode:id';
+
+    public function getId()
+    {
+        return $this->id;
+    }
+}

tests/Fixtures/TestBundle/Entity/UrlEncodedId.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * @author Daniel West <[email protected]>
+ *
+ * Resource with an ID that will be URL encoded
+ *
+ * @ORM\Entity
+ *
+ * @ApiResource(
+ *     itemOperations={
+ *         "get"={
+ *             "method"="GET",
+ *             "requirements"={"id"=".+"}
+ *         }
+ *     }
+ * )
+ */
+class UrlEncodedId
+{
+    /**
+     * @ORM\Column(type="string")
+     * @ORM\Id
+     */
+    private $id = '%encode:id';
+
+    public function getId()
+    {
+        return $this->id;
+    }
+}