add option disable_invalid_includes_query_exception

config/query-builder.php

@@ -44,6 +44,12 @@
      */
     'disable_invalid_sort_query_exception' => false,
 
+    /*
+     * By default the package will throw an `InvalidIncludeQuery` exception when an include in the
+     * URL is not allowed in the `allowedIncludes()` method.
+     */
+    'disable_invalid_includes_query_exception' => false,
+
     /*
      * By default, the package expects relationship names to be snake case plural when using fields[relationship].
      * For example, fetching the id and name for a userOwner relation would look like this:

src/Concerns/AddsIncludesToQuery.php

@@ -45,7 +45,9 @@ public function allowedIncludes($includes): static
 
         $this->ensureAllIncludesExist();
 
-        $this->addIncludesToQuery($this->request->includes());
+        $includes = $this->filterNonExistingIncludes($this->request->includes());
+
+        $this->addIncludesToQuery($includes);
 
         return $this;
     }
@@ -69,6 +71,10 @@ protected function findInclude(string $include): ?AllowedInclude
 
     protected function ensureAllIncludesExist()
     {
+        if (config('query-builder.disable_invalid_includes_query_exception', false)) {
+            return;
+        }
+
         $includes = $this->request->includes();
 
         $allowedIncludeNames = $this->allowedIncludes->map(function (AllowedInclude $allowedInclude) {
@@ -83,4 +89,15 @@ protected function ensureAllIncludesExist()
 
         // TODO: Check for non-existing relationships?
     }
+
+    protected function filterNonExistingIncludes(Collection $includes): Collection
+    {
+        if (config('query-builder.disable_invalid_includes_query_exception', false) == false) {
+            return $includes;
+        }
+
+        return $includes->filter(function ($include) {
+            return $this->findInclude($include);
+        });
+    }
 }

tests/IncludeTest.php

@@ -236,6 +236,15 @@
         ->allowedIncludes('relatedModels');
 });
 
+it('does not throw invalid include query exception when disable in config', function () {
+    config(['query-builder.disable_invalid_includes_query_exception' => true]);
+
+    createQueryFromIncludeRequest('random-model')
+        ->allowedIncludes('relatedModels');
+
+    expect(true)->toBeTrue();
+});
+
 it('can allow multiple includes', function () {
     $models = createQueryFromIncludeRequest('relatedModels')
         ->allowedIncludes('relatedModels', 'otherRelatedModels')