task: Preload singletons in idle state of job::execute

The worker object starst the JobCommandController without having
a message to execute and idles while waiting for th emessage.

This change loads all available singletons during the idle phase
so that they are present once a message is ready for execution.

Author: stephanschuler

Classes/SingletonPreloading/AllSingletonsPreloader.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace Netlogix\JobQueue\FastRabbit\SingletonPreloading;
+
+use Neos\Flow\Core\Bootstrap;
+use Neos\Flow\ObjectManagement\Configuration\Configuration;
+use Neos\Flow\ObjectManagement\ObjectManager;
+use Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Flow\Reflection\ReflectionService;
+use Neos\Flow\Annotations as Flow;
+use Throwable;
+
+use Traversable;
+
+use function array_filter;
+use function is_a;
+
+/**
+ * Fetch all known singleton classes from the ObjectManager to have
+ * all of them in the memory and ready to use.
+ *
+ * This should not be used "as is" because there's a high risk of
+ * creating singletons with expiring connections, like, for example,
+ * database connections.
+ *
+ * It's not enough to just exclude those database connections here
+ * because there might be other singletons depending on those connections
+ * through constructor injection, which triggers loading them anyway.
+ */
+class AllSingletonsPreloader implements SingletonsPreloader
+{
+    #[Flow\InjectConfiguration(path: 'AllSingletonsPreloader.ignoreClassNames', package: 'Netlogix.JobQueue.FastRabbit')]
+    protected array $ignoreClassNames = [];
+
+    public function __construct(
+        protected readonly ObjectManager $objectManager,
+        protected readonly ReflectionService $reflectionService
+    ) {
+    }
+
+    public function collect(): void
+    {
+        $objectManager = Bootstrap::$staticObjectManager;
+        foreach ($this->getSingletonClassNames($objectManager) as $className) {
+            try {
+                $objectManager->get($className);
+            } catch (Throwable $e) {
+                // ignore
+            }
+        }
+    }
+
+    /**
+     * @return Traversable<string>
+     */
+    public function getSingletonClassNames(ObjectManagerInterface $objectManager): Traversable
+    {
+        foreach (self::getSingletonClassNamesFromReflection($objectManager) as $className) {
+            foreach ($this->ignoreClassNames as $ignoredClassName) {
+                if (is_a($className, $ignoredClassName, true)) {
+                    continue;
+                }
+            }
+            yield $className;
+        }
+    }
+
+    #[Flow\CompileStatic]
+    public static function getSingletonClassNamesFromReflection(ObjectManagerInterface $objectManager): array
+    {
+        return array_filter(
+            array: $objectManager->get(ReflectionService::class)->getAllClassNames(),
+            callback: static function ($className) use ($objectManager): bool {
+                try {
+                    return $objectManager->getScope($className) === Configuration::SCOPE_SINGLETON;
+                } catch (\Exception $e) {
+                    return false;
+                }
+            }
+        );
+    }
+}

Classes/SingletonPreloading/JobCommandInitializationAspect.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Netlogix\JobQueue\FastRabbit\SingletonPreloading;
+
+use Flowpack\JobQueue\Common\Command\JobCommandController;
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Aop\JoinPointInterface;
+use Neos\Flow\Cli\Request;
+use Neos\Flow\Mvc\Controller;
+use Neos\Flow\ObjectManagement\ObjectManagerInterface;
+use Neos\Flow\Reflection\ClassReflection;
+
+#[Flow\Aspect]
+class JobCommandInitializationAspect
+{
+    public function __construct(
+        protected readonly ObjectManagerInterface $objectManager
+    ) {
+    }
+
+    #[Flow\AfterReturning('within(' . JobCommandController::class . ') && method(.*->initializeCommandMethodArguments())')]
+    public function preloadSingletonsWhenJobCommandControllerGetsInitialized(JoinPointInterface $joinPoint): void
+    {
+        $jobCommandController = $joinPoint->getProxy();
+        assert($jobCommandController instanceof JobCommandController);
+
+        $reflection = new ClassReflection($jobCommandController);
+
+        $commandMethodName = $reflection
+            ->getProperty('commandMethodName')
+            ->getValue($jobCommandController);
+
+        if ($commandMethodName !== 'executeCommand') {
+            return;
+        }
+
+        $request = $reflection
+            ->getProperty('request')
+            ->getValue($jobCommandController);
+        assert($request instanceof Request);
+
+        $arguments = $reflection
+            ->getProperty('arguments')
+            ->getValue($jobCommandController);
+        assert($arguments instanceof Controller\Arguments);
+
+        foreach ($arguments as $argument) {
+            assert($argument instanceof Controller\Argument);
+            if ($argument->isRequired() && !$request->hasArgument($argument->getName())) {
+                // only preload if the request is blocked by fetching an argument via stdin
+                $this->objectManager
+                    ->get(SingletonsPreloader::class)
+                    ->collect();
+                return;
+            }
+        }
+    }
+}

Classes/SingletonPreloading/SingletonsPreloader.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Netlogix\JobQueue\FastRabbit\SingletonPreloading;
+
+interface SingletonsPreloader
+{
+    public function collect(): void;
+}

Configuration/Settings.SingletonsPreloader.yaml

@@ -0,0 +1,14 @@
+Netlogix:
+  JobQueue:
+    FastRabbit:
+
+      AllSingletonsPreloader:
+        ignoreClassNames:
+          # cannot be preloaded due to missing constructor arguments
+          Neos\Flow\ObjectManagement\CompileTimeObjectManager:                           Neos\Flow\ObjectManagement\CompileTimeObjectManager
+          Neos\Flow\Property\TypeConverter\AbstractTypeConverter:                        Neos\Flow\Property\TypeConverter\AbstractTypeConverter
+          Neos\Flow\Security\Authentication\Controller\AbstractAuthenticationController: Neos\Flow\Security\Authentication\Controller\AbstractAuthenticationController
+          Neos\Flow\Session\Aspect\SessionObjectMethodsPointcutFilter:                   Neos\Flow\Session\Aspect\SessionObjectMethodsPointcutFilter
+          # must not be preloaded because they hold connections that can expire
+          Doctrine\DBAL\Connection:                                                      Doctrine\DBAL\Connection
+          Doctrine\ORM\EntityManagerInterface:                                           Doctrine\ORM\EntityManagerInterface