Add job options and retry strategy constants, add missing recurrence methods

Author: rybakit

README.md

@@ -18,9 +18,11 @@ composer require tarantool/jobbuilder
 use Tarantool\JobQueue\JobBuilder\JobBuilder;
 
 ...
+
 $task = JobBuilder::fromService('service_foo', ['bar', 'baz'])
     ->withConstantBackoff()
     ->withMaxRetries(3)
+    ->withRecurrenceInterval(60)
     ->withTimeToExecute(5)
     ->withTimeToRun(300)
     ->withPriority(4)

src/JobBuilder.php

@@ -26,8 +26,8 @@ class JobBuilder
     public static function fromService(string $serviceId, array $serviceArgs = []) : self
     {
         $self = new self();
-        $self->payload['service'] = $serviceId;
-        $self->payload['args'] = $serviceArgs;
+        $self->payload[JobOptions::PAYLOAD_SERVICE_ID] = $serviceId;
+        $self->payload[JobOptions::PAYLOAD_SERVICE_ARGS] = $serviceArgs;
 
         return $self;
     }
@@ -45,48 +45,64 @@ public function withServiceArg($value, $key = null) : self
         $new = clone $this;
 
         (null === $key)
-            ? $new->payload['args'][] = $value
-            : $new->payload['args'][$key] = $value;
+            ? $new->payload[JobOptions::PAYLOAD_SERVICE_ARGS][] = $value
+            : $new->payload[JobOptions::PAYLOAD_SERVICE_ARGS][$key] = $value;
 
         return $new;
     }
 
     public function withConstantBackoff() : self
     {
         $new = clone $this;
-        $new->jobOptions['retry_strategy'] = 'constant';
+        $new->jobOptions[JobOptions::RETRY_STRATEGY] = RetryStrategies::CONSTANT;
 
         return $new;
     }
 
     public function withExponentialBackoff() : self
     {
         $new = clone $this;
-        $new->jobOptions['retry_strategy'] = 'exponential';
+        $new->jobOptions[JobOptions::RETRY_STRATEGY] = RetryStrategies::EXPONENTIAL;
 
         return $new;
     }
 
     public function withLinearBackoff() : self
     {
         $new = clone $this;
-        $new->jobOptions['retry_strategy'] = 'linear';
+        $new->jobOptions[JobOptions::RETRY_STRATEGY] = RetryStrategies::LINEAR;
 
         return $new;
     }
 
     public function withMaxRetries(int $maxRetries) : self
     {
         $new = clone $this;
-        $new->jobOptions['retry_limit'] = $maxRetries;
+        $new->jobOptions[JobOptions::RETRY_LIMIT] = $maxRetries;
 
         return $new;
     }
 
     public function withDisabledRetries() : self
     {
         $new = clone $this;
-        $new->jobOptions['retry_limit'] = 0;
+        $new->jobOptions[JobOptions::RETRY_LIMIT] = 0;
+
+        return $new;
+    }
+
+    public function withRecurrenceInterval(int $interval) : self
+    {
+        $new = clone $this;
+        $new->jobOptions[JobOptions::RECURRENCE] = $interval;
+
+        return $new;
+    }
+
+    public function withDisabledRecurrence() : self
+    {
+        $new = clone $this;
+        unset($new->jobOptions[JobOptions::RECURRENCE]);
 
         return $new;
     }
@@ -134,7 +150,7 @@ public function withTube(string $tube) : self
     public function build() : array
     {
         return [
-            \array_merge(['payload' => $this->payload], $this->jobOptions),
+            \array_merge([JobOptions::PAYLOAD => $this->payload], $this->jobOptions),
             $this->taskOptions,
         ];
     }

src/JobOptions.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Tarantool JobBuilder package.
+ *
+ * (c) Eugene Leonovich <gen.work@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tarantool\JobQueue\JobBuilder;
+
+final class JobOptions
+{
+    public const PAYLOAD = 'payload';
+    public const PAYLOAD_SERVICE_ID = 'service';
+    public const PAYLOAD_SERVICE_METHOD = 'method';
+    public const PAYLOAD_SERVICE_ARGS = 'args';
+    public const RETRY_LIMIT = 'retry_limit';
+    public const RETRY_ATTEMPT = 'retry_attempt';
+    public const RETRY_STRATEGY = 'retry_strategy';
+    public const RECURRENCE = 'recurrence';
+
+    private function __construct()
+    {
+    }
+}

src/RetryStrategies.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Tarantool JobBuilder package.
+ *
+ * (c) Eugene Leonovich <gen.work@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tarantool\JobQueue\JobBuilder;
+
+final class RetryStrategies
+{
+    public const CONSTANT = 'constant';
+    public const EXPONENTIAL = 'exponential';
+    public const LINEAR = 'linear';
+
+    private function __construct()
+    {
+    }
+}

tests/JobBuilderTest.php

@@ -32,6 +32,7 @@ public function testBuildFull() : void
         [$data, $taskOptions] = JobBuilder::fromService('service_foo', ['bar', 'baz'])
             ->withConstantBackoff()
             ->withMaxRetries(3)
+            ->withRecurrenceInterval(60)
             ->withTimeToExecute(5)
             ->withTimeToRun(300)
             ->withPriority(4)
@@ -46,6 +47,7 @@ public function testBuildFull() : void
             ],
             'retry_strategy' => 'constant',
             'retry_limit' => 3,
+            'recurrence' => 60,
         ], $data);
 
         self::assertSame([