[5.3] [RFC] CMSPlugin: Lazy subscriber interface and decorator

[Fedik]

Summary of Changes

Adding LazySybscriber interface and decorator.
The decorator LazyServiceSubscriber allows to instantiate the plugin with heavy dependencies only when the event is actualy dispatched.
The interface LazySubscriberInterface also allows to use LazyServiceEventListener, hovewer the plugin should implement it on its own.

Example usage of the decorator for the plugin with heavy dependencies:

Code for plugins/system/example/services/provider.php.

Before:

return new class () implements ServiceProviderInterface {
  public function register(Container $container)
  {
    $container->set(
        PluginInterface::class,
        function (Container $container) {
            $heavyDependency1 = $container->get(Foo::class);
            $heavyDependency2 = $container->get(Bar::class);
            
            return new ExamplePlugin(
                $container->get(DispatcherInterface::class),
                (array) PluginHelper::getPlugin('system', 'example'),
                $heavyDependency1,
                $heavyDependency2
            );
        }
    );
  }
}

After:

return new class () implements ServiceProviderInterface {
  public function register(Container $container)
  {
    $container->set(
        ExamplePlugin::class,
        function (Container $container) {
            $heavyDependency1 = $container->get(Foo::class);
            $heavyDependency2 = $container->get(Bar::class);
            
            return new ExamplePlugin(
                $container->get(DispatcherInterface::class),
                (array) PluginHelper::getPlugin('system', 'example'),
                $heavyDependency1,
                $heavyDependency2
            );
        }
    )->set(
        PluginInterface::class,
        function (Container $container) {
            return new LazyServiceSubscriber($container, ExamplePlugin::class);
        }
    );
  }
}

The decorator can work very nicely with (in future):

• [6.2] [RFC] CMSPlugin: Subscriber Registration Checker Interface #43657

But I will update it depend what first will be merged this PR or that PR.

Testing Instructions

Code review by maintainers.

Check that following plugins works as before:

ScheduleRunner
TaskNotification
Webauthn

Actual result BEFORE applying this Pull Request

Works

Expected result AFTER applying this Pull Request

Works

Link to documentations

Please select:

• Documentation link for docs.joomla.org:
• No documentation changes for docs.joomla.org needed
• Pull Request link for manual.joomla.org: Info about Lazy Subscriber Manual#273
• No documentation changes for manual.joomla.org needed

References:

• [5.x][RFC] Plugins loading concept. Creating the plugin instance on demand (when the respective event is triggered) #43463

[HLeithner]

This pull request has been automatically rebased to 5.3-dev.

[Fedik]

I will redo this with Lazy Objects
Current approach is totally obsolete with PHP 8.4

[brianteeman]

But we still support earlier versions of PHP don't we?

[laoneo]

Would it not make more sense to have the whole DI container to support lazy objects? Like that, the plugins are only instantiated when actually used.

[Fedik]

But we still support earlier versions of PHP don't we?

I doubt this PR will be merged in 1-2 years, we have plenty of time 😄

Would it not make more sense to have the whole DI container to support lazy objects

I need to see a code or an example to say something about it. In theory maybe "yes".
But currently I hardly imagine how it can be done.

[Fedik]

Alternative pr is there:

• [6.1] CMSPlugin: use Lazy Object feature #45062