feat(FOUR-33043): Define a maxJobs and memory limit for BPMN and default

.env.example

@@ -33,6 +33,8 @@ TELESCOPE_ENABLED=false
 REDIS_CLIENT=predis
 REDIS_PREFIX=
 HORIZON_PREFIX=horizon:
+PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS=10
+PM4_HORIZON_SUPERVISOR_1_MAX_JOBS=100
 DOCKER_SHARED_MEMORY=256m
 PROXIES=*
 LOGOUT_OTHER_DEVICES=false

config/horizon.php

@@ -152,6 +152,7 @@
                 'minProcesses' => env('PM4_HORIZON_SUPERVISOR_BPMN_MIN_PROCESSES', 1),
                 'maxProcesses' => env('PM4_HORIZON_SUPERVISOR_BPMN_MAX_PROCESSES', 1),
                 'memory' => env('PM4_HORIZON_WORKER_MEMORY_LIMIT', 512),
+                'maxJobs' => (int) env('PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS', 10),
             ],
             'supervisor-1' => [
                 'connection' => 'redis',
@@ -162,6 +163,7 @@
                 'minProcesses' => env('PM4_HORIZON_SUPERVISOR_1_MIN_PROCESSES', 1),
                 'maxProcesses' => env('PM4_HORIZON_SUPERVISOR_1_MAX_PROCESSES', 1),
                 'memory' => env('PM4_HORIZON_WORKER_MEMORY_LIMIT', 512),
+                'maxJobs' => (int) env('PM4_HORIZON_SUPERVISOR_1_MAX_JOBS', 100),
             ],
         ],
 
@@ -176,6 +178,7 @@
                 'minProcesses' => env('PM4_HORIZON_SUPERVISOR_BPMN_MIN_PROCESSES', 1),
                 'maxProcesses' => env('PM4_HORIZON_SUPERVISOR_BPMN_MAX_PROCESSES', 1),
                 'memory' => env('PM4_HORIZON_WORKER_MEMORY_LIMIT', 512),
+                'maxJobs' => (int) env('PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS', 10),
             ],
             'supervisor-1' => [
                 'connection' => 'redis',
@@ -186,6 +189,7 @@
                 'minProcesses' => env('PM4_HORIZON_SUPERVISOR_1_MIN_PROCESSES', 1),
                 'maxProcesses' => env('PM4_HORIZON_SUPERVISOR_1_MAX_PROCESSES', 1),
                 'memory' => env('PM4_HORIZON_WORKER_MEMORY_LIMIT', 512),
+                'maxJobs' => (int) env('PM4_HORIZON_SUPERVISOR_1_MAX_JOBS', 100),
             ],
         ],
 
@@ -200,6 +204,7 @@
                 'minProcesses' => env('PM4_HORIZON_SUPERVISOR_BPMN_MIN_PROCESSES', 1),
                 'maxProcesses' => env('PM4_HORIZON_SUPERVISOR_BPMN_MAX_PROCESSES', 1),
                 'memory' => env('PM4_HORIZON_WORKER_MEMORY_LIMIT', 512),
+                'maxJobs' => (int) env('PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS', 10),
             ],
             'supervisor-1' => [
                 'connection' => 'redis',
@@ -210,6 +215,7 @@
                 'minProcesses' => env('PM4_HORIZON_SUPERVISOR_1_MIN_PROCESSES', 1),
                 'maxProcesses' => env('PM4_HORIZON_SUPERVISOR_1_MAX_PROCESSES', 1),
                 'memory' => env('PM4_HORIZON_WORKER_MEMORY_LIMIT', 512),
+                'maxJobs' => (int) env('PM4_HORIZON_SUPERVISOR_1_MAX_JOBS', 100),
             ],
         ],
     ],

