API can get component group by reference

Author: silverbackdan

features/bootstrap/DoctrineContext.php

@@ -73,6 +73,7 @@ final class DoctrineContext implements Context
     private UserPasswordHasherInterface $passwordHasher;
     private array $classes;
     private JWTEncoderInterface $jwtEncoder;
+    private JsonContext $jsonContext;
 
     /**
      * Initializes context.
@@ -110,6 +111,7 @@ public function gatherContexts(BeforeScenarioScope $scope): void
         $this->baseRestContext = $scope->getEnvironment()->getContext(BehatchRestContext::class);
         $this->minkContext = $scope->getEnvironment()->getContext(MinkContext::class);
         $this->restContext = $scope->getEnvironment()->getContext(RestContext::class);
+        $this->jsonContext = $scope->getEnvironment()->getContext(JsonContext::class);
     }
 
     /**
@@ -892,6 +894,16 @@ public function thereShouldBeDummyComponentResources(int $count): void
         Assert::assertCount($count, $repo->findAll());
     }
 
+    /**
+     * @Then the response resource should be saved as :name
+     */
+    public function theResponseResourceShouldBeSavedAs($name): void
+    {
+        $response = $this->jsonContext->getJsonAsArray();
+        Assert::assertArrayHasKey('@id', $response);
+        $this->restContext->resources[$name] = $response['@id'];
+    }
+
     /**
      * @Then there should be :count ComponentPosition resources
      */

features/main/component_groups.feature

@@ -39,6 +39,13 @@ Feature: ComponentGroup resource
     And there should be 4 DummyComponent resources
     And there should be 0 ComponentPosition resources
 
+  @loginUser
+  Scenario: I can get a component group by reference
+    Given there is a ComponentGroup with 0 components
+    When I send a "GET" request to "/_/component_groups/collection"
+    Then the response status code should be 200
+    And the JSON node "@id" should be equal to the IRI of the resource "component_group"
+
   Scenario: Components are ordered by the sortValue of the resourcePosition
     Given there is a ComponentGroup with 4 components
     When I send a "GET" request to the resource "component_group"

features/uploads/uploads.feature

@@ -137,6 +137,27 @@ Feature: API Resources which can have files uploaded
     And the JSON should be valid according to the schema "features/assets/schema/uploadable_has_files.schema.json"
     And the JSON node "_metadata.publishable.published" should be true
 
+  # Replicate a published resource not having an image, creating a draft by uploading and then publishing this draft and the published resource should have the image
+  @loginAdmin
+  Scenario: When we create a draft through means of an upload to the published, and then publish the draft, the new published resource should still have a file
+    Given I add "Content-Type" header equal to "multipart/form-data"
+    And there is a DummyUploadableAndPublishable
+    When I send a "POST" request to the resource "dummy_uploadable" and the postfix "/upload" with parameters:
+      | key  | value      |
+      | file | @image.svg |
+    Then the response status code should be 201
+    And the response resource should be saved as "dummy_uploadable_draft"
+    And I send a "PATCH" request to the resource "dummy_uploadable_draft" with body:
+    """
+    {
+        "publishedAt": "1970-11-11T23:59:59+00:00"
+    }
+    """
+    Then the response status code should be 200
+    And the response should be the resource "dummy_uploadable"
+    And the JSON should be valid according to the schema "features/assets/schema/uploadable_has_files_with_imagine.schema.json"
+    And the JSON node "_metadata.mediaObjects.file[0].contentUrl" should be a valid download link for the resource "dummy_uploadable"
+
   # DELETE
 
   @loginAdmin

src/DataProvider/StateProvider/ComponentGroupStateProvider.php

@@ -0,0 +1,47 @@
+<?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\DataProvider\StateProvider;
+
+use ApiPlatform\Doctrine\Orm\State\CollectionProvider;
+use ApiPlatform\Doctrine\Orm\State\ItemProvider;
+use ApiPlatform\Metadata\CollectionOperationInterface;
+use ApiPlatform\Metadata\Operation;
+use ApiPlatform\State\ProviderInterface;
+use Silverback\ApiComponentsBundle\Repository\Core\ComponentGroupRepository;
+use Silverback\ApiComponentsBundle\Repository\Core\RouteRepository;
+
+/**
+ * @author Daniel West <daniel@silverback.is>
+ */
+class ComponentGroupStateProvider implements ProviderInterface
+{
+    public function __construct(
+        private ComponentGroupRepository $componentGroupRepository,
+        private ProviderInterface $defaultProvider)
+    {}
+
+    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
+    {
+        if ($operation instanceof CollectionOperationInterface) {
+            return $this->defaultProvider->provide($operation->withProvider(CollectionProvider::class), $uriVariables, $context);
+        }
+
+        $id = $uriVariables['id'];
+        if (!\is_string($id)) {
+            return $this->defaultProvider->provide($operation->withProvider(ItemProvider::class), $uriVariables, $context);
+        }
+
+        return $this->componentGroupRepository->findOneByIdOrReference($id);
+    }
+}

