betinajessen

betinajessen

How to run a job periodically

How can I schedule code to run every few hours in Elixir or Phoenix framework?

So let’s say I want to send a bunch of emails or recreate sitemap or whatever every 4 hours, how would I do that in Phoenix or just with Elixir?

Most Liked

dimitarvp

dimitarvp

I recommend you to make a small GenServer that you put in your app’s supervision tree – so it stays alive for as long as the app is live – and have it do something like this:

defmodule PeriodicWorker do
  use GenServer

  @impl true
  def init(period_in_millis) do
    # The `{:continue, :init}` tuple here instructs OTP to run `handle_continue`
    # which in this case will fire the first `:do_stuff` message so the worker
    # does its job once and then schedules itself to run again in the future.
    # Without this you'd have to manually fire the message to the worker
    # when your app starts.
    {:ok, period_in_millis, {:continue, :init}}
  end

  def handle_continue(:init, period_in_millis) do
    GenServer.call(self(), {:do_stuff, period_in_millis})
  end

  @impl true
  def handle_call(:do_stuff, _caller_pid, period_in_millis) do
    do_the_thing_you_need_done_periodically_here()

    schedule_next_do_stuff(period_in_millis)

    # or change `:ok` to the return value of the function that does the real work.
    {:reply, :ok}
  end

  def schedule_next_do_stuff(period_in_millis) do
    Process.send_after(self(), :do_stuff, period_in_millis)
  end
end

You can then supervise it like this in your app:

defmodule YourApp do
  use Application

  def start(_type, _args) d
    children = [
      {PeriodicWorker, 4 * 60 * 60 * 1000}, # 4 hours
      # ... other children ....
    ]

    options = [strategy: :one_for_one, name: YourApp.Supervisor]
    Supervisor.start_link(children, options)
  end
end

Not tested but I’ve done this a number of times and it should match reality closely enough.

derpycoder

derpycoder

Here’s a concrete example, so you can copy and learn from it.

Clone the Plausible Analytics repo, and search by Oban.Worker, you will see tons of example!!

https://github.com/plausible/analytics

Some Excerpts:

for site <- sites do
    SendEmailReport.new(%{site_id: site.id, interval: "weekly"},
      scheduled_at: monday_9am(site.timezone)
    )
    |> Oban.insert!()
end

def monday_9am(timezone) do
    Timex.now(timezone)
    |> Timex.shift(weeks: 1)
    |> Timex.beginning_of_week()
    |> Timex.shift(hours: 9)
end

OR

for site <- sites do
    SendEmailReport.new(%{site_id: site.id, interval: "monthly"},
      scheduled_at: first_of_month_9am(site.timezone)
    )
    |> Oban.insert!()
end

def first_of_month_9am(timezone) do
    Timex.now(timezone)
    |> Timex.shift(months: 1)
    |> Timex.beginning_of_month()
    |> Timex.shift(hours: 9)
end

EmailReports Module

  @impl Oban.Worker
  def perform(%Oban.Job{args: %{"interval" => "weekly", "site_id" => site_id}}) do
    # Send weekly report email
  end

  @impl Oban.Worker
  def perform(%Oban.Job{args: %{"interval" => "monthly", "site_id" => site_id}}) do
    # Send monthly report email
  end
derpycoder

derpycoder

Here’s a site I found that mentions 3 ways to get it done:

https://blog.kommit.co/3-ways-to-schedule-tasks-in-elixir-i-learned-in-3-years-working-with-it-a6ca94e9e71d

The first approach is GenServer which @dimitarvp mentioned.

If your requirements are not complex, you don’t need instrumentation and are not running in distributed mode, then you don’t need anything more.

But if you would like something more, checkout: Oban Git & Documentation

Oban: Robust job processing in Elixir, backed by modern PostgreSQL. Reliable,
observable and loaded with enterprise grade features.

Where Next?

Popular in Questions Top

vertexbuffer
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
New
9mm
I am constructing a JSON object (map) and I need to conditionally set a field. I’m trying to write proper elixir-way code… and I’m at a l...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
New
Kurisu
For example for a current url like http://localhost:4000/cosmetic/products?_utf8=✓&amp;query=perfume&amp;page=2, I would like to get: ...
New
albydarned
Hello all! I am typing this post from my new MacBook Pro with the M1 chip. I’m loving it so far, and will probably use it as my daily dr...
New
alice
Hey, Just curious what are the main benefits of Elixir compared to Clojure? When is Elixir more useful than Clojure and vice versa? Th...
New
nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New
hariharasudhan94
Lets say I have map like this fetching from my database %{"_id" =&gt; #BSON.ObjectId&lt;58eb1a7a9ad169198c3dXXXX&gt;, "email" =&gt; ...
New

Other popular topics Top

senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New
AstonJ
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New
Darmani72
If I have a post route which an argument: post /my_post_route/:my_param1, MyController.my_post_handler How would get the post params ...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
vrod
I am using the Starship cross-shell prompt – it seems pretty nice, but I get some errors: [WARN] - (starship::utils): Executing command ...
New
aalberti333
As the title describes, I’m trying to run Enum.map() over a list of key/value pairs, where the value is a map. My data looks like this: ...
New
saif
Hello everyone, Long time lurker first time poster here. I’ve recently begun working on Elixir full-time again! :raised_hands: It’s been...
New
KronicDeth
Elixir plugin for JetBrain’s IntelliJ Platform (including Rubymine) This is a plugin that adds support for Elixir to JetBrains IntelliJ...
289 36352 110
New
boundedvariable
I am going through the kafka architecture. All the features what the kafka is providing are already in Erlang. I would like hear your opi...
New
komlanvi
Hi everyone, I was playing with phoenix liveView but I run into an issue. I have a form and want to validate each input text when the te...
New

Latest on Elixir Forum

Elixir Forum

We're in Beta

About us Mission Statement