Merge pull request #47 from mcpuishor/main

Add queue support for Slack alerts

README.md

@@ -127,6 +127,25 @@ use Spatie\SlackAlerts\Facades\SlackAlert;
 SlackAlert::toChannel('subscription_alerts')->message("You have a new subscriber to the {$newsletter->name} newsletter!");
 ```
 
+## Queuing
+By default, messages are sent by dispatching the job to the `default` queue. 
+
+### Configuring the queue
+In `.env` file, add
+
+```dotenv
+SLACK_ALERT_QUEUE=queue_name
+```
+
+### Changing the queue at runtime
+You can queue the job to a different queue than the one defined in config by passing it to the `onQueue` function.
+
+```php
+use Spatie\SlackAlerts\Facades\SlackAlert;
+
+SlackAlert::onQueue('some-queue')->message("Some message.");
+```
+
 ## Formatting
 
 ### Markdown

config/slack-alerts.php

@@ -13,4 +13,5 @@
      * job to set timeouts, retries, etc...
      */
     'job' => Spatie\SlackAlerts\Jobs\SendToSlackChannelJob::class,
+    'queue' => env('SLACK_ALERT_QUEUE', 'default'),
 ];

src/Config.php

@@ -37,4 +37,15 @@ public static function getWebhookUrl(string $name): string|null
 
         return $url;
     }
+
+    public static function getQueue(): string|null
+    {
+        $queue = config('slack-alerts.queue');
+
+        if (! $queue) {
+            return null;
+        }
+
+        return $queue;
+    }
 }

src/SlackAlert.php

@@ -7,6 +7,8 @@ class SlackAlert
     protected string $webhookUrlName = 'default';
     protected ?string $channel = null;
 
+    protected ?string $queue = null;
+
     public function to(string $webhookUrlName): self
     {
         $this->webhookUrlName = $webhookUrlName;
@@ -21,6 +23,13 @@ public function toChannel(string $channel): self
         return $this;
     }
 
+    public function onQueue(string $queue): self
+    {
+        $this->queue = $queue;
+
+        return $this;
+    }
+
     public function message(string $text): void
     {
         $webhookUrl = Config::getWebhookUrl($this->webhookUrlName);
@@ -35,7 +44,9 @@ public function message(string $text): void
             'channel' => $this->channel,
         ]);
 
-        dispatch($job);
+        dispatch(
+            $job->onQueue( $this->queue ?? Config::getQueue() )
+        );
     }
 
     public function blocks(array $blocks): void
@@ -52,6 +63,8 @@ public function blocks(array $blocks): void
             'channel' => $this->channel,
         ]);
 
-        dispatch($job);
+        dispatch(
+            $job->onQueue( $this->queue ?? Config::getQueue() )
+        );
     }
 }

tests/SlackAlertsTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Support\Facades\Bus;
+use Illuminate\Support\Facades\Queue;
 use Spatie\SlackAlerts\Exceptions\JobClassDoesNotExist;
 use Spatie\SlackAlerts\Exceptions\WebhookUrlNotValid;
 use Spatie\SlackAlerts\Facades\SlackAlert;
@@ -82,3 +83,25 @@
 
     SlackAlert::message('test-data');
 })->throws(JobClassDoesNotExist::class);
+
+it('can send a message via a queue set in config file ', function(string $queue){
+    config()->set('slack-alerts.webhook_urls.default', 'https://test-domain.com');
+    config()->set('slack-alerts.queue', $queue);
+
+    SlackAlert::message('test-data');
+
+    Bus::assertDispatched( SendToSlackChannelJob::class);
+})->with([
+    'default', 'my-queue'
+]);
+
+it('can send a message via a queue set at runtime ', function(string $queue){
+    config()->set('slack-alerts.webhook_urls.default', 'https://test-domain.com');
+    config()->set('slack-alerts.queue', 'custom-queue');
+
+    SlackAlert::onQueue( $queue )->message('test-data');
+
+    Bus::assertDispatched( SendToSlackChannelJob::class);
+})->with([
+    'default', 'my-queue'
+]);