IBX-9379: Added Grace Period for archived versions

bootstrap.php

@@ -4,11 +4,20 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+
+use Ibexa\Core\Persistence\Legacy\Content\Gateway\DoctrineDatabase;
+use Ibexa\Core\Persistence\Legacy\Content\Gateway\DoctrineDatabase\QueryBuilder;
+use Ibexa\Core\Repository\ContentService;
 use Symfony\Bridge\PhpUnit\ClockMock;
 use Symfony\Component\HttpFoundation\Request;
 
 // Register ClockMock for Request class before any tests are run
 // https://github.com/symfony/symfony/issues/28259
 ClockMock::register(Request::class);
 
+// Register ClockMock, as otherwise they are mocked until first method call.
+ClockMock::register(DoctrineDatabase::class);
+ClockMock::register(ContentService::class);
+ClockMock::register(QueryBuilder::class);
+
 require_once __DIR__ . '/vendor/autoload.php';

phpstan-baseline.neon

@@ -70662,12 +70662,6 @@ parameters:
 			count: 1
 			path: tests/lib/Repository/Service/Mock/ContentTest.php
 
-		-
-			message: '#^Call to new Ibexa\\Core\\Repository\\ContentService\(\) on a separate line has no effect\.$#'
-			identifier: new.resultUnused
-			count: 1
-			path: tests/lib/Repository/Service/Mock/ContentTest.php
-
 		-
 			message: '#^Cannot access offset mixed on Ibexa\\Contracts\\Core\\Repository\\Values\\Content\\Field\.$#'
 			identifier: offsetAccess.nonOffsetAccessible
@@ -70836,12 +70830,6 @@ parameters:
 			count: 1
 			path: tests/lib/Repository/Service/Mock/ContentTest.php
 
-		-
-			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Service\\Mock\\ContentTest\:\:getPartlyMockedContentService\(\) invoked with 2 parameters, 0\-1 required\.$#'
-			identifier: arguments.count
-			count: 1
-			path: tests/lib/Repository/Service/Mock/ContentTest.php
-
 		-
 			message: '#^Method Ibexa\\Tests\\Core\\Repository\\Service\\Mock\\ContentTest\:\:getPartlyMockedContentService\(\) should return Ibexa\\Core\\Repository\\ContentService&PHPUnit\\Framework\\MockObject\\MockObject but returns Ibexa\\Core\\Repository\\ContentService\.$#'
 			identifier: return.type

src/bundle/Core/ApiLoader/RepositoryFactory.php

@@ -19,6 +19,7 @@
 use Ibexa\Contracts\Core\Search\Handler as SearchHandler;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Ibexa\Core\FieldType\FieldTypeRegistry;
+use Ibexa\Core\Repository\Collector\ContentCollector;
 use Ibexa\Core\Repository\Helper\RelationProcessor;
 use Ibexa\Core\Repository\Mapper;
 use Ibexa\Core\Repository\Permission\LimitationService;
