livebook/lib/live_book/runtime/elixir_standalone.ex
Jonatan Kłosko 663ec3283e
Support starting runtime in Mix context (#61)
* Prototype standalone mode with mix

* Move runtime initialization into separate LiveViews

* Make standalone node initialization async

* Refactor async node initialization

* Automatically scroll to the bottom of output

* Refactor streaming output

* Move MessageEmitter under Utils

* Add path selector to the mix runtime picker

* Update runtime descriptions

* Add successful or error message at the end of output

* Run formatter

* Rename Standalone to ElixirStandalone for consistency

* Show only directories when looking for a mix project

* Update docs

* Extract shared standalone logic

* Make the remote primary process monitor Manager instead of session

* Further refactoring and docs

* Add tests for collectable Callback

* Add missing macro doc

* Apply review suggestions

* Decouple sending asynchronous notifications from the runtime initialization

* Apply suggestions
2021-02-26 20:53:29 +01:00

93 lines
2.8 KiB
Elixir

defmodule LiveBook.Runtime.ElixirStandalone do
defstruct [:node, :primary_pid]
# A runtime backed by a standalone Elixir node managed by LiveBook.
#
# LiveBook is responsible for starting and terminating the node.
# Most importantly we have to make sure the started node doesn't
# stay in the system when the session or the entire LiveBook terminates.
import LiveBook.Runtime.StandaloneInit
alias LiveBook.Utils
@type t :: %__MODULE__{
node: node(),
primary_pid: pid()
}
@doc """
Starts a new Elixir node (i.e. a system process) and initializes
it with LiveBook-specific modules and processes.
If no process calls `Runtime.connect/1` for a period of time,
the node automatically terminates. Whoever connects, becomes the owner
and as soon as it terminates, the node terminates as well.
The node may also be terminated manually by using `Runtime.disconnect/1`.
Note: to start the node it is required that `elixir` is a recognised
executable within the system.
"""
@spec init() :: {:ok, t()} | {:error, String.t()}
def init() do
parent_node = node()
child_node = random_node_name()
parent_process_name = random_process_name()
Utils.temporarily_register(self(), parent_process_name, fn ->
with {:ok, elixir_path} <- find_elixir_executable(),
eval <- child_node_ast(parent_node, parent_process_name) |> Macro.to_string(),
port <- start_elixir_node(elixir_path, child_node, eval),
{:ok, primary_pid} <- parent_init_sequence(child_node, port) do
runtime = %__MODULE__{
node: child_node,
primary_pid: primary_pid
}
{:ok, runtime}
else
{:error, error} ->
{:error, error}
end
end)
end
defp start_elixir_node(elixir_path, node_name, eval) do
# Here we create a port to start the system process in a non-blocking way.
Port.open({:spawn_executable, elixir_path}, [
:nouse_stdio,
args: elixir_flags(node_name) ++ ["--eval", eval]
])
end
end
defimpl LiveBook.Runtime, for: LiveBook.Runtime.ElixirStandalone do
alias LiveBook.Runtime.ErlDist
def connect(runtime) do
ErlDist.Manager.set_owner(runtime.node, self())
Process.monitor({ErlDist.Manager, runtime.node})
end
def disconnect(runtime) do
ErlDist.Manager.stop(runtime.node)
end
def evaluate_code(runtime, code, container_ref, evaluation_ref, prev_evaluation_ref \\ :initial) do
ErlDist.Manager.evaluate_code(
runtime.node,
code,
container_ref,
evaluation_ref,
prev_evaluation_ref
)
end
def forget_evaluation(runtime, container_ref, evaluation_ref) do
ErlDist.Manager.forget_evaluation(runtime.node, container_ref, evaluation_ref)
end
def drop_container(runtime, container_ref) do
ErlDist.Manager.drop_container(runtime.node, container_ref)
end
end