Properly filter by id

Author: bakura10

CHANGELOG.md

@@ -5,6 +5,8 @@
 * ZfrRest now supports coalesce filtering for "hasMany" or "findMany" requests type through the new, optional
 `enable_coalesce_filtering` module option. If enabled, ZfrRest will be able to respond to queries like
 /customers?ids[]=5&ids[]=64, where `ids` is a configurable primary key name.
+* Fix a bug with entry points. Previously, if you had an entry point configured as "/users", ZfrRest used to
+match URLs like "/userssssss".
 
 ## 0.3.3
 

config/zfr_rest.global.php.dist

@@ -51,14 +51,14 @@ return [
 
         /**
          * If enabled, it allows the REST router to filter a collection list by identifiers. For instance, considering
-         * a query /customers?ids[]=1&ids[]=2, it will be able to return a filtered collections
+         * a query /customers?$ids[]=1&$ids[]=2, it will be able to return a filtered collections
          */
         // 'enable_coalesce_filtering' => false,
 
         /**
-         * The coalesce filtering key
+         * The coalesce filtering query key
          */
-        // 'coalesce_filtering_key' => 'ids',
+        // 'coalesce_filtering_query_key' => '$ids',
 
         /**
          * Service manager configuration to configure the method handlers. A method handler handles a HTTP request

docs/07. Cookbook.md

@@ -299,12 +299,12 @@ Instead, ZfrRest allows you to enable "coalesce filtering" for identifier. This
 /customers?ids[]=2&ids[]=3&ids[]=5... and ZfrRest will automatically returns you the filtered collection.
 
 This feature is disabled by default, and you can enable it using the `enable_coalesce_filtering`. You can also customize
-the query key using the `coalesce_filtering_key` option (default to "ids"):
+the query key using the `coalesce_filtering_query_key` option (default to "$ids"):
 
 ```php
 'zfr_rest' => [
-  'enable_coalesce_filtering' => true,
-  'coalesce_filtering_key'    => 'ids'
+  'enable_coalesce_filtering'    => true,
+  'coalesce_filtering_query_key' => '$ids'
 ]
 ```
 

src/ZfrRest/Factory/GetHandlerFactory.php

@@ -34,6 +34,7 @@ class GetHandlerFactory implements FactoryInterface
      */
     public function createService(ServiceLocatorInterface $serviceLocator)
     {
+        /** @var ServiceLocatorInterface $parentLocator */
         $parentLocator = $serviceLocator->getServiceLocator();
 
         return new GetHandler($parentLocator->get('ZfrRest\Options\ModuleOptions'));

src/ZfrRest/Mvc/Controller/MethodHandler/GetHandler.php

@@ -73,15 +73,18 @@ public function handleMethod(AbstractRestfulController $controller, ResourceInte
         if ($this->moduleOptions->isEnableCoalesceFiltering() && $data instanceof Selectable) {
             /** @var \Zend\Http\Request $request */
             $request = $controller->getRequest();
-            $idsKey  = $this->moduleOptions->getCoalesceFilteringKey();
+            $idsKey  = $this->moduleOptions->getCoalesceFilteringQueryKey();
+
+            if (is_array($ids = $request->getQuery($idsKey, null))) {
+                $metadata      = $resource->getMetadata();
+                $identifierKey = $metadata->getClassMetadata()->getIdentifierFieldNames();
 
-            if ($ids = $request->getQuery($idsKey, null)) {
                 $criteria = new Criteria();
-                $criteria->where($criteria->expr()->in($idsKey, $ids));
+                $criteria->where($criteria->expr()->in(current($identifierKey), $ids));
 
                 // @TODO: maybe it would make more sense to allow to change the data from a resource, instead of
                 //        having to recreate a new one everytime
-                $resource = new Resource($data->matching($criteria), $resource->getMetadata());
+                $resource = new Resource($data->matching($criteria), $metadata);
                 $controller->getEvent()->getRouteMatch()->setParam('resource', $resource);
             }
         }

src/ZfrRest/Options/ModuleOptions.php

@@ -19,6 +19,7 @@
 namespace ZfrRest\Options;
 
 use Zend\Stdlib\AbstractOptions;
+use ZfrRest\Exception\InvalidArgumentException;
 
 /**
  * @author Michaël Gallego <mic.gallego@gmail.com>
@@ -65,18 +66,18 @@ class ModuleOptions extends AbstractOptions
      * Is the enable coalesce filtering enabled?
      *
      * If enabled, it allows the REST router to filter a collection list by identifiers. For instance, considering
-     * a query /customers?ids[]=1&ids[]=2, it will be able to return a filtered collections
+     * a query /customers?$ids[]=1&$ids[]=2, it will be able to return a filtered collections
      *
      * @var bool
      */
     protected $enableCoalesceFiltering = false;
 
     /**
-     * The coalesce filtering key
+     * The coalesce filtering query key
      *
      * @var string
      */
-    protected $coalesceFilteringKey = 'ids';
+    protected $coalesceFilteringQueryKey = '$ids';
 
     /**
      * @param array|null $options
@@ -195,18 +196,23 @@ public function isEnableCoalesceFiltering()
     }
 
     /**
-     * @param string $coalesceFilteringKey
+     * @param  string $coalesceFilteringQueryKey
+     * @throws InvalidArgumentException
      */
-    public function setCoalesceFilteringKey($coalesceFilteringKey)
+    public function setCoalesceFilteringQueryKey($coalesceFilteringQueryKey)
     {
-        $this->coalesceFilteringKey = (string) $coalesceFilteringKey;
+        if (empty($coalesceFilteringQueryKey)) {
+            throw new InvalidArgumentException('Coalesce filtering key cannot be an empty value');
+        }
+
+        $this->coalesceFilteringQueryKey = (string) $coalesceFilteringQueryKey;
     }
 
     /**
      * @return string
      */
-    public function getCoalesceFilteringKey()
+    public function getCoalesceFilteringQueryKey()
     {
-        return $this->coalesceFilteringKey;
+        return $this->coalesceFilteringQueryKey;
     }
 }

src/ZfrRest/Router/Http/ResourceGraphRoute.php

@@ -160,15 +160,16 @@ public function match(RequestInterface $request, $pathOffset = 0)
             $path = substr($path, strlen(trim($baseUrl, '/')));
         }
 
-        // If the URI does not begin by the route, we can stop immediately
-        if (substr($path, 0, strlen($this->route)) !== $this->route) {
+        $pathParts = explode('/', trim($path, '/'), 2);
+
+        // If the first path part does not match the entry point, we can stop immediately
+        if ($pathParts[0] !== trim($this->route, '/')) {
             return null;
         }
 
         // If we have only one segment (for instance "users"), then the next path to analyze is in fact
         // an empty string, hence the ternary condition
-        $pathParts = explode('/', trim($path, '/'), 2);
-        $subPath   = count($pathParts) === 1 ? '' : end($pathParts);
+        $subPath = count($pathParts) === 1 ? '' : end($pathParts);
 
         if (!$match = $this->subPathMatcher->matchSubPath($this->getResource(), $subPath)) {
             // Although this is an error, we still want to create a route match, so that the request

tests/ZfrRestTest/Asset/Resource/Metadata/Annotation/User.php

@@ -25,6 +25,7 @@
 /**
  * @ORM\Entity
  * @REST\Resource(hydrator="ClassMethods")
+ * @REST\Collection(controller="UserListController")
  */
 class User
 {

tests/ZfrRestTest/Mvc/Controller/MethodHandler/GetHandlerTest.php

@@ -109,12 +109,13 @@ public function testCanCoalesceFiltering()
         $options = new ModuleOptions();
         $options->setEnableCoalesceFiltering(true);
 
-        $controller = $this->getMock('ZfrRest\Mvc\Controller\AbstractRestfulController', ['get', 'getEvent', 'getRequest']);
-        $resource   = $this->getMock('ZfrRest\Resource\ResourceInterface');
-        $metadata   = $this->getMock('ZfrRest\Resource\Metadata\ResourceMetadataInterface');
+        $controller    = $this->getMock('ZfrRest\Mvc\Controller\AbstractRestfulController', ['get', 'getEvent', 'getRequest']);
+        $resource      = $this->getMock('ZfrRest\Resource\ResourceInterface');
+        $metadata      = $this->getMock('ZfrRest\Resource\Metadata\ResourceMetadataInterface');
+        $classMetadata = $this->getMock('Doctrine\Common\Persistence\Mapping\ClassMetadata');
 
         $request = new Request();
-        $request->setQuery(new Parameters(['ids' => [1, 2]]));
+        $request->setQuery(new Parameters(['$ids' => [1, 2]]));
 
         $data = $this->getMock('Doctrine\Common\Collections\Selectable');
 
@@ -138,14 +139,22 @@ public function testCanCoalesceFiltering()
                  ->method('getMetadata')
                  ->will($this->returnValue($metadata));
 
+        $metadata->expects($this->once())
+                 ->method('getClassMetadata')
+                 ->will($this->returnValue($classMetadata));
+
+        $classMetadata->expects($this->once())
+                      ->method('getIdentifierFieldNames')
+                      ->will($this->returnValue(['id']));
+
         $data->expects($this->once())
              ->method('matching')
              ->with($this->callback(function(Criteria $criteria) {
                  /* @var \Doctrine\Common\Collections\Expr\Comparison $comparison */
                  $comparison = $criteria->getWhereExpression();
 
                  $this->assertInstanceOf('Doctrine\Common\Collections\Expr\Comparison', $comparison);
-                 $this->assertEquals('ids', $comparison->getField());
+                 $this->assertEquals('id', $comparison->getField());
                  $this->assertEquals([1, 2], $comparison->getValue()->getValue());
 
                  return true;

tests/ZfrRestTest/Options/ModuleOptionsTest.php

@@ -46,7 +46,7 @@ public function testSettersAndGetters()
             'object_manager'                         => 'doctrine',
             'register_http_method_override_listener' => false,
             'enable_coalesce_filtering'              => true,
-            'coalesce_filtering_key'                 => 'id',
+            'coalesce_filtering_query_key'           => 'id',
             'drivers'                                => [
                 ['class' => 'foo']
             ],
@@ -56,7 +56,7 @@ public function testSettersAndGetters()
         $this->assertEquals('doctrine', $options->getObjectManager());
         $this->assertFalse($options->getRegisterHttpMethodOverrideListener());
         $this->assertTrue($options->isEnableCoalesceFiltering());
-        $this->assertEquals('id', $options->getCoalesceFilteringKey());
+        $this->assertEquals('id', $options->getCoalesceFilteringQueryKey());
         $this->assertEquals('myCache', $options->getCache());
         $this->assertCount(1, $options->getDrivers());