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>
68 lines
2.8 KiB
PHP
68 lines
2.8 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\FormBuilder\Bindings;
|
|
|
|
use App\Models\FormBuilder\FormSubmission;
|
|
use App\Support\Json\JsonCanonicalizer;
|
|
use Spatie\Activitylog\Models\Activity;
|
|
|
|
/**
|
|
* RFC-WS-6 §3 (Q12) — hierarchical activity log for the binding
|
|
* pipeline. One pass-level activity (form_submission.bindings_pass_completed)
|
|
* with N child activities (form_submission.binding_applied), linked via
|
|
* properties.parent_activity_id.
|
|
*
|
|
* Failed bindings get their own binding_applied activity entry too,
|
|
* with `error_class` / `error_message` in properties — in addition to
|
|
* their FormSubmissionActionFailure row (deliberate dual source of
|
|
* truth: activity_log is the human timeline, action_failures is the
|
|
* machine-replayable workflow).
|
|
*/
|
|
final class BindingActivityLogger
|
|
{
|
|
public function logPass(FormSubmission $submission, BindingPassResult $result): void
|
|
{
|
|
// RFC-WS-6 session 2.7 — canonicalize properties before they land
|
|
// in activity_log.properties (MySQL JSON column round-trip would
|
|
// otherwise reorder keys and break diff/regression assertions).
|
|
$passActivity = activity()
|
|
->performedOn($submission)
|
|
->withProperties(JsonCanonicalizer::canonicalize([
|
|
'binding_count' => count($result->applications),
|
|
'succeeded' => $result->successCount(),
|
|
'failed' => $result->failureCount(),
|
|
'apply_status' => $result->applyStatus()->value,
|
|
'person_provisioned' => $result->provisionedSubjectType === 'person',
|
|
'subject_type' => $result->provisionedSubjectType,
|
|
'subject_id' => $result->provisionedSubjectId,
|
|
]))
|
|
->log('form_submission.bindings_pass_completed');
|
|
|
|
$parentActivityId = $passActivity instanceof Activity ? (string) $passActivity->id : null;
|
|
|
|
foreach ($result->applications as $application) {
|
|
$properties = [
|
|
'parent_activity_id' => $parentActivityId,
|
|
'binding_id' => $application->bindingId,
|
|
'target_entity' => $application->targetEntity,
|
|
'target_attribute' => $application->targetAttribute,
|
|
'success' => $application->success,
|
|
'old_value' => $application->oldValue,
|
|
'new_value' => $application->newValue,
|
|
'source_submission_id' => (string) $submission->id,
|
|
];
|
|
if (! $application->success) {
|
|
$properties['error_class'] = $application->exceptionClass;
|
|
$properties['error_message'] = $application->exceptionMessage;
|
|
}
|
|
|
|
activity()
|
|
->performedOn($submission)
|
|
->withProperties(JsonCanonicalizer::canonicalize($properties))
|
|
->log('form_submission.binding_applied');
|
|
}
|
|
}
|
|
}
|