src/Entity/Core/ComponentGroup.php

@@ -17,6 +17,7 @@
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Silverback\ApiComponentsBundle\Annotation as Silverback;
+use Silverback\ApiComponentsBundle\DataProvider\StateProvider\ComponentGroupStateProvider;
 use Silverback\ApiComponentsBundle\Entity\Utility\IdTrait;
 use Silverback\ApiComponentsBundle\Entity\Utility\TimestampedTrait;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
@@ -30,7 +31,8 @@
 #[ApiResource(
     normalizationContext: ['groups' => ['ComponentGroup:read']],
     denormalizationContext: ['groups' => ['ComponentGroup:write']],
-    mercure: true
+    mercure: true,
+    provider: ComponentGroupStateProvider::class
 )]
 #[UniqueEntity(fields: ['reference'], message: 'There is already a ComponentGroup resource with that reference.')]
 class ComponentGroup

src/EventListener/Api/PublishableEventListener.php

@@ -83,6 +83,7 @@ public function onPostRead(RequestEvent $event): void
             return;
         }
 
+        // this will merge the draft into published on a GET request if the publish date is reached.
         $this->checkMergeDraftIntoPublished($request, $attributes['data'], true);
     }
 

src/Repository/Core/ComponentGroupRepository.php

@@ -0,0 +1,55 @@
+<?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\Repository\Core;
+
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+use Ramsey\Uuid\Exception\InvalidUuidStringException;
+use Ramsey\Uuid\Uuid;
+use Silverback\ApiComponentsBundle\Entity\Core\ComponentGroup;
+
+/**
+ * @author Daniel West <daniel@silverback.is>
+ *
+ * @method ComponentGroup|null find($id, $lockMode = null, $lockVersion = null)
+ * @method ComponentGroup|null findOneBy(array $criteria, array $orderBy = null)
+ * @method ComponentGroup[]    findAll()
+ * @method ComponentGroup[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
+ */
+class ComponentGroupRepository extends ServiceEntityRepository
+{
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, ComponentGroup::class);
+    }
+
+    public function findOneByIdOrReference(string $idOrRef): ?ComponentGroup
+    {
+        $byRef = $this->findOneBy([
+            'reference' => $idOrRef,
+        ]);
+        if ($byRef) {
+            return $byRef;
+        }
+
+        try {
+            $uuid = Uuid::fromString($idOrRef);
+
+            return $this->find($uuid);
+        } catch (InvalidUuidStringException $e) {
+        }
+
+        return null;
+    }
+}

src/Resources/config/services.php

@@ -47,6 +47,7 @@
 use Silverback\ApiComponentsBundle\Command\RefreshTokensExpireCommand;
 use Silverback\ApiComponentsBundle\Command\UserCreateCommand;
 use Silverback\ApiComponentsBundle\DataProvider\PageDataProvider;
+use Silverback\ApiComponentsBundle\DataProvider\StateProvider\ComponentGroupStateProvider;
 use Silverback\ApiComponentsBundle\DataProvider\StateProvider\FormStateProvider;
 use Silverback\ApiComponentsBundle\DataProvider\StateProvider\PageDataMetadataStateProvider;
 use Silverback\ApiComponentsBundle\DataProvider\StateProvider\RouteStateProvider;
@@ -131,6 +132,7 @@
 use Silverback\ApiComponentsBundle\RamseyUuid\UuidUriVariableTransformer\UuidUriVariableTransformer;
 use Silverback\ApiComponentsBundle\RefreshToken\Storage\DoctrineRefreshTokenStorage;
 use Silverback\ApiComponentsBundle\Repository\Core\AbstractPageDataRepository;
+use Silverback\ApiComponentsBundle\Repository\Core\ComponentGroupRepository;
 use Silverback\ApiComponentsBundle\Repository\Core\ComponentPositionRepository;
 use Silverback\ApiComponentsBundle\Repository\Core\FileInfoRepository;
 use Silverback\ApiComponentsBundle\Repository\Core\LayoutRepository;
@@ -828,6 +830,17 @@
         ->autoconfigure(false)
         ->tag('api_platform.state_provider');
 
+    $services
+        ->set(ComponentGroupStateProvider::class)
+        ->args(
+            [
+                new Reference('silverback.doctrine.repository.component_group'),
+                new Reference('api_platform.state_provider'),
+            ]
+        )
+        ->autoconfigure(false)
+        ->tag('api_platform.state_provider');
+
     $services
         ->set(FormStateProvider::class)
         ->args(
@@ -1366,6 +1379,16 @@
         )
         ->tag('doctrine.repository_service');
 
+    $services
+        ->set('silverback.doctrine.repository.component_group')
+        ->class(ComponentGroupRepository::class)
+        ->args(
+            [
+                new Reference(ManagerRegistry::class),
+            ]
+        )
+        ->tag('doctrine.repository_service');
+
     $services
         ->set('silverback.event_listener.api.orphaned_component')
         ->class(OrphanedComponentEventListener::class)