DestroyedSoul

DestroyedSoul

Form/UI updates incorrectly after push_patch

Hello,

I am trying to implement more or less basic search screen. I use Phoenix/LiveView.
I’ve come across an issue that means either I chose the wrong approach, or I suck with forms (most likely - both).

The screen is super simple at this point: search bar in the middle, filters to the right, search results in the middle.
I put all three of these elements into the single form, like this:

<div class="container">
  <.form
    for={@search_form}
    phx-change="apply_filters"
    phx-submit="search"
    class="..."
  >
    <.search_bar field={@search_form[:query]} />

    <div class="flex flex-col md:flex-row">
      <!-- Filters Column -->
      <div class="...">
        <.filters_section
          form={@search_form}
          filter1={filter1_list()}
          filter2 ={filter2_list()}
          filter3 ={filter3_list()}
        />
      </div>
      <!-- Search Results Column -->
      <div class="w-full md:w-3/4">
        <.search_results results={@results} />
      </div>
    </div>
  </.form>
</div>

filter1, filter2, filter3 is sections on the right side of the screen, each consisting of several options. Consider, the list of brands, for example, list of locations etc. They all are multi selects.

My idea is to build the screen from the endpoint. The endpoint would look something like /search?q="..."&f1=...&f2=...
So, I put this into the live view code (for now, ignoring filters, only supporting query)

def mount(_params, _session, socket) do
    socket =
      socket
      |> assign(search_form: to_form(Search.make_search_form()))
      |> assign(:results, [])

    {:ok, socket}
  end

  def handle_params(params, _uri, socket) do
    query = params["q"] || ""
    
    filters = []

    search_form = Search.make_search_form(query, filters)

    socket =
      socket
      |> update(:search_form, fn _ -> to_form(search_form, as: :search_form) end)
      |> update(:results, fn _ -> search_results(search_form) end) # this builds and executes Ecto query returning the list of results

    {:noreply, socket}
  end

Then, when the search button is pressed I do this:

def handle_event("search", %{"search_form" => search_form}, socket) do
    {:noreply, push_patch(socket, to: "/search?#{build_search_query(search_form)}")}
  end

defp build_search_query(search_form) do
    filter1 = []
    filter2 = []
    filter3 = []

    "q=#{search_form["query"]}&f1=#{filter1}&f2=#{filter2}&f3=#{filter3}"
  end

So far, this works ok. The search bar has the correct text at all times, the results are filtered properly, the filters checkboxes are enabled and disabled (UI-wise) without any problems.
The multi-select is implemented like this:

  attr :form, Phoenix.HTML.Form, required: true
  attr :field, Phoenix.HTML.FormField, required: true
  attr :options, :list, required: true

  defp multi_select(assigns) do
    ~H"""
    <div class="...">
      <%= for option <- @options do %>
        <label class="...">
          <input
            type="checkbox"
            name={"#{input_name(@form, @field.field)}[]"}
            value={option}
            checked={option in @field.value}
            class="..."
          />
          <span class="...">{option}</span>
        </label>
      <% end %>
    </div>
    """
  end

and is added to the parent tag like this:

  <div>
        <h3 class="...">Filter Name, e.g. Brands</h3>
        <.multi_select
          form={@form}
          field={@form[:param1]}
          options={@filter1}
        />
     </div>

So far, so good.
Now, I would like for filters to take part in Ecto logic as well.
I do literally 3 changes.

  1. Add handle_event function:
  def handle_event("apply_filters", %{"search_form" => search_form}, socket) do
    {:noreply, push_patch(socket, to: "/search?#{build_search_query(search_form)}")}
  end
  1. Modify how I build the search query:
defp build_search_query(search_form) do
    filter1 = convert_list_to_string(search_form["filter1"])
    filter2 = convert_list_to_string(search_form["filter2"])
    filter3 = convert_list_to_string(search_form["filter3"])

    "q=#{search_form["query"]}&f1=#{filter1}&f2=#{filter2}&f3=#{filter3}"
  end

The result of this function looks good, e.g. "q=test&f1=brand1,brand2,brand3..." etc
3. Modify the handle_params function:

def handle_params(params, _uri, socket) do
    query = params["q"] || ""
    
    filters = %{
      :filter1 => String.split(params["f1"] || "", ","),
      :filter2 => String.split(params["f2"] || "", ","),
      :filter3 => String.split(params["f3"] || "", ",")
    }

    search_form = Search.make_search_form(query, filters)

    socket =
      socket
      |> update(:search_form, fn _ -> to_form(search_form, as: :search_form) end)
      |> update(:results, fn _ -> search_results(search_form) end) # this builds and executes Ecto query returning the list of results

    {:noreply, socket}
  end

What happens after this is the following:
If I enter the screen via /search endpoint and then start enabling checkboxes - they work fine.
If I enter the screen via the pre-built search query, all looks good too: the text in the search box is fine, and the checkboxes that should be enabled, are.

In both cases, problem starts when I try to disable a checkbox. It becomes super buggy: enabled/disabled state does not correspond to the params in the query, and at some point the query starts having the same param several times, e.g. f1=brand1,brand2,brand1.

I would welcome any advice.

First Post!

joshamb

joshamb

I’d suggest reading the following:

This also goes through doing what you desire, but with a less hard-cody build_search_query.

It’s a little outdated, but using ‘verified routes’ you can just do the following:

~p"/search?#{params}"

And it does the rest.

In regards to your problem, it’s likely you will find the booleans are becoming strings, ie "false" rather than false in the params of your handle_params.


In regards to your form, it’s not gonna ‘fix’ anything but I wouldn’t suggest putting your search results in their too, you should keep it elsewhere.

Where Next?

Popular in Questions Top

chokchit
** (DBConnection.ConnectionError) connection not available and request was dropped from queue after 2733ms. You can configure how long re...
New
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
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
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID&lt;0.412.0&gt; terminating ** (Postgrex.Error) FATAL...
New
myronmarston
The Elixir Typespec docs show the following syntax for keyword lists in typespecs: # ... | [key: type] # keyword lists...
New
nobody
How to bind a phoenix app to a specific ip address? could not find anything about that, nowhere, unfortunately, but for me this is quite...
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
beno
I will often find my self writing things similar to: case some_value do nil -&gt; something() "" -&gt; something() _ -&gt; somethi...
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
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Other popular topics Top

sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
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
Nvim
Anybody knows a comprehensive comparison of Django and Phoenix, thanks for the help. Where are they similar? Where do they differ the m...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID&lt;0.412.0&gt; terminating ** (Postgrex.Error) FATAL...
New
Qqwy
Original source of discussion: This topic on the Pragmatic Programmers’ Functional Web Development with Elixir, OTP, and Phoenix forum. ...
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
AstonJ
We’ve put together this wiki for Phoenix LiveView - please feel free to add any info you feel is worth including. What is Phoenix LiveV...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
AstonJ
Seen any cool LiveView demos, sample apps or examples? Please post them here! :003:
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New

We're in Beta

About us Mission Statement