Ciclo de vida do Phoenix LiveView

Para quem não conhece, o Phoenix LiveView é uma biblioteca que funciona em cima do Phoenix, framework web feito para Elixir, e que traz todo o poder de criar aplicações ricas em tempo real. Tudo isso via server side e renderizando HTML.

A biblioteca usa todo o poder que o Elixir trouxe de websockets e comunicação em tempo real para fazer com que sua página pareça uma aplicação sendo controlada pelo framework JavaScript da moda, mas que no final é só HTML + CSS e back-end.

Antes de começarmos, espero que você já tenha seguido o guia de instalação e que já tenha se familiarizado um pouco com LiveView. Recomendo ler os links antes de avançar.

Entendendo mais o ciclo de vida do Phoenix LiveView

Para começar, essa é uma típica LiveView, onde implementamos as funções mount/3 e render/1:

defmodule MyApp.RegisterView do
  use Phoenix.LiveView
  def mount(_params, session, socket) do
    socket =
      socket
      |> assign(:anonymous_id, session.anonymous_id)
    {:ok, socket}
  end
  def render(assigns) do
    MyApp.RegisterView.render("register.html", assigns)
  end
  # ...
end

O ciclo de vida começa na função mount/3. Quando você acessa a rota de qualquer LiveView, é essa função que é executada. Ela recebe os parâmetros que vem do controller, a sessão atual e o LiveView socket. A sessão são dados privados definidos pela aplicação, geralmente no controller, quando ela chama o LiveView.

É na função mount/3 que inicializa a sua LiveView, definindo todas as variáveis que vai precisar no seu template.

Após isso, a função render/1 é chamada e o HTML é devolvido, como qualquer resposta HTML feita pelo Phoenix.

Após a renderização da página HTML, o LiveView se conecta com o socket, que mais uma vez chama a função mount/3 da view, ficando conectado e “de olho” em qualquer evento feito pelo navegador.

Quando acontece qualquer evento na página, o socket envia esse evento para a LiveView usando a função handle_event/3, a qual detalharemos nos próximos parágrafos.

De uma forma simplista, é assim que funciona o ciclo de vida do Phoenix LiveView.

Aconteceu um evento, o que ocorre?

O Phoenix LiveView tem um código JavaScript que fica rodando no browser e envia todos os eventos através do websocket para o back-end. O socket faz uma chamada pra função handle_event/3, passando três parâmetros que são: o nome do evento, os parâmetros que acompanham aquele evento e o próprio socket.

Nesse código, eu declarei a handle_event/3 duas vezes, uma para tratar o evento validate e outra para tratar o save. São essas funções que você vai usar para interagir com a página HTML. Foi essa parte que mais mexeu minha cabeça 🤯

Demorou um pouco pra cair a ficha de que tudo é um “template normal” do Phoenix. Isso significa que a interação com a página se dá pelo velho if/else + combinações de handle_event/3.

Um exemplo bem legal é esse aqui, que adaptei para uma versão mais recente (dev!) do Phoenix, onde já podemos criar uma nova aplicação Phoenix incluindo o Phoenix LiveView (mix phx.new path --live).

Nesse exemplo, um formulário com 3 passos é implementado e no final as informações são “salvas” no banco de dados. O código na view são vários if/elses e o controle do que é visto é feito na LiveView, usando a função handle_event/3 para cada passo desse formulário.

Aqui segue o código do template para que veja os vários if/elses (a organização disso entra em um segundo post!) e também o código da LiveView com todas as funções que manipulam esse template.

<%= form_for @changeset, "#", [phx_change: :validate, phx_submit: :save], fn f -> %>
  <%= if @current_step == 1 do %>
    <div>
      <%= label f, :title %>
      <%= text_input f, :title, autofocus: true %>
      <%= error_tag f, :title %>
    </div>
    <div>
      <%= label f, :description %>
      <%= text_input f, :description %>
      <%= error_tag f, :description %>
    </div>
  <% else %>
    <%= hidden_input f, :title %>
    <%= hidden_input f, :description %>
  <% end %>
  <%= if @current_step == 2 do %>
    <div>
      <%= label f, :type %>
      <%= label do %>
        <%= radio_button f, :type, "thing_a" %>
        Thing A
      <% end %>
      <%= label do %>
        <%= radio_button f, :type, "thing_b" %>
        Thing B
      <% end %>
      <%= error_tag f, :type %>
   </div>
  <% else %>
    <%= hidden_input f, :type %>
  <% end %>
  <%= if @current_step == 3 do %>
    <div>
      <%= label f, :something_else %>
      <%= text_input f, :something_else, autofocus: true %>
      <%= error_tag f, :something_else %>
    </div>
  <% end %>
  <%= if @current_step > 1 do %><button phx-click="prev-step">Back</button><% end %>
  <%= if @current_step == 3 do %>
    <%= submit "Submit" %>
  <% else %>
    <button phx-click="next-step">Continue</button>
  <% end %>
<% end %>

defmodule PhoenixLiveViewExampleWeb.StepFormLive do
  alias PhoenixLiveViewExample.StepForm
  alias PhoenixLiveViewExampleWeb.StepFormView
  use PhoenixLiveViewExampleWeb, :live_view
  def mount(_params, _session, socket) do
    socket =
      socket
      |> assign(current_step: 1)
      |> assign(changeset: StepForm.changeset(%StepForm{}, %{}))
    {:ok, socket}
  end
  def render(assigns) do
    StepFormView.render("form.html", assigns)
  end
  def handle_event("prev-step", _params, socket) do
    new_step = max(socket.assigns.current_step - 1, 1)
    {:noreply, assign(socket, current_step: new_step)}
  end
  def handle_event("next-step", _params, socket) do
    current_step = socket.assigns.current_step
    changeset = socket.assigns.changeset
    step_invalid =
      case current_step do
        1 -> Enum.any?(Keyword.keys(changeset.errors), fn k -> k in [:title, :description] end)
        2 -> Enum.any?(Keyword.keys(changeset.errors), fn k -> k in [:type] end)
        _ -> true
      end
    new_step = if step_invalid, do: current_step, else: current_step + 1
    {:noreply, assign(socket, :current_step, new_step)}
  end
  def handle_event("validate", %{"step_form" => params}, socket) do
    changeset = StepForm.changeset(%StepForm{}, params) |> Map.put(:action, :insert)
    {:noreply, assign(socket, :changeset, changeset)}
  end
  def handle_event("save", %{"step_form" => params}, socket) do
    # Pretending to insert stuff if changeset is valid
    changeset = StepForm.changeset(%StepForm{}, params)
    case changeset.valid? do
      true ->
        {:noreply,
          socket
          |> put_flash(:info, "StepForm inserted => #{inspect(changeset.changes)}")
          |> redirect(to: "/")}
      false ->
        {:noreply, assign(socket, :changeset, %{changeset | action: :insert})}
    end
  end
end

.