kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-05 04:03:26 +00:00
Code Issues Projects Releases Wiki Activity

Make sure webhook messages can be versionised later.

Browse Source
This commit is contained in:
James Cole
2020-12-04 20:19:52 +01:00
parent 7ee9b51b3f
commit 48d1d5c90b
10 changed files with 413 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
app/Services/Webhook/StandardWebhookSender.php Normal file
View File

@@ -0,0 +1,138 @@
<?php
/*
* StandardWebhookSender.php
* Copyright (c) 2020 james@firefly-iii.org
*
* This file is part of Firefly III (https://github.com/firefly-iii).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
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;
/**
* Class StandardWebhookSender
*/
class StandardWebhookSender implements WebhookSenderInterface
{
private Collection $messages;
private int $version = 1;
/**
* @inheritDoc
*/
public function getVersion(): int
{
return $this->version;
}
/**
* @inheritDoc
*/
public function setMessages(Collection $messages): void
{
$this->messages = $messages;
}
/**
* @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);
Log::debug(sprintf('Trying to send webhook message #%d', $message->id));
try {
$json = json_encode($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();
return;
}
$options = [
'body' => $json,
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Signature' => $signature,
'connect_timeout' => 3.14,
'User-Agent' => sprintf('FireflyIII/%s', config('firefly.version')),
'timeout' => 10,
],
];
$client = new Client;
//$logs = $message->logs ?? [];
try {
$res = $client->request('POST', $message->webhook->url, $options);
$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;
}
$message->save();
// $attempt = new WebhookAttempt;
// $attempt->webhookMessage()->associate($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 request body size: %d bytes', strlen($json)));
Log::debug(sprintf('Response body: %s', $res->getBody()));
//$sender
//$this->sendMessageV0($message);
}
}

46
app/Services/Webhook/WebhookSenderInterface.php Normal file
View File

@@ -0,0 +1,46 @@
<?php
/*
* WebhookSenderInterface.php
* Copyright (c) 2020 james@firefly-iii.org
*
* This file is part of Firefly III (https://github.com/firefly-iii).
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
namespace FireflyIII\Services\Webhook;
use FireflyIII\Models\WebhookMessage;
use Illuminate\Support\Collection;
/**
* Interface WebhookSenderInterface
*/
interface WebhookSenderInterface
{
/**
* @return int
*/
public function getVersion(): int;
/**
* @param Collection $messages
*/
public function setMessages(Collection $messages): void;
/**
*
*/
public function send(): void;
}