feat: all in, any in filter operators

tailflow · Jun 20, 2022 · f063f6d · f063f6d
1 parent 8e4f970
commit f063f6d
Show file tree

Hide file tree

Showing 7 changed files with 167 additions and 14 deletions.
diff --git a/src/Drivers/Standard/ParamsValidator.php b/src/Drivers/Standard/ParamsValidator.php
@@ -53,7 +53,7 @@ public function validateFilters(Request $request): void
                 'filters' => ['sometimes', 'array'],
                 'filters.*.type' => ['sometimes', 'in:and,or'],
                 'filters.*.field' => ['required_with:filters', 'regex:/^[\w.\_\-\>]+$/', new WhitelistedField($this->filterableBy)],
-                'filters.*.operator' => ['sometimes', 'in:<,<=,>,>=,=,!=,like,not like,ilike,not ilike,in,not in'],
+                'filters.*.operator' => ['sometimes', 'in:<,<=,>,>=,=,!=,like,not like,ilike,not ilike,in,not in,all in,any in'],
                 'filters.*.value' => ['present', 'nullable'],
             ]
         )->validate();

diff --git a/src/Drivers/Standard/QueryBuilder.php b/src/Drivers/Standard/QueryBuilder.php
@@ -9,6 +9,7 @@
 use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Arr;
+use JsonException;
 use Orion\Http\Requests\Request;
 use RuntimeException;
 
