Send Brrr push notifications for new webmentions
Dispatches a queued job to POST to a configured Brrr webhook whenever a brand-new webmention is saved, so replies/likes/reposts show up as push notifications instead of requiring a manual check of the site.
This commit is contained in:
parent
31c49ac3fc
commit
f9f2744fad
6 changed files with 138 additions and 0 deletions
|
|
@ -78,6 +78,8 @@ SESSION_SAME_SITE=strict
|
|||
|
||||
LOG_SLACK_WEBHOOK_URL=
|
||||
|
||||
BRRR_WEBHOOK_URL=
|
||||
|
||||
FLARE_KEY=
|
||||
|
||||
IGNITION_OPEN_AI_KEY=
|
||||
|
|
|
|||
56
app/Jobs/NotifyBrrrOfWebMention.php
Normal file
56
app/Jobs/NotifyBrrrOfWebMention.php
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Jobs;
|
||||
|
||||
use App\Models\WebMention;
|
||||
use Illuminate\Bus\Queueable;
|
||||
use Illuminate\Contracts\Queue\ShouldQueue;
|
||||
use Illuminate\Foundation\Bus\Dispatchable;
|
||||
use Illuminate\Queue\InteractsWithQueue;
|
||||
use Illuminate\Queue\SerializesModels;
|
||||
use Illuminate\Support\Facades\Http;
|
||||
|
||||
class NotifyBrrrOfWebMention implements ShouldQueue
|
||||
{
|
||||
use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
|
||||
|
||||
/**
|
||||
* Create a new job instance.
|
||||
*/
|
||||
public function __construct(
|
||||
protected WebMention $webMention
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Execute the job.
|
||||
*/
|
||||
public function handle(): void
|
||||
{
|
||||
$webhookUrl = config('services.brrr.webhook_url');
|
||||
|
||||
if (blank($webhookUrl)) {
|
||||
return;
|
||||
}
|
||||
|
||||
Http::post($webhookUrl, [
|
||||
'title' => $this->title(),
|
||||
'message' => "From {$this->webMention->source}",
|
||||
'open_url' => $this->webMention->target,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a notification title based on the webmention type.
|
||||
*/
|
||||
private function title(): string
|
||||
{
|
||||
return match ($this->webMention->type) {
|
||||
'in-reply-to' => 'New reply',
|
||||
'like-of' => 'New like',
|
||||
'repost-of' => 'New repost',
|
||||
default => 'New webmention',
|
||||
};
|
||||
}
|
||||
}
|
||||
|
|
@ -96,6 +96,7 @@ class ProcessWebMention implements ShouldQueue
|
|||
$webmention->type = $type;
|
||||
$webmention->mf2 = json_encode($microformats);
|
||||
$webmention->save();
|
||||
dispatch(new NotifyBrrrOfWebMention($webmention));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -39,4 +39,8 @@ return [
|
|||
'token' => env('CLOUDCONVERT_API_TOKEN'),
|
||||
],
|
||||
|
||||
'brrr' => [
|
||||
'webhook_url' => env('BRRR_WEBHOOK_URL'),
|
||||
],
|
||||
|
||||
];
|
||||
|
|
|
|||
71
tests/Unit/Jobs/NotifyBrrrOfWebMentionJobTest.php
Normal file
71
tests/Unit/Jobs/NotifyBrrrOfWebMentionJobTest.php
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Tests\Unit\Jobs;
|
||||
|
||||
use App\Jobs\NotifyBrrrOfWebMention;
|
||||
use App\Models\WebMention;
|
||||
use Illuminate\Http\Client\Request;
|
||||
use Illuminate\Support\Facades\Http;
|
||||
use PHPUnit\Framework\Attributes\Test;
|
||||
use Tests\TestCase;
|
||||
|
||||
class NotifyBrrrOfWebMentionJobTest extends TestCase
|
||||
{
|
||||
#[Test]
|
||||
public function it_posts_a_reply_notification_to_the_brrr_webhook(): void
|
||||
{
|
||||
config(['services.brrr.webhook_url' => 'https://api.brrr.now/v1/br_usr_test']);
|
||||
Http::fake();
|
||||
|
||||
$webMention = WebMention::factory()->make([
|
||||
'source' => 'https://example.org/reply/1',
|
||||
'target' => 'https://jonnybarnes.uk/notes/1',
|
||||
'type' => 'in-reply-to',
|
||||
]);
|
||||
|
||||
$job = new NotifyBrrrOfWebMention($webMention);
|
||||
$job->handle();
|
||||
|
||||
Http::assertSent(function (Request $request) {
|
||||
return $request->url() === 'https://api.brrr.now/v1/br_usr_test'
|
||||
&& $request['title'] === 'New reply'
|
||||
&& $request['message'] === 'From https://example.org/reply/1'
|
||||
&& $request['open_url'] === 'https://jonnybarnes.uk/notes/1';
|
||||
});
|
||||
}
|
||||
|
||||
#[Test]
|
||||
public function it_titles_notifications_by_webmention_type(): void
|
||||
{
|
||||
config(['services.brrr.webhook_url' => 'https://api.brrr.now/v1/br_usr_test']);
|
||||
Http::fake();
|
||||
|
||||
foreach ([
|
||||
'in-reply-to' => 'New reply',
|
||||
'like-of' => 'New like',
|
||||
'repost-of' => 'New repost',
|
||||
'something-else' => 'New webmention',
|
||||
] as $type => $expectedTitle) {
|
||||
$webMention = WebMention::factory()->make(['type' => $type]);
|
||||
|
||||
(new NotifyBrrrOfWebMention($webMention))->handle();
|
||||
|
||||
Http::assertSent(fn (Request $request) => $request['title'] === $expectedTitle);
|
||||
}
|
||||
}
|
||||
|
||||
#[Test]
|
||||
public function it_does_nothing_when_no_webhook_url_is_configured(): void
|
||||
{
|
||||
config(['services.brrr.webhook_url' => null]);
|
||||
Http::fake();
|
||||
|
||||
$webMention = WebMention::factory()->make();
|
||||
|
||||
(new NotifyBrrrOfWebMention($webMention))->handle();
|
||||
|
||||
Http::assertNothingSent();
|
||||
}
|
||||
}
|
||||
|
|
@ -5,6 +5,7 @@ declare(strict_types=1);
|
|||
namespace Tests\Unit\Jobs;
|
||||
|
||||
use App\Exceptions\RemoteContentNotFoundException;
|
||||
use App\Jobs\NotifyBrrrOfWebMention;
|
||||
use App\Jobs\ProcessWebMention;
|
||||
use App\Jobs\SaveProfileImage;
|
||||
use App\Models\Note;
|
||||
|
|
@ -71,6 +72,7 @@ class ProcessWebMentionJobTest extends TestCase
|
|||
$job->handle($parser);
|
||||
|
||||
Queue::assertPushed(SaveProfileImage::class);
|
||||
Queue::assertPushed(NotifyBrrrOfWebMention::class);
|
||||
$this->assertDatabaseHas('webmentions', [
|
||||
'source' => $source,
|
||||
'type' => 'like-of',
|
||||
|
|
@ -104,6 +106,7 @@ class ProcessWebMentionJobTest extends TestCase
|
|||
$job->handle($parser);
|
||||
|
||||
Queue::assertPushed(SaveProfileImage::class);
|
||||
Queue::assertNotPushed(NotifyBrrrOfWebMention::class);
|
||||
$this->assertDatabaseHas('webmentions', [
|
||||
'source' => $source,
|
||||
'type' => 'in-reply-to',
|
||||
|
|
@ -206,6 +209,7 @@ class ProcessWebMentionJobTest extends TestCase
|
|||
$job = new ProcessWebMention($note, $source);
|
||||
$job->handle($parser);
|
||||
|
||||
Queue::assertPushed(NotifyBrrrOfWebMention::class);
|
||||
$this->assertGreaterThan(255, strlen($source));
|
||||
$this->assertDatabaseHas('webmentions', [
|
||||
'source' => $source,
|
||||
|
|
|
|||
Loading…
Reference in a new issue