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 4 of 4 Posts Switch mode

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.

joshamb

joshamb

And if you wanted to further improve your solution, you could use an ‘embedded_schema’ to create your filter, and just past the .changes from it’s changeset into the URL to reduce clutter.

This is rather than the plain map you are passing into to_form

cmo

cmo

And use assign instead of update if you’re setting rather than updating the value.

DestroyedSoul

DestroyedSoul OP

Hello,
Thanks for the article suggestion.
It indeed does what I want to achieve as well.
I compared their logic with mine, and I have to say it’s pretty much the same (except for my build_search_query etc that you mentioned).
I tried to play around with the code to make it look more like theirs, but that did not help much.
As well as using ~p"/search?#{params}"

What I see is that in the article they only have string params, while I have lists.
It all works with just the search query (which is string), until I start trying to parse lists too.
Even ~p"/search?#{params}" returns string like "search/?query=test&f1[]=value1&f1[]=value2", whereas I would expect something like "/search?query=test&f1=value1,value2"

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

I don’t have booleans yet anywhere, just string query (which works fine) and lists of strings for filters.

— All posts loaded —

Where Next?

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
michallepicki
I am using Oban and occasionally, shortly after a deployment, a handful of jobs can fail because of dependency on other parts of the syst...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement