[DoctrineBridge] Fix LockStoreSchemaListener not working properly with iterable objects #54407

barton-webwings · 2024-03-26T13:54:21Z

Q	A
Branch?	6.4
Bug fix?	yes
New feature?	yes
Deprecations?	no
Issues	Fix #54406
License	MIT

carsonbot · 2024-03-26T13:54:27Z

Hey!

Thanks for your PR. You are targeting branch "6.4" but it seems your PR description refers to branch "7.1 for features / 5.4, 6.4, or 7.0 for bug fixes".
Could you update the PR description or change target branch? This helps core maintainers a lot.

Cheers!

Carsonbot

MatTheCat · 2024-03-26T14:46:31Z

I think you can simply revert #50761:

ArrayIterator won’t work as expected when passed a traversable (this is why testPostGenerateSchemaWithInvalidLockStore passes: its iterator won’t yield anything. You can be sure because its generator uses $this while being static).
Exceptions thrown inside a generator will appear when calling valid or next, not current.
An exception thrown inside a generator would close it, even if caught when iterating; this could result in other stores being silently ignored.
LogicExceptions are not supposed to be caught.

…tener` raised by `StoreFactory`" This reverts commit 0acd403.

nicolas-grekas · 2024-04-11T15:10:25Z

/cc @alexandre-daubois FYI

alexandre-daubois · 2024-04-11T15:22:25Z

Indeed my solution doesn't work as expected. I don't think that reverting the PR is the best solution, because it would fix a bug but reintroduce one in the codebase.

I'm on my phone right now but I can have a look at it tomorrow to find/have a look for a proper solution, if you need help 🙂

barton-webwings · 2024-04-12T08:56:29Z

I think there could be a better solution to the original issue #50761.

Personally, I would take a similar path to Monolog's NullHandler or Mailer's NullTransport and introduce a NullStore and a corresponding case to the StoreFactory. The DSN could look something like LOCK_STORE=null://.

This way we would avoid the InvalidArgumentException, which I agree is a legitimate exception, but preserve the option to effectively disable the Lock component.

alexandre-daubois · 2024-04-12T09:07:52Z

Seems to be a great solution indeed, I like it!

barton-webwings · 2024-04-12T10:31:50Z

I pushed a draft of my proposed solution into this PR, hopefully I didn't miss anything.

Since the StoreFactory already has cases which are not strictly a dsn, I went with a simple null, which would theoretically work with existing cases of LOCK_STORE=null.

alexandre-daubois

Seems like a clean solution like this 😊

nicolas-grekas · 2024-04-12T12:02:26Z

So, that's a new feature now, isn't it?

Toflar · 2024-04-25T14:47:19Z

Not really a new feature. The current implementation is broken. It will not add the required schema as described in #54406. Just faced the same issue and this PR fixes it :)

MatTheCat · 2024-05-04T15:34:30Z

The NullStore is a new feature.

#50761 revert is a fix.

xabbuh · 2024-08-05T12:22:40Z

src/Symfony/Component/Lock/Store/NullStore.php

+ *
+ * @author Pavel Bartoň <[email protected]>
+ */
+class NullStore implements BlockingSharedLockStoreInterface


Introducing this class (as well as the changes to the StoreFactory) must be moved into a separate PR targeting the 7.2 branch. That's a new feature.

xabbuh · 2024-08-05T12:23:25Z

src/Symfony/Bridge/Doctrine/Tests/SchemaListener/LockStoreSchemaListenerTest.php

@@ -40,20 +39,4 @@ public function testPostGenerateSchemaLockPdo()
        $subscriber = new LockStoreSchemaListener([$lockStore]);
        $subscriber->postGenerateSchema($event);
    }
-
-    public function testPostGenerateSchemaWithInvalidLockStore()


this test should be kept as fixing the issue #50761 tried to fix is legitimate

xabbuh · 2024-08-05T12:23:49Z

src/Symfony/Bridge/Doctrine/SchemaListener/LockStoreSchemaListener.php

-                }
-
-                $store->configureSchema($event->getSchema(), $this->getIsSameDatabaseChecker($connection));
-            } catch (InvalidArgumentException) {


we still need catch the exception to not reintroduce the bug that #50761 tried to fix

MatTheCat · 2024-08-05T13:05:25Z

@xabbuh there was in fact no bug prior to #50761: it is normal an exception is thrown when giving the StoreFactory an invalid DSN, and it is outlined by the fact said exception extends LogicException, which is not supposed to be caught.

uwej711 · 2024-08-07T12:25:50Z

OK, so where do we go from here? Keep the current bug in 6.4, revert the commit that causes the bug and having the issue it tried to fix again or something else?

xabbuh · 2024-08-08T07:09:41Z

I would be okay with both solutions. Either reverting #50671 or switching to foreach). But the new null schema cannot be merged into 6.4 and must be moved into a PR targeting 7.2.

barton-webwings · 2024-08-08T08:30:38Z

I am closing this PR, as it is superseded by #57944.
I am actually only interested in the bugfix part of this issue, so we can remove the workaround after update.
If someone wants to make a PR for the new feature introduced, feel free.

…Cat) This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [DoctrineBridge] Fix the `LockStoreSchemaListener` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #54406 | License | MIT #54407 got sidetracked ~and `@barton`-webwings seems no longer active on GitHub~ so this PR takes over. Commits ------- db070a1 [DoctrineBridge] Fix the `LockStoreSchemaListener`

carsonbot added Status: Needs Review Bug Deprecation Feature labels Mar 26, 2024

carsonbot added this to the 6.4 milestone Mar 26, 2024

Revert "[DoctrineBridge] Ignore invalid stores in `LockStoreSchemaLis…

