chore: update api-platform to 4.0.3 (#454)

api-platform · Oct 4, 2024 · 7f20c98 · 7f20c98
1 parent 2af5c1f
commit 7f20c98
Show file tree

Hide file tree

Showing 25 changed files with 296 additions and 280 deletions.
diff --git a/api/composer.lock b/api/composer.lock
diff --git a/api/config/packages/api_platform.yaml b/api/config/packages/api_platform.yaml
@@ -1,6 +1,6 @@
 api_platform:
     title: API Platform's demo
-    version: 4.0.2
+    version: 4.0.3
     description: |
         This is a demo application of the [API Platform](https://api-platform.com) framework.
         [Its source code](https://github.com/api-platform/demo) includes various examples, check it out!

diff --git a/api/src/Command/BooksImportCommand.php b/api/src/Command/BooksImportCommand.php
@@ -27,7 +27,7 @@ public function __construct(
         private readonly SerializerInterface $serializer,
         private readonly DecoderInterface $decoder,
         private readonly HttpClientInterface $client,
-        private readonly LoggerInterface $logger
+        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

diff --git a/api/src/Doctrine/Orm/Extension/BookmarkQueryCollectionExtension.php b/api/src/Doctrine/Orm/Extension/BookmarkQueryCollectionExtension.php
@@ -31,7 +31,7 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
         }
 
         $queryBuilder
-            ->andWhere(sprintf('%s.user = :user', $queryBuilder->getRootAliases()[0]))
+            ->andWhere(\sprintf('%s.user = :user', $queryBuilder->getRootAliases()[0]))
             ->setParameter('user', $user)
         ;
     }

diff --git a/api/src/Doctrine/Orm/Filter/NameFilter.php b/api/src/Doctrine/Orm/Filter/NameFilter.php
@@ -47,8 +47,8 @@ protected function filterProperty(string $property, $value, QueryBuilder $queryB
             $parameterName = $queryNameGenerator->generateParameterName("name{$key}");
             $queryBuilder->setParameter($parameterName, "%{$value}%");
             $expressions[] = $queryBuilder->expr()->orX(
-                $queryBuilder->expr()->like(sprintf('%s.firstName', $alias), ":{$parameterName}"),
-                $queryBuilder->expr()->like(sprintf('%s.lastName', $alias), ":{$parameterName}")
+                $queryBuilder->expr()->like(\sprintf('%s.firstName', $alias), ":{$parameterName}"),
+                $queryBuilder->expr()->like(\sprintf('%s.lastName', $alias), ":{$parameterName}")
             );
         }
         $queryBuilder->andWhere($queryBuilder->expr()->andX(...$expressions));
@@ -72,7 +72,7 @@ protected function normalizeValues($value, string $property): ?array
 
         if (empty($values)) {
             $this->getLogger()->notice('Invalid filter ignored', [
-                'exception' => new \InvalidArgumentException(sprintf('At least one value is required, multiple values should be in "%1$s[]=firstvalue&%1$s[]=secondvalue" format', $property)),
+                'exception' => new \InvalidArgumentException(\sprintf('At least one value is required, multiple values should be in "%1$s[]=firstvalue&%1$s[]=secondvalue" format', $property)),
             ]);
 
             return null;

diff --git a/api/src/Entity/User.php b/api/src/Entity/User.php
@@ -118,6 +118,6 @@ public function getName(): ?string
             return null;
         }
 
-        return trim(sprintf('%s %s', $this->firstName, $this->lastName));
+        return trim(\sprintf('%s %s', $this->firstName, $this->lastName));
     }
 }
