bert.hausmans
a791a276fa
MySQL 8.0 JSON columns may reorder associative-array keys on round-trip. For audit-immutable values (schema snapshots, webhook payloads, activity log diffs), this is corrupting: re-emits produce different byte sequences for the same logical content. Introduced JsonCanonicalizer (recursive ksort on associative arrays; numeric-indexed lists preserve order) and applied at every writer site that produces byte-stable JSON: - FormSubmissionService: canonicalize the schema_snapshot array before storage (audit-immutable per ARCH §4.3, RFC-WS-6 v1.1). - FormField::logFieldChange / FormSchema::logSchemaChange: canonicalize activity-log properties before withProperties() so old/new diffs read back byte-stable. - BindingActivityLogger: canonicalize both the pass-level and per-binding activity properties. - FormWebhookDispatcher: canonicalize payload_snapshot before storage (delivery-time HMAC re-encodes the same canonical bytes). - DeliverFormWebhookJob: switched json_encode to JsonCanonicalizer::encode for the HMAC-signed body, so the signature is byte-stable across re-deliveries and reproducible by receivers from the same logical payload. Sites NOT canonicalized (deliberate): - form_schemas.settings — opaque UI config; key order has no semantic meaning, no byte-stability requirement. - form_schemas.translations / form_fields.translations — read by display layer; key order doesn't matter. - form_templates.schema_snapshot — user-supplied input via store/ update; user is the source of truth, not audit-immutable in the same way as form_submissions.schema_snapshot. Reverted the 7 assertEquals workarounds from session 2.6: - ConditionalLogicActivityLogPayloadTest - ConditionalLogicBackfillTest::test_rollback_reconstructs_canonical_json - FormFieldBindingMigrationTest::test_rollback_reconstructs_json_and_drops_table - FormFieldOptionServiceAndScopeTest::test_replace_options_emits_activity_log_on_field_only - FormFieldOptionsActivityLogTest::test_field_updated_payload_contains_options_diff_when_options_change - FormFieldOptionsBackfillTest::test_forward_migration_backfills_rows_strips_translations_and_rewrites_snapshot - FormFieldOptionsSnapshotAndStrictRequestTest::test_submission_snapshot_embeds_rich_shape_options Each now uses assertSame on JsonCanonicalizer::encode of both sides — byte-stable comparison meaningful regardless of MySQL JSON storage behavior. New regression test SchemaSnapshotByteStableAcrossReemitsTest exercises the contract end-to-end: complex schema with bindings, validation rules, options, conditional logic, submitted; reads schema_snapshot via three roads (Eloquent cast, fresh model, raw bytes) and asserts the canonical encode is identical. ARCH-FORM-BUILDER.md §4.6.1 gets a "Byte-stability" sub-section explaining what's canonicalized and why. Test count: 1388 → 1400 (+11 JsonCanonicalizer unit, +1 snapshot regression). Larastan clean. Rector dry-run unchanged at 355. Refs: WS-6 session 2.6 deviation #4 cleanup, RFC-WS-6 v1.1 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
93 lines
3.4 KiB
PHP
93 lines
3.4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Services\FormBuilder;
|
|
|
|
use App\Enums\FormBuilder\FormWebhookDeliveryStatus;
|
|
use App\Jobs\FormBuilder\DeliverFormWebhookJob;
|
|
use App\Models\FormBuilder\FormSchemaWebhook;
|
|
use App\Models\FormBuilder\FormSubmission;
|
|
use App\Models\FormBuilder\FormWebhookDelivery;
|
|
use App\Support\Json\JsonCanonicalizer;
|
|
|
|
/**
|
|
* Finds active webhooks for a submission's schema + trigger and queues a
|
|
* DeliverFormWebhookJob per delivery row (ARCH §17.5.2).
|
|
*/
|
|
final class FormWebhookDispatcher
|
|
{
|
|
public function dispatchForSubmission(FormSubmission $submission, string $triggerEvent): void
|
|
{
|
|
if ($submission->is_test) {
|
|
return;
|
|
}
|
|
|
|
$webhooks = FormSchemaWebhook::query()
|
|
->where('form_schema_id', $submission->form_schema_id)
|
|
->where('trigger_event', $triggerEvent)
|
|
->where('is_active', true)
|
|
->get();
|
|
|
|
foreach ($webhooks as $webhook) {
|
|
/** @var FormWebhookDelivery $delivery */
|
|
$delivery = FormWebhookDelivery::create([
|
|
'form_schema_webhook_id' => $webhook->id,
|
|
'form_submission_id' => $submission->id,
|
|
'trigger_event' => $triggerEvent,
|
|
'status' => FormWebhookDeliveryStatus::PENDING->value,
|
|
'attempts' => 0,
|
|
// RFC-WS-6 session 2.7 — canonicalize before storage; the
|
|
// delivery job HMAC-signs the same canonical bytes after
|
|
// re-encode, so signature is reproducible.
|
|
'payload_snapshot' => JsonCanonicalizer::canonicalize(
|
|
$this->buildPayload($submission, $triggerEvent),
|
|
),
|
|
]);
|
|
|
|
DeliverFormWebhookJob::dispatch($delivery->id)->onConnection('webhooks')->onQueue('webhooks');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return array<string, mixed>
|
|
*/
|
|
private function buildPayload(FormSubmission $submission, string $triggerEvent): array
|
|
{
|
|
$submission->loadMissing(['schema', 'schema.organisation', 'values.field']);
|
|
|
|
$values = [];
|
|
foreach ($submission->values as $value) {
|
|
if ($value->field?->slug) {
|
|
$values[$value->field->slug] = $value->value;
|
|
}
|
|
}
|
|
|
|
return [
|
|
'event' => 'form_submission.'.$triggerEvent,
|
|
'triggered_at' => now()->toIso8601String(),
|
|
'organisation' => [
|
|
'id' => $submission->schema?->organisation?->id,
|
|
'name' => $submission->schema?->organisation?->name,
|
|
'slug' => $submission->schema?->organisation?->slug,
|
|
],
|
|
'schema' => [
|
|
'id' => $submission->schema?->id,
|
|
'purpose' => $submission->schema?->purpose instanceof \BackedEnum
|
|
? $submission->schema->purpose->value
|
|
: $submission->schema?->purpose,
|
|
'slug' => $submission->schema?->slug,
|
|
'version' => $submission->schema?->version,
|
|
],
|
|
'submission' => [
|
|
'id' => $submission->id,
|
|
'subject_type' => $submission->subject_type,
|
|
'subject_id' => $submission->subject_id,
|
|
'submitted_at' => optional($submission->submitted_at)->toIso8601String(),
|
|
'submitted_by_user_id' => $submission->submitted_by_user_id,
|
|
'values' => $values,
|
|
],
|
|
];
|
|
}
|
|
}
|