fix(hydra): store and use hydra context as static asset

api-platform · Oct 30, 2024 · 97db06a · 97db06a
1 parent 001d771
commit 97db06a
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 8 deletions.
diff --git a/features/hydra/docs.feature b/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 JSON node "@context[0]" should be equal to "/bundles/apiplatform/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#"

diff --git a/src/Hydra/Serializer/DocumentationNormalizer.php b/src/Hydra/Serializer/DocumentationNormalizer.php
@@ -573,7 +573,7 @@ private function computeDoc(Documentation $object, array $classes, string $hydra
     private function getContext(string $hydraPrefix = ContextBuilder::HYDRA_PREFIX): array
     {
         return [
-            ContextBuilderInterface::HYDRA_CONTEXT,
+            '/bundles/apiplatform/hydra/context.jsonld',
             [
                 '@vocab' => $this->urlGenerator->generate('api_doc', ['_format' => self::FORMAT], UrlGeneratorInterface::ABS_URL).'#',
                 'hydra' => ContextBuilderInterface::HYDRA_NS,

diff --git a/src/Hydra/Tests/Serializer/DocumentationNormalizerTest.php b/src/Hydra/Tests/Serializer/DocumentationNormalizerTest.php
@@ -106,7 +106,7 @@ private function doTestNormalize($resourceMetadataFactory = null): void
 
         $expected = [
             '@context' => [
-                'http://www.w3.org/ns/hydra/context.jsonld',
+                '/bundles/apiplatform/hydra/context.jsonld',
                 [
                     '@vocab' => '/doc#',
                     'hydra' => 'http://www.w3.org/ns/hydra/core#',
@@ -406,7 +406,7 @@ public function testNormalizeInputOutputClass(): void
 
         $expected = [
             '@context' => [
-                'http://www.w3.org/ns/hydra/context.jsonld',
+                '/bundles/apiplatform/hydra/context.jsonld',
                 [
                     '@vocab' => '/doc#',
                     'hydra' => 'http://www.w3.org/ns/hydra/core#',
@@ -766,7 +766,7 @@ public function testNormalizeWithoutPrefix(): void
 
         $expected = [
             '@context' => [
-                'http://www.w3.org/ns/hydra/context.jsonld',
+                '/bundles/apiplatform/hydra/context.jsonld',
                 [
                     '@vocab' => '/doc#',
                     'hydra' => 'http://www.w3.org/ns/hydra/core#',

diff --git a/src/JsonLd/ContextBuilder.php b/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 ['/bundles/apiplatform/hydra/context.jsonld', $context];
         }
 
         return $context;

diff --git a/src/JsonLd/ContextBuilderInterface.php b/src/JsonLd/ContextBuilderInterface.php
@@ -23,7 +23,6 @@
  */
 interface ContextBuilderInterface
 {
-    public const HYDRA_CONTEXT = 'http://www.w3.org/ns/hydra/context.jsonld';
     public const HYDRA_NS = 'http://www.w3.org/ns/hydra/core#';
     public const JSONLD_NS = 'http://www.w3.org/ns/json-ld#';
     public const RDF_NS = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#';

diff --git a/tests/JsonLd/ContextBuilderTest.php b/tests/JsonLd/ContextBuilderTest.php
@@ -291,7 +291,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',
+            '/bundles/apiplatform/hydra/context.jsonld',
             [
                 '@vocab' => '#',
                 'hydra' => 'http://www.w3.org/ns/hydra/core#',

diff --git a/update-js.sh b/update-js.sh
@@ -94,5 +94,12 @@ fi
 mkdir -p "$dest"
 cp node_modules/redoc/bundles/redoc.standalone.js "$dest"
 
+dest=src/Symfony/Bundle/Resources/public/hydra/
+if [[ -d "$dest" ]]; then
+rm -Rf "$dest"
+fi
+mkdir -p "$dest"
+curl -L -A "Mozilla/5.0" -o "${dest}context.jsonld" http://www.w3.org/ns/hydra/context.jsonld
+
 rm -Rf package.json node_modules/
 # TODO Laravel public files