Refactor the channels and add log channel

guanguans · guanguans · commit 26bf3928ff5b · 2022-03-13T17:58:04.000+08:00
diff --git a/src/Channels/ChanifyChannel.php b/src/Channels/ChanifyChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\ChanifyClient;
 use Guanguans\Notify\Messages\Chanify\TextMessage;
 
 class ChanifyChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\ChanifyClient
+     */
+    protected $client;
+
+    public function __construct(ChanifyClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $report)
     {
         return new TextMessage([
diff --git a/src/Channels/Channel.php b/src/Channels/Channel.php
@@ -12,56 +12,14 @@
 
 use Guanguans\LaravelExceptionNotify\Contracts\Channel as ChannelContract;
 use Guanguans\LaravelExceptionNotify\Support\Traits\CreateStatic;
-use Guanguans\Notify\Clients\Client;
-use Illuminate\Pipeline\Pipeline;
 use Illuminate\Support\Str;
 
 abstract class Channel implements ChannelContract
 {
     use CreateStatic;
 
-    /**
-     * @var \Guanguans\Notify\Clients\Client
-     */
-    protected $client;
-
-    public function __construct(Client $client)
-    {
-        $this->client = $client;
-    }
-
-    public function report(string $report)
-    {
-        $report = $this->handleReport($report);
-
-        return $this
-            ->client
-            ->setMessage($this->createMessage($report))
-            ->send();
-    }
-
-    abstract protected function createMessage(string $report);
-
-    protected function handleReport(string $report): string
-    {
-        return (new Pipeline(app()))
-            ->send($report)
-            ->through($this->getPipeline())
-            ->then(function ($passable) {
-                return $passable;
-            });
-    }
-
     public function getName(): string
     {
         return Str::lcfirst(Str::beforeLast(class_basename($this), 'Channel'));
     }
-
-    public function getPipeline(): array
-    {
-        return array_merge(
-            config('exception-notify.pipeline', []),
-            config(sprintf('exception-notify.channels.%s.pipeline', $this->getName()), [])
-        );
-    }
 }
diff --git a/src/Channels/DingTalkChannel.php b/src/Channels/DingTalkChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\DingTalkClient;
 use Guanguans\Notify\Messages\DingTalk\TextMessage;
 
 class DingTalkChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\DingTalkClient
+     */
+    protected $client;
+
+    public function __construct(DingTalkClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $report)
     {
         return new TextMessage(['content' => $report]);
diff --git a/src/Channels/FeiShuChannel.php b/src/Channels/FeiShuChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\FeiShuClient;
 use Guanguans\Notify\Messages\FeiShu\TextMessage;
 
 class FeiShuChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\FeiShuClient
+     */
+    protected $client;
+
+    public function __construct(FeiShuClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $report)
     {
         return new TextMessage($report);
diff --git a/src/Channels/LogChannel.php b/src/Channels/LogChannel.php
@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * This file is part of the guanguans/laravel-exception-notify.
+ *
+ * (c) guanguans <ityaozm@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled.
+ */
+
+namespace Guanguans\LaravelExceptionNotify\Channels;
+
+use Illuminate\Support\Facades\Log;
+
+class LogChannel extends Channel
+{
+    public function report(string $report)
+    {
+        Log::error($report);
+    }
+}
diff --git a/src/Channels/MailChannel.php b/src/Channels/MailChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\MailerClient;
 use Guanguans\Notify\Messages\EmailMessage;
 
 class MailChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\MailerClient
+     */
+    protected $client;
+
+    public function __construct(MailerClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $report)
     {
         return EmailMessage::create()
diff --git a/src/Channels/NullChannel.php b/src/Channels/NullChannel.php
@@ -10,16 +10,10 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
-use Guanguans\LaravelExceptionNotify\Contracts\Channel;
-
-class NullChannel implements Channel
+class NullChannel extends Channel
 {
-    public function getName(): string
-    {
-        return 'null';
-    }
-
     public function report(string $report)
     {
+        // noop
     }
 }
diff --git a/src/Channels/ServerChanChannel.php b/src/Channels/ServerChanChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\ServerChanClient;
 use Guanguans\Notify\Messages\ServerChanMessage;
 
 class ServerChanChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\ServerChanClient
+     */
+    protected $client;
+
+    public function __construct(ServerChanClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $content)
     {
         return new ServerChanMessage(config('exception-notify.title'), $content);
diff --git a/src/Channels/WeWorkChannel.php b/src/Channels/WeWorkChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\WeWorkClient;
 use Guanguans\Notify\Messages\WeWork\TextMessage;
 
 class WeWorkChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\WeWorkClient
+     */
+    protected $client;
+
+    public function __construct(WeWorkClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $report)
     {
         return new TextMessage(['content' => $report]);
diff --git a/src/Channels/XiZhiChannel.php b/src/Channels/XiZhiChannel.php
@@ -10,10 +10,29 @@
 
 namespace Guanguans\LaravelExceptionNotify\Channels;
 
+use Guanguans\Notify\Clients\XiZhiClient;
 use Guanguans\Notify\Messages\XiZhiMessage;
 
 class XiZhiChannel extends Channel
 {
+    /**
+     * @var \Guanguans\Notify\Clients\XiZhiClient
+     */
+    protected $client;
+
+    public function __construct(XiZhiClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function report(string $report)
+    {
+        return $this
+            ->client
+            ->setMessage($this->createMessage($report))
+            ->send();
+    }
+
     protected function createMessage(string $content)
     {
         return new XiZhiMessage(config('exception-notify.title'), $content);
diff --git a/src/ExceptionNotifyManager.php b/src/ExceptionNotifyManager.php
@@ -13,6 +13,7 @@
 use Guanguans\LaravelExceptionNotify\Channels\ChanifyChannel;
 use Guanguans\LaravelExceptionNotify\Channels\DingTalkChannel;
 use Guanguans\LaravelExceptionNotify\Channels\FeiShuChannel;
+use Guanguans\LaravelExceptionNotify\Channels\LogChannel;
 use Guanguans\LaravelExceptionNotify\Channels\MailChannel;
 use Guanguans\LaravelExceptionNotify\Channels\NullChannel;
 use Guanguans\LaravelExceptionNotify\Channels\ServerChanChannel;
@@ -229,6 +230,11 @@ protected function createFeiShuDriver()
         );
     }
 
+    protected function createLogDriver()
+    {
+        return new LogChannel();
+    }
+
     protected function createMailDriver()
     {
         return new MailChannel(
diff --git a/src/Jobs/ReportExceptionJob.php b/src/Jobs/ReportExceptionJob.php
@@ -16,6 +16,7 @@
 use Guanguans\LaravelExceptionNotify\Support\Traits\CreateStatic;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Pipeline\Pipeline;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Facades\Log;
@@ -65,11 +66,31 @@ public function __construct(Channel $channel)
      */
     public function handle(string $report)
     {
+        $report = $this->handleReport($report);
+
         $this->fireReportingEvent($report);
         $result = $this->channel->report($report);
         $this->fireReportedEvent($result);
     }
 
+    protected function getChannelPipeline(): array
+    {
+        return array_merge(
+            config('exception-notify.pipeline', []),
+            config(sprintf('exception-notify.channels.%s.pipeline', $this->channel->getName()), [])
+        );
+    }
+
+    protected function handleReport(string $report): string
+    {
+        return (new Pipeline(app()))
+            ->send($report)
+            ->through($this->getChannelPipeline())
+            ->then(function ($passable) {
+                return $passable;
+            });
+    }
+
     protected function fireReportingEvent(string $report)
     {
         event(new ReportingEvent($this->channel, $report));

Original file line number	Diff line number	Diff line change
`@@ -10,16 +10,10 @@`
`10`	`10`
`11`	`11`	`namespace Guanguans\LaravelExceptionNotify\Channels;`
`12`	`12`
`13`		`-use Guanguans\LaravelExceptionNotify\Contracts\Channel;`
`14`		`-`
`15`		`-class NullChannel implements Channel`
	`13`	`+class NullChannel extends Channel`
`16`	`14`	`{`
`17`		`- public function getName(): string`
`18`		`- {`
`19`		`- return 'null';`
`20`		`- }`
`21`		`-`
`22`	`15`	`public function report(string $report)`
`23`	`16`	`{`
	`17`	`+ // noop`
`24`	`18`	`}`
`25`	`19`	`}`