Merge branch '8.x'

Author: GrahamCampbell

CHANGELOG-6.x.md

@@ -6,6 +6,7 @@
 use Illuminate\Console\ConfirmableTrait;
 use Illuminate\Database\ConnectionResolverInterface as Resolver;
 use Illuminate\Database\Eloquent\Model;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
 
 class SeedCommand extends Command
@@ -90,7 +91,7 @@ public function handle()
      */
     protected function getSeeder()
     {
-        $class = $this->input->getOption('class');
+        $class = $this->input->getArgument('class') ?? $this->input->getOption('class');
 
         if (strpos($class, '\\') === false) {
             $class = 'Database\\Seeders\\'.$class;
@@ -118,6 +119,18 @@ protected function getDatabase()
         return $database ?: $this->laravel['config']['database.default'];
     }
 
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return [
+            ['class', InputArgument::OPTIONAL, 'The class name of the root seeder', null],
+        ];
+    }
+
     /**
      * Get the console command options.
      *

src/Illuminate/Database/Console/Seeds/SeedCommand.php

@@ -119,7 +119,7 @@ public function discoverEvents()
                     ->reduce(function ($discovered, $directory) {
                         return array_merge_recursive(
                             $discovered,
-                            DiscoverEvents::within($directory, base_path())
+                            DiscoverEvents::within($directory, $this->eventDiscoveryBasePath())
                         );
                     }, []);
     }
@@ -135,4 +135,14 @@ protected function discoverEventsWithin()
             $this->app->path('Listeners'),
         ];
     }
+
+    /**
+     * Get the base path to be used during event discovery.
+     *
+     * @return string
+     */
+    protected function eventDiscoveryBasePath()
+    {
+        return base_path();
+    }
 }

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

@@ -33,6 +33,7 @@ class WorkCommand extends Command
                             {--force : Force the worker to run even in maintenance mode}
                             {--memory=128 : The memory limit in megabytes}
                             {--sleep=3 : Number of seconds to sleep when no job is available}
+                            {--rest=0 : Number of seconds to rest between jobs}
                             {--timeout=60 : The number of seconds a child process can run}
                             {--tries=1 : Number of times to attempt a job before logging it failed}';
 
@@ -143,7 +144,8 @@ protected function gatherWorkerOptions()
             $this->option('force'),
             $this->option('stop-when-empty'),
             $this->option('max-jobs'),
-            $this->option('max-time')
+            $this->option('max-time'),
+            $this->option('rest')
         );
     }
 

src/Illuminate/Queue/Console/WorkCommand.php

@@ -8,6 +8,20 @@
 
 class ThrottlesExceptions
 {
+    /**
+     * The developer specified key that the rate limiter should use.
+     *
+     * @var string
+     */
+    protected $key;
+
+    /**
+     * Indicates whether the throttle key should use the job's UUID.
+     *
+     * @var bool
+     */
+    protected $byJob = false;
+
     /**
      * The maximum number of attempts allowed before rate limiting applies.
      *
@@ -27,14 +41,7 @@ class ThrottlesExceptions
      *
      * @var int
      */
-    protected $retryAfterMinutes;
-
-    /**
-     * The rate limiter key.
-     *
-     * @var string
-     */
-    protected $key;
+    protected $retryAfterMinutes = 0;
 
     /**
      * The callback that determines if rate limiting should apply.
@@ -48,7 +55,7 @@ class ThrottlesExceptions
      *
      * @var string
      */
-    protected $prefix = 'circuit_breaker:';
+    protected $prefix = 'laravel_throttles_exceptions:';
 
     /**
      * The rate limiter instance.
@@ -62,15 +69,13 @@ class ThrottlesExceptions
      *
      * @param  int  $maxAttempts
      * @param  int  $decayMinutes
-     * @param  int  $retryAfterMinutes
      * @param  string  $key
+     * @return void
      */
-    public function __construct($maxAttempts = 10, $decayMinutes = 10, $retryAfterMinutes = 0, string $key = '')
+    public function __construct($maxAttempts = 10, $decayMinutes = 10)
     {
         $this->maxAttempts = $maxAttempts;
         $this->decayMinutes = $decayMinutes;
-        $this->retryAfterMinutes = $retryAfterMinutes;
-        $this->key = $key;
     }
 
     /**
@@ -129,6 +134,19 @@ public function withPrefix(string $prefix)
         return $this;
     }
 
+    /**
+     * Specify the number of seconds a job should be delayed when it is released (before it has reached its max exceptions).
+     *
+     * @param  int  $backoff
+     * @return $this
+     */
+    public function backoff($backoff)
+    {
+        $this->retryAfterMinutes = $backoff;
+
+        return $this;
+    }
+
     /**
      * Get the cache key associated for the rate limiter.
      *
@@ -137,7 +155,38 @@ public function withPrefix(string $prefix)
      */
     protected function getKey($job)
     {
-        return $this->prefix.md5(empty($this->key) ? get_class($job) : $this->key);
+        if ($this->key) {
+            return $this->prefix.$this->key;
+        } elseif ($this->byJob) {
+            return $this->prefix.$job->job->uuid();
+        }
+
+        return $this->prefix.md5(get_class($job));
+    }
+
+    /**
+     * Set the value that the rate limiter should be keyed by.
+     *
+     * @param  string  $key
+     * @return $this
+     */
+    public function by($key)
+    {
+        $this->key = $key;
+
+        return $this;
+    }
+
+    /**
+     * Indicate that the throttle key should use the job's UUID.
+     *
+     * @return $this
+     */
+    public function byJob()
+    {
+        $this->byJob = true;
+
+        return $this;
     }
 
     /**

src/Illuminate/Queue/Middleware/ThrottlesExceptions.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Illuminate\Queue\Middleware;
+
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Redis\Factory as Redis;
+use Illuminate\Redis\Limiters\DurationLimiter;
+use Illuminate\Support\InteractsWithTime;
+use Throwable;
+
+class ThrottlesExceptionsWithRedis extends ThrottlesExceptions
+{
+    use InteractsWithTime;
+
+    /**
+     * The Redis factory implementation.
+     *
+     * @var \Illuminate\Contracts\Redis\Factory
+     */
+    protected $redis;
+
+    /**
+     * The rate limiter instance.
+     *
+     * @var \Illuminate\Redis\Limiters\DurationLimiter
+     */
+    protected $limiter;
+
+    /**
+     * Process the job.
+     *
+     * @param  mixed  $job
+     * @param  callable  $next
+     * @return mixed
+     */
+    public function handle($job, $next)
+    {
+        $this->redis = Container::getInstance()->make(Redis::class);
+
+        $this->limiter = new DurationLimiter(
+            $this->redis, $this->getKey($job), $this->maxAttempts, $this->decayMinutes * 60
+        );
+
+        if ($this->limiter->tooManyAttempts()) {
+            return $job->release($this->limiter->decaysAt - $this->currentTime());
+        }
+
+        try {
+            $next($job);
+
+            $this->limiter->clear();
+        } catch (Throwable $throwable) {
+            if ($this->whenCallback && ! call_user_func($this->whenCallback, $throwable)) {
+                throw $throwable;
+            }
+
+            $this->limiter->acquire();
+
+            return $job->release($this->retryAfterMinutes * 60);
+        }
+    }
+}

