IBX-9379: Added Grace Period for archived versions #515

mateuszbieniek · 2025-03-17T14:28:31Z

🎫 Issue	IBX-9379

Description:

This PR introduces a "grace period" that allows for archived versions to be accessed by the user, even when they don't have a versionread policy and the requested version was archived within X seconds from the execution of the loadContent method.
The default grace period is 30 seconds (the same as probably the most popular response timeout for web servers).
The grace period now acts as a failsafe for situations when the published version number changes in the middle of the request (please check IBX-9379 for more info).

TODO:

Cache invalidation (persistence/HTTP) when grace period usage was detected
Test coverage

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

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

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

src/lib/Repository/ContentService.php

phpstan-baseline.neon

adamwojs

Can we limit "grace period" to only last archived version ?

Steveb-p · 2025-03-20T07:14:24Z

Can we limit "grace period" to only last archived version ?

That's the thing - previous archived version is not known. There isn't any entry that indicates what it was, or at least we did not find one.

mateuszbieniek · 2025-03-20T07:15:26Z

In theory, we can (version with archived state and "highest" modification date timestamp - but that would be more like a "best guess"), but my test shows that in extreme situations, you can have more than one version change during a request.

alongosz

Overall it seems to me as rather a workaround that should be resolved by better cache invalidation after transaction succeeds, but I don't have an actual better solution in that regard ATM (and I know it's not trivial) 😅, so I'm leaning towards accepting your solution, provided the remarks below are addressed.

Integration tests coverage is necessary for those changes to be accepted into upstream.
Other remarks in diff comments:

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

alongosz · 2025-03-20T13:42:49Z

src/lib/Repository/ContentService.php

        if (
            !$content->getVersionInfo()->isPublished()
            && !$this->permissionResolver->canUser('content', 'versionread', $content)
        ) {
-            throw new UnauthorizedException('content', 'versionread', ['contentId' => $contentId, 'versionNo' => $versionNo]);
+            if (!$this->isInGracePeriod($content, $this->settings['grace_period_in_seconds'], $versionNo)) {
+                throw new UnauthorizedException('content', 'versionread', ['contentId' => $contentId, 'versionNo' => $versionNo]);
+            }
        }


That check was not only to disallow viewing "unpublished" versions, but also other drafts, even for content that hasn't been published at all. While I see that your implementation of isInGracePeriod checks indeed for archived versions, you should probably check first if content has been archived. If it hasn't then that's a normal draft someone is working on before publishing it, so it should throw unauthorized exception right away if there's no versionread policy.

Try combining that nested if-if into a single chained expression following code style of L389-390.

Ad. 2. It's really useful to review SonarCloud / SonarQube analysis. https://sonarcloud.io/project/issues?sinceLeakPeriod=true&issueStatuses=OPEN%2CCONFIRMED&pullRequest=515&id=ibexa_core&open=AZWkhRnq4uuA193_QeJw
or install SonarQube plugin for PHPStorm.

Can you explain point 1 in more detail? I don't see a way that the grace period will grant access to a draft for a person that should be blocked by a versionread on the first hand.

Can you explain point 1 in more detail? I don't see a way that the grace period will grant access to a draft for a person that should be blocked by a versionread on the first hand.

Essentially

|| ($content->getVersionInfo()->isArchived() && $this->isInGracePeriod())

costs less, performance-wise, than isInGracePeriod alone, for the cases if we're dealing with draft, not an older published version.
Unless I'm missing something...

@alongosz
Did you not meant

( $content->getVersionInfo()->isArchived() && --->**!**<--- $this->isInGracePeriod($content, $this->settings['grace_period_in_seconds'], $versionNo) )

?

update: either way, this breaks the solution for some reason, hard to debug why, I guess sometimes the old version is not yet in archived state?

alongosz · 2025-03-20T13:52:40Z

src/lib/Repository/ContentService.php

            // Version archive limit (0-50), only enforced on publish, not on un-publish.
            'default_version_archive_limit' => 5,
            'remove_archived_versions_on_publish' => true,
+            'grace_period_in_seconds' => 30,