diff --git a/api/src/Security/Core/UserProvider.php b/api/src/Security/Core/UserProvider.php
@@ -24,7 +24,7 @@ public function refreshUser(UserInterface $user): UserInterface
     {
         $manager = $this->registry->getManagerForClass($user::class);
         if (!$manager) {
-            throw new UnsupportedUserException(sprintf('User class "%s" not supported.', $user::class));
+            throw new UnsupportedUserException(\sprintf('User class "%s" not supported.', $user::class));
         }
 
         $manager->refresh($user);

diff --git a/api/src/Security/Http/AccessToken/Oidc/OidcDiscoveryTokenHandler.php b/api/src/Security/Http/AccessToken/Oidc/OidcDiscoveryTokenHandler.php
@@ -87,7 +87,7 @@ public function getUserBadgeFrom(string $accessToken): UserBadge
 
             $claims = json_decode($jws->getPayload(), true);
             if (empty($claims[$this->claim])) {
-                throw new MissingClaimException(sprintf('"%s" claim not found.', $this->claim));
+                throw new MissingClaimException(\sprintf('"%s" claim not found.', $this->claim));
             }
 
             // UserLoader argument can be overridden by a UserProvider on AccessTokenAuthenticator::authenticate

diff --git a/api/src/Security/Http/Protection/ResourceResourceHandler.php b/api/src/Security/Http/Protection/ResourceResourceHandler.php
@@ -41,10 +41,10 @@ public function create(object $resource, UserInterface $owner, array $context =
         $this->securityAuthorizationClient->request('POST', $this->getResourceRegistrationEndpoint(), [
             'auth_bearer' => $this->getPAT(),
             'json' => [
-                'name' => sprintf('%s_%s', $shortName, $resource->getId()->__toString()),
-                'displayName' => sprintf('%s #%s', $operation->getShortName(), $resource->getId()->__toString()),
+                'name' => \sprintf('%s_%s', $shortName, $resource->getId()->__toString()),
+                'displayName' => \sprintf('%s #%s', $operation->getShortName(), $resource->getId()->__toString()),
                 'uris' => [$resourceIri],
-                'type' => sprintf('urn:%s:resources:%s', $this->oidcClientId, $shortName),
+                'type' => \sprintf('urn:%s:resources:%s', $this->oidcClientId, $shortName),
                 'owner' => $owner->getUserIdentifier(),
             ],
         ]);
@@ -75,7 +75,7 @@ public function delete(object $resource, UserInterface $owner, array $context =
                     'max' => 1,
                     'uri' => $resourceIri,
                     'owner' => $owner->getUserIdentifier(),
-                    'type' => sprintf('urn:%s:resources:%s', $this->oidcClientId, $shortName),
+                    'type' => \sprintf('urn:%s:resources:%s', $this->oidcClientId, $shortName),
                 ],
             ]
         );
