Merge branch 'release/2.1.1'

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.1.1] - 2022-04-04
+
+### Fixed
+
+- Pass sparse field sets to the `JsonApiBuilder` class, ensuring that they are present on any generated page objects.
+  Previously this omission meant that page URLs were missing any fields sent by the client.
+
 ## [2.1.0] - 2022-02-20
 
 ### Added

src/QueryBuilder/JsonApiBuilder.php

@@ -146,6 +146,7 @@ public function withQueryParameters(QueryParametersContract $query): self
 
         $this->filter($query->filter())
             ->sortWithDefault($query->sortFields())
+            ->sparseFieldSets($query->sparseFieldSets())
             ->with($query->includePaths())
             ->withCount($query->countable());
 
@@ -169,6 +170,20 @@ public function filter($filters): self
         return $this;
     }
 
+    /**
+     * Set the sparse field sets for the query.
+     *
+     * @param mixed $fields
+     * @return $this
+     * @todo in a future version, these need to be used to determine which columns to retrieve from the db.
+     */
+    public function sparseFieldSets($fields): self
+    {
+        $this->parameters->setSparseFieldSets($fields);
+
+        return $this;
+    }
+
     /**
      * Sort models using JSON:API sort fields.
      *

tests/lib/Acceptance/Pagination/PagePaginationTest.php

@@ -28,6 +28,7 @@
 use Illuminate\Pagination\AbstractPaginator;
 use Illuminate\Support\LazyCollection;
 use LaravelJsonApi\Contracts\Pagination\Page;
+use LaravelJsonApi\Core\Query\QueryParameters;
 use LaravelJsonApi\Core\Support\Arr;
 use LaravelJsonApi\Eloquent\Pagination\PagePagination;
 use LaravelJsonApi\Eloquent\Tests\Acceptance\TestCase;
@@ -644,6 +645,53 @@ public function testItCanRemoveMeta(): void
         $this->assertPage($posts->take(3), $page);
     }
 
+    public function testUrlsIncludeOtherQueryParameters(): void
+    {
+        $posts = Post::factory()->count(6)->create();
+        $slugs = $posts->take(4)->pluck('slug')->implode(',');
+
+        $links = [
+            'first' => [
+                'href' => 'http://localhost/api/v1/posts?' . Arr::query([
+                        'fields' => $fields = [
+                            'posts' => 'author,slug,title',
+                            'users' => 'name',
+                        ],
+                        'filter' => ['slugs' => $slugs],
+                        'include' => 'author',
+                        'page' => ['number' => '1', 'size' => '3'],
+                        'sort' => '-createdAt',
+                    ]),
+            ],
+            'last' => [
+                'href' => $last = 'http://localhost/api/v1/posts?' . Arr::query([
+                        'fields' => $fields,
+                        'filter' => ['slugs' => $slugs],
+                        'include' => 'author',
+                        'page' => ['number' => '2', 'size' => '3'],
+                        'sort' => '-createdAt',
+                    ]),
+            ],
+            'next' => [
+                'href' => $last,
+            ],
+        ];
+
+        $query = QueryParameters::make()
+            ->setFilters(['slugs' => $slugs])
+            ->setSparseFieldSets($fields)
+            ->setIncludePaths('author')
+            ->setSortFields('-createdAt');
+
+        $page = $this->posts
+            ->repository()
+            ->queryAll()
+            ->withQuery($query)
+            ->paginate(['size' => 3]);
+
+        $this->assertSame($links, $page->links()->toArray());
+    }
+
     /**
      * Assert that the pages match.
      *