[12.x] perf: support iterables for event discovery paths #55699

calebdw · 2025-05-09T19:30:25Z

Hello!

This adds support for passing iterables to discover events. It also improves the performance of the event discovery by allowing multiple directories to be passed to DiscoverEvents::within().

Motivation

We have many modules and want to discover all listeners in a Listeners directory, to do that we have the following:

// bootstrap/app.php
return Application::configure(basePath: dirname(__DIR__))
    ->withEvents(array_keys(iterator_to_array(
        Finder::create()
            ->directories()
            ->in([base_path('modules')])
            ->path('Listeners'),
    )))
    // ...

However, the problem is that the file system is walked on every request (adding ~30ms to the boot time) and this argument isn't even used when the events are cached---in short this is a wasted operation in production.

This PR will allow for something like the following (which does not walk the file system if the events are cached):

// bootstrap/app.php
return Application::configure(basePath: dirname(__DIR__))
    ->withEvents(new LazyCollection(
        fn () => Finder::create()
            ->directories()
            ->in([base_path('modules')])
            ->path('Listeners')
    )->keys())
    // ...

Thanks!

taylorotwell · 2025-05-10T17:50:46Z

Can you revert all of the styling changes so it's easier to see the real changes.

calebdw · 2025-05-10T18:19:05Z

Yes, reverted

taylorotwell · 2025-05-10T18:24:31Z

src/Illuminate/Foundation/Support/Providers/EventServiceProvider.php

-                    $discovered,
-                    DiscoverEvents::within($directory, $this->eventDiscoveryBasePath())
-                );
-            }, []);


This array_merge_recursive can be totally removed? Does this not break anything?

Yes because the DiscoverEvents::within() does the same thing with its double foreach loops:

framework/src/Illuminate/Foundation/Events/DiscoverEvents.php

Lines 30 to 49 in ea17178

public static function within($listenerPath, $basePath)

{

$listeners = new Collection(static::getListenerEvents(

Finder::create()->files()->in($listenerPath), $basePath

));

$discoveredEvents = [];

foreach ($listeners as $listener => $events) {

foreach ($events as $event) {

if (! isset($discoveredEvents[$event])) {

$discoveredEvents[$event] = [];

}

$discoveredEvents[$event][] = $listener;

}

}

return $discoveredEvents;

}

The Finder::in() method can accept an array and we're able to process all the listeners at once instead of repeated calls for every directory and then having to merge all of the arrays into one large array

calebdw · 2025-05-10T19:31:07Z

Thanks!

calebdw force-pushed the calebdw/push-zlwtltklxypn branch 7 times, most recently from 30a132d to 0584d85 Compare May 9, 2025 19:51

taylorotwell marked this pull request as draft May 10, 2025 17:51

feat: support iterables for event discovery paths

07749cf

calebdw force-pushed the calebdw/push-zlwtltklxypn branch from 0584d85 to 07749cf Compare May 10, 2025 18:18

calebdw marked this pull request as ready for review May 10, 2025 18:18

taylorotwell reviewed May 10, 2025

View reviewed changes

taylorotwell merged commit bcfa7c3 into laravel:12.x May 10, 2025
58 checks passed

calebdw deleted the calebdw/push-zlwtltklxypn branch May 10, 2025 19:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[12.x] perf: support iterables for event discovery paths #55699

[12.x] perf: support iterables for event discovery paths #55699

	public static function within($listenerPath, $basePath)
	{
	$listeners = new Collection(static::getListenerEvents(
	Finder::create()->files()->in($listenerPath), $basePath
	));

	$discoveredEvents = [];

	foreach ($listeners as $listener => $events) {
	foreach ($events as $event) {
	if (! isset($discoveredEvents[$event])) {
	$discoveredEvents[$event] = [];
	}

	$discoveredEvents[$event][] = $listener;
	}
	}

	return $discoveredEvents;
	}

[12.x] perf: support iterables for event discovery paths #55699

[12.x] perf: support iterables for event discovery paths #55699

Conversation

Motivation

Choose a reason for hiding this comment

Choose a reason for hiding this comment