Behaviour module for notification reports.

This behaviour encapsulates notifications which behave like reports = notifications are sent periodically.

example

Example

defmodule Scenarios.Template.Reporter do
  @callback Toolbox.Scenario.Template.StageBased

  alias Crontab.CronExpression
  alias Scenarios.Template.Reporter.DailyReport
  alias Toolbox.Message
  alias Toolbox.Report
  alias Toolbox.Runtime.Stage.Unit
  alias Toolbox.Scenario.OutputAction

  import Crontab.CronExpression

  @impl true
  def init(init_timestamp, %Unit{} = unit) do
    # report schedule defined as crontab expression
    report_schedule = ~e[* * * * *]

    # timezone used to display localized timestamp in notification
    timezone = "Europe/Prague"

    # args to init report state
    init_arg = :ok

    {:ok, outputs, report_state} =
      Report.init(DailyReport, init_timestamp, report_schedule, timezone, init_arg)

    {:ok, outputs, %Unit{unit | state: %{report_state: report_state}}}
  end

  @impl true
  def handle_message(%Message{} = msg, %Unit{} = unit) do
    {:ok, outputs, report_state} = Report.process_message(unit.state.report_state, msg)
    {:reply, outputs, %Unit{unit | state: %{unit.state | report_state: report_state}}}
  end
end

defmodule Scenarios.Template.Reporter.DailyReport do
  @callback Toolbox.Report

  alias Toolbox.Message
  alias Toolbox.Scenario.OutputAction

  @impl true
  def init(:ok) do
    {:ok, [], %{incomming_messages: []}}
  end

  @impl true
  def handle_process_message(%{} = state, %Message{} = msg) do
    {:ok, [], %{incomming_messages: [msg | state.incomming_messages]}}
  end

  @impl true
  def handle_publish_report(%{} = state, publish_timestamp, last_publish_timestamp) do
    report_notification =
      OutputAction.new_notification_action(publish_timestamp, %{
        type: :daily_report,
        primary_asset: nil,
        data: %{
          "incomming_messages" => state.incomming_messages,
          "publish_time" => publish_timestamp,
          "last_publish_time" => last_timestamp
        }
      })

    {:ok, [report_notification], %{incomming_messages: []}}
  end
end