fix: amend eager load iterator incorrectly filtering some paths

lindyhopchris · lindyhopchris · commit 119ed645b386 · 2024-10-13T13:41:50.000+01:00
Closes #39
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,11 @@ All notable changes to this project will be documented in this file. This projec
 
 - [#38](https://github.com/laravel-json-api/eloquent/pull/38) Added `WhereAll` and `WhereAny` filters.
 
+### Fixed
+
+- [#39](https://github.com/laravel-json-api/eloquent/issues/39) Fixed a bug in the eager loader iterator where include
+  paths starting with the same word were incorrectly removed. E.g. `car` and `carOwner` would result in just `carOwner`.
+
 ## [4.2.0] - 2024-08-26
 
 ### Added
diff --git a/src/QueryBuilder/EagerLoading/EagerLoadIterator.php b/src/QueryBuilder/EagerLoading/EagerLoadIterator.php
@@ -25,7 +25,6 @@
  */
 class EagerLoadIterator implements IteratorAggregate
 {
-
     /**
      * @var Schema
      */
@@ -70,11 +69,13 @@ public function __construct(Schema $schema, IncludePaths $paths)
      */
     public function collect(): Collection
     {
-        $values = collect($this);
+        $values = Collection::make($this);
 
-        return $values->reject(
-            fn($path) => $values->contains(fn($check) => $path !== $check && Str::startsWith($check, $path))
-        )->sort()->values();
+        return $values
+            ->reject(static fn(string $path) => $values
+                ->contains(fn(string $check) => $path !== $check && Str::startsWith($check, $path . '.')))
+            ->sort()
+            ->values();
     }
 
     /**
diff --git a/tests/app/Models/Mechanic.php b/tests/app/Models/Mechanic.php
@@ -13,6 +13,7 @@
 
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\HasOneThrough;
 
 class Mechanic extends Model
@@ -25,6 +26,14 @@ class Mechanic extends Model
      */
     protected $fillable = ['name'];
 
+    /**
+     * @return HasOne
+     */
+    public function car(): HasOne
+    {
+        return $this->hasOne(Car::class);
+    }
+
     /**
      * @return HasOneThrough
      */
diff --git a/tests/app/Schemas/MechanicSchema.php b/tests/app/Schemas/MechanicSchema.php
@@ -15,6 +15,7 @@
 use LaravelJsonApi\Eloquent\Contracts\Paginator;
 use LaravelJsonApi\Eloquent\Fields\DateTime;
 use LaravelJsonApi\Eloquent\Fields\ID;
+use LaravelJsonApi\Eloquent\Fields\Relations\HasOne;
 use LaravelJsonApi\Eloquent\Fields\Relations\HasOneThrough;
 use LaravelJsonApi\Eloquent\Fields\Str;
 use LaravelJsonApi\Eloquent\Filters\WhereIdIn;
@@ -39,6 +40,7 @@ public function fields(): array
             ID::make(),
             DateTime::make('createdAt')->readOnly(),
             Str::make('name'),
+            HasOne::make('car'),
             HasOneThrough::make('carOwner'),
             DateTime::make('updatedAt')->readOnly(),
         ];
diff --git a/tests/lib/Acceptance/EagerLoading/EagerLoaderTest.php b/tests/lib/Acceptance/EagerLoading/EagerLoaderTest.php
@@ -62,6 +62,11 @@ public static function includePathsProvider(): array
                     'profile', // auto included for users
                 ],
             ],
+            'mechanic' => [
+                'mechanics',
+                'car,carOwner,carOwner.car,carOwner.car.mechanic,car.mechanic',
+                ['car.mechanic', 'carOwner.car.mechanic'],
+            ],
         ];
     }
 
