Merge pull request #36 from bookboon/hotfix/type-safe-api

fix: MappingApi and safe type the config
bookboon · Jun 23, 2022 · 07a375a · 07a375a
2 parents 027e6e1 + 902b107
commit 07a375a
Show file tree

Hide file tree

Showing 8 changed files with 142 additions and 58 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -20,7 +20,27 @@ public function getConfigTreeBuilder()
             ->getRootNode()
             ->children()
             ->scalarNode('default_class_namespace')->setDeprecated()->end()
-            ->arrayNode('apis')->normalizeKeys(false)->scalarPrototype()->end()->end()
+            ->arrayNode('apis')
+                ->beforeNormalization()
+                    ->ifArray()
+                    ->then(static function ($v) {
+                        $outArray = [];
+                        foreach ($v as $namespace => $uri) {
+                            $outArray[] = isset($uri['uri']) ? $uri : [
+                                'namespace' => $namespace,
+                                'uri' => $uri
+                            ];
+                        }
+                        return $outArray;
+                    })
+                ->end()
+                ->arrayPrototype()
+                    ->children()
+                        ->scalarNode('namespace')->end()
+                        ->scalarNode('uri')->end()
+                    ->end()
+                ->end()
+            ->end()
             ->arrayNode('mappings')->setDeprecated()
                 ->beforeNormalization()
                     ->ifArray()

diff --git a/Helpers/LinkParser.php b/Helpers/LinkParser.php
@@ -59,7 +59,11 @@ protected function getParameters(string $content) : array
         $parameters = [ApiIterable::LIMIT, ApiIterable::OFFSET];
 
         $parsedUrl = parse_url($content, PHP_URL_QUERY);
