fix(hydra): store and use hydra context in a local variable (#6765)

Co-authored-by: Kévin Dunglas <kevin@dunglas.fr>
Co-authored-by: soyuka <soyuka@users.noreply.github.com>

Author: 3 people

composer.json

@@ -9,7 +9,10 @@
     "autoload": {
         "psr-4": {
             "ApiPlatform\\": "src/"
-        }
+        },
+        "files": [
+            "src/JsonLd/HydraContext.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

features/hydra/docs.feature

@@ -13,7 +13,7 @@ Feature: Documentation support
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
     # Context
-    And the JSON node "@context[0]" should be equal to "http://www.w3.org/ns/hydra/context.jsonld"
+    And the Hydra context matches the online resource "http://www.w3.org/ns/hydra/context.jsonld"
     And the JSON node "@context[1].@vocab" should be equal to "http://example.com/docs.jsonld#"
     And the JSON node "@context[1].hydra" should be equal to "http://www.w3.org/ns/hydra/core#"
     And the JSON node "@context[1].rdf" should be equal to "http://www.w3.org/1999/02/22-rdf-syntax-ns#"

src/Hydra/Serializer/DocumentationNormalizer.php

@@ -35,6 +35,8 @@
 use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
+use const ApiPlatform\JsonLd\HYDRA_CONTEXT;
+
 /**
  * Creates a machine readable Hydra API documentation.
  *
@@ -573,7 +575,7 @@ private function computeDoc(Documentation $object, array $classes, string $hydra
     private function getContext(string $hydraPrefix = ContextBuilder::HYDRA_PREFIX): array
     {
         return [
-            ContextBuilderInterface::HYDRA_CONTEXT,
+            HYDRA_CONTEXT,
             [
                 '@vocab' => $this->urlGenerator->generate('api_doc', ['_format' => self::FORMAT], UrlGeneratorInterface::ABS_URL).'#',
                 'hydra' => ContextBuilderInterface::HYDRA_NS,

src/Hydra/Tests/Serializer/DocumentationNormalizerTest.php

@@ -37,6 +37,8 @@
 use Prophecy\PhpUnit\ProphecyTrait;
 use Symfony\Component\PropertyInfo\Type;
 
+use const ApiPlatform\JsonLd\HYDRA_CONTEXT;
+
 /**
  * @author Amrouche Hamza <hamza.simperfit@gmail.com>
  */
@@ -106,7 +108,7 @@ private function doTestNormalize($resourceMetadataFactory = null): void
 
         $expected = [
             '@context' => [
-                'http://www.w3.org/ns/hydra/context.jsonld',
+                HYDRA_CONTEXT,
                 [
                     '@vocab' => '/doc#',
                     'hydra' => 'http://www.w3.org/ns/hydra/core#',
@@ -406,7 +408,7 @@ public function testNormalizeInputOutputClass(): void
 
         $expected = [
             '@context' => [
-                'http://www.w3.org/ns/hydra/context.jsonld',
+                HYDRA_CONTEXT,
                 [
                     '@vocab' => '/doc#',
                     'hydra' => 'http://www.w3.org/ns/hydra/core#',
@@ -766,7 +768,7 @@ public function testNormalizeWithoutPrefix(): void
 
         $expected = [
             '@context' => [
-                'http://www.w3.org/ns/hydra/context.jsonld',
+                HYDRA_CONTEXT,
                 [
                     '@vocab' => '/doc#',
                     'hydra' => 'http://www.w3.org/ns/hydra/core#',

src/JsonLd/ContextBuilder.php

@@ -185,7 +185,7 @@ private function getResourceContextWithShortname(string $resourceClass, int $ref
         }
 
         if (false === ($this->defaultContext[self::HYDRA_CONTEXT_HAS_PREFIX] ?? true)) {
-            return [ContextBuilderInterface::HYDRA_CONTEXT, $context];
+            return [HYDRA_CONTEXT, $context];
         }
 
         return $context;

src/JsonLd/HydraContext.php

@@ -32,6 +32,9 @@
         "psr-4": {
             "ApiPlatform\\JsonLd\\": ""
         },
+        "files": [
+            "./HydraContext.php"
+        ],
         "exclude-from-classmap": [
             "/Tests/"
         ]

src/JsonLd/composer.json

@@ -301,4 +301,26 @@ private function getLastJsonResponse(): \stdClass
 
         return $decoded;
     }
+
+    /**
+     * @Then the Hydra context matches the online resource :url
+     */
+    public function assertHydraContextIsCorrect(string $url): void
+    {
+        $opts = [
+            'http' => [
+                'method' => 'GET',
+                'header' => "User-Agent: Mozilla/5.0\r\n",
+            ],
+        ];
+
+        $context = stream_context_create($opts);
+        $upstream = json_decode(file_get_contents($url, false, $context));
+        $actual = $this->getLastJsonResponse();
+        $local = $actual->{'@context'}[0];
+        Assert::assertEquals(
+            $upstream,
+            $local
+        );
+    }
 }

tests/Behat/HydraContext.php

@@ -35,6 +35,8 @@
 use Prophecy\Prophecy\ObjectProphecy;
 use Symfony\Component\PropertyInfo\Type;
 
+use const ApiPlatform\JsonLd\HYDRA_CONTEXT;
+
 /**
  * @author Markus Mächler <markus.maechler@bithost.ch>
  */
@@ -291,7 +293,7 @@ public function testResourceContextWithoutHydraPrefix(): void
         $contextBuilder = new ContextBuilder($this->resourceNameCollectionFactoryProphecy->reveal(), $this->resourceMetadataCollectionFactoryProphecy->reveal(), $this->propertyNameCollectionFactoryProphecy->reveal(), $this->propertyMetadataFactoryProphecy->reveal(), $this->urlGeneratorProphecy->reveal(), null, null, [ContextBuilder::HYDRA_CONTEXT_HAS_PREFIX => false]);
 
         $expected = [
-            'http://www.w3.org/ns/hydra/context.jsonld',
+            HYDRA_CONTEXT,
             [
                 '@vocab' => '#',
                 'hydra' => 'http://www.w3.org/ns/hydra/core#',

tests/JsonLd/ContextBuilderTest.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+$opts = [
+    'http' => [
+        'method' => 'GET',
+        'header' => "User-Agent: Mozilla/5.0\r\n",
+    ],
+];
+
+$context = stream_context_create($opts);
+$hydraContext = json_decode(file_get_contents('http://www.w3.org/ns/hydra/context.jsonld', false, $context), true);
+file_put_contents('src/JsonLd/HydraContext.php', '<?php
+declare(strict_types=1);
+
+namespace ApiPlatform\JsonLd;
+
+/*
+ * This is an autogenerated file, DO NOT MODIFY IT.
+ * Run the update-hydra-context.php script at the root of the project to refresh it.
+ */
+const HYDRA_CONTEXT = '.var_export($hydraContext, true).';');