ahmido
4d3fcd28a9
What Implements tenant-scoped backup scheduling end-to-end: schedules CRUD, minute-based dispatch, queued execution, run history, manual “Run now/Retry”, retention (keep last N), and auditability. Key changes Filament UI: Backup Schedules resource with tenant scoping + SEC-002 role gating. Scheduler + queue: tenantpilot:schedules:dispatch command wired in scheduler (runs every minute), creates idempotent BackupScheduleRun records and dispatches jobs. Execution: RunBackupScheduleJob syncs policies, creates immutable backup sets, updates run status, writes audit logs, applies retry/backoff mapping, and triggers retention. Run history: Relation manager + “View” modal rendering run details. UX polish: row actions grouped; bulk actions grouped (run now / retry / delete). Bulk dispatch writes DB notifications (shows in notifications panel). Validation: policy type hard-validation on save; unknown policy types handled safely at runtime (skipped/partial). Tests: comprehensive Pest coverage for CRUD/scoping/validation, idempotency, job outcomes, error mapping, retention, view modal, run-now/retry notifications, bulk delete (incl. operator forbidden). Files / Areas Filament: BackupScheduleResource.php and app/Filament/Resources/BackupScheduleResource/* Scheduling/Jobs: app/Console/Commands/TenantpilotDispatchBackupSchedules.php, app/Jobs/RunBackupScheduleJob.php, app/Jobs/ApplyBackupScheduleRetentionJob.php, console.php Models/Migrations: app/Models/BackupSchedule.php, app/Models/BackupScheduleRun.php, database/migrations/backup_schedules, backup_schedule_runs Notifications: BackupScheduleRunDispatchedNotification.php Specs: specs/032-backup-scheduling-mvp/* (tasks/checklist/quickstart updates) How to test (Sail) Run tests: ./vendor/bin/sail artisan test tests/Feature/BackupScheduling Run formatter: ./vendor/bin/sail php ./vendor/bin/pint --dirty Apply migrations: ./vendor/bin/sail artisan migrate Manual dispatch: ./vendor/bin/sail artisan tenantpilot:schedules:dispatch Notes Uses DB notifications for queued UI actions to ensure they appear in the notifications panel even under queue fakes in tests. Checklist gate for 032 is PASS; tasks updated accordingly. Co-authored-by: Ahmed Darrazi <ahmeddarrazi@adsmac.local> Reviewed-on: #34
99 lines
3.1 KiB
Markdown
99 lines
3.1 KiB
Markdown
# Data Model: Backup Scheduling MVP (032)
|
|
|
|
**Date**: 2026-01-05
|
|
|
|
This document describes the entities, relationships, validation rules, and state transitions derived from the feature spec.
|
|
|
|
## Entities
|
|
|
|
### 1) BackupSchedule (`backup_schedules`)
|
|
|
|
**Purpose**: Defines a tenant-scoped recurring backup plan.
|
|
|
|
**Fields**
|
|
- `id` (bigint, PK)
|
|
- `tenant_id` (FK → `tenants.id`, required)
|
|
- `name` (string, required)
|
|
- `is_enabled` (bool, default true)
|
|
- `timezone` (string, required; default `UTC`)
|
|
- `frequency` (enum: `daily|weekly`, required)
|
|
- `time_of_day` (time, required)
|
|
- `days_of_week` (json, nullable; required when `frequency=weekly`)
|
|
- array<int> in range 1..7 (Mon..Sun)
|
|
- `policy_types` (jsonb, required)
|
|
- array<string>; keys MUST exist in `config('tenantpilot.supported_policy_types')`
|
|
- `include_foundations` (bool, default true)
|
|
- `retention_keep_last` (int, default 30)
|
|
- `last_run_at` (datetime, nullable)
|
|
- `last_run_status` (string, nullable)
|
|
- `next_run_at` (datetime, nullable)
|
|
- timestamps
|
|
|
|
**Indexes**
|
|
- `(tenant_id, is_enabled)`
|
|
- optional `(next_run_at)`
|
|
|
|
**Validation Rules (MVP)**
|
|
- `tenant_id`: required, exists
|
|
- `name`: required, max length (e.g. 255)
|
|
- `timezone`: required, valid IANA tz
|
|
- `frequency`: required, in `[daily, weekly]`
|
|
- `time_of_day`: required
|
|
- `days_of_week`: required if weekly; values 1..7; unique values
|
|
- `policy_types`: required, array, min 1; all values in supported types config
|
|
- `retention_keep_last`: required, int, min 1
|
|
|
|
**State**
|
|
- Enabled/disabled (`is_enabled`)
|
|
|
|
---
|
|
|
|
### 2) BackupScheduleRun (`backup_schedule_runs`)
|
|
|
|
**Purpose**: Represents one execution attempt of a schedule.
|
|
|
|
**Fields**
|
|
- `id` (bigint, PK)
|
|
- `backup_schedule_id` (FK → `backup_schedules.id`, required)
|
|
- `tenant_id` (FK → `tenants.id`, required; denormalized)
|
|
- `scheduled_for` (datetime, required; UTC minute-slot)
|
|
- `started_at` (datetime, nullable)
|
|
- `finished_at` (datetime, nullable)
|
|
- `status` (enum: `running|success|partial|failed|canceled|skipped`, required)
|
|
- `summary` (jsonb, required)
|
|
- suggested keys:
|
|
- `policies_total` (int)
|
|
- `policies_backed_up` (int)
|
|
- `errors_count` (int)
|
|
- `type_breakdown` (object)
|
|
- `warnings` (array)
|
|
- `unknown_policy_types` (array<string>)
|
|
- `error_code` (string, nullable)
|
|
- `error_message` (text, nullable)
|
|
- `backup_set_id` (FK → `backup_sets.id`, nullable)
|
|
- timestamps
|
|
|
|
**Indexes**
|
|
- `(backup_schedule_id, scheduled_for)`
|
|
- `(tenant_id, created_at)`
|
|
- unique `(backup_schedule_id, scheduled_for)` (idempotency)
|
|
|
|
**State transitions**
|
|
- `running` → `success|partial|failed|skipped|canceled`
|
|
|
|
---
|
|
|
|
## Relationships
|
|
|
|
- Tenant `hasMany` BackupSchedule
|
|
- BackupSchedule `belongsTo` Tenant
|
|
- BackupSchedule `hasMany` BackupScheduleRun
|
|
- BackupScheduleRun `belongsTo` BackupSchedule
|
|
- BackupScheduleRun `belongsTo` Tenant
|
|
- BackupScheduleRun `belongsTo` BackupSet (nullable)
|
|
|
|
## Notes
|
|
|
|
- `BackupSet` and `BackupItem` already support soft deletes in this repo; retention can soft-delete old backup sets.
|
|
- Unknown policy types are prevented at save-time, but runs defensively re-check to handle legacy DB data.
|