tests/unit/Config/HorizonConfigTest.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit\Config;
+
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\DB;
+use ProcessMaker\Jobs\TestStatusJob;
+use Tests\TestCase;
+
+class HorizonConfigTest extends TestCase
+{
+    private const ENVIRONMENTS = ['production', 'local', 'staging'];
+
+    private const SUPERVISORS = ['supervisor-bpmn', 'supervisor-1'];
+
+    protected function tearDown(): void
+    {
+        $this->unsetMaxJobsEnvironmentVariables();
+
+        parent::tearDown();
+    }
+
+    public function testMaxJobsUsesRecommendedDefaultsForAllSupervisors(): void
+    {
+        $this->unsetMaxJobsEnvironmentVariables();
+
+        $configuration = include base_path('config/horizon.php'); // NOSONAR: load fresh config after changing environment variables.
+
+        foreach (self::ENVIRONMENTS as $environment) {
+            $this->assertSame(10, $configuration['environments'][$environment]['supervisor-bpmn']['maxJobs']);
+            $this->assertSame(100, $configuration['environments'][$environment]['supervisor-1']['maxJobs']);
+        }
+    }
+
+    public function testMaxJobsCanBeDisabledWithZero(): void
+    {
+        putenv('PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS=0');
+        putenv('PM4_HORIZON_SUPERVISOR_1_MAX_JOBS=0');
+
+        $configuration = include base_path('config/horizon.php'); // NOSONAR: load fresh config after changing environment variables.
+
+        foreach (self::ENVIRONMENTS as $environment) {
+            foreach (self::SUPERVISORS as $supervisor) {
+                $this->assertSame(
+                    0,
+                    $configuration['environments'][$environment][$supervisor]['maxJobs'],
+                    "{$environment}.{$supervisor} should allow maxJobs to be disabled"
+                );
+            }
+        }
+    }
+
+    public function testMaxJobsCanBeConfiguredAsTwoForBpmnAndDefaultSupervisors(): void
+    {
+        putenv('PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS=2');
+        putenv('PM4_HORIZON_SUPERVISOR_1_MAX_JOBS=2');
+
+        $configuration = include base_path('config/horizon.php'); // NOSONAR: load fresh config after changing environment variables.
+
+        foreach (self::ENVIRONMENTS as $environment) {
+            foreach (self::SUPERVISORS as $supervisor) {
+                $this->assertSame(
+                    2,
+                    $configuration['environments'][$environment][$supervisor]['maxJobs'],
+                    "{$environment}.{$supervisor} should use the configured maxJobs value"
+                );
+            }
+        }
+    }
+
+    public function testFiveJobsContinueProcessingAcrossWorkersWithMaxJobsTwo(): void
+    {
+        $queue = 'maxjobs-test-' . bin2hex(random_bytes(4));
+        $jobPrefix = 'maxjobs-test-' . bin2hex(random_bytes(4));
+        $maxJobs = 2;
+
+        Config::set('queue.default', 'redis');
+        Config::set('horizon.environments.local.supervisor-bpmn.maxJobs', $maxJobs);
+
+        foreach (range(1, 5) as $number) {
+            TestStatusJob::dispatch(
+                "{$jobPrefix}-{$number}",
+                'Horizon maxJobs integration test'
+            )->onQueue($queue);
+        }
+
+        foreach ([2, 4, 5] as $expectedCount) {
+            $exitCode = Artisan::call('queue:work', [
+                'connection' => 'redis',
+                '--queue' => $queue,
+                '--max-jobs' => $maxJobs,
+                '--stop-when-empty' => true,
+                '--tries' => 1,
+                '--memory' => 1024,
+            ]);
+
+            $this->assertSame(0, $exitCode);
+            $this->assertSame(
+                $expectedCount,
+                DB::table('test_status')
+                    ->where('name', 'like', "{$jobPrefix}-%")
+                    ->count()
+            );
+        }
+    }
+
+    private function unsetMaxJobsEnvironmentVariables(): void
+    {
+        putenv('PM4_HORIZON_SUPERVISOR_BPMN_MAX_JOBS');
+        putenv('PM4_HORIZON_SUPERVISOR_1_MAX_JOBS');
+    }
+}