fix: relations specified in "alwaysIncluded" method were not included

tailflow · Oct 31, 2022 · 18fe34a · 18fe34a
1 parent c264c6a
commit 18fe34a
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 25 deletions.
diff --git a/src/Drivers/Standard/ParamsValidator.php b/src/Drivers/Standard/ParamsValidator.php
@@ -213,7 +213,7 @@ public function validateIncludes(Request $request): void
         Validator::make(
             $request->query(),
             [
-                'includes' => ['sometimes', 'string', new WhitelistedQueryFields($this->includableBy)],
+                'include' => ['sometimes', 'string', new WhitelistedQueryFields($this->includableBy)],
             ]
         )->validate();
     }

diff --git a/src/Drivers/Standard/QueryBuilder.php b/src/Drivers/Standard/QueryBuilder.php
@@ -41,11 +41,6 @@ class QueryBuilder implements \Orion\Contracts\QueryBuilder
      */
     private $intermediateMode;
 
-    /**
-     * @var string $table
-     */
-    private $table;
-
     /**
      * @inheritDoc
      */
@@ -329,7 +324,8 @@ protected function buildPivotFilterNestedQueryWhereClause(
      */
     public function getQualifiedFieldName(string $field): string
     {
-        $table = $this->table ?? (new $this->resourceModelClass)->getTable();
+        $table = (new $this->resourceModelClass)->getTable();
+
         return "{$table}.{$field}";
     }
 
@@ -538,7 +534,7 @@ public function applyAggregatesToQuery($query, Request $request, array $aggregat
                 );
             }
 
-            $aggregateDescriptors = $aggregateDescriptors->merge($request->post('aggregates', []));
+            $aggregateDescriptors = $aggregateDescriptors->merge($request->get('aggregates', []));
         }
 
         foreach ($aggregateDescriptors as $aggregateDescriptor) {
@@ -586,14 +582,17 @@ public function applyIncludesToQuery($query, Request $request, array $includeDes
     {
         if (!$includeDescriptors) {
             $this->paramsValidator->validateIncludes($request);
-            // Here we regroup query and post params on the same format
-            $includeDescriptors =
-                collect(explode(',', $request->query('include', '')))
-                    ->filter()
-                    ->map(function ($include) {
-                        return ['relation' => $include];
-                    })
-                    ->merge($request->post('includes', []));
+
+            $requestedIncludeDescriptors = collect($request->get('includes', []));
+
+            $includeDescriptors = collect($this->relationsResolver->requestedRelations($request))
+                ->map(function ($include) use ($requestedIncludeDescriptors) {
+                    $requestedIncludeDescriptor = $requestedIncludeDescriptors
+                        ->where('relation', $include)
+                        ->first();
+
+                    return $requestedIncludeDescriptor ?? ['relation' => $include];
+                })->toArray();
         }
 
         foreach ($includeDescriptors as $includeDescriptor) {

diff --git a/src/Drivers/Standard/RelationsResolver.php b/src/Drivers/Standard/RelationsResolver.php
@@ -41,12 +41,17 @@ public function __construct(array $includableRelations, array $alwaysIncludedRel
      */
     public function requestedRelations(Request $request): array
     {
-        $requestedIncludesQueryStr = $request->query('include', '');
-        $requestedIncludesQuery = explode(',', $requestedIncludesQueryStr);
-        $requestedIncludesPost = collect($request->post('includes', []))->pluck('relation');
-        $requestedIncludes = $requestedIncludesPost->merge($requestedIncludesQuery)->unique()->filter()->all();
+        $requestedIncludesQuery = collect(explode(',', $request->query('include', '')));
+        $requestedIncludesBody = collect($request->get('includes', []))->pluck('relation');
 
-        $allowedIncludes = array_unique(array_merge($this->includableRelations, $this->alwaysIncludedRelations));
+        $requestedIncludes = $requestedIncludesQuery
+            ->merge($requestedIncludesBody)
+            ->merge($this->alwaysIncludedRelations)
+            ->unique()->filter()->all();
+
+        $allowedIncludes = array_unique(
+            array_merge($this->includableRelations, $this->alwaysIncludedRelations)
+        );
 
         $validatedIncludes = [];
 
@@ -69,7 +74,7 @@ public function requestedRelations(Request $request): array
             }
         }
 
-        return array_unique(array_merge($validatedIncludes, $this->alwaysIncludedRelations));
+        return $validatedIncludes;
     }
 
     /**

diff --git a/src/Http/Controllers/BaseController.php b/src/Http/Controllers/BaseController.php
@@ -113,7 +113,7 @@ public function __construct()
                 'filterableBy' => $this->filterableBy(),
                 'sortableBy' => $this->sortableBy(),
                 'aggregatableBy' => $this->aggregates(),
-                'includableBy' => $this->includes(),
+                'includableBy' => array_merge($this->includes(), $this->alwaysIncludes()),
             ]
         );
         $this->relationsResolver = App::makeWith(

diff --git a/tests/Unit/Http/Controllers/BaseControllerTest.php b/tests/Unit/Http/Controllers/BaseControllerTest.php
@@ -59,7 +59,7 @@ public function dependencies_are_resolved_correctly()
                 'filterableBy' => ['test_filterable_field'],
                 'sortableBy' => ['test_sortable_field'],
                 'aggregatableBy' => ['test_aggregatable_field'],
-                'includableBy' => ['testRelation'],
+                'includableBy' => ['testRelation', 'testAlwaysIncludedRelation'],
             ]
         )->once()->andReturn($fakeParamsValidator);
 

diff --git a/tests/Unit/Http/Controllers/RelationControllerTest.php b/tests/Unit/Http/Controllers/RelationControllerTest.php
@@ -53,7 +53,7 @@ public function dependencies_are_resolved_correctly()
                 'filterableBy' => ['test_filterable_field'],
                 'sortableBy' => ['test_sortable_field'],
                 'aggregatableBy' => ['test_aggregatable_field'],
-                'includableBy' => ['testRelation'],
+                'includableBy' => ['testRelation', 'testAlwaysIncludedRelation'],
             ]
         )->once()->andReturn($fakeParamsValidator);