defmodule LivebookWeb.SessionLive do use LivebookWeb, :live_view import LivebookWeb.UserHelpers import LivebookWeb.SessionHelpers import Livebook.Utils, only: [format_bytes: 1] alias Livebook.{Sessions, Session, Delta, Notebook, Runtime, LiveMarkdown} alias Livebook.Notebook.{Cell, ContentLoader} alias Livebook.JSInterop on_mount(LivebookWeb.SidebarHook) @impl true def mount(%{"id" => session_id}, _session, socket) do # We use the tracked sessions to locate the session pid, but then # we talk to the session process exclusively for getting all the information case Sessions.fetch_session(session_id) do {:ok, %{pid: session_pid}} -> {data, client_id} = if connected?(socket) do {data, client_id} = Session.register_client(session_pid, self(), socket.assigns.current_user) Session.subscribe(session_id) Livebook.NotebookManager.subscribe_starred_notebooks() {data, client_id} else data = Session.get_data(session_pid) {data, nil} end socket = if connected?(socket) do payload = %{ clients: Enum.map(data.clients_map, fn {client_id, user_id} -> client_info(client_id, data.users_map[user_id]) end) } push_event(socket, "session_init", payload) else socket end session = Session.get_by_pid(session_pid) platform = platform_from_socket(socket) {:ok, socket |> assign( self_path: ~p"/sessions/#{session.id}", session: session, client_id: client_id, platform: platform, data_view: data_to_view(data), autofocus_cell_id: autofocus_cell_id(data.notebook), page_title: get_page_title(data.notebook.name), select_secret_ref: nil, select_secret_options: nil, allowed_uri_schemes: Livebook.Config.allowed_uri_schemes(), starred_files: Livebook.NotebookManager.starred_notebooks() |> starred_files() ) |> assign_private(data: data) |> prune_outputs() |> prune_cell_sources() |> allow_upload(:cell_image, accept: ~w(.jpg .jpeg .png .gif .svg), max_entries: 1, max_file_size: 5_000_000 )} :error -> {:ok, redirect(socket, to: ~p"/")} end end # Puts the given assigns in `socket.private`, # to ensure they are not used for rendering. defp assign_private(socket, assigns) do Enum.reduce(assigns, socket, fn {key, value}, socket -> put_in(socket.private[key], value) end) end defp platform_from_socket(socket) do with user_agent when is_binary(user_agent) <- get_connect_info(socket, :user_agent) do platform_from_user_agent(user_agent) else _ -> nil end end @impl true def render(assigns) do ~H"""
<.sections_list data_view={@data_view} />
<.clients_list data_view={@data_view} client_id={@client_id} />
<.live_component module={LivebookWeb.SessionLive.SecretsListComponent} id="secrets-list" session={@session} secrets={@data_view.secrets} hub_secrets={@data_view.hub_secrets} hub={@data_view.hub} />
<.live_component module={LivebookWeb.SessionLive.AppInfoComponent} id="app-info" session={@session} settings={@data_view.app_settings} apps={@data_view.apps} />
<.runtime_info data_view={@data_view} session={@session} />

<%= @data_view.notebook_name %>

