Send a webhook for every change a person makes to a record
Events are {resource}.created, .updated, .deleted and .restored for content,
the inbox, redirects, repositories and media, taken from the audit log so the
two agree on what happened. Subscriptions take wildcards. Users, tokens,
webhooks and settings are never sent, nor what the application does by
itself; the inbox's own words only with personal data enabled.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -6,11 +6,14 @@ namespace App\Support\Webhooks;
|
||||
|
||||
use App\Jobs\DeliverWebhook;
|
||||
use App\Models\Application;
|
||||
use App\Models\AuditLog;
|
||||
use App\Models\Member;
|
||||
use App\Models\ReviewComment;
|
||||
use App\Models\Revision;
|
||||
use App\Models\Webhook;
|
||||
use App\Models\WebhookDelivery;
|
||||
use App\Support\AdminContent;
|
||||
use App\Support\Audit\Auditor;
|
||||
use App\Support\ContentTypes;
|
||||
use App\Support\SiteUrls;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
@@ -93,6 +96,90 @@ final class Webhooks
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* `projects.created`, `pages.updated`, `media.deleted`…: whatever a person
|
||||
* did to a record, from the audit log — which already leaves out what the
|
||||
* application does by itself, and already masks secrets, so the two
|
||||
* cannot disagree about what happened.
|
||||
*/
|
||||
public static function auditRecorded(AuditLog $entry): void
|
||||
{
|
||||
[$resource, $action] = array_pad(explode('.', $entry->action, 2), 2, null);
|
||||
|
||||
if (! in_array($resource, Webhook::RESOURCES, true) || ! in_array($action, Webhook::ACTIONS, true)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$record = self::find($resource, $entry->subject_id);
|
||||
$changes = $entry->changes;
|
||||
|
||||
$data = [
|
||||
'type' => $resource,
|
||||
'id' => is_numeric($entry->subject_id) ? (int) $entry->subject_id : $entry->subject_id,
|
||||
'title' => $entry->subject_label,
|
||||
'action' => $action,
|
||||
'by' => ['id' => $entry->user_id, 'name' => $entry->user_name],
|
||||
'via' => $entry->via,
|
||||
'changes' => $changes,
|
||||
'url' => $action === 'deleted' || $record === null ? null : self::publicUrl($record),
|
||||
];
|
||||
|
||||
$personal = [];
|
||||
|
||||
// A submission is somebody else's words: what is sent about it by
|
||||
// default is how it is being handled, nothing they wrote.
|
||||
if ($resource === 'applications') {
|
||||
$data['title'] = $record instanceof Application ? $record->subject() : null;
|
||||
$data['changes'] = $changes === null ? null : array_intersect_key($changes, array_flip(['status', 'handled_by', 'handled_at']));
|
||||
$personal = [
|
||||
'name' => $record?->name,
|
||||
'email' => $record?->email,
|
||||
'changes' => $changes,
|
||||
];
|
||||
}
|
||||
|
||||
self::dispatch($entry->action, $data, $personal);
|
||||
}
|
||||
|
||||
protected static function find(string $resource, ?string $id): ?Model
|
||||
{
|
||||
$model = array_search($resource, Auditor::AUDITED, true);
|
||||
|
||||
if ($model === false || $id === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$query = $model::query();
|
||||
|
||||
if (method_exists($model, 'bootSoftDeletes')) {
|
||||
$query->withTrashed();
|
||||
}
|
||||
|
||||
return $query->find($id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Where it can be seen on the site, when it can be.
|
||||
*/
|
||||
protected static function publicUrl(Model $record): ?string
|
||||
{
|
||||
if (method_exists($record, 'isPublishedNow') && ! $record->isPublishedNow()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if ($record instanceof Member) {
|
||||
return $record->is_public
|
||||
? rtrim((string) config('site.url'), '/').SiteUrls::path('member', (string) config('locales.default'), $record->slug)
|
||||
: null;
|
||||
}
|
||||
|
||||
$siteType = AdminContent::PREVIEWABLE[AdminContent::nameOf($record) ?? ''] ?? null;
|
||||
|
||||
return $siteType
|
||||
? (SiteUrls::absoluteAlternates($record, $siteType)[(string) config('locales.default')] ?? null)
|
||||
: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Publishing and unpublishing are already told apart by the history, for
|
||||
* every kind of record and from wherever it happened; this listens there.
|
||||
|
||||
Reference in New Issue
Block a user