For this to be "override-able" you need to:

add that option to: \Ibexa\Bundle\Core\DependencyInjection\Configuration\Parser\Repository\Options::addSemanticConfig,

map it in \Ibexa\Bundle\Core\ApiLoader\RepositoryFactory::buildRepository#L129.

That's a plan, yes.

alongosz · 2025-03-20T13:56:39Z

tests/lib/Repository/Service/Mock/ContentTest.php

    }

-    public function testLoadContentNotPublishedStatusUnauthorized()
+    public function testLoadContentNotPublishedStatusUnauthorized(bool $expectException = true)


How exactly does this work? Seems this is always true, since there's no data provider or test dependency here.

This is leftover from when I wanted to reuse this test case with a grace period enabled, please ignore it.

This is leftover from when I wanted to reuse this test case with a grace period enabled, please ignore it.

ok, just make sure it's dropped in the final version. I'd rather move coverage of grace period to integration tests layer.

mateuszbieniek · 2025-03-20T14:11:59Z

Overall it seems to me as rather a workaround that should be resolved by better cache invalidation after transaction succeeds, but I don't have an actual better solution in that regard ATM (and I know it's not trivial) 😅, so I'm leaning towards accepting your solution, provided the remarks below are addressed.

This issue is not related to cache at all, except that the outcome of this issue can mess it up.

glye

Tricksy problem. I agree it looks like a workaround to a problem that should have some kind of better atomic solution, but if that isn't possible, then we'll have to go for it.

It better not be possible for the end user to influcence the length of the grace period. It looks ok, but please make sure they can't extend it years back. Also it should never work on trashed content, right?

mateuszbieniek · 2025-03-28T15:12:00Z

Cache changes lookin' good! Will we handle in the same subscriber the HTTP cache clearing as well?

tests/integration/Core/Resources/settings/common.yml

src/bundle/Core/EventSubscriber/ClearCollectedContentCacheSubscriber.php

konradoboza

Have you perhaps checked if the provided test case fails before introducing those changes?

bootstrap.php

tests/integration/Core/Repository/ContentServiceTest.php

tests/integration/Core/Repository/UserServiceTest.php

tests/integration/Core/Repository/ContentServiceTest.php

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

src/lib/Repository/Collector/ContentCollector.php

…n issue with mocking it otherwise - for some reason, time methods are not mocked when called by previous tests.

…ame problem but with other tests cases.

Co-authored-by: Konrad Oboza <[email protected]>

Co-authored-by: Andrew Longosz <[email protected]>

sonarqubecloud · 2025-04-04T10:33:20Z

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

tomaszszopinski

QA approved on Ibexa DXP 4.6 commerce.

mateuszbieniek added the Work in progress label Mar 17, 2025

github-actions bot assigned mikadamczyk, alongosz and tischsoic Mar 17, 2025

Steveb-p approved these changes Mar 18, 2025

View reviewed changes

mateuszbieniek changed the title ~~[WIP] IBX-9379 Added Grace Period for achived versions~~ [WIP] IBX-9379 Added Grace Period for archived versions Mar 18, 2025

adamwojs reviewed Mar 20, 2025

View reviewed changes

alongosz reviewed Mar 20, 2025

View reviewed changes

glye approved these changes Mar 21, 2025

View reviewed changes

ViniTou force-pushed the publish_grace_period branch 3 times, most recently from 510fbea to b339d4a Compare March 28, 2025 14:57

ViniTou force-pushed the publish_grace_period branch from 25a7809 to c5b3e5e Compare March 28, 2025 15:30

adamwojs approved these changes Apr 3, 2025

View reviewed changes

tests/integration/Core/Resources/settings/common.yml Outdated Show resolved Hide resolved

src/bundle/Core/EventSubscriber/ClearCollectedContentCacheSubscriber.php Outdated Show resolved Hide resolved

ViniTou changed the title ~~[WIP] IBX-9379 Added Grace Period for archived versions~~ IBX-9379: Added Grace Period for archived versions Apr 3, 2025

adamwojs added Ready for review and removed Work in progress labels Apr 3, 2025

