Merge branch 2.7 into 3.0

Author: soyuka

.github/workflows/ci.yml

@@ -22,9 +22,9 @@ jobs:
       - name: Run commitlint
         run: | 
             commit=$(gh api \
-              -H "Accept: application/vnd.github+json" \
               /repos/${{ github.repository }}/pulls/${{github.event.number}}/commits \
-              | jq -r '.[0].commit.message')
+              | jq -r '.[0].commit.message' \
+              | head -n 1)
             # we can't use npx see https://github.com/conventional-changelog/commitlint/issues/613
             echo '{}' > package.json
             npm install --no-fund --no-audit @commitlint/config-conventional @commitlint/cli

features/jsonld/non_resource.feature

@@ -38,6 +38,7 @@ Feature: JSON-LD non-resource handling
       }
     }
     """
+    And the JSON node "notAResource.@id" should not exist
 
   Scenario: Get a resource containing a raw object with selected properties
     Given there are 1 dummy objects with relatedDummy and its thirdLevel
@@ -123,3 +124,11 @@ Feature: JSON-LD non-resource handling
       "id": 1
     }
     """
+
+  @php8
+  Scenario: Get a generated id
+    When I send a "GET" request to "/genids/1"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON node "totalPrice.@id" should exist

src/GraphQl/Serializer/ItemNormalizer.php

@@ -59,6 +59,8 @@ public function supportsNormalization(mixed $data, string $format = null, array
     /**
      * {@inheritdoc}
      *
+     * @param array<string, mixed> $context
+     *
      * @throws UnexpectedValueException
      */
     public function normalize(mixed $object, string $format = null, array $context = []): array|string|int|float|bool|\ArrayObject|null

src/Hydra/Serializer/CollectionNormalizer.php

@@ -68,6 +68,7 @@ public function normalize(mixed $object, string $format = null, array $context =
     {
         $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
         $context = $this->initContext($resourceClass, $context);
+        $context['api_collection_sub_level'] = true;
         $data = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
         $data['@id'] = $this->iriConverter->getIriFromResource($resourceClass, UrlGeneratorInterface::ABS_PATH, $context['operation'] ?? null, $context);
         $data['@type'] = 'hydra:Collection';

src/JsonLd/ContextBuilder.php

@@ -15,7 +15,6 @@
 
 use ApiPlatform\Api\IriConverterInterface;
 use ApiPlatform\Api\UrlGeneratorInterface;
-use ApiPlatform\Exception\RuntimeException;
 use ApiPlatform\Metadata\Get;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
@@ -123,12 +122,10 @@ public function getAnonymousResourceContext(object $object, array $context = [],
             '@type' => $shortName,
         ];
 
-        if (!isset($context['iri']) || false !== $context['iri']) {
-            if (!isset($context['iri']) && !$this->iriConverter) {
-                throw new RuntimeException('Can not guess an anonymous resource IRI without IRI Converter.');
-            }
-
-            $jsonLdContext['@id'] = $context['iri'] ?? $this->iriConverter->getIriFromResource($object);
+        if (isset($context['iri'])) {
+            $jsonLdContext['@id'] = $context['iri'];
+        } elseif (true === ($context['gen_id'] ?? true) && $this->iriConverter) {
+            $jsonLdContext['@id'] = $this->iriConverter->getIriFromResource($object);
         }
 
         if ($context['has_context'] ?? false) {

src/JsonLd/Serializer/ItemNormalizer.php

@@ -79,6 +79,12 @@ public function normalize(mixed $object, string $format = null, array $context =
             $context = $this->initContext($resourceClass, $context);
             $metadata = $this->addJsonLdContext($this->contextBuilder, $resourceClass, $context);
         } elseif ($this->contextBuilder instanceof AnonymousContextBuilderInterface) {
+            if ($context['api_collection_sub_level'] ?? false) {
+                unset($context['api_collection_sub_level']);
+                $context['output']['genid'] = true;
+                $context['output']['iri'] = null;
+            }
+
             // We should improve what's behind the context creation, its probably more complicated then it should
             $metadata = $this->createJsonLdContext($this->contextBuilder, $object, $context);
         }

src/JsonLd/Serializer/JsonLdContextTrait.php

@@ -51,11 +51,11 @@ private function createJsonLdContext(AnonymousContextBuilderInterface $contextBu
     {
         // We're in a collection, don't add the @context part
         if (isset($context['jsonld_has_context'])) {
-            return $contextBuilder->getAnonymousResourceContext($object, ['api_resource' => $context['api_resource'] ?? null, 'has_context' => true]);
+            return $contextBuilder->getAnonymousResourceContext($object, ($context['output'] ?? []) + ['api_resource' => $context['api_resource'] ?? null, 'has_context' => true]);
         }
 
         $context['jsonld_has_context'] = true;
 
-        return $contextBuilder->getAnonymousResourceContext($object, ['api_resource' => $context['api_resource'] ?? null]);
+        return $contextBuilder->getAnonymousResourceContext($object, ($context['output'] ?? []) + ['api_resource' => $context['api_resource'] ?? null]);
     }
 }

src/JsonLd/Serializer/ObjectNormalizer.php

@@ -14,7 +14,6 @@
 namespace ApiPlatform\JsonLd\Serializer;
 
 use ApiPlatform\Api\IriConverterInterface;
-use ApiPlatform\Exception\InvalidArgumentException;
 use ApiPlatform\JsonLd\AnonymousContextBuilderInterface;
 use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
@@ -74,11 +73,6 @@ public function normalize(mixed $object, string $format = null, array $context =
         }
 
         if (isset($originalResource)) {
-            try {
-                $context['output']['iri'] = $this->iriConverter->getIriFromResource($originalResource);
-            } catch (InvalidArgumentException) {
-                // The original resource has no identifiers
-            }
             $context['api_resource'] = $originalResource;
         }
 

src/Metadata/ApiProperty.php

@@ -68,6 +68,7 @@ public function __construct(
         private ?array $schema = null,
         private ?bool $initializable = null,
         private $iris = null,
+        private ?bool $genId = null,
         private array $extraProperties = []
     ) {
         if (\is_string($types)) {
@@ -403,4 +404,20 @@ public function withIris(string|array $iris): self
 
         return $metadata;
     }
+
+    /**
+     * Whether to generate a skolem iri on anonymous resources.
+     */
+    public function getGenId()
+    {
+        return $this->genId;
+    }
+
+    public function withGenId(bool $genId): self
+    {
+        $metadata = clone $this;
+        $metadata->genId = $genId;
+
+        return $metadata;
+    }
 }

src/Metadata/Extractor/XmlPropertyExtractor.php

@@ -71,6 +71,7 @@ protected function extractPath(string $path): void
                 'initializable' => $this->phpize($property, 'initializable', 'bool'),
                 'extraProperties' => $this->buildExtraProperties($property, 'extraProperties'),
                 'iris' => $this->buildArrayValue($property, 'iri'),
+                'genId' => $this->phpize($property, 'genId', 'bool'),
             ];
         }
     }