[9.x] Avoid mutating the $expectedLitener
between loops on Event::assertListening
#46095
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After upgrading from Laravel
8.x
to9.x
, some of the assertions for theassertListening
failed randomly.I observed that when iteration over the listeners for a given event, if a
Class[@]method
callback (PostAutoEventSubscriber::class . '@handle'
) string is evaluated before any class-based listener (PostAutoEventSubscriber::class
), it causes the assertion to fail wrongfully.This happens because after the callback string is evaluated, the
$expectedListener
is normalized for the comparison. It causes the subsequent iteration to compare the$actualListener
with the changed$expectedListener
from the previous one.You can attest that by changing the order in which the listeners are bound in the
tests/Integration/Events/EventFakeTest.php
from:To:
To solve the issue, we're just "caching" the normalized form of the expected listeners to avoid mutability between the iteration loops.