tests

Author: soyuka

src/Laravel/ApiPlatformProvider.php

@@ -89,7 +89,6 @@
 use ApiPlatform\Laravel\Eloquent\PropertyAccess\PropertyAccessor as EloquentPropertyAccessor;
 use ApiPlatform\Laravel\Eloquent\PropertyInfo\EloquentExtractor;
 use ApiPlatform\Laravel\Eloquent\Serializer\EloquentNameConverter;
-use ApiPlatform\Laravel\Eloquent\Serializer\Mapping\Loader\RelationMetadataLoader;
 use ApiPlatform\Laravel\Eloquent\Serializer\SerializerContextBuilder as EloquentSerializerContextBuilder;
 use ApiPlatform\Laravel\GraphQl\Controller\EntrypointController as GraphQlEntrypointController;
 use ApiPlatform\Laravel\GraphQl\Controller\GraphiQlController;
@@ -573,7 +572,8 @@ public function register(): void
                 $app->make(LoggerInterface::class),
                 $app->make(ResourceMetadataCollectionFactoryInterface::class),
                 $app->make(ResourceAccessCheckerInterface::class),
-                $defaultContext
+                $defaultContext,
+                // $app->make(TagCollectorInterface::class)
             );
         });
 
@@ -621,6 +621,7 @@ public function register(): void
                 $defaultContext,
                 $app->make(ResourceMetadataCollectionFactoryInterface::class),
                 $app->make(ResourceAccessCheckerInterface::class),
+                // $app->make(TagCollectorInterface::class),
             );
         });
 
@@ -866,7 +867,6 @@ public function register(): void
                 $defaultContext,
                 $app->make(ResourceMetadataCollectionFactoryInterface::class),
                 $app->make(ResourceAccessCheckerInterface::class),
-                null
                 // $app->make(TagCollectorInterface::class),
             );
         });
@@ -961,7 +961,8 @@ public function register(): void
                 $app->make(NameConverterInterface::class),
                 $app->make(ClassMetadataFactoryInterface::class),
                 $defaultContext,
-                $app->make(ResourceAccessCheckerInterface::class)
+                $app->make(ResourceAccessCheckerInterface::class),
+                // $app->make(TagCollectorInterface::class)
             );
         });
 

src/Laravel/Tests/PurgerTest.php

@@ -0,0 +1,112 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Laravel\Tests;
+
+use ApiPlatform\Laravel\Test\ApiTestAssertionsTrait;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Orchestra\Testbench\Concerns\WithWorkbench;
+use Orchestra\Testbench\TestCase;
+use Workbench\App\Models\Author;
+use Workbench\App\Models\Book;
+use Workbench\App\Purger\MockPurger;
+
+class PurgerTest extends TestCase
+{
+    use ApiTestAssertionsTrait;
+    use RefreshDatabase;
+    use WithWorkbench;
+
+    protected function getEnvironmentSetUp($app): void
+    {
+        $app['config']->set('api-platform.http_cache.invalidation.purger', MockPurger::class);
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        MockPurger::reset();
+    }
+
+    public function testPurgeOnCreate(): void
+    {
+        $author = Author::factory()->create();
+
+        $this->postJson('/api/books', [
+            'isbn' => '978-3-16-148410-0',
+            'name' => 'The Test Book',
+            'author' => '/api/authors/'.$author->id,
+        ], ['Accept' => 'application/ld+json']);
+
+        $this->assertTagsWerePurged([
+            '/api/books', // The collection of the created resource
+            '/api/authors/'.$author->id, // The related resource
+        ]);
+    }
+
+    public function testPurgeOnUpdate(): void
+    {
+        $book = Book::factory()->has(Author::factory())->create();
+
+        $this->patchJson('/api/books/'.$book->id, [
+            'name' => 'An Updated Name',
+        ], [
+            'Accept' => 'application/ld+json',
+            'Content-Type' => 'application/merge-patch+json',
+        ]);
+
+        $this->assertTagsWerePurged([
+            '/api/books', // The collection of the updated resource
+            '/api/books/'.$book->id, // The item itself
+        ]);
+    }
+
+    public function testPurgeOnUpdateChangingRelation(): void
+    {
+        $book = Book::factory()->has(Author::factory())->create();
+        $oldAuthor = $book->author;
+        $newAuthor = Author::factory()->create();
+
+        $this->putJson('/api/books/'.$book->id, [
+            'name' => $book->name, // PUT requires all fields
+            'author' => '/api/authors/'.$newAuthor->id,
+        ], ['Accept' => 'application/ld+json']);
+
+        $this->assertTagsWerePurged([
+            '/api/books',
+            '/api/books/'.$book->id,
+            '/api/authors/'.$oldAuthor->id, // The old related resource
+            '/api/authors/'.$newAuthor->id, // The new related resource
+        ]);
+    }
+
+    public function testPurgeOnDelete(): void
+    {
+        $book = Book::factory()->has(Author::factory())->create();
+        $author = $book->author;
+
+        $this->deleteJson('/api/books/'.$book->id);
+
+        $this->assertTagsWerePurged([
+            '/api/books',
+            '/api/books/'.$book->id,
+            '/api/authors/'.$author->id, // The related resource
+        ]);
+    }
+
+    private function assertTagsWerePurged(array $expectedTags): void
+    {
+        sort($expectedTags);
+        $this->assertEquals($expectedTags, MockPurger::getPurgedTags());
+    }
+}

src/Laravel/workbench/app/Providers/WorkbenchServiceProvider.php

@@ -22,6 +22,7 @@
 use Orchestra\Testbench\Workbench\Workbench;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
+use Workbench\App\Purger\MockPurger;
 use Workbench\App\Services\DummyService;
 use Workbench\App\State\CustomProviderWithDependency;
 
@@ -36,6 +37,7 @@ public function register(): void
         $config->set('api-platform.resources', [app_path('Models'), app_path('ApiResource')]);
         $config->set('cache.default', 'null');
 
+        $this->app->singleton(MockPurger::class, fn ($app) => new MockPurger));
         $this->app->singleton(DummyService::class, fn ($app) => new DummyService($app['config']->get('api-platform.title')));
         $this->app->singleton(CustomProviderWithDependency::class, fn ($app) => new CustomProviderWithDependency($app->make(DummyService::class)));
     }

src/Laravel/workbench/app/Purger/MockPurger.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Workbench\App\Purger;
+
+use App\Contracts\ApiCache\PurgerInterface;
+
+class MockPurger implements PurgerInterface
+{
+    /**
+     * @var string[]
+     */
+    public static array $purgedTags = [];
+
+    public function purge(array $tags): void
+    {
+        self::$purgedTags = array_merge(self::$purgedTags, $tags);
+    }
+
+    public static function reset(): void
+    {
+        self::$purgedTags = [];
+    }
+
+    /**
+     * @return string[]
+     */
+    public static function getPurgedTags(): array
+    {
+        // Return unique and sorted tags for consistent assertions
+        $tags = array_unique(self::$purgedTags);
+        sort($tags);
+
+        return $tags;
+    }
+}