[12.x] Add ability to control QueueWorker memory exceeded exit code (#57044)

* init

* Update WorkCommand.php

* cs

* fix up test

* init

* Update WorkCommandTest.php

* try fix flakiness

* cs

* Update WorkCommandTest.php

* Update WorkCommandTest.php

* readd const to prevent breaking change

:trollface:

* use variable

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: jackbayliss

src/Illuminate/Queue/Console/WorkCommand.php

@@ -168,7 +168,7 @@ protected function gatherWorkerOptions()
             $this->option('stop-when-empty'),
             $this->option('max-jobs'),
             $this->option('max-time'),
-            $this->option('rest')
+            $this->option('rest'),
         );
     }
 

src/Illuminate/Queue/Worker.php

@@ -99,6 +99,13 @@ class Worker
      */
     protected static $popCallbacks = [];
 
+    /**
+     * The custom exit code to be used when memory is exceeded.
+     *
+     * @var int|null
+     */
+    public static $memoryExceededExitCode;
+
     /**
      * Create a new queue worker.
      *
@@ -307,7 +314,7 @@ protected function stopIfNecessary(WorkerOptions $options, $lastRestart, $startT
     {
         return match (true) {
             $this->shouldQuit => static::EXIT_SUCCESS,
-            $this->memoryExceeded($options->memory) => static::EXIT_MEMORY_LIMIT,
+            $this->memoryExceeded($options->memory) => static::$memoryExceededExitCode ?: static::EXIT_MEMORY_LIMIT,
             $this->queueShouldRestart($lastRestart) => static::EXIT_SUCCESS,
             $options->stopWhenEmpty && is_null($job) => static::EXIT_SUCCESS,
             $options->maxTime && hrtime(true) / 1e9 - $startTime >= $options->maxTime => static::EXIT_SUCCESS,

tests/Integration/Queue/WorkCommandTest.php

@@ -7,6 +7,7 @@
 use Illuminate\Database\UniqueConstraintViolationException;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Queue\Worker;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\Exceptions;
@@ -162,6 +163,27 @@ public function testMaxTimeExceeded()
         $this->assertFalse(SecondJob::$ran);
     }
 
+    public function testMemoryExitCode()
+    {
+        $this->markTestSkippedWhenUsingQueueDrivers(['redis', 'beanstalkd']);
+
+        Worker::$memoryExceededExitCode = 25;
+
+        Queue::push(new FirstJob);
+        Queue::push(new SecondJob);
+
+        $this->artisan('queue:work', [
+            '--memory' => 0.1,
+        ])->assertExitCode(25);
+
+        // Memory limit isn't checked until after the first job is attempted.
+        $this->assertSame(1, Queue::size());
+        $this->assertTrue(FirstJob::$ran);
+        $this->assertFalse(SecondJob::$ran);
+
+        Worker::$memoryExceededExitCode = null;
+    }
+
     public function testFailedJobListenerOnlyRunsOnce()
     {
         $this->markTestSkippedWhenUsingQueueDrivers(['redis', 'beanstalkd']);