Feat/url generator (#161)

* CS fixes

* Implement configurable url generator for uploadable fields

* Run ci on all branches except v1

* Fix version checker test

* Test break with http-client 6.2.5. Added conflict to use 6.2.2

* Initial services to provide public and temporary urls

* Introduce constructor arguments that a user can overwrite to provide configuration for the new url generators

Author: silverbackdan

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: CI
 on:
   push:
     branches:
-      - main
+      - '!v1'
   pull_request:
     branches-ignore:
       - v1

composer.json

@@ -142,6 +142,7 @@
         "symfony/web-link": "<=6.0",
         "doctrine/collections": "<1.7",
         "doctrine/orm": "<2.13",
-        "api-platform/core": "3.1.0"
+        "api-platform/core": "3.1.0",
+        "symfony/http-client": "6.2.5"
     }
 }

features/bootstrap/ProfilerContext.php

@@ -169,7 +169,7 @@ public function theResourceShouldBePurgedFromTheCache(string $resourceName)
         /** @var HttpClientDataCollector $collector */
         $collector = $this->getProfile()->getCollector('http_client');
         $purged = [];
-        foreach ($collector->getClients() as $clientName => $clientInfo) {
+        foreach ($collector->getClients() as $clientInfo) {
             foreach ($clientInfo['traces'] as $trace) {
                 /** @var Data $data */
                 $data = $trace['options']->getValue()['normalized_headers'];

features/main/current_version.feature

@@ -8,7 +8,7 @@ Feature: In order to detect the current API Components Bundle Version
     And I add "Content-Type" header equal to "<header>"
     When I send a "GET" request to "/docs.<ext>"
     Then the response status code should be 200
-    And the JSON node "info.version" should match the regex '/^1\.0\.0 \((?:dev-main|1\.0\.0\+no\-version\-set)@(?:[a-zA-Z0-9]+)?\)$/'
+    And the JSON node "info.version" should match the regex '/^1\.0\.0 \((?:dev-[a-zA-Z0-9]+|1\.0\.0\+no\-version\-set)@(?:[a-zA-Z0-9]+)?\)$/'
     Examples:
       | header              | ext    |
       | application/json    | json   |

src/Annotation/UploadableField.php

@@ -19,22 +19,15 @@
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
 final class UploadableField
 {
-    public string $property;
-
-    public ?string $prefix;
-
-    public ?array $imagineFilters;
-
     // Nice to have - feature to configure the IRI in the output media objects for this field
     // public string $iri = 'http://schema.org/MediaObject';
 
-    public ?string $adapter;
-
-    public function __construct(string $adapter, string $property = 'filename', ?string $prefix = null, ?array $imagineFilters = [])
-    {
-        $this->property = $property;
-        $this->prefix = $prefix;
-        $this->imagineFilters = $imagineFilters;
-        $this->adapter = $adapter;
+    public function __construct(
+        public string $adapter,
+        public string $urlGenerator = 'api',
+        public string $property = 'filename',
+        public ?string $prefix = null,
+        public ?array $imagineFilters = []
+    ) {
     }
 }

src/Factory/Uploadable/ApiUrlGenerator.php

@@ -1,19 +1,34 @@
 <?php
 
+/*
+ * This file is part of the Silverback API Components Bundle Project
+ *
+ * (c) Daniel West <daniel@silverback.is>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
 namespace Silverback\ApiComponentsBundle\Factory\Uploadable;
 
 use ApiPlatform\Api\IriConverterInterface;
+use League\Flysystem\Filesystem;
 use Symfony\Component\HttpFoundation\UrlHelper;
 use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
 
-class ApiUrlGenerator implements UploadableUrlGenerator
+class ApiUrlGenerator implements UploadableUrlGeneratorInterface
 {
     public function __construct(private readonly IriConverterInterface $iriConverter, private readonly UrlHelper $urlHelper)
-    {}
+    {
+    }
 
-    public function generateUrl(object $object, string $fileProperty): string {
+    public function generateUrl(object $object, string $fileProperty, Filesystem $filesystem, string $path): string
+    {
         $resourceId = $this->iriConverter->getIriFromResource($object);
         $converter = new CamelCaseToSnakeCaseNameConverter();
+
         return $this->urlHelper->getAbsoluteUrl(sprintf('%s/download/%s', $resourceId, $converter->normalize($fileProperty)));
     }
 }

src/Factory/Uploadable/MediaObjectFactory.php

@@ -22,11 +22,13 @@
 use Silverback\ApiComponentsBundle\AttributeReader\UploadableAttributeReader;
 use Silverback\ApiComponentsBundle\Entity\Core\FileInfo;
 use Silverback\ApiComponentsBundle\Entity\Utility\ImagineFiltersInterface;
+use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
 use Silverback\ApiComponentsBundle\Flysystem\FilesystemProvider;
 use Silverback\ApiComponentsBundle\Helper\Uploadable\FileInfoCacheManager;
 use Silverback\ApiComponentsBundle\Imagine\FlysystemDataLoader;
 use Silverback\ApiComponentsBundle\Model\Uploadable\MediaObject;
 use Silverback\ApiComponentsBundle\Utility\ClassMetadataTrait;
+use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
@@ -43,9 +45,9 @@ public function __construct(
         private readonly FilesystemProvider $filesystemProvider,
         private readonly FlysystemDataLoader $flysystemDataLoader,
         private readonly RequestStack $requestStack,
-        private readonly ApiUrlGenerator $urlGenerator,
-        private readonly ?FilterService $filterService = null)
-    {
+        private readonly ServiceLocator $urlGenerators,
+        private readonly ?FilterService $filterService = null
+    ) {
         $this->initRegistry($managerRegistry);
     }
 
@@ -69,13 +71,15 @@ public function createMediaObjects(object $object): ?ArrayCollection
             }
 
             // todo: the content URL perhaps will just be a public URL from the source/CDN instead of via this API download action
-//            if ($filesystem instanceof PublicUrlGenerator) {
-//                // $filesystem->publicUrl();
-//            }
 //            if ($filesystem instanceof TemporaryUrlGenerator) {
 //                // $filesystem->temporaryUrl();
 //            }
-            $contentUrl = $this->urlGenerator->generateUrl($object, $fileProperty);
+
+            $urlGenerator = $this->urlGenerators->get($fieldConfiguration->urlGenerator);
+            if (!$urlGenerator instanceof UploadableUrlGeneratorInterface) {
+                throw new InvalidArgumentException(sprintf('The url generator provided must implement %s', UploadableUrlGeneratorInterface::class));
+            }
+            $contentUrl = $urlGenerator->generateUrl($object, $fileProperty, $filesystem, $path);
 
             // Populate the primary MediaObject
             try {

src/Factory/Uploadable/PublicUrlGenerator.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Silverback API Components Bundle Project
+ *
+ * (c) Daniel West <daniel@silverback.is>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Silverback\ApiComponentsBundle\Factory\Uploadable;
+
+use League\Flysystem\Config;
+use League\Flysystem\Filesystem;
+use League\Flysystem\UrlGeneration\PublicUrlGenerator as FlysystemPublicUrlGenerator;
+use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
+
+class PublicUrlGenerator implements UploadableUrlGeneratorInterface
+{
+    public function __construct(private readonly array $config = [])
+    {
+    }
+
+    public function generateUrl(object $object, string $fileProperty, Filesystem $filesystem, string $path): string
+    {
+        if (!$filesystem instanceof FlysystemPublicUrlGenerator) {
+            throw new InvalidArgumentException(sprintf('The public URL generator requires a filesystem implementing %s', FlysystemPublicUrlGenerator::class));
+        }
+
+        return $filesystem->publicUrl($path, new Config($this->config));
+    }
+}

src/Factory/Uploadable/TemporaryUrlGenerator.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Silverback API Components Bundle Project
+ *
+ * (c) Daniel West <daniel@silverback.is>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Silverback\ApiComponentsBundle\Factory\Uploadable;
+
+use League\Flysystem\Config;
+use League\Flysystem\Filesystem;
+use League\Flysystem\UrlGeneration\TemporaryUrlGenerator as FlysystemTemporaryUrlGenerator;
+use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
+
+class TemporaryUrlGenerator implements UploadableUrlGeneratorInterface
+{
+    public function __construct(private readonly array $config = [], private readonly string $expires = '+3 days')
+    {
+    }
+
+    public function generateUrl(object $object, string $fileProperty, Filesystem $filesystem, string $path): string
+    {
+        if (!$filesystem instanceof FlysystemTemporaryUrlGenerator) {
+            throw new InvalidArgumentException(sprintf('The public URL generator requires a filesystem implementing %s', FlysystemTemporaryUrlGenerator::class));
+        }
+
+        return $filesystem->temporaryUrl($path, new \DateTime($this->expires), new Config($this->config));
+    }
+}