1stSolo

1stSolo

Do something after Task death

I have a legacy code that I’m refactoring into executing asynchronously. The easiest would be to start a Task from DynamicSupervisor. But I don’t know how to handle task termination/completion.

  • Don’t need to restart failed tasks, so :temporary mode for supervisor suits me.
  • For normal completion of the task, need to send a message via PubSub
  • For abnormal termination of the task, need to send a message via PubSub and possibly do some cleanup.

I suppose for normal death I can trigger PubSub in the function that calls legacy process and is passed into Task. But abnormal must be caught somehow…

Is DynamicSupervisor suitable for that? How do I catch task’s :DOWN message for whatever reason - normal or abnormal termination?

Marked As Solved

zachallaun

zachallaun

Here’s what I came up with as an exercise. Some small liberties taken based on how I set up Phoenix.PubSub, but hopefully still understandable.

defmodule MyApp.TaskManager do
  use GenServer
  
  @pubsub_topic "really_important_tasks"

  @doc """
  Starts a singleton task manager.
  """
  def start_link(arg) do
    GenServer.start_link(__MODULE__, arg, name: __MODULE__)
  end

  @doc """
  Starts an async task and broadcasts the result or failure.
  """
  def async_task(id, fun) do
    GenServer.cast(__MODULE__, {:async_task, id, fun})
  end
  
  @impl true
  def init(opts) do
    {:ok, %{supervisor: Keyword.fetch!(opts, :supervisor), tasks: %{}}}
  end
  
  @impl true
  def handle_cast({:async_task, id, fun}, %{supervisor: supervisor, tasks: tasks} = state) do
    %Task{ref: ref} = Task.Supervisor.async_nolink(supervisor, fun)
    {:noreply, %{state | tasks: Map.put(tasks, ref, id)}}
  end
  
  @impl true
  def handle_info({ref, result}, state) when is_reference(ref) do
    {:noreply, broadcast_result(state, ref, {:ok, result})}
  end
  
  def handle_info({:DOWN, _ref, :process, _pid, :normal}, state) do
    {:noreply, state}
  end
  
  def handle_info({:DOWN, ref, :process, _pid, reason}, %{tasks: tasks} = state) do
    {:noreply, broadcast_result(state, ref, {:error, reason})}
  end
  
  defp broadcast_result(%{tasks: tasks} = state, ref, result) do
    if id = tasks[ref] do
      MyApp.PubSub.broadcast(@pubsub_topic, {:task, id, result})
    end
    
    %{state | tasks: Map.delete(tasks, ref)}
  end
end

# when starting your application
children = [
  MyApp.PubSub,
  {Task.Supervisor, name: MyApp.TaskSupervisor},
  {MyApp.TaskManager, supervisor: MyApp.TaskSupervisor}
]

Supervisor.start_link(children, strategy: :one_for_one)

# to start tasks
MyApp.TaskManager.async_task("some_important_thing", &do_the_thing/0)

# if you care about results
MyApp.PubSub.subscribe("really_important_tasks:*")

(Having written this out, I think it’s pretty well worth the ~50 lines of code to have control over and insight into task execution.)

Also Liked

zachallaun

zachallaun

I’d additionally recommend using a Task.Supervisor.

iex(1)> Supervisor.start_link([{Task.Supervisor, name: MyTaskSupervisor}], strategy: :one_for_one)
{:ok, #PID<0.114.0>}

iex(2)> Task.Supervisor.async_nolink(MyTaskSupervisor, fn -> :awesome_task end)
%Task{
  mfa: {:erlang, :apply, 2},
  owner: #PID<0.112.0>,
  pid: #PID<0.117.0>,
  ref: #Reference<0.987707504.2573795360.120005>
}

iex(3)> flush()
{#Reference<0.987707504.2573795360.120005>, :awesome_task},
 {:DOWN, #Reference<0.987707504.2573795360.120005>, :process, #PID<0.117.0>, :normal}

iex(4)> Task.Supervisor.async_nolink(MyTaskSupervisor, fn -> raise "uh oh" end)
%Task{
  mfa: {:erlang, :apply, 2},
  owner: #PID<0.112.0>,
  pid: #PID<0.120.0>,
  ref: #Reference<0.987707504.2573795360.120046>
}

iex(5)> flush()
{:DOWN, #Reference<0.987707504.2573795360.120178>, :process, #PID<0.129.0>,
 {%RuntimeError{message: "uh oh"}, ...}}

Docs for async_nolink/3 have some more information on this. Basically, if the task succeeds, you’ll receive a {task_ref, result} message. Regardless of success of failure, you’ll receive a {:DOWN, ref, :process, pid, reason} message. If it was a normal exit, that reason will be :normal. Otherwise, it was abnormal.

Your process kicking off these tasks can implement handle_info and pattern-match on these to broadcast the appropriate PubSub message.

zachallaun

zachallaun

Perhaps you’re used to something like promises that have a success/error callback. That’s just not how the BEAM works, though – the primitives and assumptions are different.

Consider that you could pass a function to the supervisor to run on success/failure of a task. When the supervisor calls your function, what happens if it crashes? It takes down the whole supervisor.

All of these components have been very carefully designed and tested for robustness. Sometimes things seem tricky because there’s a gap in some API or some ergonomics to be improved, but I don’t think that’s the case here.

mpope

mpope

IIRC tasks are linked to the calling process

When invoked, a new process will be created, linked and monitored by the caller. Once the task action finishes, a message will be sent to the caller with the result.

The calling process will need to trap exits, handle the task’s abnormal termination, and then perform the cleanup. This is described here, but what that really means is you just need a handle_info to capture the exit message.

Where Next?

Popular in Questions Top

chrisalley
ExUnit now has describe blocks which is a welcome addition coming from RSpec. In the docs, it states that nested hierarchies of describe ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
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
fayddelight
I tried installing elixir 1.11.2 erlang 23.3.4 via asdf in my zsh shell. Enabled the versions locally and globally. When I list them ...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
Brian
What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....
New
PeterCarter
There are pre-rolled solutions for other frameworks that do work. However, Phoenix does not seem to have these. Have people had good expe...
New
jaysoifer
Is there a way to rollback a specific migration and only that one (“skipping” all the other ones)? Would mix ecto.rollback -v 200809061...
New

Other popular topics 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
msaraiva
Surface is an experimental library built on top of Phoenix LiveView and its new LiveComponent API that aims to provide a more declarative...
564 43806 214
New
Lily
In templates/appointment/index.html.eex: &lt;%= for appointment &lt;- @appointments do %&gt; &lt;tr&gt; &lt;td&gt;&lt;%= appoi...
New
gausby
I asked this very same question on twitter and got some interesting feedback, but I thought it would be a good question to ask here as we...
1207 39523 209
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
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
Brian
What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....
New
dogweather
I wrote this comment on r/haskell, and it’s not popular there. :wink: But I think I’m on to something… Haskell reminds me of Java, and e...
New
JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 54250 245
New
JorisKok
I have a server on AWS, and was running a load test using artillery. When looking at the Phoenix dashboard I see the Ports going to 100% ...
New

We're in Beta

About us Mission Statement