@@ -62,6 +63,7 @@ public function __construct(
      * @param Builder|Relation $query
      * @param Request $request
      * @return Builder|Relation
+     * @throws JsonException
      */
     public function buildQuery($query, Request $request)
     {
@@ -102,6 +104,7 @@ public function applyScopesToQuery($query, Request $request): void
      * @param Builder|Relation $query
      * @param Request $request
      * @param array $filterDescriptors
+     * @throws JsonException
      */
     public function applyFiltersToQuery($query, Request $request, array $filterDescriptors = []): void
     {
@@ -146,6 +149,7 @@ function ($relationQuery) use ($relationField, $filterDescriptor) {
      * @param Builder|Relation $query
      * @param bool $or
      * @return Builder|Relation
+     * @throws JsonException
      */
     protected function buildFilterQueryWhereClause(string $field, array $filterDescriptor, $query, bool $or = false)
     {
@@ -168,6 +172,7 @@ protected function buildFilterQueryWhereClause(string $field, array $filterDescr
      * @param Builder|Relation $query
      * @param bool $or
      * @return Builder|Relation
+     * @throws JsonException
      */
     protected function buildFilterNestedQueryWhereClause(
         string $field,
@@ -180,16 +185,36 @@ protected function buildFilterNestedQueryWhereClause(
 
         if ($treatAsDateField && Carbon::parse($filterDescriptor['value'])->toTimeString() === '00:00:00') {
             $constraint = 'whereDate';
+        } elseif (in_array(Arr::get($filterDescriptor, 'operator'), ['all in', 'any in'])) {
+            $constraint = 'whereJsonContains';
         } else {
             $constraint = 'where';
         }
 
-        if (!is_array($filterDescriptor['value']) || $constraint === 'whereDate') {
-            $query->{$or ? 'or' . ucfirst($constraint) : $constraint}(
+        if ($constraint !== 'whereJsonContains' && (!is_array(
+                    $filterDescriptor['value']
+                ) || $constraint === 'whereDate')) {
+            $query->{$or ? 'or'.ucfirst($constraint) : $constraint}(
                 $field,
                 $filterDescriptor['operator'] ?? '=',
                 $filterDescriptor['value']
             );
+        } elseif ($constraint === 'whereJsonContains') {
+            if (!is_array($filterDescriptor['value'])) {
+                $query->{$or ? 'orWhereJsonContains' : 'whereJsonContains'}(
+                    $field,
+                    $filterDescriptor['value']
+                );
+            } else {
+                $query->{$or ? 'orWhere' : 'where'}(function ($nestedQuery) use ($filterDescriptor, $field) {
+                    foreach ($filterDescriptor['value'] as $value) {
+                        $nestedQuery->{$filterDescriptor['operator'] === 'any in' ? 'orWhereJsonContains' : 'whereJsonContains'}(
+                            $field,
+                            $value
+                        );
+                    }
+                });
+            }
         } else {
             $query->{$or ? 'orWhereIn' : 'whereIn'}(
                 $field,
@@ -335,14 +360,14 @@ function ($relationQuery) use ($relationField, $requestedSearchString, $caseSens
                                 if (!$caseSensitive) {
                                     return $relationQuery->whereRaw(
                                         "lower({$relationField}) like lower(?)",
-                                        ['%' . $requestedSearchString . '%']
+                                        ['%'.$requestedSearchString.'%']
                                     );
                                 }
 
                                 return $relationQuery->where(
                                     $relationField,
                                     'like',
-                                    '%' . $requestedSearchString . '%'
+                                    '%'.$requestedSearchString.'%'
                                 );
                             }
                         );
@@ -352,13 +377,13 @@ function ($relationQuery) use ($relationField, $requestedSearchString, $caseSens
                         if (!$caseSensitive) {
                             $whereQuery->orWhereRaw(
                                 "lower({$qualifiedFieldName}) like lower(?)",
-                                ['%' . $requestedSearchString . '%']
+                                ['%'.$requestedSearchString.'%']
                             );
                         } else {
                             $whereQuery->orWhere(
                                 $qualifiedFieldName,
                                 'like',
-                                '%' . $requestedSearchString . '%'
+                                '%'.$requestedSearchString.'%'
                             );
                         }
                     }

diff --git a/src/Specs/Builders/Builder.php b/src/Specs/Builders/Builder.php
@@ -4,6 +4,8 @@
 
 namespace Orion\Specs\Builders;
 
+use Illuminate\Contracts\Container\BindingResolutionException;
+
 class Builder
 {
     /** @var InfoBuilder */
@@ -35,6 +37,10 @@ public function __construct(
         $this->tagsBuilder = $tagsBuilder;
     }
 
+    /**
+     * @return array
+     * @throws BindingResolutionException
+     */
     public function build(): array
     {
         return [

diff --git a/tests/Feature/StandardIndexFilteringOperationsTest.php b/tests/Feature/StandardIndexFilteringOperationsTest.php
@@ -533,4 +533,116 @@ public function getting_a_list_of_resources_filtered_by_model_datetime_field():
             $this->makePaginator([$matchingPost], 'posts/search')
         );
     }
+
+    /** @test */
+    public function getting_a_list_of_resources_filtered_by_jsonb_array_field_inclusive(): void
+    {
+        if (config('database.default') === 'sqlite'){
+            $this->markTestSkipped('Not supported with SQLite');
+        }
+
+        $matchingPost = factory(Post::class)
+            ->create(['options' =>  ['a', 'b', 'c']])->fresh();
+        factory(Post::class)->create(['publish_at' => Carbon::now()])->fresh();
+
+        Gate::policy(Post::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/posts/search',
+            [
+                'filters' => [
+                    ['field' => 'options', 'operator' => 'all in', 'value' => ['a', 'b']],
+                ],
+            ]
+        );
+
+        $this->assertResourcesPaginated(
+            $response,
+            $this->makePaginator([$matchingPost], 'posts/search')
+        );
+    }
+
+    /** @test */
+    public function getting_a_list_of_resources_filtered_by_nested_jsonb_array_field_inclusive(): void
+    {
+        if (config('database.default') === 'sqlite'){
+            $this->markTestSkipped('Not supported with SQLite');
+        }
+
+        $matchingPost = factory(Post::class)
+            ->create(['options' => ['nested_field' => ['a', 'b', 'c']]])->fresh();
+        factory(Post::class)->create(['publish_at' => Carbon::now()])->fresh();
+
+        Gate::policy(Post::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/posts/search',
+            [
+                'filters' => [
+                    ['field' => 'options->nested_field', 'operator' => 'all in', 'value' => ['a', 'b']],
+                ],
+            ]
+        );
+
+        $this->assertResourcesPaginated(
+            $response,
+            $this->makePaginator([$matchingPost], 'posts/search')
+        );
+    }
+
+    /** @test */
+    public function getting_a_list_of_resources_filtered_by_jsonb_array_field_exclusive(): void
+    {
+        if (config('database.default') === 'sqlite'){
+            $this->markTestSkipped('Not supported with SQLite');
+        }
+
+        $matchingPost = factory(Post::class)
+            ->create(['options' =>  ['a', 'd']])->fresh();
+        factory(Post::class)->create(['publish_at' => Carbon::now()])->fresh();
+
+        Gate::policy(Post::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/posts/search',
+            [
+                'filters' => [
+                    ['field' => 'options', 'operator' => 'any in', 'value' => ['a', 'b']],
+                ],
+            ]
+        );
+
+        $this->assertResourcesPaginated(
+            $response,
+            $this->makePaginator([$matchingPost], 'posts/search')
+        );
+    }
+
+    /** @test */
+    public function getting_a_list_of_resources_filtered_by_nested_jsonb_array_field_exclusive(): void
+    {
+        if (config('database.default') === 'sqlite'){
+            $this->markTestSkipped('Not supported with SQLite');
+        }
+
+        $matchingPost = factory(Post::class)
+            ->create(['options' => ['nested_field' => ['a', 'd']]])->fresh();
+        factory(Post::class)->create(['publish_at' => Carbon::now()])->fresh();
+
+        Gate::policy(Post::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/posts/search',
+            [
+                'filters' => [
+                    ['field' => 'options->nested_field', 'operator' => 'any in', 'value' => ['a', 'b']],
+                ],
+            ]
+        );
+
+        $this->assertResourcesPaginated(
+            $response,
+            $this->makePaginator([$matchingPost], 'posts/search')
+        );
+    }
 }
diff --git a/tests/Fixtures/app/Http/Controllers/PostsController.php b/tests/Fixtures/app/Http/Controllers/PostsController.php
@@ -25,30 +25,38 @@ protected function beforeSave(Request $request, $entity)
         }
     }
 
-    public function sortableBy() : array
+    public function sortableBy(): array
     {
         return ['title', 'user.name', 'meta->nested_field'];
     }
 
-    public function filterableBy() : array
+    public function filterableBy(): array
     {
-        return ['title', 'position', 'publish_at', 'user.name', 'meta->nested_field'];
+        return [
+            'title',
+            'position',
+            'publish_at',
+            'user.name',
+            'meta->nested_field',
+            'options',
+            'options->nested_field',
+        ];
     }
 
-    public function searchableBy() : array
+    public function searchableBy(): array
     {
         return ['title', 'user.name'];
     }
 
-    public function exposedScopes() : array
+    public function exposedScopes(): array
     {
         return ['published', 'publishedAt'];
     }
 
     /**
      * @return array
      */
-    public function includes() : array
+    public function includes(): array
     {
         return ['user'];
     }

diff --git a/tests/Fixtures/app/Models/Post.php b/tests/Fixtures/app/Models/Post.php
@@ -27,7 +27,8 @@ class Post extends Model
      * @var array
      */
     protected $casts = [
-        'meta' => 'array'
+        'meta' => 'array',
+        'options' => 'array',
     ];
 
     /**

diff --git a/tests/Fixtures/database/migrations/2019_01_06_113445_create_posts_table.php b/tests/Fixtures/database/migrations/2019_01_06_113445_create_posts_table.php
@@ -20,6 +20,7 @@ public function up()
             $table->text('body');
             $table->string('tracking_id')->nullable();
             $table->jsonb('meta')->nullable();
+            $table->jsonb('options')->nullable();
             $table->unsignedInteger('position')->default(0);
 
             $table->unsignedBigInteger('user_id')->nullable();