Add Controller to get asyncUpload signatures

Added new files for handling asynchronous file uploads in ChillDocStoreBundle. The new files include a controller for generating temporary URLs (AsyncUploadController.php), a security authorization file (AsyncUploadVoter.php), and a corresponding test file (AsyncUploadControllerTest.php). These implementations permit asynchronous uploads via POST, GET, and HEAD methods while maintaining security protocols.

src/Bundle/ChillDocStoreBundle/Controller/AsyncUploadController.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Controller;
+
+use Chill\DocStoreBundle\AsyncUpload\Exception\TempUrlGeneratorException;
+use Chill\DocStoreBundle\AsyncUpload\TempUrlGeneratorInterface;
+use Chill\DocStoreBundle\Security\Authorization\AsyncUploadVoter;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
+use Symfony\Component\Serializer\SerializerInterface;
+
+final readonly class AsyncUploadController
+{
+    public function __construct(
+        private TempUrlGeneratorInterface $tempUrlGenerator,
+        private SerializerInterface $serializer,
+        private Security $security,
+        private LoggerInterface $logger,
+    ) {}
+
+    /**
+     * @Route("/asyncupload/temp_url/generate/{method}",
+     *       name="async_upload.generate_url")
+     */
+    public function getSignedUrl(string $method, Request $request): JsonResponse
+    {
+        try {
+            switch (strtolower($method)) {
+                case 'post':
+                    $p = $this->tempUrlGenerator
+                        ->generatePost(
+                            $request->query->has('expires_delay') ? $request->query->getInt('expires_delay') : null,
+                            $request->query->has('submit_delay') ? $request->query->getInt('submit_delay') : null
+                        )
+                    ;
+                    break;
+                case 'get':
+                case 'head':
+                    $object_name = $request->query->get('object_name', null);
+
+                    if (null === $object_name) {
+                        return (new JsonResponse((object) [
+                            'message' => 'the object_name is null',
+                        ]))
+                            ->setStatusCode(JsonResponse::HTTP_BAD_REQUEST);
+                    }
+                    $p = $this->tempUrlGenerator->generate(
+                        $method,
+                        $object_name,
+                        $request->query->has('expires_delay') ? $request->query->getInt('expires_delay') : null
+                    );
+                    break;
+                default:
+                    return (new JsonResponse((object) ['message' => 'the method '
+                        ."{$method} is not valid"]))
+                        ->setStatusCode(JsonResponse::HTTP_BAD_REQUEST);
+            }
+        } catch (TempUrlGeneratorException $e) {
+            $this->logger->warning('The client requested a temp url'
+                .' which sparkle an error.', [
+                    'message' => $e->getMessage(),
+                    'expire_delay' => $request->query->getInt('expire_delay', 0),
+                    'file_count' => $request->query->getInt('file_count', 1),
+                    'method' => $method,
+                ]);
+
+            $p = new \stdClass();
+            $p->message = $e->getMessage();
+            $p->status = JsonResponse::HTTP_BAD_REQUEST;
+
+            return new JsonResponse($p, JsonResponse::HTTP_BAD_REQUEST);
+        }
+
+        if (!$this->security->isGranted(AsyncUploadVoter::GENERATE_SIGNATURE, $p)) {
+            throw new AccessDeniedHttpException('not allowed to generate this signature');
+        }
+
+        return new JsonResponse(
+            $this->serializer->serialize($p, 'json', [AbstractNormalizer::GROUPS => ['read']]),
+            Response::HTTP_OK,
+            [],
+            true
+        );
+    }
+}

