Add config to disable InvalidSortQuery exception (#830)

* Add config to disable InvalidSortQuery exception

* $sort can be null

Author: bohemima

config/query-builder.php

@@ -32,6 +32,12 @@
      */
     'disable_invalid_filter_query_exception' => false,
 
+    /*
+     * By default the package will throw an `InvalidSortQuery` exception when a sort in the
+     * URL is not allowed in the `allowedSorts()` method.
+     */
+    'disable_invalid_sort_query_exception' => false,
+
     /*
      * By default the package inspects query string of request using $request->query().
      * You can change this behavior to inspect the request body using $request->input()

src/Concerns/SortsQuery.php

@@ -85,7 +85,7 @@ protected function addRequestedSortsToQuery()
 
                 $sort = $this->findSort($key);
 
-                $sort->sort($this, $descending);
+                $sort?->sort($this, $descending);
             });
     }
 
@@ -99,6 +99,10 @@ protected function findSort(string $property): ?AllowedSort
 
     protected function ensureAllSortsExist(): void
     {
+        if (config('query-builder.disable_invalid_sort_query_exception')) {
+            return;
+        }
+
         $requestedSortNames = $this->request->sorts()->map(function (string $sort) {
             return ltrim($sort, '-');
         });

tests/SortTest.php

@@ -136,6 +136,15 @@
         ->allowedSorts('id');
 });
 
+it('does not throw invalid sort query exception when disable in config', function () {
+    config(['query-builder.disable_invalid_sort_query_exception' => true]);
+
+    createQueryFromSortRequest('name')
+        ->allowedSorts('id');
+
+    expect(true)->toBeTrue();
+});
+
 test('an invalid sort query exception contains the unknown and allowed sorts', function () {
     $exception = InvalidSortQuery::sortsNotAllowed(collect(['unknown sort']), collect(['allowed sort']));