Message sending is now a job

This commit is contained in:
James Cole
2020-12-05 07:01:26 +01:00
parent deb829dfdb
commit 9576806765
8 changed files with 105 additions and 98 deletions

View File

@@ -104,7 +104,6 @@ class StandardMessageGenerator implements MessageGeneratorInterface
foreach ($this->webhooks as $webhook) {
$this->runWebhook($webhook);
}
//event(new RequestedSendWebhookMessages);
}
/**

View File

@@ -22,6 +22,7 @@ declare(strict_types=1);
namespace FireflyIII\Handlers\Events;
use FireflyIII\Events\RequestedSendWebhookMessages;
use FireflyIII\Events\StoredTransactionGroup;
use FireflyIII\Generator\Webhook\MessageGeneratorInterface;
use FireflyIII\Models\TransactionJournal;
@@ -92,6 +93,9 @@ class StoredGroupEventHandler
$engine->setObjects(new Collection([$group]));
// tell the generator to generate the messages
$engine->generateMessages();
// trigger event to send them:
event(new RequestedSendWebhookMessages);
}
}

View File

@@ -22,6 +22,7 @@ declare(strict_types=1);
namespace FireflyIII\Handlers\Events;
use FireflyIII\Events\RequestedSendWebhookMessages;
use FireflyIII\Events\UpdatedTransactionGroup;
use FireflyIII\Generator\Webhook\MessageGeneratorInterface;
use FireflyIII\Models\Account;
@@ -125,8 +126,10 @@ class UpdatedGroupEventHandler
/** @var MessageGeneratorInterface $engine */
$engine = app(MessageGeneratorInterface::class);
$engine->setUser($user);
$engine->setTransactionGroups(new Collection([$group]));
$engine->setObjects(new Collection([$group]));
$engine->setTrigger(Webhook::TRIGGER_UPDATE_TRANSACTION);
$engine->generateMessages();
event(new RequestedSendWebhookMessages);
}
}

View File

@@ -22,14 +22,8 @@
namespace FireflyIII\Handlers\Events;
use Exception;
use FireflyIII\Helpers\Webhook\SignatureGeneratorInterface;
use FireflyIII\Models\WebhookAttempt;
use FireflyIII\Jobs\SendWebhookMessage;
use FireflyIII\Models\WebhookMessage;
use FireflyIII\Services\Webhook\WebhookSenderInterface;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use JsonException;
use Log;
/**
@@ -42,6 +36,7 @@ class WebhookEventHandler
*/
public function sendWebhookMessages(): void
{
// kick offf the job!
$messages = WebhookMessage
::where('webhook_messages.sent', 0)
->where('webhook_messages.errored', 0)
@@ -52,10 +47,8 @@ class WebhookEventHandler
}
)->splice(0, 3);
Log::debug(sprintf('Found %d webhook message(s) ready to be send.', $messages->count()));
$sender =app(WebhookSenderInterface::class);
$sender->setMessages($messages);
$sender->send();
foreach ($messages as $message) {
SendWebhookMessage::dispatch($message)->afterResponse();
}
}
}

View File

@@ -0,0 +1,44 @@
<?php
namespace FireflyIII\Jobs;
use FireflyIII\Models\WebhookMessage;
use FireflyIII\Services\Webhook\WebhookSenderInterface;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
/**
* Class SendWebhookMessage
*/
class SendWebhookMessage implements ShouldQueue
{
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
private WebhookMessage $message;
/**
* Create a new job instance.
*
* @return void
*/
public function __construct(WebhookMessage $message)
{
$this->message = $message;
}
/**
* Execute the job.
*
* @return void
*/
public function handle(): void
{
// send job!
$sender = app(WebhookSenderInterface::class);
$sender->setMessage($this->message);
$sender->send();
}
}

View File

