Switch the release component to a form to enable recovery

This commit is contained in:
Claudio Ortolina
2026-04-08 18:22:44 +01:00
parent d406e98fce
commit 49d26e1fd0
3 changed files with 282 additions and 180 deletions
+138 -46
View File
@@ -19,7 +19,9 @@ defmodule MusicLibraryWeb.Components.Release do
|> assign(:can_scrobble?, ScrobbleActivity.can_scrobble?())
|> assign(:release_with_tracks, AsyncResult.loading())
|> assign(:already_scrobbled, false)
|> assign(:selected_tracks, MapSet.new())}
|> assign(:selected_tracks, MapSet.new())
|> assign(:form, to_form(%{}, as: :release))
|> assign(:pending_form_params, nil)}
end
@impl true
@@ -27,10 +29,9 @@ defmodule MusicLibraryWeb.Components.Release do
{:ok,
socket
|> assign(assigns)
|> assign_async(:release_with_tracks, fn ->
with {:ok, release} <- load_release_with_tracks(record.selected_release_id) do
{:ok, %{release_with_tracks: release}}
end
|> assign(:release_with_tracks, AsyncResult.loading())
|> start_async(:release_with_tracks, fn ->
load_release_with_tracks(record.selected_release_id)
end)}
end
@@ -38,6 +39,52 @@ defmodule MusicLibraryWeb.Components.Release do
{:ok, assign(socket, assigns)}
end
@impl true
def handle_async(:release_with_tracks, {:ok, {:ok, release}}, socket) do
socket =
socket
|> assign(
:release_with_tracks,
AsyncResult.ok(socket.assigns.release_with_tracks, release)
)
|> apply_pending_form_params()
{:noreply, socket}
end
def handle_async(:release_with_tracks, {:ok, {:error, reason}}, socket) do
{:noreply,
assign(
socket,
:release_with_tracks,
AsyncResult.failed(socket.assigns.release_with_tracks, {:error, reason})
)}
end
def handle_async(:release_with_tracks, {:exit, reason}, socket) do
{:noreply,
assign(
socket,
:release_with_tracks,
AsyncResult.failed(socket.assigns.release_with_tracks, {:exit, reason})
)}
end
defp apply_pending_form_params(socket) do
case socket.assigns.pending_form_params do
nil ->
socket
params ->
release = socket.assigns.release_with_tracks.result
new_selected = apply_form_params(release, params, socket.assigns.selected_tracks)
socket
|> assign(:selected_tracks, new_selected)
|> assign(:pending_form_params, nil)
end
end
@impl true
def render(assigns) do
~H"""
@@ -48,6 +95,16 @@ defmodule MusicLibraryWeb.Components.Release do
placement="right"
class="min-w-xs sm:min-w-sm"
>
<.form
for={@form}
id={"#{@sheet_id}-form"}
phx-target={@myself}
phx-change="validate"
phx-auto-recover="recover_form"
>
<input type="hidden" name="release[selected_tracks][]" value="" />
<input type="hidden" name="release[toggle_medium][]" value="" />
<div class="mt-6 flex items-center justify-between gap-4">
<label class="cursor-pointer text-lg font-semibold text-zinc-700 dark:text-zinc-300">
<input
@@ -57,15 +114,14 @@ defmodule MusicLibraryWeb.Components.Release do
}
type="checkbox"
id="medium-checkbox-1"
name="release[toggle_medium][]"
value="1"
checked={
medium_selected?(
Release.get_medium(@release_with_tracks.result, 1),
@selected_tracks
)
}
phx-click="toggle_medium"
phx-value-medium-number={1}
phx-target={@myself}
class="mr-2 size-4 rounded border-gray-300 bg-gray-100 text-blue-600 focus:ring-2 focus:ring-blue-500 dark:border-gray-600 dark:bg-gray-700 dark:ring-offset-gray-800 dark:focus:ring-blue-600"
/>
{gettext("Tracks")}
@@ -73,6 +129,7 @@ defmodule MusicLibraryWeb.Components.Release do
<.button_group>
<.button
:if={@release_with_tracks.ok?}
type="button"
variant="soft"
size="sm"
phx-click="print_tracklist"
@@ -83,6 +140,7 @@ defmodule MusicLibraryWeb.Components.Release do
</.button>
<.button
:if={@can_scrobble? && @release_with_tracks.ok?}
type="button"
variant="soft"
size="sm"
disabled={@already_scrobbled}
@@ -122,6 +180,7 @@ defmodule MusicLibraryWeb.Components.Release do
/>
{gettext("Error loading tracks")}
<.button
type="button"
variant="ghost"
size="xs"
phx-click={JS.push("load_release_tracks", target: @myself)}
@@ -144,6 +203,7 @@ defmodule MusicLibraryWeb.Components.Release do
/>
</.async_result>
</div>
</.form>
</.sheet>
</div>
"""
@@ -169,10 +229,9 @@ defmodule MusicLibraryWeb.Components.Release do
:if={@can_scrobble?}
type="checkbox"
id={"medium-checkbox-#{@medium.number}"}
name="release[toggle_medium][]"
value={@medium.number}
checked={medium_selected?(@medium, @selected_tracks)}
phx-click="toggle_medium"
phx-value-medium-number={@medium.number}
phx-target={@myself}
class="mr-2 size-4 rounded border-gray-300 bg-gray-100 text-blue-600 focus:ring-2 focus:ring-blue-500 dark:border-gray-600 dark:bg-gray-700 dark:ring-offset-gray-800 dark:focus:ring-blue-600"
/>
{medium_title(@medium)}
@@ -183,6 +242,7 @@ defmodule MusicLibraryWeb.Components.Release do
<.button_group>
<.button
:if={@record}
type="button"
variant="soft"
size="sm"
phx-click="print_medium_tracklist"
@@ -194,6 +254,7 @@ defmodule MusicLibraryWeb.Components.Release do
</.button>
<.button
:if={@can_scrobble?}
type="button"
variant="soft"
size="sm"
disabled={@already_scrobbled || MapSet.size(@selected_tracks) > 0}
@@ -213,7 +274,6 @@ defmodule MusicLibraryWeb.Components.Release do
release_artists={@release_artists}
selected_tracks={@selected_tracks}
can_scrobble?={@can_scrobble?}
myself={@myself}
/>
<.separator />
<p class="text-right text-xs text-zinc-700 md:text-sm dark:text-zinc-300">
@@ -235,7 +295,6 @@ defmodule MusicLibraryWeb.Components.Release do
attr :release_artists, :list, required: true
attr :selected_tracks, :any, required: true
attr :can_scrobble?, :boolean, required: true
attr :myself, :any, required: true
def track_list(assigns) do
~H"""
@@ -250,10 +309,9 @@ defmodule MusicLibraryWeb.Components.Release do
<input
type="checkbox"
id={"track-checkbox-#{track.id}"}
name="release[selected_tracks][]"
value={track.id}
checked={MapSet.member?(@selected_tracks, track.id)}
phx-click="toggle_track"
phx-value-track-id={track.id}
phx-target={@myself}
class="size-4 rounded border-gray-300 bg-gray-100 text-blue-600 focus:ring-2 focus:ring-blue-500 dark:border-gray-600 dark:bg-gray-700 dark:ring-offset-gray-800 dark:focus:ring-blue-600"
/>
</span>
@@ -347,38 +405,25 @@ defmodule MusicLibraryWeb.Components.Release do
{:noreply, socket}
end
def handle_event("toggle_track", %{"track-id" => track_id}, socket) do
selected_tracks = socket.assigns.selected_tracks
updated_tracks =
if MapSet.member?(selected_tracks, track_id) do
MapSet.delete(selected_tracks, track_id)
else
MapSet.put(selected_tracks, track_id)
def handle_event("validate", %{"release" => params}, socket)
when release_loaded?(socket.assigns) do
release = socket.assigns.release_with_tracks.result
new_selected = apply_form_params(release, params, socket.assigns.selected_tracks)
{:noreply, assign(socket, :selected_tracks, new_selected)}
end
{:noreply, assign(socket, :selected_tracks, updated_tracks)}
def handle_event("validate", %{"release" => params}, socket) do
# Release not yet loaded (e.g., phx-auto-recover fires before async completes).
# Stash the params; handle_async/3 will apply them once the release is available.
{:noreply, assign(socket, :pending_form_params, params)}
end
def handle_event("toggle_medium", %{"medium-number" => number}, socket) do
{number, ""} = Integer.parse(number)
selected_tracks = socket.assigns.selected_tracks
release_with_tracks = socket.assigns.release_with_tracks.result
medium_tracks =
release_with_tracks
|> Release.medium_tracks(number)
|> Enum.map(& &1.id)
|> MapSet.new()
updated_tracks =
if MapSet.subset?(medium_tracks, selected_tracks) do
MapSet.difference(selected_tracks, medium_tracks)
else
MapSet.union(selected_tracks, medium_tracks)
def handle_event("validate", _params, socket) do
{:noreply, socket}
end
{:noreply, assign(socket, :selected_tracks, updated_tracks)}
def handle_event("recover_form", params, socket) do
handle_event("validate", params, socket)
end
def handle_event("scrobble_selected_tracks", _params, socket)
@@ -495,10 +540,9 @@ defmodule MusicLibraryWeb.Components.Release do
{:noreply,
socket
|> assign_async(:release_with_tracks, fn ->
with {:ok, release} <- load_release_with_tracks(selected_release_id) do
{:ok, %{release_with_tracks: release}}
end
|> assign(:release_with_tracks, AsyncResult.loading())
|> start_async(:release_with_tracks, fn ->
load_release_with_tracks(selected_release_id)
end)}
end
@@ -513,6 +557,54 @@ defmodule MusicLibraryWeb.Components.Release do
MapSet.subset?(medium_track_ids, selected_tracks)
end
@doc """
Applies form params from a track-selection form to produce a new `selected_tracks` MapSet.
Detects master-toggle transitions (the `release[toggle_medium][]` field) by diffing the
incoming params against the current server-side `current_selected` MapSet. When a medium's
master toggle transitions from unchecked to checked, all of its tracks are added; when it
transitions the other way, all of its tracks are removed.
Used by both `Release` (as a LiveComponent) and `MusicLibraryWeb.ScrobbleLive.Show` to
share identical form-driven selection logic.
"""
@spec apply_form_params(MusicBrainz.Release.t(), map(), MapSet.t()) :: MapSet.t()
def apply_form_params(release, params, current_selected) do
form_selected =
(params["selected_tracks"] || [])
|> Enum.reject(&(&1 == ""))
|> MapSet.new()
toggled_medium_numbers =
(params["toggle_medium"] || [])
|> Enum.reject(&(&1 == ""))
|> Enum.map(&String.to_integer/1)
|> MapSet.new()
current_fully_selected =
for medium <- release.media,
medium_selected?(medium, current_selected),
into: MapSet.new(),
do: medium.number
Enum.reduce(release.media, form_selected, fn medium, acc ->
was_fully_selected? = MapSet.member?(current_fully_selected, medium.number)
is_toggled_now? = MapSet.member?(toggled_medium_numbers, medium.number)
medium_track_ids = medium.tracks |> Enum.map(& &1.id) |> MapSet.new()
cond do
not was_fully_selected? and is_toggled_now? ->
MapSet.union(acc, medium_track_ids)
was_fully_selected? and not is_toggled_now? ->
MapSet.difference(acc, medium_track_ids)
true ->
acc
end
end)
end
def scrobble_button_label(selected_tracks) do
if MapSet.size(selected_tracks) > 0 do
gettext("Scrobble selected tracks")
@@ -4,7 +4,6 @@ defmodule MusicLibraryWeb.ScrobbleLive.Show do
import(MusicLibraryWeb.Components.Release, only: [medium: 1, scrobble_button_label: 1])
import MusicLibraryWeb.RecordComponents, only: [country_label: 1]
alias MusicBrainz.Release
alias MusicLibrary.ScrobbleActivity
alias MusicLibraryWeb.ErrorMessages
@@ -77,7 +76,17 @@ defmodule MusicLibraryWeb.ScrobbleLive.Show do
</dl>
</div>
<div :if={@release.media != []} class="mt-6 space-y-4">
<.form
:if={@release.media != []}
for={@form}
id="scrobble-release-form"
class="mt-6 space-y-4"
phx-change="validate"
phx-auto-recover="recover_form"
>
<input type="hidden" name="release[selected_tracks][]" value="" />
<input type="hidden" name="release[toggle_medium][]" value="" />
<div class="flex items-center justify-between">
<h3 class="text-lg font-semibold text-zinc-900 dark:text-zinc-200">
{gettext("Tracks")}
@@ -85,6 +94,7 @@ defmodule MusicLibraryWeb.ScrobbleLive.Show do
<.button
:if={@can_scrobble}
type="button"
variant="soft"
size="sm"
phx-click={
@@ -108,7 +118,7 @@ defmodule MusicLibraryWeb.ScrobbleLive.Show do
media_count={MusicBrainz.Release.media_count(@release)}
myself={nil}
/>
</div>
</.form>
</div>
</div>
</div>
@@ -124,7 +134,8 @@ defmodule MusicLibraryWeb.ScrobbleLive.Show do
release: nil,
can_scrobble: ScrobbleActivity.can_scrobble?(),
page_title: "Scrobble Release",
selected_tracks: MapSet.new()
selected_tracks: MapSet.new(),
form: to_form(%{}, as: :release)
)}
end
@@ -229,37 +240,22 @@ defmodule MusicLibraryWeb.ScrobbleLive.Show do
end
end
def handle_event("toggle_medium", %{"medium-number" => number}, socket) do
{number, ""} = Integer.parse(number)
selected_tracks = socket.assigns.selected_tracks
release = socket.assigns.release
def handle_event("validate", %{"release" => params}, socket) do
if socket.assigns.release do
new_selected =
MusicLibraryWeb.Components.Release.apply_form_params(
socket.assigns.release,
params,
socket.assigns.selected_tracks
)
medium_tracks =
release
|> Release.medium_tracks(number)
|> Enum.map(& &1.id)
|> MapSet.new()
updated_tracks =
if MapSet.subset?(medium_tracks, selected_tracks) do
MapSet.difference(selected_tracks, medium_tracks)
{:noreply, assign(socket, :selected_tracks, new_selected)}
else
MapSet.union(selected_tracks, medium_tracks)
{:noreply, socket}
end
end
{:noreply, assign(socket, :selected_tracks, updated_tracks)}
end
def handle_event("toggle_track", %{"track-id" => track_id}, socket) do
selected_tracks = socket.assigns.selected_tracks
updated_tracks =
if MapSet.member?(selected_tracks, track_id) do
MapSet.delete(selected_tracks, track_id)
else
MapSet.put(selected_tracks, track_id)
end
{:noreply, assign(socket, :selected_tracks, updated_tracks)}
def handle_event("recover_form", params, socket) do
handle_event("validate", params, socket)
end
end
@@ -1,7 +1,7 @@
defmodule MusicLibraryWeb.ScrobbleLive.ShowTest do
use MusicLibraryWeb.ConnCase
import Phoenix.LiveViewTest, only: [render_click: 3]
import Phoenix.LiveViewTest, only: [element: 2, render_change: 2, render_click: 3]
alias MusicBrainz.Fixtures.Release, as: ReleaseFixtures
alias MusicLibrary.Secrets
@@ -120,14 +120,18 @@ defmodule MusicLibraryWeb.ScrobbleLive.ShowTest do
# Toggle track on — button label changes
session
|> unwrap(fn view ->
render_click(view, "toggle_track", %{"track-id" => track_id})
view
|> element("#scrobble-release-form")
|> render_change(%{"release" => %{"selected_tracks" => [track_id]}})
end)
|> assert_has("button", "Scrobble selected tracks")
# Toggle track off — button label reverts
session
|> unwrap(fn view ->
render_click(view, "toggle_track", %{"track-id" => track_id})
view
|> element("#scrobble-release-form")
|> render_change(%{"release" => %{"selected_tracks" => []}})
end)
|> assert_has("button", "Scrobble release")
end
@@ -138,14 +142,18 @@ defmodule MusicLibraryWeb.ScrobbleLive.ShowTest do
# Toggle medium 1 on — button label changes
session
|> unwrap(fn view ->
render_click(view, "toggle_medium", %{"medium-number" => "1"})
view
|> element("#scrobble-release-form")
|> render_change(%{"release" => %{"toggle_medium" => ["1"]}})
end)
|> assert_has("button", "Scrobble selected tracks")
# Toggle medium 1 off — button label reverts
session
|> unwrap(fn view ->
render_click(view, "toggle_medium", %{"medium-number" => "1"})
view
|> element("#scrobble-release-form")
|> render_change(%{"release" => %{"toggle_medium" => []}})
end)
|> assert_has("button", "Scrobble release")
end
@@ -157,7 +165,10 @@ defmodule MusicLibraryWeb.ScrobbleLive.ShowTest do
session
|> unwrap(fn view ->
render_click(view, "toggle_track", %{"track-id" => track_id})
view
|> element("#scrobble-release-form")
|> render_change(%{"release" => %{"selected_tracks" => [track_id]}})
render_click(view, "scrobble_selected_tracks", %{})
end)
|> assert_has("#toast-group", "Selected tracks scrobbled successfully")
@@ -207,7 +218,10 @@ defmodule MusicLibraryWeb.ScrobbleLive.ShowTest do
session
|> unwrap(fn view ->
render_click(view, "toggle_track", %{"track-id" => track_id})
view
|> element("#scrobble-release-form")
|> render_change(%{"release" => %{"selected_tracks" => [track_id]}})
render_click(view, "scrobble_selected_tracks", %{})
end)
|> assert_has("#toast-group", "Error scrobbling selected tracks")