@@ -85,7 +85,7 @@ public function delete(object $resource, UserInterface $owner, array $context =
         // delete corresponding resource_set on OIDC server
         $this->securityAuthorizationClient->request(
             'DELETE',
-            sprintf('%s/%s', $this->getResourceRegistrationEndpoint(), $resourceSet['_id']),
+            \sprintf('%s/%s', $this->getResourceRegistrationEndpoint(), $resourceSet['_id']),
             [
                 'auth_bearer' => $this->getPAT(),
             ]

diff --git a/api/src/Security/Voter/OidcRoleVoter.php b/api/src/Security/Voter/OidcRoleVoter.php
@@ -36,7 +36,7 @@ protected function supports(string $attribute, mixed $subject): bool
     protected function voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token): bool
     {
         if (!empty($subject)) {
-            throw new \InvalidArgumentException(sprintf('Invalid subject type, expected empty string or "null", got "%s".', get_debug_type($subject)));
+            throw new \InvalidArgumentException(\sprintf('Invalid subject type, expected empty string or "null", got "%s".', get_debug_type($subject)));
         }
 
         // ensure user is authenticated

diff --git a/api/src/Security/Voter/OidcTokenIntrospectRoleVoter.php b/api/src/Security/Voter/OidcTokenIntrospectRoleVoter.php
@@ -43,7 +43,7 @@ protected function supports(string $attribute, mixed $subject): bool
     protected function voteOnAttribute(string $attribute, mixed $subject, TokenInterface $token): bool
     {
         if (!empty($subject)) {
-            throw new \InvalidArgumentException(sprintf('Invalid subject type, expected empty string or "null", got "%s".', get_debug_type($subject)));
+            throw new \InvalidArgumentException(\sprintf('Invalid subject type, expected empty string or "null", got "%s".', get_debug_type($subject)));
         }
 
         // ensure user is authenticated

diff --git a/api/src/Security/Voter/OidcTokenPermissionVoter.php b/api/src/Security/Voter/OidcTokenPermissionVoter.php
@@ -47,7 +47,7 @@ protected function voteOnAttribute(string $attribute, mixed $subject, TokenInter
         }
 
         if (!\is_string($subject)) {
-            throw new \InvalidArgumentException(sprintf('Invalid subject type, expected "string" or "object", got "%s".', get_debug_type($subject)));
+            throw new \InvalidArgumentException(\sprintf('Invalid subject type, expected "string" or "object", got "%s".', get_debug_type($subject)));
         }
 
         // ensure user is authenticated
@@ -69,7 +69,7 @@ protected function voteOnAttribute(string $attribute, mixed $subject, TokenInter
                     'response_mode' => 'decision',
                     'permission_resource_format' => 'uri',
                     'permission_resource_matching_uri' => true,
-                    'permission' => sprintf('%s', $subject),
+                    'permission' => \sprintf('%s', $subject),
                 ],
             ]);
 

diff --git a/api/src/Serializer/BookNormalizer.php b/api/src/Serializer/BookNormalizer.php
@@ -21,7 +21,7 @@ final class BookNormalizer implements NormalizerInterface, NormalizerAwareInterf
      */
     public function __construct(
         #[Autowire(service: ReviewRepository::class)]
-        private ObjectRepository $repository
+        private ObjectRepository $repository,
     ) {
     }
 

diff --git a/api/src/Serializer/IriTransformerNormalizer.php b/api/src/Serializer/IriTransformerNormalizer.php
@@ -20,7 +20,7 @@ final class IriTransformerNormalizer implements NormalizerInterface, NormalizerA
 
     public function __construct(
         private readonly IriConverterInterface $iriConverter,
-        private readonly OperationMetadataFactoryInterface $operationMetadataFactory
+        private readonly OperationMetadataFactoryInterface $operationMetadataFactory,
     ) {
     }
 

diff --git a/api/src/State/Processor/BookPersistProcessor.php b/api/src/State/Processor/BookPersistProcessor.php
@@ -25,7 +25,7 @@ public function __construct(
         #[Autowire(service: PersistProcessor::class)]
         private ProcessorInterface $persistProcessor,
         private HttpClientInterface $client,
-        private DecoderInterface $decoder
+        private DecoderInterface $decoder,
     ) {
     }
 

diff --git a/api/src/State/Processor/BookmarkPersistProcessor.php b/api/src/State/Processor/BookmarkPersistProcessor.php
@@ -24,7 +24,7 @@ public function __construct(
         #[Autowire(service: PersistProcessor::class)]
         private ProcessorInterface $persistProcessor,
         private Security $security,
-        private ClockInterface $clock
+        private ClockInterface $clock,
     ) {
     }
 

diff --git a/api/src/Validator/UniqueUserBookValidator.php b/api/src/Validator/UniqueUserBookValidator.php
@@ -22,7 +22,7 @@ final class UniqueUserBookValidator extends ConstraintValidator
     public function __construct(
         private readonly Security $security,
         private readonly ManagerRegistry $registry,
-        private readonly PropertyAccessorInterface $propertyAccessor
+        private readonly PropertyAccessorInterface $propertyAccessor,
     ) {
     }
 
@@ -47,7 +47,7 @@ public function validate($value, Constraint $constraint): void
         $className = ClassUtils::getRealClass($value::class);
         $manager = $this->registry->getManagerForClass($className);
         if (!$manager) {
-            throw new ValidatorException(sprintf('"%s" is not a valid entity.', $className));
+            throw new ValidatorException(\sprintf('"%s" is not a valid entity.', $className));
         }
 
         if ($manager->getRepository($className)->findOneBy(['user' => $user, 'book' => $book])) {

diff --git a/api/symfony.lock b/api/symfony.lock
@@ -2,6 +2,20 @@
     "api-platform/schema-generator": {
         "version": "v4.0.0"
     },
+    "api-platform/symfony": {
+        "version": "4.0",
+        "recipe": {
+            "repo": "github.com/symfony/recipes",
+            "branch": "main",
+            "version": "4.0",
+            "ref": "e9952e9f393c2d048f10a78f272cd35e807d972b"
+        },
+        "files": [
+            "config/packages/api_platform.yaml",
+            "config/routes/api_platform.yaml",
+            "src/ApiResource/.gitignore"
+        ]
+    },
     "composer/pcre": {
         "version": "1.0.0"
     },

diff --git a/api/tests/Api/Admin/BookTest.php b/api/tests/Api/Admin/BookTest.php
@@ -54,9 +54,9 @@ public function asNonAdminUserICannotGetACollectionOfBooks(int $expectedCode, st
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -196,9 +196,9 @@ public function asNonAdminUserICannotGetABook(int $expectedCode, string $hydraDe
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -254,9 +254,9 @@ public function asNonAdminUserICannotCreateABook(int $expectedCode, string $hydr
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -290,7 +290,7 @@ public static function getInvalidDataOnCreate(): iterable
             Response::HTTP_UNPROCESSABLE_ENTITY,
             [
                 '@type' => 'ConstraintViolationList',
-                'hydra:title' => 'An error occurred',
+                'title' => 'An error occurred',
                 'violations' => [
                     [
                         'propertyPath' => 'book',
@@ -316,8 +316,8 @@ public static function getInvalidData(): iterable
             Response::HTTP_UNPROCESSABLE_ENTITY,
             [
                 '@type' => 'ConstraintViolationList',
-                'hydra:title' => 'An error occurred',
-                'hydra:description' => 'condition: This value should be of type ' . BookCondition::class . '.',
+                'title' => 'An error occurred',
+                'description' => 'condition: This value should be of type ' . BookCondition::class . '.',
                 'violations' => [
                     [
                         'propertyPath' => 'condition',
@@ -334,8 +334,8 @@ public static function getInvalidData(): iterable
             Response::HTTP_UNPROCESSABLE_ENTITY,
             [
                 '@type' => 'ConstraintViolationList',
-                'hydra:title' => 'An error occurred',
-                'hydra:description' => 'condition: This value should be of type ' . BookCondition::class . '.',
+                'title' => 'An error occurred',
+                'description' => 'condition: This value should be of type ' . BookCondition::class . '.',
                 'violations' => [
                     [
                         'propertyPath' => 'condition',
@@ -352,7 +352,7 @@ public static function getInvalidData(): iterable
             Response::HTTP_UNPROCESSABLE_ENTITY,
             [
                 '@type' => 'ConstraintViolationList',
-                'hydra:title' => 'An error occurred',
+                'title' => 'An error occurred',
                 'violations' => [
                     [
                         'propertyPath' => 'book',
@@ -442,9 +442,9 @@ public function asNonAdminUserICannotUpdateBook(int $expectedCode, string $hydra
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -570,9 +570,9 @@ public function asNonAdminUserICannotDeleteABook(int $expectedCode, string $hydr
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 

diff --git a/api/tests/Api/Admin/ReviewTest.php b/api/tests/Api/Admin/ReviewTest.php
@@ -55,9 +55,9 @@ public function asNonAdminUserICannotGetACollectionOfReviews(int $expectedCode,
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -163,9 +163,9 @@ public function asNonAdminUserICannotGetAReview(int $expectedCode, string $hydra
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -227,9 +227,9 @@ public function asNonAdminUserICannotUpdateAReview(int $expectedCode, string $hy
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }
 
@@ -334,9 +334,9 @@ public function asNonAdminUserICannotDeleteAReview(int $expectedCode, string $hy
         self::assertResponseHeaderSame('content-type', 'application/problem+json; charset=utf-8');
         self::assertResponseHeaderSame('link', '<http://www.w3.org/ns/hydra/error>; rel="http://www.w3.org/ns/json-ld#error",<http://localhost/docs.jsonld>; rel="http://www.w3.org/ns/hydra/core#apiDocumentation"');
         self::assertJsonContains([
-            '@type' => 'hydra:Error',
-            'hydra:title' => 'An error occurred',
-            'hydra:description' => $hydraDescription,
+            '@type' => 'Error',
+            'title' => 'An error occurred',
+            'description' => $hydraDescription,
         ]);
     }