@@ -93,7 +94,8 @@ public function buildRepository(
         LocationFilteringHandler $locationFilteringHandler,
         PasswordValidatorInterface $passwordValidator,
         ConfigResolverInterface $configResolver,
-        NameSchemaServiceInterface $nameSchemaService
+        NameSchemaServiceInterface $nameSchemaService,
+        ContentCollector $contentCollector
     ): Repository {
         $config = $this->container->get(RepositoryConfigurationProvider::class)->getRepositoryConfig();
 
@@ -119,6 +121,7 @@ public function buildRepository(
             $passwordValidator,
             $configResolver,
             $nameSchemaService,
+            $contentCollector,
             [
                 'role' => [
                     'policyMap' => $this->policyMap,
@@ -127,6 +130,7 @@ public function buildRepository(
                 'content' => [
                     'default_version_archive_limit' => $config['options']['default_version_archive_limit'],
                     'remove_archived_versions_on_publish' => $config['options']['remove_archived_versions_on_publish'],
+                    'grace_period_in_seconds' => $config['options']['grace_period_in_seconds'] ?? (int) ini_get('max_execution_time'),
                 ],
             ],
             $this->logger

src/bundle/Core/DependencyInjection/Configuration/Parser/Repository/Options.php

@@ -27,6 +27,9 @@ public function addSemanticConfig(NodeBuilder $nodeBuilder): void
                         ->defaultTrue()
                         ->info('Enables automatic removal of archived versions when publishing, at the cost of performance. "ezplatform:content:cleanup-versions" command should be used to perform this task instead if this option is set to false.')
                     ->end()
+                    ->integerNode('grace_period_in_seconds')
+                        ->info('Provide a value in seconds, when archived content is still accessible for users with access to current version. Prevents 500 error when accessed content is updated during request. Defaults to php max execution time.')
+                    ->end()
                 ->end()
             ->end();
     }

src/bundle/Core/EventSubscriber/ClearCollectedContentCacheSubscriber.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Core\EventSubscriber;
+
+use Ibexa\Core\Persistence\Cache\Identifier\CacheIdentifierGeneratorInterface;
+use Ibexa\Core\Repository\Collector\ContentCollector;
+use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\TerminateEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+final class ClearCollectedContentCacheSubscriber implements EventSubscriberInterface
+{
+    private TagAwareAdapterInterface $cache;
+
+    private CacheIdentifierGeneratorInterface $identifierGenerator;
+
+    private ContentCollector $contentCollector;
+
+    public function __construct(
+        ContentCollector $contentCollector,
+        TagAwareAdapterInterface $cache,
+        CacheIdentifierGeneratorInterface $identifierGenerator
+    ) {
+        $this->cache = $cache;
+        $this->identifierGenerator = $identifierGenerator;
+        $this->contentCollector = $contentCollector;
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [KernelEvents::TERMINATE => 'clearCache'];
+    }
+
+    public function clearCache(TerminateEvent $event): void
+    {
+        foreach ($this->contentCollector->getCollectedContentIds() as $contentId) {
+            $this->cache->invalidateTags([
+                $this->identifierGenerator->generateTag('content', [$contentId]),
+            ]);
+        }
+
+        $this->contentCollector->reset();
+    }
+}

src/bundle/Core/Resources/config/services.yml

@@ -304,6 +304,12 @@ services:
         tags:
             - {name: kernel.event_subscriber}
 
+    Ibexa\Bundle\Core\EventSubscriber\ClearCollectedContentCacheSubscriber:
+        autowire: true
+        autoconfigure: true
+        arguments:
+            $cache: '@ibexa.cache_pool'
+
     Ibexa\Bundle\Core\EventSubscriber\TrustedHeaderClientIpEventSubscriber:
         arguments:
             $trustedHeaderName: '%ibexa.trusted_header_client_ip_name%'

src/contracts/Persistence/Content/Handler.php

@@ -131,6 +131,13 @@ public function loadContentInfoByRemoteId($remoteId);
      */
     public function loadVersionInfo($contentId, $versionNo = null);
 
+    /**
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
+     *
+     * @return int[]
+     */
+    public function loadVersionNoArchivedWithin(int $contentId, int $seconds): array;
+
     /**
      * Returns the number of versions with draft status created by the given $userId.
      *

src/lib/Base/Container/ApiLoader/RepositoryFactory.php

@@ -20,6 +20,7 @@
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Ibexa\Core\Base\Exceptions\InvalidArgumentException;
 use Ibexa\Core\FieldType\FieldTypeRegistry;
+use Ibexa\Core\Repository\Collector\ContentCollector;
 use Ibexa\Core\Repository\Helper\RelationProcessor;
 use Ibexa\Core\Repository\Mapper;
 use Ibexa\Core\Repository\Permission\LimitationService;
@@ -85,6 +86,7 @@ public function buildRepository(
         PasswordValidatorInterface $passwordValidator,
         ConfigResolverInterface $configResolver,
         NameSchemaServiceInterface $nameSchemaService,
+        ContentCollector $contentCollector,
         array $languages
     ): Repository {
         return new $this->repositoryClass(
@@ -109,6 +111,7 @@ public function buildRepository(
             $passwordValidator,
             $configResolver,
             $nameSchemaService,
+            $contentCollector,
             [
                 'role' => [
                     'policyMap' => $this->policyMap,

src/lib/Persistence/Cache/ContentHandler.php

@@ -266,6 +266,14 @@ public function loadVersionInfo($contentId, $versionNo = null)
         return $versionInfo;
     }
 
+    /**
+     * @return int[]
+     */
+    public function loadVersionNoArchivedWithin(int $contentId, int $seconds): array
+    {
+        return $this->persistenceHandler->contentHandler()->loadVersionNoArchivedWithin($contentId, $seconds);
+    }
+
     public function countDraftsForUser(int $userId): int
     {
         $this->logger->logCall(__METHOD__, ['user' => $userId]);

src/lib/Persistence/Legacy/Content/Gateway.php

@@ -212,6 +212,11 @@ abstract public function loadContentInfoList(array $contentIds): array;
      */
     abstract public function loadVersionInfo(int $contentId, ?int $versionNo = null): array;
 
+    /**
+     * @return array<mixed>
+     */
+    abstract public function loadVersionNoArchivedWithin(int $contentId, int $seconds): array;
+
     /**
      * Return the number of all versions with given status created by the given $userId.
      */

src/lib/Persistence/Legacy/Content/Gateway/DoctrineDatabase.php

@@ -910,6 +910,51 @@ public function loadVersionInfo(int $contentId, ?int $versionNo = null): array
         return $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
     }
 
+    /**
+     * @return array<int,array<string,mixed>>
+     */
+    public function loadVersionNoArchivedWithin(int $contentId, int $seconds): array
+    {
+        $cutoffTimestamp = time() - $seconds;
+        if ($cutoffTimestamp < 0) {
+            return [];
+        }
+        $queryBuilder = $this->queryBuilder->createVersionInfoFindQueryBuilder();
+        $expr = $queryBuilder->expr();
+
+        $queryBuilder
+            ->andWhere(
+                $expr->eq(
+                    'v.contentobject_id',
+                    $queryBuilder->createNamedParameter(
+                        $contentId,
+                        ParameterType::INTEGER,
+                        ':content_id'
+                    )
+                )
+            )->andWhere(
+                $expr->eq(
+                    'v.status',
+                    $queryBuilder->createNamedParameter(
+                        VersionInfo::STATUS_ARCHIVED,
+                        ParameterType::INTEGER,
+                        ':status'
+                    )
+                )
+            )->andWhere(
+                $expr->gt(
+                    'v.modified',
+                    $queryBuilder->createNamedParameter(
+                        $cutoffTimestamp,
+                        ParameterType::INTEGER,
+                        ':modified'
+                    )
+                )
+            )->orderBy('v.modified', 'DESC');
+
+        return $queryBuilder->execute()->fetchAllAssociative();
+    }
+
     public function countVersionsForUser(int $userId, int $status = VersionInfo::STATUS_DRAFT): int
     {
         $query = $this->connection->createQueryBuilder();

src/lib/Persistence/Legacy/Content/Gateway/DoctrineDatabase/QueryBuilder.php

@@ -10,7 +10,6 @@
 use Doctrine\DBAL\ParameterType;
 use Doctrine\DBAL\Query\QueryBuilder as DoctrineQueryBuilder;
 use Ibexa\Core\Persistence\Legacy\Content\Gateway;
-use function time;
 
 /**
  * @internal For internal use by the Content gateway.

src/lib/Persistence/Legacy/Content/Gateway/ExceptionConversion.php

@@ -217,6 +217,18 @@ public function loadVersionInfo(int $contentId, ?int $versionNo = null): array
         }
     }
 
+    /**
+     * @return int[]
+     */
+    public function loadVersionNoArchivedWithin(int $contentId, int $seconds): array
+    {
+        try {
+            return $this->innerGateway->loadVersionNoArchivedWithin($contentId, $seconds);
+        } catch (DBALException | PDOException $e) {
+            throw DatabaseException::wrap($e);
+        }
+    }
+
     public function countVersionsForUser(int $userId, int $status = VersionInfo::STATUS_DRAFT): int
     {
         try {

src/lib/Persistence/Legacy/Content/Handler.php

@@ -483,6 +483,21 @@ public function loadVersionInfo($contentId, $versionNo = null)
         return reset($versionInfo);
     }
 
+    public function loadVersionNoArchivedWithin(int $contentId, int $seconds): array
+    {
+        $rows = $this->contentGateway->loadVersionNoArchivedWithin($contentId, $seconds);
+        if (empty($rows)) {
+            throw new NotFound('content', $contentId);
+        }
+
+        $archivedVersionNos = [];
+        foreach ($rows as $row) {
+            $archivedVersionNos[] = (int) $row['ezcontentobject_version_version'];
+        }
+
+        return $archivedVersionNos;
+    }
+
     public function countDraftsForUser(int $userId): int
     {
         return $this->contentGateway->countVersionsForUser($userId, VersionInfo::STATUS_DRAFT);

src/lib/Repository/Collector/ContentCollector.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Core\Repository\Collector;
+
+use Ibexa\Contracts\Core\Repository\Values\Content\Content;
+use Symfony\Contracts\Service\ResetInterface;
+
+final class ContentCollector implements ResetInterface
+{
+    /** @var array<int, bool> */
+    private array $contentMap = [];
+
+    public function collectContent(Content $content): void
+    {
+        $this->contentMap[$content->getId()] = false;
+    }
+
+    /**
+     * @return int[]
+     */
+    public function getCollectedContentIds(): array
+    {
+        return array_keys($this->contentMap);
+    }
+
+    public function reset(): void
+    {
+        $this->contentMap = [];
+    }
+}