[9.x] Throw exception when ResourceCollection collects something else than … (#40844)

* Throw exception when ResourceCollection collects something else than JsonResource

* Apply StyleCI

* Throw LogicException instead of RuntimeException

* formatting

Co-authored-by: Taylor Otwell <[email protected]>

Author: bastien-phi

src/Illuminate/Http/Resources/CollectsResources.php

@@ -2,10 +2,12 @@
 
 namespace Illuminate\Http\Resources;
 
+use Illuminate\Http\Resources\Json\JsonResource;
 use Illuminate\Pagination\AbstractCursorPaginator;
 use Illuminate\Pagination\AbstractPaginator;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use LogicException;
 use ReflectionClass;
 use Traversable;
 
@@ -45,15 +47,21 @@ protected function collectResource($resource)
      */
     protected function collects()
     {
-        if ($this->collects) {
-            return $this->collects;
-        }
+        $collects = null;
 
-        if (str_ends_with(class_basename($this), 'Collection') &&
+        if ($this->collects) {
+            $collects = $this->collects;
+        } elseif (str_ends_with(class_basename($this), 'Collection') &&
             (class_exists($class = Str::replaceLast('Collection', '', get_class($this))) ||
              class_exists($class = Str::replaceLast('Collection', 'Resource', get_class($this))))) {
-            return $class;
+            $collects = $class;
         }
+
+        if (! $collects || is_subclass_of($collects, JsonResource::class)) {
+            return $collects;
+        }
+
+        throw new LogicException('Resource collections must collect instances of '.JsonResource::class.'.');
     }
 
     /**

tests/Integration/Http/Fixtures/PostModelCollectionResource.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Http\Fixtures;
+
+use Illuminate\Http\Resources\Json\ResourceCollection;
+
+class PostModelCollectionResource extends ResourceCollection
+{
+    public $collects = Post::class;
+
+    public function toArray($request)
+    {
+        return ['data' => $this->collection];
+    }
+}

tests/Integration/Http/ResourceTest.php

@@ -21,6 +21,7 @@
 use Illuminate\Tests\Integration\Http\Fixtures\Post;
 use Illuminate\Tests\Integration\Http\Fixtures\PostCollectionResource;
 use Illuminate\Tests\Integration\Http\Fixtures\PostCollectionResourceWithPaginationInformation;
+use Illuminate\Tests\Integration\Http\Fixtures\PostModelCollectionResource;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResource;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithAnonymousResourceCollectionWithPaginationInformation;
 use Illuminate\Tests\Integration\Http\Fixtures\PostResourceWithExtraData;
@@ -36,6 +37,7 @@
 use Illuminate\Tests\Integration\Http\Fixtures\ResourceWithPreservedKeys;
 use Illuminate\Tests\Integration\Http\Fixtures\SerializablePostResource;
 use Illuminate\Tests\Integration\Http\Fixtures\Subscription;
+use LogicException;
 use Mockery;
 use Orchestra\Testbench\TestCase;
 
@@ -1043,6 +1045,19 @@ public function testCollectionResourcesAreCountable()
         $this->assertCount(2, $collection);
     }
 
+    public function testCollectionResourcesMustCollectResources()
+    {
+        $posts = collect([
+            new Post(['id' => 1, 'title' => 'Test title']),
+            new Post(['id' => 2, 'title' => 'Test title 2']),
+        ]);
+
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('must collect');
+
+        new PostModelCollectionResource($posts);
+    }
+
     public function testKeysArePreservedIfTheResourceIsFlaggedToPreserveKeys()
     {
         $data = [