Packages

quantum

2.0.0-beta.1
3.5.3 3.5.2 retired 3.5.1 retired 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.2 3.0.1 3.0.0 3.0.0-rc.3 3.0.0-rc.2 3.0.0-rc.1 2.4.0 2.3.4 2.3.3 2.3.2 2.3.1 retired 2.3.0 retired 2.2.7 2.2.6 2.2.5 retired 2.2.4 retired 2.2.3 retired 2.2.2 retired 2.2.1 retired 2.2.0 retired 2.1.3 retired 2.1.2 retired 2.1.1 retired 2.1.0 retired 2.1.0-beta.1 retired 2.0.4 retired 2.0.3 retired 2.0.2 retired 2.0.1 retired 2.0.0 retired 2.0.0-beta.2 retired 2.0.0-beta.1 retired 1.9.3 retired 1.9.2 retired 1.9.1 retired 1.9.0 retired 1.8.1 retired 1.8.0 retired 1.7.1 retired 1.7.0 retired 1.6.1 retired 1.6.0 retired 1.5.0 retired 1.4.0 retired 1.3.2 retired 1.3.1 retired 1.3.0 retired 1.2.4 retired 1.2.3 retired 1.2.2 retired 1.2.1 retired 1.2.0 retired 1.1.0 retired 1.0.4 retired 1.0.3 retired 1.0.2 retired 1.0.1 retired 1.0.0 retired

Cron-like job scheduler for Elixir.

Retired package: It is possible that tasks are skipped if the execution takes too long
HexDocs

Current section

Files

Jump to
Readme
66 Versions
3 Dependencies
Dependants
Files
Activity
quantum lib quantum executor.ex
Raw

lib/quantum/executor.ex 

defmodule Quantum.Executor do

  @moduledoc false



  alias Crontab.CronExpression

  alias Crontab.DateChecker



  @date_library Application.get_env(:quantum, :date_library, Quantum.DateLibrary.Timex)



  @typep job :: {Quantum.Job.schedule, Quantum.Job.task, Quantum.Job.timezone}

  @typep state :: %{date: NaiveDateTime.t, reboot: boolean}

  @typep executed :: boolean



  @doc """

  Execute a job if the date matches it's schedule.



  ### Parameters:



      * `job`

      * `state`

  """

  @spec execute(job, state) :: executed

  # On Reboot only execute reboot enabled cron expressions

  def execute({%CronExpression{reboot: true}, fun, _}, %{reboot: true}) do

    execute_task(fun)

    true

  end

  def execute(_, %{reboot: true}), do: false

  # Reboot enabled cron expressions run only on reboot, cancel

  def execute({%CronExpression{reboot: true}, _, _}, %{reboot: false}), do: false

  # Check Extended Expression every second

  def execute(job = {%CronExpression{extended: true}, _, _}, state) do

    execute_task_if_date_matches(job, state)

  end

  # On Second 0 check all expressions

  def execute(job = {%CronExpression{extended: false}, _, _}, state = %{date: %NaiveDateTime{second: 0}}) do

      execute_task_if_date_matches(job, state)

  end

  def execute({%CronExpression{extended: false}, _, _}, _), do: false



  @spec execute_task_if_date_matches(job, state) :: executed

  defp execute_task_if_date_matches({cron_expression, task, tz}, %{date: date}) do

    date_naive = convert_to_timezone(date, tz)



    if DateChecker.matches_date?(cron_expression, date_naive) do

      execute_task(task)

      true

    else

      false

    end

  end



  @spec execute_task(Quantum.Job.task) :: any

  defp execute_task({mod, fun, args}), do: :erlang.apply(mod, fun, args)

  defp execute_task(fun) when is_function(fun, 0), do: fun.()



  # Convert date to given TZ.

  #

  # * UTC: No Conversion

  # * Local: Not supported anymore

  # * Other: Convert via `Quantum.DateLibrary`

  @spec convert_to_timezone(NaiveDateTime.t, :utc) :: NaiveDateTime.t

  defp convert_to_timezone(date, :utc), do: date

  @spec convert_to_timezone(NaiveDateTime.t, :local) :: no_return

  defp convert_to_timezone(_, :local), do: raise "TZ local is no longer supported."

  @spec convert_to_timezone(NaiveDateTime.t, String.t) :: NaiveDateTime.t

  defp convert_to_timezone(date, tz), do: @date_library.utc_to_tz(date, tz)

end