@@ -21,22 +21,20 @@
namespace FireflyIII\Services\Webhook;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Helpers\Webhook\SignatureGeneratorInterface;
use FireflyIII\Models\WebhookAttempt;
use FireflyIII\Models\WebhookMessage;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use Illuminate\Support\Collection;
use Log;
use JsonException;
use Log;
/**
* Class StandardWebhookSender
*/
class StandardWebhookSender implements WebhookSenderInterface
{
private Collection $messages;
private int $version = 1;
private WebhookMessage $message;
private int $version = 1;
/**
* @inheritDoc
@@ -49,49 +47,32 @@ class StandardWebhookSender implements WebhookSenderInterface
/**
* @inheritDoc
*/
public function setMessages(Collection $messages): void
public function setMessage(WebhookMessage $message): void
{
$this->messages = $messages;
$this->message = $message;
}
/**
* @inheritDoc
*/
public function send(): void
{
/** @var WebhookMessage $message */
foreach ($this->messages as $message) {
try {
$this->sendMessage($message);
} catch (FireflyException $e) {
// TODO log attempt and make WebhookAttempt
}
}
}
/**
* @param WebhookMessage $message
*
* @throws \GuzzleHttp\Exception\GuzzleException
*/
private function sendMessage(WebhookMessage $message): void
{
// have the signature generator generate a signature. If it fails, the error thrown will
// end up in send() to be caught.
$signatureGenerator = app(SignatureGeneratorInterface::class);
$signature = $signatureGenerator->generate($message);
$signature = $signatureGenerator->generate($this->message);
Log::debug(sprintf('Trying to send webhook message #%d', $message->id));
Log::debug(sprintf('Trying to send webhook message #%d', $this->message->id));
try {
$json = json_encode($message->message, JSON_THROW_ON_ERROR);
$json = json_encode($this->message->message, JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
// TODO throw Firefly Exception
// $attempt = new WebhookAttempt;
// $attempt->webhookMessage()->associate($message);
// $attempt->status_code = 0;
// $attempt->logs = sprintf('Json error: %s', $e->getMessage());
// $attempt->save();
// $attempt = new WebhookAttempt;
// $attempt->webhookMessage()->associate($this->message);
// $attempt->status_code = 0;
// $attempt->logs = sprintf('Json error: %s', $e->getMessage());
// $attempt->save();
return;
}
@@ -107,32 +88,32 @@ class StandardWebhookSender implements WebhookSenderInterface
],
];
$client = new Client;
//$logs = $message->logs ?? [];
//$logs = $this->message->logs ?? [];
try {
$res = $client->request('POST', $message->webhook->url, $options);
$message->sent = true;
} catch (ClientException|Exception $e) {
$res = $client->request('POST', $this->message->webhook->url, $options);
$this->message->sent = true;
} catch (ClientException | Exception $e) {
Log::error($e->getMessage());
Log::error($e->getTraceAsString());
//$logs[] = sprintf('%s: %s', date('Y-m-d H:i:s'), $e->getMessage());
$message->errored = true;
$message->sent = false;
$this->message->errored = true;
$this->message->sent = false;
}
$message->save();
$this->message->save();
// $attempt = new WebhookAttempt;
// $attempt->webhookMessage()->associate($message);
// $attempt->status_code = $res->getStatusCode();
// $attempt->logs = '';
// $attempt->response = (string)$res->getBody();
// $attempt->save();
// $attempt = new WebhookAttempt;
// $attempt->webhookMessage()->associate($this->message);
// $attempt->status_code = $res->getStatusCode();
// $attempt->logs = '';
// $attempt->response = (string)$res->getBody();
// $attempt->save();
Log::debug(sprintf('Webhook message #%d was sent. Status code %d', $message->id, $res->getStatusCode()));
Log::debug(sprintf('Webhook message #%d was sent. Status code %d', $this->message->id, $res->getStatusCode()));
Log::debug(sprintf('Webhook request body size: %d bytes', strlen($json)));
Log::debug(sprintf('Response body: %s', $res->getBody()));
//$sender
//$this->sendMessageV0($message);
//$this->sendMessageV0($this->message);
}
}

View File

@@ -22,7 +22,6 @@
namespace FireflyIII\Services\Webhook;
use FireflyIII\Models\WebhookMessage;
use Illuminate\Support\Collection;
/**
* Interface WebhookSenderInterface
@@ -35,9 +34,9 @@ interface WebhookSenderInterface
public function getVersion(): int;
/**
* @param Collection $messages
* @param WebhookMessage $message
*/
public function setMessages(Collection $messages): void;
public function setMessage(WebhookMessage $message): void;
/**
*