chore(api): upgrade to api-platform 3.0

api/composer.json

@@ -5,7 +5,7 @@
         "php": ">=8.1.0",
         "ext-ctype": "*",
         "ext-iconv": "*",
-        "api-platform/core": "2.7.7",
+        "api-platform/core": "3.0.8",
         "composer/package-versions-deprecated": "1.11.99",
         "cweagans/composer-patches": "1.7.3",
         "doctrine/doctrine-bundle": "2.8.2",

api/config/bundles.php

@@ -6,7 +6,7 @@
     Symfony\Bundle\MercureBundle\MercureBundle::class => ['all' => true],
     Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],
     Doctrine\Bundle\DoctrineBundle\DoctrineBundle::class => ['all' => true],
-    ApiPlatform\Core\Bridge\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
+    ApiPlatform\Symfony\Bundle\ApiPlatformBundle::class => ['all' => true],
     Nelmio\CorsBundle\NelmioCorsBundle::class => ['all' => true],
     Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true],
     Symfony\Bundle\MakerBundle\MakerBundle::class => ['dev' => true],

api/config/services.yaml

@@ -11,6 +11,17 @@ services:
         autowire: true      # Automatically injects dependencies in your services.
         autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
 
+
+    _instanceof:
+        App\State\Util\AbstractPersistProcessor:
+            bind:
+                $decorated: '@api_platform.doctrine.orm.state.persist_processor'
+
+        App\State\Util\AbstractRemoveProcessor:
+            bind:
+                $decorated: '@api_platform.doctrine.orm.state.remove_processor'
+
+
     # makes classes in src/ available to be used as services
     # this creates a service per class whose id is the fully-qualified class name
     App\:
@@ -24,9 +35,6 @@ services:
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones
 
-    App\DataPersister\Util\DataPersisterObservable:
-        arguments: [ '@api_platform.doctrine.orm.data_persister' ]
-
     App\Validator\MaterialItemUpdateGroupSequence:
         public: true
 
@@ -45,14 +53,10 @@ services:
         tags:
             - 'app.input_filter'
 
-    App\Metadata\Resource\Factory\GraphQLSecurityResourceMetadataFactory:
-        decorates: 'api_platform.metadata.resource.metadata_factory'
-
     App\Serializer\Normalizer\RelatedCollectionLinkNormalizer:
         decorates: 'api_platform.hal.normalizer.item'
         arguments:
             - '@.inner'
-            - '@api_platform.route_name_resolver'
             - '@api_platform.filter_locator'
             - '@serializer.name_converter.metadata_aware'
             - '@Rize\UriTemplate'
@@ -78,7 +82,7 @@ services:
         decorates: 'api_platform.serializer.context_builder'
 
     App\Serializer\PreventAutomaticEmbeddingPropertyMetadataFactory:
-        decorates: 'api_platform.metadata.property.metadata_factory.legacy'
+        decorates: 'api_platform.metadata.property.metadata_factory'
         # Priority should be 1 lower than the one of SerializerPropertyMetadataFactory, see
         # https://github.com/api-platform/core/blob/main/src/Bridge/Symfony/Bundle/Resources/config/metadata/metadata.xml#L65
         decoration_priority: 29
@@ -167,3 +171,38 @@ services:
                 # ensure, data coming from API without timezone information is interpreted as UTC
                 # (e.g. period start '2021-01-01' in POST payload)
                 datetime_timezone: 'UTC'
+
+    # https://github.com/api-platform/core/issues/4975#issuecomment-1253617780
+    api_platform.cache.metadata.property:
+        parent: cache.system
+        tags: [ cache.pool ]
+    api_platform.cache.metadata.resource:
+        parent: cache.system
+        tags: [ cache.pool ]
+    api_platform.cache.metadata.resource_collection:
+        parent: cache.system
+        tags: [ cache.pool ]
+    api_platform.cache.route_name_resolver:
+        parent: cache.system
+        tags: [ cache.pool ]
+    api_platform.cache.identifiers_extractor:
+        parent: cache.system
+        tags: [ cache.pool ]
+    api_platform.elasticsearch.cache.metadata.document:
+        parent: cache.system
+        tags: [ cache.pool ]
+
+    # https://github.com/api-platform/core/issues/4975#issuecomment-1327620795
+    # Speeds up api-platform cache build substantially
+    # May have to be removed soon when api-platform removes these services
+    # see vendor/api-platform/core/src/Symfony/Bundle/Resources/config/metadata/property.xml:41
+    api_platform.cache.metadata.identifier:
+        parent: cache.adapter.array
+        tags: [ cache.pool ]
+    api_platform.metadata.property.identifier_metadata_factory.cached:
+        class: ApiPlatform\Metadata\Property\Factory\CachedPropertyMetadataFactory
+        decorates: api_platform.metadata.property.identifier_metadata_factory
+        decoration_priority: 99
+        arguments:
+            - '@api_platform.cache.metadata.identifier'
+            - '@api_platform.metadata.property.identifier_metadata_factory.cached.inner'