<.menu id="session-menu"> <:toggle> <.menu_item> <.link patch={~p"/sessions/#{@session.id}/export/livemd"} role="menuitem"> <.remix_icon icon="download-2-line" /> Export <.menu_item> <.menu_item> <.menu_item disabled={@data_view.file == nil}> <%= if @data_view.file in @starred_files do %> <% else %> <% end %> <.menu_item> <.remix_icon icon="dashboard-2-line" /> See on Dashboard <.menu_item variant={:danger}> <.link navigate={~p"/home/sessions/#{@session.id}/close"} role="menuitem"> <.remix_icon icon="close-circle-line" /> Close
<.menu position={:bottom_left} id="notebook-hub-menu"> <:toggle>
in <%= @data_view.hub.hub_emoji %> <%= @data_view.hub.hub_name %> <.remix_icon icon="arrow-down-s-line" class="invisible group-hover:visible" />
<.menu_item :for={hub <- @saved_hubs}> <.menu_item> <.link navigate={~p"/hub"} aria-label="Add Hub" role="menuitem"> <.remix_icon icon="add-line" class="align-middle mr-1" /> Add Hub
<.live_component module={LivebookWeb.SessionLive.CellComponent} id={@data_view.setup_cell_view.id} session_id={@session.id} session_pid={@session.pid} client_id={@client_id} runtime={@data_view.runtime} installing?={@data_view.installing?} allowed_uri_schemes={@allowed_uri_schemes} cell_view={@data_view.setup_cell_view} />
<.live_component :for={{section_view, index} <- Enum.with_index(@data_view.section_views)} module={LivebookWeb.SessionLive.SectionComponent} id={section_view.id} index={index} session_id={@session.id} session_pid={@session.pid} client_id={@client_id} runtime={@data_view.runtime} smart_cell_definitions={@data_view.smart_cell_definitions} installing?={@data_view.installing?} allowed_uri_schemes={@allowed_uri_schemes} section_view={section_view} />
<.current_user_modal current_user={@current_user} /> <.modal :if={@live_action == :runtime_settings} id="runtime-settings-modal" show width={:big} patch={@self_path} > <.live_component module={LivebookWeb.SessionLive.RuntimeComponent} id="runtime-settings" session={@session} runtime={@data_view.runtime} /> <.modal :if={@live_action == :file_settings} id="persistence-modal" show width={:big} patch={@self_path} > <.live_component module={LivebookWeb.SessionLive.PersistenceComponent} id="persistence" session={@session} file={@data_view.file} persist_outputs={@data_view.persist_outputs} autosave_interval_s={@data_view.autosave_interval_s} /> <.modal :if={@live_action == :shortcuts} id="shortcuts-modal" show width={:large} patch={@self_path} > <.live_component module={LivebookWeb.SessionLive.ShortcutsComponent} id="shortcuts" platform={@platform} /> <.modal :if={@live_action == :cell_settings} id="cell-settings-modal" show width={:medium} patch={@self_path} > <.live_component module={settings_component_for(@cell)} id="cell-settings" session={@session} return_to={@self_path} cell={@cell} /> <.modal :if={@live_action == :cell_upload} id="cell-upload-modal" show width={:medium} patch={@self_path} > <.live_component module={LivebookWeb.SessionLive.CellUploadComponent} id="cell-upload" session={@session} return_to={@self_path} uploads={@uploads} cell_upload_metadata={@cell_upload_metadata} /> <.modal :if={@live_action == :delete_section} id="delete-section-modal" show width={:medium} patch={@self_path} > <.live_component module={LivebookWeb.SessionLive.DeleteSectionComponent} id="delete-section" session={@session} return_to={@self_path} section={@section} is_first={@section.id == @first_section_id} /> <.modal :if={@live_action == :bin} id="bin-modal" show width={:big} patch={@self_path}> <.live_component module={LivebookWeb.SessionLive.BinComponent} id="bin" session={@session} return_to={@self_path} bin_entries={@data_view.bin_entries} /> <.modal :if={@live_action == :export} id="export-modal" show width={:big} patch={@self_path}> <.live_component module={LivebookWeb.SessionLive.ExportComponent} id="export" session={@session} tab={@tab} /> <.modal :if={@live_action == :package_search} id="package-search-modal" show width={:medium} patch={@self_path} > <%= live_render(@socket, LivebookWeb.SessionLive.PackageSearchLive, id: "package-search", session: %{ "session" => @session, "runtime" => @data_view.runtime, "return_to" => @self_path } ) %> <.modal :if={@live_action == :secrets} id="secrets-modal" show width={:big} patch={@self_path}> <.live_component module={LivebookWeb.SessionLive.SecretsComponent} id="secrets" session={@session} secrets={@data_view.secrets} hub_secrets={@data_view.hub_secrets} hub={@data_view.hub} prefill_secret_name={@prefill_secret_name} select_secret_ref={@select_secret_ref} select_secret_options={@select_secret_options} return_to={@self_path} /> """ end defp button_item(assigns) do ~H""" """ end defp link_item(assigns) do assigns = assign_new(assigns, :link_attrs, fn -> [] end) ~H""" <.link patch={@path} class={[ "text-gray-400 hover:text-gray-50 focus:text-gray-50 rounded-xl h-10 w-10 flex items-center justify-center", @active && "text-gray-50 bg-gray-700" ]} aria-label={@label} {@link_attrs} > <.remix_icon icon={@icon} class="text-2xl" /> """ end defp sections_list(assigns) do ~H"""

Sections

<.section_status status={elem(section_item.status, 0)} cell_id={elem(section_item.status, 1)} />
""" end defp clients_list(assigns) do ~H"""

Users

<%= length(@data_view.clients) %> connected
<%= if client_id != @client_id do %> <% end %>
""" end defp runtime_info(assigns) do ~H"""

Runtime

<.link patch={~p"/sessions/#{@session.id}/settings/runtime"} class="icon-button p-0"> <.remix_icon icon="settings-3-line text-xl" />
<.labeled_text :for={{label, value} <- Runtime.describe(@data_view.runtime)} label={label} one_line > <%= value %>
<%= if Runtime.connected?(@data_view.runtime) do %> <% else %> <.link patch={~p"/sessions/#{@session.id}/settings/runtime"} class="button-base button-outlined-gray bg-transparent" > Configure <% end %>
<%= if uses_memory?(@session.memory_usage) do %> <.memory_info memory_usage={@session.memory_usage} /> <% else %>
Memory

<%= format_bytes(@session.memory_usage.system.free) %> available out of <%= format_bytes( @session.memory_usage.system.total ) %>