d6b4d84

…tener` raised by `StoreFactory`" This reverts commit 0acd403.

barton-webwings force-pushed the 6.4 branch from e65178d to d6b4d84 Compare March 27, 2024 13:02

nicolas-grekas added DoctrineBridge and removed Feature Deprecation labels Apr 11, 2024

nicolas-grekas changed the title ~~Fix LockStoreSchemaListener not working properly with iterable objects~~ [DoctrineBridge] Fix LockStoreSchemaListener not working properly with iterable objects Apr 11, 2024

barton-webwings added 2 commits April 12, 2024 11:39

[Lock] Add NullStore

adeae5a

[Lock] Add a case for the new NullStore to StoreFactory

a2d215a

barton-webwings requested a review from jderusse as a code owner April 12, 2024 10:28

[Lock] Add licence header to NullStore

e8c0279

alexandre-daubois approved these changes Apr 12, 2024

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Apr 12, 2024

xabbuh requested changes Aug 5, 2024

View reviewed changes

carsonbot removed the Status: Reviewed label Aug 5, 2024

carsonbot added the Status: Needs Work label Aug 5, 2024

MatTheCat mentioned this pull request Aug 8, 2024

[DoctrineBridge] Fix the LockStoreSchemaListener #57944

Merged

barton-webwings closed this Aug 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DoctrineBridge] Fix LockStoreSchemaListener not working properly with iterable objects #54407

[DoctrineBridge] Fix LockStoreSchemaListener not working properly with iterable objects #54407

barton-webwings commented Mar 26, 2024 •

edited

Loading

carsonbot commented Mar 26, 2024

MatTheCat commented Mar 26, 2024 •

edited

Loading

nicolas-grekas commented Apr 11, 2024

alexandre-daubois commented Apr 11, 2024 •

edited

Loading

barton-webwings commented Apr 12, 2024

alexandre-daubois commented Apr 12, 2024

barton-webwings commented Apr 12, 2024 •

edited

Loading

alexandre-daubois left a comment

nicolas-grekas commented Apr 12, 2024

Toflar commented Apr 25, 2024

MatTheCat commented May 4, 2024 •

edited

Loading

xabbuh Aug 5, 2024

xabbuh Aug 5, 2024

xabbuh Aug 5, 2024

MatTheCat commented Aug 5, 2024

uwej711 commented Aug 7, 2024

xabbuh commented Aug 8, 2024

barton-webwings commented Aug 8, 2024

[DoctrineBridge] Fix LockStoreSchemaListener not working properly with iterable objects #54407

[DoctrineBridge] Fix LockStoreSchemaListener not working properly with iterable objects #54407

Conversation

barton-webwings commented Mar 26, 2024 • edited Loading

carsonbot commented Mar 26, 2024

MatTheCat commented Mar 26, 2024 • edited Loading

nicolas-grekas commented Apr 11, 2024

alexandre-daubois commented Apr 11, 2024 • edited Loading

barton-webwings commented Apr 12, 2024

alexandre-daubois commented Apr 12, 2024

barton-webwings commented Apr 12, 2024 • edited Loading

alexandre-daubois left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Apr 12, 2024

Toflar commented Apr 25, 2024

MatTheCat commented May 4, 2024 • edited Loading

xabbuh Aug 5, 2024

Choose a reason for hiding this comment

xabbuh Aug 5, 2024

Choose a reason for hiding this comment

xabbuh Aug 5, 2024

Choose a reason for hiding this comment

MatTheCat commented Aug 5, 2024

uwej711 commented Aug 7, 2024

xabbuh commented Aug 8, 2024

barton-webwings commented Aug 8, 2024

barton-webwings commented Mar 26, 2024 •

edited

Loading

MatTheCat commented Mar 26, 2024 •

edited

Loading

alexandre-daubois commented Apr 11, 2024 •

edited

Loading

barton-webwings commented Apr 12, 2024 •

edited

Loading

MatTheCat commented May 4, 2024 •

edited

Loading