ahmido/TenantAtlas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity
bd6df1f343
TenantAtlas/specs/055-ops-ux-rollout/contracts/ux-contracts.md
ahmido bd6df1f343 055-ops-ux-rollout (#64) 
Kurzbeschreibung

Implementiert Feature 055 — Ops‑UX Constitution Rollout v1.3.0.
Behebt: globales BulkOperationProgress-Widget benötigt keinen manuellen Refresh mehr; ETA/Elapsed aktualisieren korrekt; Widget verschwindet automatisch.
Verbesserungen: zuverlässiges polling (Alpine factory + Livewire fallback), sofortiger Enqueue‑Signal-Dispatch, Failure‑Message‑Sanitization, neue Guard‑ und Regressionstests, Specs/Tasks aktualisiert.
Was geändert wurde (Auszug)

InventoryLanding.php
bulk-operation-progress.blade.php
OperationUxPresenter.php
SyncRestoreRunToOperationRun.php
PolicyResource.php
PolicyVersionResource.php
RestoreRunResource.php
tests/Feature/OpsUx/* (PollerRegistration, TerminalNotificationFailureMessageTest, CanonicalViewRunLinksTest, OperationCatalogCoverageTest, UnknownOperationTypeLabelTest)
InventorySyncButtonTest.php
tasks.md
Tests

Neue Tests hinzugefügt; php artisan test --group=ops-ux lokal grün (alle relevanten Tests laufen).
How to verify manually

Auf Branch wechseln: 055-ops-ux-rollout
In Filament: Inventory → Sync (oder relevante Bulk‑Aktion) auslösen.
Beobachten: Progress‑Widget erscheint sofort, ETA/Elapsed aktualisiert, Widget verschwindet nach Fertigstellung ohne Browser‑Refresh.
Optional: ./vendor/bin/sail exec app php artisan test --filter=OpsUx oder php artisan test --group=ops-ux
Besonderheiten / Hinweise

Einzelne, synchrone Policy‑Actions (ignore/restore/PolicyVersion single archive/restore/forceDelete) sind absichtlich inline und erzeugen kein OperationRun. Bulk‑Aktionen und restore.execute werden als Runs modelliert. Wenn gewünscht, kann ich die inline‑Actions auf OperationRunService umstellen, damit sie in Monitoring → Operations sichtbar werden.
Remote: Branch ist bereits gepusht (origin/055-ops-ux-rollout). PR kann in Gitea erstellt werden.
Links

Specs & tasks: tasks.md
Monitoring page: Operations.php

Co-authored-by: Ahmed Darrazi <ahmeddarrazi@adsmac.local>
Reviewed-on: #64
2026-01-18 14:50:15 +00:00

2.1 KiB
Raw Blame History

UX Contracts (non-API) — Ops-UX Constitution Rollout (055)

This feature does not introduce new public HTTP APIs. Instead it defines internal UX contracts: shared builders/presenters that all operation-related UI must use.

Surfaces

A) Toast (queued only)

Trigger: user clicks “Start operation” / submits a form that enqueues a job.

Contract

  • Toast must appear immediately.
  • Must not write a DB notification for queued.
  • Copy (canonical) (OPS-UX Constitution v1.3.0):
    • Title: {OperationLabel} queued
    • Body: Running in the background.

Optional alternative body (not additive):

  • You can monitor progress in Operations.

Forbidden in toast:

  • counts/metrics
  • percentages/progress
  • terminal outcomes (completed/failed/partial)
  • feature-specific copy

Notes:

  • Toast is queued-only.
  • Terminal outcomes are delivered via DB notification (initiator-only).
  • Live awareness is via Progress Widget + Monitoring → Operations.

B) Progress widget (queued/running only)

Audience: tenant-wide for users with Monitoring access.

Contract

  • Only shows runs with status queued or running.
  • At most 5 items.
  • If more than 5, show +N more link to canonical Operations index.
  • Each row must include a canonical View run action linking to Run Detail.
  • Must use centralized label + status copy.
  • Polling cadence must be “calm”: start fast when there are actives, then back off.

C) Terminal DB notification

Trigger: transition to a terminal state.

Audience: initiator-only.

Contract

  • Exactly one notification per run per initiator.
  • Must not write queued notifications.
  • Title/body/status must be derived via centralized presenter.
  • Must include canonical View run link.
  • Optional summary uses summary_counts with whitelist rules.

Strings

All copy that appears in these surfaces must come from a shared source (presenter or resource strings), not ad-hoc in Blade/Livewire.

Metrics (summary_counts)

Allowed keys:

  • See spec.md (FR-012) “Canonical allowed summary keys (single source of truth)”.

Any other keys must not render.