-        parse_str($parsedUrl, $queryParams);
+        $queryParams = [];
+
+        if (is_string($parsedUrl)) {
+            parse_str($parsedUrl, $queryParams);
+        }
 
         foreach ($parameters as $param) {
             if (array_key_exists($param, $queryParams)) {

diff --git a/Mapping/MappingApi.php b/Mapping/MappingApi.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Bookboon\JsonLDClient\Mapping;
+
+class MappingApi
+{
+    protected string $namespace;
+    protected string $uri;
+
+    public function __construct($namespace, $uri)
+    {
+        $this->namespace = $namespace;
+        $this->uri = $uri;
+    }
+
+    public function getNamespace(): string
+    {
+        return $this->namespace;
+    }
+
+    public function setNamespace(string $namespace): void
+    {
+        $this->namespace = $namespace;
+    }
+
+    public function getUri(): string
+    {
+        return $this->uri;
+    }
+
+    public function setUri(string $uri): void
+    {
+        $this->uri = $uri;
+    }
+
+
+}
diff --git a/Mapping/MappingCollection.php b/Mapping/MappingCollection.php
@@ -10,15 +10,17 @@
 class MappingCollection
 {
     protected const CACHE_PREFIX = 'api-mapping-';
+
     /** @var array<MappingEndpoint> */
     protected array $mappings;
-    /** @var array<string,string> */
+
+    /** @var array<MappingApi> */
     private array $apis;
     private ?CacheInterface $cache;
 
     /**
-     * @param array $mappings
-     * @param array<string,string> $apis
+     * @param array<MappingEndpoint> $mappings
+     * @param array<MappingApi> $apis
      * @throws MappingException
      */
     public function __construct(array $mappings, array $apis, CacheInterface $cache = null)
@@ -37,6 +39,7 @@ public function __construct(array $mappings, array $apis, CacheInterface $cache
     public static function create(array $mappings, array $apis): MappingCollection
     {
         $endpoints = [];
+        $apiObjects = [];
 
         foreach ($mappings as $map) {
             if (!isset($map['uri'], $map['type'])) {
@@ -55,7 +58,15 @@ public static function create(array $mappings, array $apis): MappingCollection
             );
         }
 
-        return new self($endpoints, $apis);
+        foreach ($apis as $api) {
+            if (!isset($api['uri'], $api['namespace'])) {
+                throw new MappingException('Invalid apis config');
+            }
+
+            $apiObjects[] = new MappingApi($api['namespace'], $api['uri']);
+        }
+
+        return new self($endpoints, $apiObjects);
     }
 
     /**
@@ -162,9 +173,9 @@ protected function getEndpointProperties(string $className): array {
     }
 
     protected function findApiForClass(string $classname): string {
-        foreach ($this->apis as $namespace => $apiUrl) {
-            if (str_starts_with($classname, $namespace)) {
-                return $apiUrl;
+        foreach ($this->apis as $api) {
+            if (str_starts_with($classname, $api->getNamespace())) {
+                return $api->getUri();
             }
         }
 

diff --git a/Tests/Client/JsonLdClientTest.php b/Tests/Client/JsonLdClientTest.php
@@ -7,6 +7,7 @@
 use Bookboon\JsonLDClient\Client\JsonLDNotFoundException;
 use Bookboon\JsonLDClient\Client\JsonLDResponseException;
 use Bookboon\JsonLDClient\Client\JsonLDSerializationException;
+use Bookboon\JsonLDClient\Mapping\MappingApi;
 use Bookboon\JsonLDClient\Mapping\MappingCollection;
 use Bookboon\JsonLDClient\Mapping\MappingEndpoint;
 use Bookboon\JsonLDClient\Models\ApiIterable;
@@ -521,7 +522,7 @@ protected function getClientForResponses(array $responses, CacheInterface $cache
             new MappingEndpoint(NestedClass::class, 'http://otherhost/nested', [], true)
         ];
         $apis = [
-            'Bookboon\JsonLDClient\Tests\Fixtures\Models' => 'https://example.com/api/v1'
+            new MappingApi('Bookboon\JsonLDClient\Tests\Fixtures\Models', 'https://example.com/api/v1')
         ];
 
         return new JsonLDClient(

diff --git a/Tests/Fixtures/SerializerHelper.php b/Tests/Fixtures/SerializerHelper.php
@@ -4,7 +4,9 @@
 namespace Bookboon\JsonLDClient\Tests\Fixtures;
 
 
+use Bookboon\JsonLDClient\Mapping\MappingApi;
 use Bookboon\JsonLDClient\Mapping\MappingCollection;
+use Bookboon\JsonLDClient\Mapping\MappingEndpoint;
 use Bookboon\JsonLDClient\Serializer\JsonLDEncoder;
 use Bookboon\JsonLDClient\Serializer\JsonLDMapNormalizer;
 use Bookboon\JsonLDClient\Serializer\JsonLDNormalizer;
@@ -15,14 +17,19 @@
 use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
 use Symfony\Component\Serializer\Encoder\JsonDecode;
-use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
-use Symfony\Component\Serializer\Normalizer\UnwrappingDenormalizer;
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Serializer\SerializerInterface;
 
 class SerializerHelper
 {
+    /**
+     * @param array<MappingEndpoint> $mappings
+     * @param array $defaultContext
+     * @param array<MappingApi> $apiRoot
+     * @return SerializerInterface
+     * @throws \Bookboon\JsonLDClient\Mapping\MappingException
+     */
     public static function create(array $mappings = [], array $defaultContext = [], array $apiRoot = []) : SerializerInterface
     {
         $docblockExtractor = new PhpDocExtractor();

diff --git a/Tests/Mapping/MappingCollectionTest.php b/Tests/Mapping/MappingCollectionTest.php
@@ -75,17 +75,20 @@ public function testMissingPart() : void
                 [
                     'type' => 'OtherApp\Test'
                 ]
-            ],[]
+            ],
+            []
         );
     }
 
     public function testInvalidConstructor() : void
     {
         $this->expectException(MappingException::class);
+        /** @psalm-suppress InvalidArgument */
         $collection = new MappingCollection(
             [
                 new SimpleClass()
-            ],[]
+            ],
+            []
         );
     }