src/Illuminate/Queue/Middleware/ThrottlesExceptionsWithRedis.php

@@ -156,6 +156,10 @@ public function daemon($connectionName, $queue, WorkerOptions $options)
                 $jobsProcessed++;
 
                 $this->runJob($job, $connectionName, $options);
+
+                if ($options->rest > 0) {
+                    $this->sleep($options->rest);
+                }
             } else {
                 $this->sleep($options->sleep);
             }

src/Illuminate/Queue/Worker.php

@@ -39,6 +39,13 @@ class WorkerOptions
      */
     public $sleep;
 
+    /**
+     * The number of seconds to rest between jobs.
+     *
+     * @var int
+     */
+    public $rest;
+
     /**
      * The maximum amount of times a job may be attempted.
      *
@@ -87,14 +94,16 @@ class WorkerOptions
      * @param  bool  $stopWhenEmpty
      * @param  int  $maxJobs
      * @param  int  $maxTime
+     * @param  int  $rest
      * @return void
      */
     public function __construct($name = 'default', $backoff = 0, $memory = 128, $timeout = 60, $sleep = 3, $maxTries = 1,
-                                $force = false, $stopWhenEmpty = false, $maxJobs = 0, $maxTime = 0)
+                                $force = false, $stopWhenEmpty = false, $maxJobs = 0, $maxTime = 0, $rest = 0)
     {
         $this->name = $name;
         $this->backoff = $backoff;
         $this->sleep = $sleep;
+        $this->rest = $rest;
         $this->force = $force;
         $this->memory = $memory;
         $this->timeout = $timeout;

src/Illuminate/Queue/WorkerOptions.php

@@ -111,6 +111,30 @@ public function acquire()
         return (bool) $results[0];
     }
 
+    /**
+     * Determine if the key has been "accessed" too many times.
+     *
+     * @return bool
+     */
+    public function tooManyAttempts()
+    {
+        [$this->decaysAt, $this->remaining] = $this->redis->eval(
+            $this->tooManyAttemptsLuaScript(), 1, $this->name, microtime(true), time(), $this->decay, $this->maxLocks
+        );
+
+        return $this->remaining <= 0;
+    }
+
+    /**
+     * Clear the limiter.
+     *
+     * @return void
+     */
+    public function clear()
+    {
+        $this->redis->del($this->name);
+    }
+
     /**
      * Get the Lua script for acquiring a lock.
      *
@@ -143,6 +167,36 @@ protected function luaScript()
 end
 
 return {reset(), ARGV[2] + ARGV[3], ARGV[4] - 1}
+LUA;
+    }
+
+    /**
+     * Get the Lua script to determine if the key has been "accessed" too many times.
+     *
+     * KEYS[1] - The limiter name
+     * ARGV[1] - Current time in microseconds
+     * ARGV[2] - Current time in seconds
+     * ARGV[3] - Duration of the bucket
+     * ARGV[4] - Allowed number of tasks
+     *
+     * @return string
+     */
+    protected function tooManyAttemptsLuaScript()
+    {
+        return <<<'LUA'
+
+if redis.call('EXISTS', KEYS[1]) == 0 then
+    return {0, ARGV[2] + ARGV[3]}
+end
+
+if ARGV[1] >= redis.call('HGET', KEYS[1], 'start') and ARGV[1] <= redis.call('HGET', KEYS[1], 'end') then
+    return {
+        redis.call('HGET', KEYS[1], 'end'),
+        ARGV[4] - redis.call('HGET', KEYS[1], 'count')
+    }
+end
+
+return {0, ARGV[2] + ARGV[3]}
 LUA;
     }
 }