Packages

quantum

2.0.0
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.ex
Raw

lib/quantum.ex 

defmodule Quantum do

  @moduledoc """

  Contains config functions to aid the rest of the lib

  """



  require Logger



  alias Quantum.Normalizer

  alias Quantum.Job

  alias Quantum.RunStrategy.Random



  @defaults [global: false,

             cron: [],

             timeout: 5_000,

             schedule: nil,

             overlap: true,

             timezone: :utc,

             run_strategy: {Random, :cluster}]



  @doc """

  Retrieves only scheduler related configuration.

  """

  def scheduler_config(quantum, otp_app, custom) do

    config =

      @defaults

      |> Keyword.merge(Application.get_env(otp_app, quantum, []))

      |> Keyword.merge(custom)

      |> Keyword.merge([otp_app: otp_app, quantum: quantum])



    # Default Runner Name

    runner = if Keyword.fetch!(config, :global),

      do: {:global, Module.concat(quantum, Runner)},

      else: Module.concat(quantum, Runner)



    # Default Task Supervisor Name

    task_supervisor = Module.concat(quantum, Task.Supervisor)



    config

    |> Keyword.put_new(:runner, runner)

    |> Keyword.put_new(:task_supervisor, task_supervisor)

  end



  @doc """

  Retrieves the comprehensive runtime configuration.

  """

  def runtime_config(quantum, otp_app, custom) do

    config = scheduler_config(quantum, otp_app, custom)



    # Load Jobs from Config

    jobs =

      config

      |> Keyword.get(:jobs, [])

      |> Enum.map(&Normalizer.normalize(quantum.new_job(config), &1))

      |> remove_jobs_with_duplicate_names(quantum)



    Keyword.put(config, :jobs, jobs)

  end



  defp remove_jobs_with_duplicate_names(job_list, quantum) do

    Enum.reduce(job_list, [], fn

      %Job{name: nil} = job, acc ->

        [{nil, job} | acc]

      %Job{name: name} = job, acc ->

        if Enum.member?(Keyword.keys(acc), name) do

          Logger.warn("Job with name '#{name}' of quantum '#{quantum}' not started due to duplicate job name")

          acc

        else

          [{name, job} | acc]

        end

    end)

  end

end