api/src/DTO/Invitation.php

@@ -2,8 +2,14 @@
 
 namespace App\DTO;
 
-use ApiPlatform\Core\Annotation\ApiProperty;
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\Patch;
+use App\State\InvitationAcceptProcessor;
+use App\State\InvitationProvider;
+use App\State\InvitationRejectProcessor;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 
@@ -12,51 +18,39 @@
  * already have an account.
  */
 #[ApiResource(
-    collectionOperations: [
-        'get' => [
-            'security' => 'false',
-            'path' => '',
-            'openapi_context' => [
-                'description' => 'Not implemented. Only needed that we can show this endpoint in /index.jsonhal.',
-            ],
-        ],
+    operations: [
+        new Get(
+            provider: InvitationProvider::class,
+            uriTemplate: '/invitations/{inviteKey}/find{._format}', // TO DISCUSS: Wouldn't '/{inviteKey}{._format}' be more REST-like
+            normalizationContext: self::ITEM_NORMALIZATION_CONTEXT,
+            openapiContext: ['description' => 'Use myInviteKey to find an invitation in the dev environment.']
+        ),
+        new Patch(
+            provider: InvitationProvider::class,
+            processor: InvitationAcceptProcessor::class,
+            output: Invitation::class,
+            security: 'is_authenticated()',
+            uriTemplate: '/invitations/{inviteKey}/'.self::ACCEPT.'{._format}',
+            denormalizationContext: ['groups' => ['write']],
+            normalizationContext: self::ITEM_NORMALIZATION_CONTEXT,
+            openapiContext: ['summary' => 'Accept an Invitation.', 'description' => 'Use myInviteKey2 to accept an invitation in dev environment.'],
+            validationContext: ['groups' => ['Default', 'accept']]
+        ),
+        new Patch(
+            provider: InvitationProvider::class,
+            processor: InvitationRejectProcessor::class,
+            output: Invitation::class,
+            uriTemplate: '/invitations/{inviteKey}/'.self::REJECT.'{._format}',
+            denormalizationContext: ['groups' => ['write']],
+            normalizationContext: self::ITEM_NORMALIZATION_CONTEXT,
+            openapiContext: ['summary' => 'Reject an Invitation.', 'description' => 'Use myInviteKey to reject an invitation in dev environment.']
+        ),
+        new GetCollection(
+            provider: InvitationProvider::class,
+            security: 'false',
+            openapiContext: ['description' => 'Not implemented. Only needed that we can show this endpoint in /index.jsonhal.']
+        ),
     ],
-    itemOperations: [
-        'get' => [
-            'path' => '/{inviteKey}/find.{_format}',
-            'normalization_context' => self::ITEM_NORMALIZATION_CONTEXT,
-            'openapi_context' => [
-                'description' => 'Use myInviteKey to find an invitation in the dev environment.',
-            ],
-        ],
-        self::ACCEPT => [
-            'security' => 'is_authenticated()',
-            'method' => 'PATCH',
-            'path' => '/{inviteKey}/'.self::ACCEPT.'.{_format}',
-            'denormalization_context' => [
-                'groups' => ['write'],
-            ],
-            'normalization_context' => self::ITEM_NORMALIZATION_CONTEXT,
-            'openapi_context' => [
-                'summary' => 'Accept an Invitation.',
-                'description' => 'Use myInviteKey2 to accept an invitation in dev environment.',
-            ],
-            'validation_groups' => ['Default', 'accept'],
-        ],
-        self::REJECT => [
-            'method' => 'PATCH',
-            'path' => '/{inviteKey}/'.self::REJECT.'.{_format}',
-            'denormalization_context' => [
-                'groups' => ['write'],
-            ],
-            'normalization_context' => self::ITEM_NORMALIZATION_CONTEXT,
-            'openapi_context' => [
-                'summary' => 'Reject an Invitation.',
-                'description' => 'Use myInviteKey to reject an invitation in dev environment.',
-            ],
-        ],
-    ],
-    routePrefix: '/invitations'
 )]
 class Invitation {
     public const ACCEPT = 'accept';