PHPORM-119 Fix integration with Spacie Query Builder - Don't qualify field names in document models (mongodb#2676)

Author: GromNaN

composer.json

@@ -34,7 +34,8 @@
         "phpunit/phpunit": "^10.3",
         "orchestra/testbench": "^8.0",
         "mockery/mockery": "^1.4.4",
-        "doctrine/coding-standard": "12.0.x-dev"
+        "doctrine/coding-standard": "12.0.x-dev",
+        "spatie/laravel-query-builder": "^5.6"
     },
     "replace": {
         "jenssegers/mongodb": "self.version"

src/Eloquent/Model.php

@@ -577,6 +577,12 @@ public function newEloquentBuilder($query)
         return new Builder($query);
     }
 
+    /** @inheritdoc */
+    public function qualifyColumn($column)
+    {
+        return $column;
+    }
+
     /** @inheritdoc */
     protected function newBaseQueryBuilder()
     {

tests/ExternalPackageTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Laravel\Tests;
+
+use Illuminate\Http\Request;
+use MongoDB\Laravel\Tests\Models\User;
+use Spatie\QueryBuilder\AllowedFilter;
+use Spatie\QueryBuilder\AllowedSort;
+use Spatie\QueryBuilder\QueryBuilder;
+
+/**
+ * Test integration with external packages.
+ */
+class ExternalPackageTest extends TestCase
+{
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        User::truncate();
+    }
+
+    /**
+     * Integration test with spatie/laravel-query-builder.
+     */
+    public function testSpacieQueryBuilder(): void
+    {
+        User::insert([
+            ['name' => 'Jimmy Doe', 'birthday' => '2012-11-12', 'role' => 'user'],
+            ['name' => 'John Doe', 'birthday' => '1980-07-08', 'role' => 'admin'],
+            ['name' => 'Jane Doe', 'birthday' => '1983-09-10', 'role' => 'admin'],
+            ['name' => 'Jess Doe', 'birthday' => '2014-05-06', 'role' => 'user'],
+        ]);
+
+        $request = Request::create('/users', 'GET', ['filter' => ['role' => 'admin'], 'sort' => '-birthday']);
+        $result = QueryBuilder::for(User::class, $request)
+            ->allowedFilters([
+                AllowedFilter::exact('role'),
+            ])
+            ->allowedSorts([
+                AllowedSort::field('birthday'),
+            ])
+            ->get();
+
+        $this->assertCount(2, $result);
+        $this->assertSame('Jane Doe', $result[0]->name);
+    }
+}

tests/ModelTest.php

@@ -25,6 +25,7 @@
 use MongoDB\Laravel\Tests\Models\Item;
 use MongoDB\Laravel\Tests\Models\MemberStatus;
 use MongoDB\Laravel\Tests\Models\Soft;
+use MongoDB\Laravel\Tests\Models\SqlUser;
 use MongoDB\Laravel\Tests\Models\User;
 
 use function abs;
@@ -58,6 +59,17 @@ public function testNewModel(): void
         $this->assertEquals('_id', $user->getKeyName());
     }
 
+    public function testQualifyColumn(): void
+    {
+        // Don't qualify field names in document models
+        $user = new User();
+        $this->assertEquals('name', $user->qualifyColumn('name'));
+
+        // Qualify column names in hybrid SQL models
+        $sqlUser = new SqlUser();
+        $this->assertEquals('users.name', $sqlUser->qualifyColumn('name'));
+    }
+
     public function testInsert(): void
     {
         $user        = new User();