src/Bundle/ChillDocStoreBundle/Security/Authorization/AsyncUploadVoter.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Security\Authorization;
+
+use Chill\DocStoreBundle\AsyncUpload\SignedUrl;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Authorization\Voter\Voter;
+use Symfony\Component\Security\Core\Security;
+
+final class AsyncUploadVoter extends Voter
+{
+    public const GENERATE_SIGNATURE = 'CHILL_DOC_GENERATE_ASYNC_SIGNATURE';
+
+    public function __construct(
+        private readonly Security $security,
+    ) {}
+
+    protected function supports($attribute, $subject): bool
+    {
+        return self::GENERATE_SIGNATURE === $attribute && $subject instanceof SignedUrl;
+    }
+
+    protected function voteOnAttribute($attribute, $subject, TokenInterface $token): bool
+    {
+        /** @var SignedUrl $subject */
+        if (!in_array($subject->method, ['POST', 'GET', 'HEAD'], true)) {
+            return false;
+        }
+
+        return $this->security->isGranted('ROLE_USER') || $this->security->isGranted('ROLE_ADMIN');
+    }
+}

src/Bundle/ChillDocStoreBundle/Tests/Controller/AsyncUploadControllerTest.php

@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\DocStoreBundle\Tests\Controller;
+
+use Chill\DocStoreBundle\AsyncUpload\SignedUrl;
+use Chill\DocStoreBundle\AsyncUpload\SignedUrlPost;
+use Chill\DocStoreBundle\AsyncUpload\TempUrlGeneratorInterface;
+use Chill\DocStoreBundle\Controller\AsyncUploadController;
+use Chill\DocStoreBundle\Security\Authorization\AsyncUploadVoter;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
+use Psr\Log\NullLogger;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
+use Symfony\Component\Security\Core\Security;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+class AsyncUploadControllerTest extends TestCase
+{
+    use ProphecyTrait;
+
+    public function testGenerateWhenUserIsNotGranted(): void
+    {
+        $this->expectException(AccessDeniedHttpException::class);
+        $controller = $this->buildAsyncUploadController(false);
+
+        $controller->getSignedUrl('POST', new Request());
+    }
+
+    public function testGeneratePost(): void
+    {
+        $controller = $this->buildAsyncUploadController(true);
+
+        $actual = $controller->getSignedUrl('POST', new Request());
+        $decodedActual = json_decode($actual->getContent(), true, JSON_THROW_ON_ERROR, JSON_THROW_ON_ERROR);
+
+        self::assertArrayHasKey('method', $decodedActual);
+        self::assertEquals('POST', $decodedActual['method']);
+    }
+
+    public function testGenerateGet(): void
+    {
+        $controller = $this->buildAsyncUploadController(true);
+
+        $actual = $controller->getSignedUrl('GET', new Request(['object_name' => 'abc']));
+        $decodedActual = json_decode($actual->getContent(), true, JSON_THROW_ON_ERROR, JSON_THROW_ON_ERROR);
+
+        self::assertArrayHasKey('method', $decodedActual);
+        self::assertEquals('GET', $decodedActual['method']);
+    }
+
+    private function buildAsyncUploadController(
+        bool $isGranted,
+    ): AsyncUploadController {
+        $tempUrlGenerator = new class () implements TempUrlGeneratorInterface {
+            public function generatePost(int $expire_delay = null, int $submit_delay = null, int $max_file_count = 1): SignedUrlPost
+            {
+                return new SignedUrlPost(
+                    'https://object.store.example',
+                    new \DateTimeImmutable('1 hour'),
+                    150,
+                    1,
+                    1800,
+                    '',
+                    'abc',
+                    'abc'
+                );
+            }
+
+            public function generate(string $method, string $object_name, int $expire_delay = null): SignedUrl
+            {
+                return new SignedUrl(
+                    $method,
+                    'https://object.store.example',
+                    new \DateTimeImmutable('1 hour')
+                );
+            }
+        };
+
+        $serializer = $this->prophesize(SerializerInterface::class);
+        $serializer->serialize(Argument::type(SignedUrl::class), 'json', Argument::type('array'))
+            ->will(fn (array $args): string => json_encode(['method' => $args[0]->method], JSON_THROW_ON_ERROR, 3));
+
+        $security = $this->prophesize(Security::class);
+        $security->isGranted(AsyncUploadVoter::GENERATE_SIGNATURE, Argument::type(SignedUrl::class))
+            ->willReturn($isGranted);
+
+        return new AsyncUploadController(
+            $tempUrlGenerator,
+            $serializer->reveal(),
+            $security->reveal(),
+            new NullLogger()
+        );
+    }
+}