Merge pull request #50 from igoptx/feature/addDelay

Add functions to delay the job that delivers the message

README.md

@@ -127,6 +127,19 @@ use Spatie\DiscordAlerts\Facades\DiscordAlert;
 DiscordAlert::to('https://custom-url.com')->message("You have a new subscriber to the {$newsletter->name} newsletter!");
 ```
 
+### Using the delay feature
+
+The `delayMinutes` of the `delayHours` function can be used to delay the message to Discord and can be used in parallel.
+
+```php
+use Spatie\DiscordAlerts\Facades\DiscordAlert;
+
+DiscordAlert::to('https://custom-url.com')->delayMinutes(5)->message("You have a new subscriber to the {$newsletter->name} newsletter!");
+DiscordAlert::to('https://custom-url.com')->delayHours(1)->message("You have a new subscriber to the {$newsletter->name} newsletter!");
+
+DiscordAlert::to('https://custom-url.com')->delayHours(1)->delayMinutes(10)->message("You have a new subscriber to the {$newsletter->name} newsletter!");
+```
+
 ## Formatting
 
 ### Markdown

src/DiscordAlert.php

@@ -6,9 +6,24 @@ class DiscordAlert
 {
     protected string $webhookUrlName = 'default';
 
+    protected int $delay = 0; // minutes
+
     public function to(string $webhookUrlName): self
     {
         $this->webhookUrlName = $webhookUrlName;
+        $this->delay = 0;
+
+        return $this;
+    }
+
+    public function delayMinutes(int $minutes = 0){
+        $this->delay+= $minutes;
+
+        return $this;
+    }
+
+    public function delayHours(int $hours = 0){
+        $this->delay+= $hours * 60;
 
         return $this;
     }
@@ -37,7 +52,7 @@ public function message(string $text, array $embeds = []): void
 
         $job = Config::getJob($jobArguments);
 
-        dispatch($job)->onConnection(Config::getConnection());
+        dispatch($job)->delay(now()->addMinutes($this->delay))->onConnection(Config::getConnection());
     }
 
     private function parseNewline(string $text): string

src/Facades/DiscordAlert.php

@@ -6,6 +6,8 @@
 
 /**
  * @method static self to(string $text)
+ * @method static self delayMinutes(int $minutes)
+ * @method static self delayHours(int $hours)
  * @method static void message(string $text, array $embeds = null)
  *
  * @see \Spatie\DiscordAlerts\DiscordAlert

tests/DiscordAlertsTest.php

@@ -104,3 +104,33 @@
         return $job->text === "test " . PHP_EOL . " data" && count($job->embeds);
     });
 });
+
+it('can delay a message by minutes', function () {
+    config()->set('discord-alerts.webhook_urls.default', 'https://test-domain.com');
+
+    DiscordAlert::delayMinutes(10)->message('test-data');
+
+    Bus::assertDispatched(SendToDiscordChannelJob::class, function ($job) {
+        return $job->delay === 10;
+    });
+});
+
+it('can delay a message by hours', function () {
+    config()->set('discord-alerts.webhook_urls.default', 'https://test-domain.com');
+
+    DiscordAlert::delayHours(1)->message('test-data');
+
+    Bus::assertDispatched(SendToDiscordChannelJob::class, function ($job) {
+        return $job->delay === 60;
+    });
+});
+
+it('can delay a message by hours and minutes', function () {
+    config()->set('discord-alerts.webhook_urls.default', 'https://test-domain.com');
+
+    DiscordAlert::delayHours(1)->delayMinutes(10)->message('test-data');
+
+    Bus::assertDispatched(SendToDiscordChannelJob::class, function ($job) {
+        return $job->delay === 70;
+    });
+});