tbialcz approved these changes Apr 3, 2025

View reviewed changes

barw4 approved these changes Apr 3, 2025

View reviewed changes

barw4 requested a review from a team April 3, 2025 06:52

adamwojs added Ready for QA and removed Ready for review labels Apr 3, 2025

konradoboza reviewed Apr 3, 2025

View reviewed changes

tomaszszopinski force-pushed the publish_grace_period branch from d150fbb to 6bd05a0 Compare April 3, 2025 07:10

Steveb-p reviewed Apr 3, 2025

View reviewed changes

src/lib/Persistence/Legacy/Content/Gateway/DoctrineDatabase/QueryBuilder.php Outdated Show resolved Hide resolved

Steveb-p reviewed Apr 3, 2025

View reviewed changes

src/lib/Repository/Collector/ContentCollector.php Outdated Show resolved Hide resolved

ViniTou and others added 20 commits April 4, 2025 12:29

pass same id

f1f89fb

Moved to mockable time in integration test

01f457b

Moved registering mocked time services to setUp method, as there is a…

7d895a2

…n issue with mocking it otherwise - for some reason, time methods are not mocked when called by previous tests.

Moved registering mocked time services to bootstrap, as now it have s…

b14af0f

…ame problem but with other tests cases.

I am having such a good time

13bcc0e

I'm having a ball

9966027

dont stop me now

6efedc8

just give ma a call

12feb97

extracted collector from subscriber

8e5548b

cs fix

6875253

marked Subscriber as final

7ebad66

restored final keyword

d979a0a

implement Reset interface

0c35b84

Update tests/integration/Core/Repository/ContentServiceTest.php

9efaa4b

Co-authored-by: Konrad Oboza <[email protected]>

Update tests/integration/Core/Repository/UserServiceTest.php

56fa8f1

Co-authored-by: Konrad Oboza <[email protected]>

Update tests/integration/Core/Repository/ContentServiceTest.php

7df510b

Co-authored-by: Konrad Oboza <[email protected]>

Update tests/integration/Core/Repository/ContentServiceTest.php

42b39cf

Co-authored-by: Konrad Oboza <[email protected]>

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

bec0cb4

Co-authored-by: Andrew Longosz <[email protected]>

dropped shared on ContentCollector

32d3da4

Typehinted against TagAwareAdapterInterface to match @ibexa.cache_pool

811e55c

tomaszszopinski force-pushed the publish_grace_period branch from 8219258 to 811e55c Compare April 4, 2025 10:30

tomaszszopinski added QA approved and removed Ready for QA labels Apr 7, 2025

tomaszszopinski approved these changes Apr 7, 2025

View reviewed changes

ViniTou merged commit d177f13 into ibexa:4.6 Apr 7, 2025
21 checks passed

mnocon added the Doc needed The changes require some documentation label Apr 7, 2025

mnocon mentioned this pull request Apr 7, 2025

Added description of the grace period ibexa/documentation-developer#2696

Merged

mnocon removed the Doc needed The changes require some documentation label Apr 7, 2025

mnocon mentioned this pull request Apr 9, 2025

Release notes 4.6.19 ibexa/documentation-developer#2698

Merged

IBX-9379: Added Grace Period for archived versions #515

IBX-9379: Added Grace Period for archived versions #515

Uh oh!

Conversation

mateuszbieniek commented Mar 17, 2025 • edited by ViniTou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adamwojs left a comment

Choose a reason for hiding this comment

Uh oh!

Steveb-p commented Mar 20, 2025

Uh oh!

mateuszbieniek commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alongosz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ViniTou Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mateuszbieniek commented Mar 20, 2025

Uh oh!

glye left a comment

Choose a reason for hiding this comment

Uh oh!

mateuszbieniek commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

konradoboza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Apr 4, 2025

Quality Gate passed

Uh oh!

tomaszszopinski left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants

mateuszbieniek commented Mar 17, 2025 •

edited by ViniTou

Loading

mateuszbieniek commented Mar 20, 2025 •

edited

Loading

ViniTou Mar 25, 2025 •

edited

Loading