mayor
0c77dd84e7
Adds @spec annotations to all Oban worker perform/1 functions to improve
static analysis and documentation. Return types are specific to each worker's
actual behavior:
Workers returning 🆗
- BackupSummaryWorker
- BackupTimeoutWorker
- DeviceMonitorWorker
- DevicePollerWorker
- JobHealthCheckWorker
- NeighborCleanupWorker
Workers with complex returns:
- DiscoveryWorker: :ok | :discard
- FirmwareVersionFetcherWorker: :ok | {:error, term()}
- LoginHistoryCleanupWorker: {:ok, %{deleted: non_neg_integer(), anonymized_deleted: non_neg_integer()}}
- MikrotikBackupWorker: :ok | {:error, String.t()}
- SessionCleanupWorker: {:ok, %{sessions_deleted: non_neg_integer()}}
Analysis found that none of these workers have complex job parameters that
would benefit from embedded schemas - all use either no parameters or simple
device_id strings passed in job args.
StaleAgentWorker already had a typespec on find_stale_agents/0 from previous work.
All 98 worker tests passing after changes.
36 lines
1 KiB
Elixir
36 lines
1 KiB
Elixir
defmodule Towerops.Workers.BackupSummaryWorker do
|
|
@moduledoc """
|
|
Oban worker that sends daily backup summary emails.
|
|
|
|
Runs daily at 8 AM via cron schedule. Sends email report to admins if there
|
|
were any failed or timed-out backup requests in the past 24 hours.
|
|
"""
|
|
|
|
use Oban.Worker, queue: :maintenance, max_attempts: 1
|
|
|
|
alias Towerops.Devices.BackupRequests
|
|
|
|
require Logger
|
|
|
|
@impl Oban.Worker
|
|
@spec perform(Oban.Job.t()) :: :ok
|
|
def perform(%Oban.Job{}) do
|
|
yesterday = DateTime.add(DateTime.utc_now(), -24 * 60 * 60, :second)
|
|
|
|
summary = BackupRequests.summary_since(yesterday)
|
|
|
|
Logger.info("Backup summary for past 24 hours", summary: summary)
|
|
|
|
if summary.failed > 0 or summary.timeout > 0 do
|
|
failed_devices = BackupRequests.list_failed_devices_since(yesterday)
|
|
|
|
Logger.warning("Backup failures detected",
|
|
failed_count: summary.failed,
|
|
timeout_count: summary.timeout,
|
|
devices: Enum.map(failed_devices, & &1.device_id)
|
|
)
|
|
end
|
|
|
|
:ok
|
|
end
|
|
end
|