<% end %>
""" end defp memory_info(assigns) do assigns = assign(assigns, :runtime_memory, runtime_memory(assigns.memory_usage)) ~H"""
Memory <%= format_bytes(@memory_usage.system.free) %> available
<%= type %> <%= memory.unit %>
Total: <%= format_bytes(@memory_usage.runtime.total) %>
""" end defp section_status(%{status: :evaluating} = assigns) do ~H""" """ end defp section_status(%{status: :stale} = assigns) do ~H""" """ end defp section_status(assigns), do: ~H"" defp settings_component_for(%Cell.Code{}), do: LivebookWeb.SessionLive.CodeCellSettingsComponent defp branching_tooltip_attrs(name, parent_name) do direction = if String.length(name) >= 16, do: "left", else: "right" wrapped_name = Livebook.Utils.wrap_line("”" <> parent_name <> "”", 16) label = "Branches from\n#{wrapped_name}" [class: "tooltip #{direction}", data_tooltip: label] end @impl true def handle_params(%{"cell_id" => cell_id}, _url, socket) when socket.assigns.live_action == :cell_settings do {:ok, cell, _} = Notebook.fetch_cell_and_section(socket.private.data.notebook, cell_id) {:noreply, assign(socket, cell: cell)} end def handle_params(%{"section_id" => section_id, "cell_id" => cell_id}, _url, socket) when socket.assigns.live_action == :cell_upload do cell_id = case cell_id do "" -> nil id -> id end {:noreply, assign(socket, cell_upload_metadata: %{section_id: section_id, cell_id: cell_id})} end def handle_params(%{"section_id" => section_id}, _url, socket) when socket.assigns.live_action == :delete_section do {:ok, section} = Notebook.fetch_section(socket.private.data.notebook, section_id) first_section_id = hd(socket.private.data.notebook.sections).id {:noreply, assign(socket, section: section, first_section_id: first_section_id)} end def handle_params(%{"path_parts" => path_parts}, requested_url, socket) when socket.assigns.live_action == :catch_all do path_parts = Enum.map(path_parts, fn "__parent__" -> ".." part -> part end) path = Path.join(path_parts) {:noreply, handle_relative_path(socket, path, requested_url)} end def handle_params(%{"tab" => tab}, _url, socket) when socket.assigns.live_action == :export do {:noreply, assign(socket, tab: tab)} end def handle_params(params, _url, socket) when socket.assigns.live_action == :secrets do socket = if params["preselect_name"] do assign(socket, prefill_secret_name: params["preselect_name"]) else # Erase any previously stored reference assign(socket, prefill_secret_name: params["secret_name"], select_secret_ref: nil, select_secret_options: nil ) end {:noreply, socket} end def handle_params(_params, _url, socket) do {:noreply, socket} end @impl true def handle_event("append_section", %{}, socket) do idx = length(socket.private.data.notebook.sections) Session.insert_section(socket.assigns.session.pid, idx) {:noreply, socket} end def handle_event("insert_section_below", params, socket) do with {:ok, section, index} <- section_with_next_index( socket.private.data.notebook, params["section_id"], params["cell_id"] ) do Session.insert_section_into(socket.assigns.session.pid, section.id, index) end {:noreply, socket} end def handle_event( "set_section_parent", %{"section_id" => section_id, "parent_id" => parent_id}, socket ) do Session.set_section_parent(socket.assigns.session.pid, section_id, parent_id) {:noreply, socket} end def handle_event("unset_section_parent", %{"section_id" => section_id}, socket) do Session.unset_section_parent(socket.assigns.session.pid, section_id) {:noreply, socket} end def handle_event("insert_cell_below", params, socket) do {type, attrs} = cell_type_and_attrs_from_params(params) with {:ok, section, index} <- section_with_next_index( socket.private.data.notebook, params["section_id"], params["cell_id"] ) do Session.insert_cell(socket.assigns.session.pid, section.id, index, type, attrs) end {:noreply, socket} end def handle_event("delete_cell", %{"cell_id" => cell_id}, socket) do Session.delete_cell(socket.assigns.session.pid, cell_id) {:noreply, socket} end def handle_event("set_notebook_name", %{"value" => name}, socket) do name = normalize_name(name) Session.set_notebook_name(socket.assigns.session.pid, name) {:noreply, socket} end def handle_event("set_section_name", %{"metadata" => section_id, "value" => name}, socket) do name = normalize_name(name) Session.set_section_name(socket.assigns.session.pid, section_id, name) {:noreply, socket} end def handle_event( "apply_cell_delta", %{"cell_id" => cell_id, "tag" => tag, "delta" => delta, "revision" => revision}, socket ) do tag = String.to_atom(tag) delta = Delta.from_compressed(delta) Session.apply_cell_delta(socket.assigns.session.pid, cell_id, tag, delta, revision) {:noreply, socket} end def handle_event( "report_cell_revision", %{"cell_id" => cell_id, "tag" => tag, "revision" => revision}, socket ) do tag = String.to_atom(tag) Session.report_cell_revision(socket.assigns.session.pid, cell_id, tag, revision) {:noreply, socket} end def handle_event("move_cell", %{"cell_id" => cell_id, "offset" => offset}, socket) do offset = ensure_integer(offset) Session.move_cell(socket.assigns.session.pid, cell_id, offset) {:noreply, socket} end def handle_event("move_section", %{"section_id" => section_id, "offset" => offset}, socket) do offset = ensure_integer(offset) Session.move_section(socket.assigns.session.pid, section_id, offset) {:noreply, socket} end def handle_event("delete_section", %{"section_id" => section_id}, socket) do socket = case Notebook.fetch_section(socket.private.data.notebook, section_id) do {:ok, %{cells: []} = section} -> Session.delete_section(socket.assigns.session.pid, section.id, true) socket {:ok, section} -> push_patch(socket, to: ~p"/sessions/#{socket.assigns.session.id}/delete-section/#{section.id}" ) :error -> socket end {:noreply, socket} end def handle_event("recover_smart_cell", %{"cell_id" => cell_id}, socket) do Session.recover_smart_cell(socket.assigns.session.pid, cell_id) {:noreply, socket} end def handle_event("convert_smart_cell", %{"cell_id" => cell_id}, socket) do Session.convert_smart_cell(socket.assigns.session.pid, cell_id) {:noreply, socket} end def handle_event( "add_smart_cell_dependencies", %{"kind" => kind, "variant_idx" => variant_idx}, socket ) do with %{requirement: %{variants: variants}} <- Enum.find(socket.private.data.smart_cell_definitions, &(&1.kind == kind)), {:ok, variant} <- Enum.fetch(variants, variant_idx) do dependencies = Enum.map(variant.packages, & &1.dependency) Session.add_dependencies(socket.assigns.session.pid, dependencies) end {status, socket} = maybe_reconnect_runtime(socket) if status == :ok do Session.queue_cell_evaluation(socket.assigns.session.pid, Cell.setup_cell_id()) end {:noreply, socket} end def handle_event("queue_cell_evaluation", %{"cell_id" => cell_id} = params, socket) do data = socket.private.data {status, socket} = with {:ok, cell, _section} <- Notebook.fetch_cell_and_section(data.notebook, cell_id), true <- Cell.setup?(cell), false <- data.cell_infos[cell.id].eval.validity == :fresh do maybe_reconnect_runtime(socket) else _ -> {:ok, socket} end if params["disable_dependencies_cache"] do Session.disable_dependencies_cache(socket.assigns.session.pid) end if status == :ok do Session.queue_cell_evaluation(socket.assigns.session.pid, cell_id) end {:noreply, socket} end def handle_event("queue_section_evaluation", %{"section_id" => section_id}, socket) do Session.queue_section_evaluation(socket.assigns.session.pid, section_id) {:noreply, socket} end def handle_event("queue_full_evaluation", %{"forced_cell_ids" => forced_cell_ids}, socket) do Session.queue_full_evaluation(socket.assigns.session.pid, forced_cell_ids) {:noreply, socket} end def handle_event("cancel_cell_evaluation", %{"cell_id" => cell_id}, socket) do Session.cancel_cell_evaluation(socket.assigns.session.pid, cell_id) {:noreply, socket} end def handle_event("queue_cells_reevaluation", %{}, socket) do Session.queue_cells_reevaluation(socket.assigns.session.pid) {:noreply, socket} end def handle_event( "set_reevaluate_automatically", %{"value" => value, "cell_id" => cell_id}, socket ) do Session.set_cell_attributes(socket.assigns.session.pid, cell_id, %{ reevaluate_automatically: value }) {:noreply, socket} end def handle_event("save", %{}, socket) do if socket.private.data.file do Session.save(socket.assigns.session.pid) {:noreply, socket} else {:noreply, push_patch(socket, to: ~p"/sessions/#{socket.assigns.session.id}/settings/file")} end end def handle_event("reconnect_runtime", %{}, socket) do {_, socket} = maybe_reconnect_runtime(socket) {:noreply, socket} end def handle_event("connect_runtime", %{}, socket) do {_, socket} = connect_runtime(socket) {:noreply, socket} end def handle_event("setup_default_runtime", %{}, socket) do {status, socket} = connect_runtime(socket) if status == :ok do Session.queue_cell_evaluation(socket.assigns.session.pid, Cell.setup_cell_id()) end {:noreply, socket} end def handle_event("disconnect_runtime", %{}, socket) do Session.disconnect_runtime(socket.assigns.session.pid) {:noreply, socket} end def handle_event("intellisense_request", %{"cell_id" => cell_id} = params, socket) do request = case params do %{"type" => "completion", "hint" => hint} -> {:completion, hint} %{"type" => "details", "line" => line, "column" => column} -> column = JSInterop.js_column_to_elixir(column, line) {:details, line, column} %{"type" => "signature", "hint" => hint} -> {:signature, hint} %{"type" => "format", "code" => code} -> {:format, code} end data = socket.private.data with {:ok, cell, _section} <- Notebook.fetch_cell_and_section(data.notebook, cell_id) do if Runtime.connected?(data.runtime) do parent_locators = Session.parent_locators_for_cell(data, cell) ref = Runtime.handle_intellisense(data.runtime, self(), request, parent_locators) {:reply, %{"ref" => inspect(ref)}, socket} else info = cond do params["type"] == "completion" and not params["editor_auto_completion"] -> "You need to start a runtime (or evaluate a cell) for code completion" params["type"] == "format" -> "You need to start a runtime (or evaluate a cell) to enable code formatting" true -> nil end socket = if info, do: put_flash(socket, :info, info), else: socket {:reply, %{"ref" => nil}, socket} end else _ -> {:noreply, socket} end end def handle_event("fork_session", %{}, socket) do %{pid: pid, images_dir: images_dir} = socket.assigns.session # Fetch the data, as we don't keep cells' source in the state data = Session.get_data(pid) notebook = Notebook.forked(data.notebook) {:noreply, create_session(socket, notebook: notebook, copy_images_from: images_dir)} end def handle_event("star_notebook", %{}, socket) do data = socket.private.data Livebook.NotebookManager.add_starred_notebook(data.file, data.notebook.name) {:noreply, socket} end def handle_event("unstar_notebook", %{}, socket) do Livebook.NotebookManager.remove_starred_notebook(socket.private.data.file) {:noreply, socket} end def handle_event("erase_outputs", %{}, socket) do Session.erase_outputs(socket.assigns.session.pid) {:noreply, socket} end def handle_event("location_report", report, socket) do Phoenix.PubSub.broadcast_from( Livebook.PubSub, self(), "sessions:#{socket.assigns.session.id}", {:location_report, socket.assigns.client_id, report} ) {:noreply, socket} end def handle_event( "select_secret", %{ "js_view_ref" => select_secret_ref, "preselect_name" => preselect_name, "options" => select_secret_options }, socket ) do socket = assign(socket, select_secret_ref: select_secret_ref, select_secret_options: select_secret_options ) {:noreply, push_patch(socket, to: ~p"/sessions/#{socket.assigns.session.id}/secrets?preselect_name=#{preselect_name}" )} end def handle_event("select_hub", %{"id" => id}, socket) do Session.set_notebook_hub(socket.assigns.session.pid, id) {:noreply, socket} end @impl true def handle_info({:operation, operation}, socket) do {:noreply, handle_operation(socket, operation)} end def handle_info({:error, error}, socket) do message = error |> to_string() |> upcase_first() {:noreply, put_flash(socket, :error, message)} end def handle_info({:hydrate_bin_entries, hydrated_entries}, socket) do hydrated_entries_map = Map.new(hydrated_entries, fn entry -> {entry.cell.id, entry} end) data = Map.update!(socket.private.data, :bin_entries, fn bin_entries -> Enum.map(bin_entries, fn entry -> case Map.fetch(hydrated_entries_map, entry.cell.id) do {:ok, hydrated_entry} -> hydrated_entry :error -> entry end end) end) {:noreply, socket |> assign_private(data: data) |> assign(data_view: data_to_view(data))} end def handle_info({:session_updated, session}, socket) do {:noreply, assign(socket, :session, session)} end def handle_info(:session_closed, socket) do {:noreply, socket |> put_flash(:info, "Session has been closed") |> push_navigate(to: ~p"/")} end def handle_info({:runtime_intellisense_response, ref, request, response}, socket) do response = process_intellisense_response(response, request) payload = %{"ref" => inspect(ref), "response" => response} {:noreply, push_event(socket, "intellisense_response", payload)} end def handle_info({:location_report, client_id, report}, socket) do report = Map.put(report, :client_id, client_id) {:noreply, push_event(socket, "location_report", report)} end def handle_info({:set_input_values, values, local}, socket) do if local do socket = Enum.reduce(values, socket, fn {input_id, value}, socket -> operation = {:set_input_value, socket.assigns.client_id, input_id, value} handle_operation(socket, operation) end) {:noreply, socket} else for {input_id, value} <- values do Session.set_input_value(socket.assigns.session.pid, input_id, value) end {:noreply, socket} end end def handle_info({:queue_bound_cells_evaluation, input_id}, socket) do Session.queue_bound_cells_evaluation(socket.assigns.session.pid, input_id) {:noreply, socket} end def handle_info({:cell_upload_complete, metadata, url}, socket) do params = %{ "type" => "image", "section_id" => metadata.section_id, "cell_id" => metadata.cell_id, "url" => url } handle_event("insert_cell_below", params, socket) end def handle_info({:push_patch, to}, socket) do {:noreply, push_patch(socket, to: to)} end def handle_info({:starred_notebooks_updated, starred_notebooks}, socket) do {:noreply, assign(socket, starred_files: starred_files(starred_notebooks))} end def handle_info(_message, socket), do: {:noreply, socket} defp handle_relative_path(socket, path, requested_url) do cond do String.ends_with?(path, LiveMarkdown.extension()) -> handle_relative_notebook_path(socket, path, requested_url) true -> socket |> put_flash( :error, "Got unrecognised session path: #{path}\nIf you want to link another notebook, make sure to include the .livemd extension" ) |> redirect_to_self() end end defp handle_relative_notebook_path(socket, relative_path, requested_url) do resolution_location = location(socket.private.data) case resolution_location do nil -> socket |> put_flash( :info, "Cannot resolve notebook path #{relative_path}, because the current notebook has no location" ) |> redirect_to_self() resolution_location -> origin = ContentLoader.resolve_location(resolution_location, relative_path) fallback_locations = fallback_relative_locations(resolution_location, relative_path) case session_id_by_location(origin) do {:ok, session_id} -> redirect_path = session_path(session_id, url_hash: get_url_hash(requested_url)) push_navigate(socket, to: redirect_path) {:error, :none} -> open_notebook(socket, origin, fallback_locations, requested_url) {:error, :many} -> origin_str = case origin do {:url, url} -> url {:file, file} -> file.path end socket |> put_flash( :error, "Cannot navigate, because multiple sessions were found for #{origin_str}" ) |> redirect_to_self() end end end defp location(data) defp location(%{file: file}) when is_map(file), do: {:file, file} defp location(%{origin: origin}), do: origin defp get_url_hash(requested_url) do case String.split(requested_url, "#") do [_, url_hash] -> url_hash _ -> nil end end defp open_notebook(socket, origin, fallback_locations, requested_url) do case fetch_content_with_fallbacks(origin, fallback_locations) do {:ok, content} -> {notebook, messages} = Livebook.LiveMarkdown.notebook_from_livemd(content) # If the current session has no file, fork the notebook fork? = socket.private.data.file == nil {file, notebook} = file_and_notebook(fork?, origin, notebook) url_hash = get_url_hash(requested_url) socket |> put_import_warnings(messages) |> create_session( notebook: notebook, origin: origin, file: file, url_hash: url_hash ) {:error, message} -> socket |> put_flash(:error, "Cannot navigate, " <> message) |> redirect_to_self() end end def fallback_relative_locations({:file, _}, _relative_path), do: [] def fallback_relative_locations(resolution_location, relative_path) do # Other locations to check in case the relative location doesn't # exist. For example, in ExDoc all pages (including notebooks) are # flat, regardless of how they are structured in the file system name = relative_path |> String.split("/") |> Enum.at(-1) flat_location = ContentLoader.resolve_location(resolution_location, name) [flat_location] end defp fetch_content_with_fallbacks(location, fallbacks) do case ContentLoader.fetch_content_from_location(location) do {:ok, content} -> {:ok, content} error -> fallbacks |> Enum.reject(&(&1 == location)) |> Enum.find_value(error, fn fallback -> with {:error, _} <- ContentLoader.fetch_content_from_location(fallback), do: nil end) end end defp file_and_notebook(fork?, origin, notebook) defp file_and_notebook(false, {:file, file}, notebook), do: {file, notebook} defp file_and_notebook(true, {:file, _file}, notebook), do: {nil, Notebook.forked(notebook)} defp file_and_notebook(_fork?, _origin, notebook), do: {nil, notebook} defp session_id_by_location(location) do sessions = Sessions.list_sessions() session_with_file = Enum.find(sessions, fn session -> session.file && {:file, session.file} == location end) # A session associated with the given file takes # precedence over sessions originating from this file if session_with_file do {:ok, session_with_file.id} else sessions |> Enum.filter(fn session -> session.origin == location end) |> case do [session] -> {:ok, session.id} [] -> {:error, :none} _ -> {:error, :many} end end end defp redirect_to_self(socket) do push_patch(socket, to: ~p"/sessions/#{socket.assigns.session.id}") end defp handle_operation(socket, operation) do case Session.Data.apply_operation(socket.private.data, operation) do {:ok, data, actions} -> socket |> assign_private(data: data) |> assign( data_view: update_data_view(socket.assigns.data_view, socket.private.data, data, operation) ) |> after_operation(socket, operation) |> handle_actions(actions) :error -> socket end end defp after_operation(socket, _prev_socket, {:client_join, client_id, user}) do push_event(socket, "client_joined", %{client: client_info(client_id, user)}) end defp after_operation(socket, _prev_socket, {:client_leave, client_id}) do push_event(socket, "client_left", %{client_id: client_id}) end defp after_operation(socket, _prev_socket, {:update_user, _client_id, user}) do updated_clients = socket.private.data.clients_map |> Enum.filter(fn {_client_id, user_id} -> user_id == user.id end) |> Enum.map(fn {client_id, _user_id} -> client_info(client_id, user) end) push_event(socket, "clients_updated", %{clients: updated_clients}) end defp after_operation(socket, _prev_socket, {:set_notebook_name, _client_id, name}) do assign(socket, page_title: get_page_title(name)) end defp after_operation(socket, _prev_socket, {:insert_section, client_id, _index, section_id}) do if client_id == socket.assigns.client_id do push_event(socket, "section_inserted", %{section_id: section_id}) else socket end end defp after_operation( socket, _prev_socket, {:insert_section_into, client_id, _section_id, _index, section_id} ) do if client_id == socket.assigns.client_id do push_event(socket, "section_inserted", %{section_id: section_id}) else socket end end defp after_operation( socket, _prev_socket, {:delete_section, _client_id, section_id, _delete_cells} ) do push_event(socket, "section_deleted", %{section_id: section_id}) end defp after_operation(socket, _prev_socket, {:insert_cell, client_id, _, _, _, cell_id, _attrs}) do socket = prune_cell_sources(socket) if client_id == socket.assigns.client_id do push_event(socket, "cell_inserted", %{cell_id: cell_id}) else socket end end defp after_operation(socket, prev_socket, {:delete_cell, _client_id, cell_id}) do # Find a sibling cell that the client would focus if the deleted cell has focus. sibling_cell_id = case Notebook.fetch_cell_sibling(prev_socket.private.data.notebook, cell_id, 1) do {:ok, next_cell} -> next_cell.id :error -> case Notebook.fetch_cell_sibling(prev_socket.private.data.notebook, cell_id, -1) do {:ok, previous_cell} -> previous_cell.id :error -> nil end end push_event(socket, "cell_deleted", %{cell_id: cell_id, sibling_cell_id: sibling_cell_id}) end defp after_operation(socket, _prev_socket, {:restore_cell, client_id, cell_id}) do socket = prune_cell_sources(socket) if client_id == socket.assigns.client_id do push_event(socket, "cell_restored", %{cell_id: cell_id}) else socket end end defp after_operation(socket, _prev_socket, {:move_cell, client_id, cell_id, _offset}) do if client_id == socket.assigns.client_id do push_event(socket, "cell_moved", %{cell_id: cell_id}) else socket end end defp after_operation(socket, _prev_socket, {:move_section, client_id, section_id, _offset}) do if client_id == socket.assigns.client_id do push_event(socket, "section_moved", %{section_id: section_id}) else socket end end defp after_operation( socket, _prev_socket, {:add_cell_evaluation_output, _client_id, _cell_id, _output} ) do prune_outputs(socket) end defp after_operation( socket, _prev_socket, {:add_cell_evaluation_response, _client_id, cell_id, _output, metadata} ) do socket |> prune_outputs() |> push_event("evaluation_finished:#{cell_id}", %{code_error: metadata.code_error}) end defp after_operation( socket, _prev_socket, {:smart_cell_started, _client_id, _cell_id, _delta, _chunks, _js_view, _editor} ) do prune_cell_sources(socket) end defp after_operation(socket, _prev_socket, _operation), do: socket defp handle_actions(socket, actions) do Enum.reduce(actions, socket, &handle_action(&2, &1)) end defp handle_action(socket, {:broadcast_delta, client_id, cell, tag, delta}) do if client_id == socket.assigns.client_id do push_event(socket, "cell_acknowledgement:#{cell.id}:#{tag}", %{}) else push_event(socket, "cell_delta:#{cell.id}:#{tag}", %{delta: Delta.to_compressed(delta)}) end end defp handle_action(socket, _action), do: socket defp client_info(id, user) do %{id: id, hex_color: user.hex_color, name: user.name || "Anonymous"} end defp normalize_name(name) do name |> String.trim() |> String.replace(~r/\s+/, " ") |> case do "" -> "Untitled" name -> name end end def upcase_first(string) do {head, tail} = String.split_at(string, 1) String.upcase(head) <> tail end defp cell_type_and_attrs_from_params(%{"type" => "markdown"}), do: {:markdown, %{}} defp cell_type_and_attrs_from_params(%{"type" => "code"}), do: {:code, %{}} defp cell_type_and_attrs_from_params(%{"type" => "smart", "kind" => kind}) do {:smart, %{kind: kind}} end defp cell_type_and_attrs_from_params(%{"type" => "diagram"}) do source = """ ```mermaid graph TD; A-->B; A-->C; B-->D; C-->D; ```\ """ {:markdown, %{source: source}} end defp cell_type_and_attrs_from_params(%{"type" => "image", "url" => url}) do source = "![](#{url})" {:markdown, %{source: source}} end defp section_with_next_index(notebook, section_id, cell_id) defp section_with_next_index(notebook, section_id, nil) do with {:ok, section} <- Notebook.fetch_section(notebook, section_id) do {:ok, section, 0} end end defp section_with_next_index(notebook, _section_id, cell_id) do with {:ok, cell, section} <- Notebook.fetch_cell_and_section(notebook, cell_id) do index = Enum.find_index(section.cells, &(&1 == cell)) {:ok, section, index + 1} end end defp ensure_integer(n) when is_integer(n), do: n defp ensure_integer(n) when is_binary(n), do: String.to_integer(n) defp encode_digest(nil), do: nil defp encode_digest(digest), do: Base.encode64(digest) defp process_intellisense_response( %{range: %{from: from, to: to}} = response, {:details, line, _column} ) do %{ response | range: %{ from: JSInterop.elixir_column_to_js(from, line), to: JSInterop.elixir_column_to_js(to, line) } } end # Currently we don't use signature docs, so we optimise the response # to exclude them defp process_intellisense_response( %{signature_items: signature_items} = response, {:signature, _hint} ) do %{response | signature_items: Enum.map(signature_items, &%{&1 | documentation: nil})} end defp process_intellisense_response(response, _request), do: response defp autofocus_cell_id(%Notebook{sections: [%{cells: [%{id: id, source: ""}]}]}), do: id defp autofocus_cell_id(_notebook), do: nil defp connect_runtime(socket) do case Runtime.connect(socket.private.data.runtime) do {:ok, runtime} -> Session.set_runtime(socket.assigns.session.pid, runtime) {:ok, socket} {:error, message} -> {:error, put_flash(socket, :error, "Failed to connect runtime - #{message}")} end end defp maybe_reconnect_runtime(%{private: %{data: data}} = socket) do if Runtime.connected?(data.runtime) do data.runtime |> Runtime.duplicate() |> Runtime.connect() |> case do {:ok, new_runtime} -> Session.set_runtime(socket.assigns.session.pid, new_runtime) {:ok, clear_flash(socket, :error)} {:error, message} -> {:error, put_flash(socket, :error, "Failed to connect runtime - #{message}")} end else {:ok, socket} end end defp starred_files(starred_notebooks) do for info <- starred_notebooks, into: MapSet.new(), do: info.file end # Builds view-specific structure of data by cherry-picking # only the relevant attributes. # We then use `@data_view` in the templates and consequently # irrelevant changes to data don't change `@data_view`, so LV doesn't # have to traverse the whole template tree and no diff is sent to the client. defp data_to_view(data) do %{ file: data.file, persist_outputs: data.notebook.persist_outputs, autosave_interval_s: data.notebook.autosave_interval_s, dirty: data.dirty, runtime: data.runtime, smart_cell_definitions: data.smart_cell_definitions, global_status: global_status(data), notebook_name: data.notebook.name, sections_items: for section <- data.notebook.sections do %{ id: section.id, name: section.name, parent: parent_section_view(section.parent_id, data), status: cells_status(section.cells, data) } end, clients: data.clients_map |> Enum.map(fn {client_id, user_id} -> {client_id, data.users_map[user_id]} end) |> Enum.sort_by(fn {_client_id, user} -> user.name end), installing?: data.cell_infos[Cell.setup_cell_id()].eval.status == :evaluating, setup_cell_view: %{cell_to_view(hd(data.notebook.setup_section.cells), data) | type: :setup}, section_views: section_views(data.notebook.sections, data), bin_entries: data.bin_entries, secrets: data.secrets, hub: Livebook.Hubs.fetch_hub!(data.notebook.hub_id), hub_secrets: data.hub_secrets, apps_status: apps_status(data), app_settings: data.notebook.app_settings, apps: data.apps } end defp cells_status(cells, data) do eval_infos = for cell <- cells, Cell.evaluable?(cell), info = data.cell_infos[cell.id].eval, do: Map.put(info, :id, cell.id) most_recent = eval_infos |> Enum.filter(& &1.evaluation_end) |> Enum.max_by(& &1.evaluation_end, DateTime, fn -> nil end) cond do evaluating = Enum.find(eval_infos, &(&1.status == :evaluating)) -> {:evaluating, evaluating.id} most_recent != nil and most_recent.errored -> {:errored, most_recent.id} stale = Enum.find(eval_infos, &(&1.validity == :stale)) -> {:stale, stale.id} most_recent != nil -> {:evaluated, most_recent.id} true -> {:fresh, nil} end end defp global_status(data) do cells = data.notebook |> Notebook.evaluable_cells_with_section() |> Enum.map(fn {cell, _} -> cell end) cells_status(cells, data) end defp section_views(sections, data) do sections |> Enum.map(& &1.name) |> names_to_html_ids() |> Enum.zip(sections) |> Enum.map(fn {html_id, section} -> %{ id: section.id, html_id: html_id, name: section.name, parent: parent_section_view(section.parent_id, data), has_children?: Notebook.child_sections(data.notebook, section.id) != [], valid_parents: for parent <- Notebook.valid_parents_for(data.notebook, section.id) do %{id: parent.id, name: parent.name} end, cell_views: Enum.map(section.cells, &cell_to_view(&1, data)) } end) end defp parent_section_view(nil, _data), do: nil defp parent_section_view(parent_id, data) do {:ok, section} = Notebook.fetch_section(data.notebook, parent_id) %{id: section.id, name: section.name} end defp cell_to_view(%Cell.Markdown{} = cell, data) do info = data.cell_infos[cell.id] %{ id: cell.id, type: :markdown, source_view: source_view(cell.source, info.sources.primary) } end defp cell_to_view(%Cell.Code{} = cell, data) do info = data.cell_infos[cell.id] %{ id: cell.id, type: :code, source_view: source_view(cell.source, info.sources.primary), eval: eval_info_to_view(cell, info.eval, data), reevaluate_automatically: cell.reevaluate_automatically } end defp cell_to_view(%Cell.Smart{} = cell, data) do info = data.cell_infos[cell.id] %{ id: cell.id, type: :smart, source_view: source_view(cell.source, info.sources.primary), eval: eval_info_to_view(cell, info.eval, data), status: info.status, js_view: cell.js_view, editor: cell.editor && %{ language: cell.editor.language, placement: cell.editor.placement, source_view: source_view(cell.editor.source, info.sources.secondary) } } end defp eval_info_to_view(cell, eval_info, data) do %{ outputs: cell.outputs, validity: eval_info.validity, status: eval_info.status, errored: eval_info.errored, reevaluates_automatically: eval_info.reevaluates_automatically, evaluation_time_ms: eval_info.evaluation_time_ms, evaluation_start: eval_info.evaluation_start, evaluation_digest: encode_digest(eval_info.evaluation_digest), outputs_batch_number: eval_info.outputs_batch_number, # Pass input values relevant to the given cell input_values: input_values_for_cell(cell, data) } end defp source_view(:__pruned__, _source_info) do :__pruned__ end defp source_view(source, source_info) do %{ source: source, revision: source_info.revision } end defp input_values_for_cell(cell, data) do input_ids = for output <- cell.outputs, attrs <- Cell.find_inputs_in_output(output), do: attrs.id Map.take(data.input_values, input_ids) end defp apps_status(%{apps: []}), do: nil defp apps_status(%{apps: [app | _]}), do: app.status # Updates current data_view in response to an operation. # In most cases we simply recompute data_view, but for the # most common ones we only update the relevant parts. defp update_data_view(data_view, prev_data, data, operation) do case operation do {:report_cell_revision, _client_id, _cell_id, _tag, _revision} -> data_view {:apply_cell_delta, _client_id, _cell_id, _tag, _delta, _revision} -> update_dirty_status(data_view, data) {:update_smart_cell, _client_id, _cell_id, _cell_state, _delta, _chunks, _reevaluate} -> update_dirty_status(data_view, data) # For outputs that update existing outputs we send the update directly # to the corresponding component, so the DOM patch is isolated and fast. # This is important for intensive output updates {:add_cell_evaluation_output, _client_id, _cell_id, {:frame, _outputs, %{type: type, ref: ref}}} when type != :default -> for {idx, {:frame, frame_outputs, _}} <- Notebook.find_frame_outputs(data.notebook, ref) do send_update(LivebookWeb.Output.FrameComponent, id: "output-#{idx}", outputs: frame_outputs, update_type: type ) end data_view {:add_cell_evaluation_output, _client_id, cell_id, {:stdout, text}} -> # Lookup in previous data to see if the output is already there case Notebook.fetch_cell_and_section(prev_data.notebook, cell_id) do {:ok, %{outputs: [{idx, {:stdout, _}} | _]}, _section} -> send_update(LivebookWeb.Output.StdoutComponent, id: "output-#{idx}", text: text) data_view _ -> data_to_view(data) end _ -> data_to_view(data) end end defp prune_outputs(%{private: %{data: data}} = socket) do assign_private( socket, data: update_in(data.notebook, &Notebook.prune_cell_outputs/1) ) end defp prune_cell_sources(%{private: %{data: data}} = socket) do assign_private( socket, data: update_in( data.notebook, &Notebook.update_cells(&1, fn %Notebook.Cell.Smart{} = cell -> %{cell | source: :__pruned__, attrs: :__pruned__} |> prune_smart_cell_editor_source() %{source: _} = cell -> %{cell | source: :__pruned__} cell -> cell end) ) ) end defp prune_smart_cell_editor_source(%{editor: %{source: _}} = cell), do: put_in(cell.editor.source, :__pruned__) defp prune_smart_cell_editor_source(cell), do: cell # Changes that affect only a single cell are still likely to # have impact on dirtiness, so we need to always mirror it defp update_dirty_status(data_view, data) do put_in(data_view.dirty, data.dirty) end defp get_page_title(notebook_name) do "Livebook - #{notebook_name}" end defp memory_color(:atom), do: "bg-blue-500" defp memory_color(:code), do: "bg-yellow-600" defp memory_color(:processes), do: "bg-blue-700" defp memory_color(:binary), do: "bg-green-500" defp memory_color(:ets), do: "bg-red-500" defp memory_color(:other), do: "bg-gray-400" defp runtime_memory(%{runtime: memory}) do memory |> Map.drop([:total, :system]) |> Enum.map(fn {type, bytes} -> {type, %{ unit: format_bytes(bytes), percentage: Float.round(bytes / memory.total * 100, 2), value: bytes }} end) end defp app_status_color(nil), do: "bg-gray-400" defp app_status_color(:booting), do: "bg-blue-500" defp app_status_color(:running), do: "bg-green-bright-400" defp app_status_color(:error), do: "bg-red-400" defp app_status_color(:shutting_down), do: "bg-gray-500" defp app_status_color(:stopped), do: "bg-gray-500" end