diff --git a/GLOSSARY.md b/GLOSSARY.md index 0c443ea..c2416c9 100644 --- a/GLOSSARY.md +++ b/GLOSSARY.md @@ -31,6 +31,11 @@ pieces each side has, written strongest side first and colour-agnostic (e.g. "KQ v KR"). Used to group and search endgames by material. _Avoid_: Material signature, hash +**Public code**: +The short, stable identifier an endgame is played under in player-facing +links, distinct from its database id and safe to share. +_Avoid_: Slug, UUID, endgame id, token + ## Identity & access **User**: diff --git a/docs/adr/0006-public-code-for-player-urls.md b/docs/adr/0006-public-code-for-player-urls.md new file mode 100644 index 0000000..b0f63ae --- /dev/null +++ b/docs/adr/0006-public-code-for-player-urls.md @@ -0,0 +1,18 @@ +# Player-facing endgame URLs use a public code + +Player links address an endgame by a short random **public code** rather than +its database UUID. The UUID stays the admin identity: admin routes mount by +id and the Show page displays both. The code is stable for the row's lifetime +and unguessable, so a shared play link neither exposes a primary key nor +invites enumeration. Keys were rejected as the handle because many endgames +share one (that is how the list groups them), and Key-plus-ordinal would break +when endgames are added or removed. A FEN hash was rejected as longer and +derivable without hiding anything new. + +## Consequences + +- Admin URLs and the admin list keep the UUID, so debugging still lines up + with the database. Admin search accepts either identifier plus a FEN or FEN + fragment. +- A public code is generated on insert and backfilled by migration; it is + never regenerated on update. diff --git a/lib/chesstrainer/endgames.ex b/lib/chesstrainer/endgames.ex index c965751..3a9017f 100644 --- a/lib/chesstrainer/endgames.ex +++ b/lib/chesstrainer/endgames.ex @@ -92,6 +92,63 @@ defmodule Chesstrainer.Endgames do """ def get_endgame!(id), do: Repo.get!(Endgame, id) + @doc """ + Gets a single endgame by its public code, raising if it does not exist. + """ + def get_endgame_by_public_code!(public_code) do + Repo.get_by!(Endgame, public_code: public_code) + end + + @doc """ + Finds endgames by database id, public code, or FEN. + + A full FEN matches exactly (after normalisation); a fragment matches any FEN + containing it. Themes are preloaded. A blank query returns `[]`. + """ + def search(query) do + query = String.trim(query || "") + + if query == "" do + [] + else + [search_by_id(query), search_by_public_code(query), search_by_fen(query)] + |> Enum.reject(&is_nil/1) + |> List.flatten() + |> Enum.uniq_by(& &1.id) + end + end + + defp search_by_id(query) do + case Ecto.UUID.cast(query) do + {:ok, id} -> Repo.get(Endgame, id) |> preload_themes() + :error -> nil + end + end + + defp search_by_public_code(query) do + Repo.get_by(Endgame, public_code: query) |> preload_themes() + end + + defp search_by_fen(query) do + pattern = "%" <> escape_like(Chesstrainer.FEN.normalize(query)) <> "%" + + Endgame + |> where([e], like(e.fen, ^pattern)) + |> preload(:themes) + |> order_by([e], asc: e.key, asc: e.fen) + |> Repo.all() + end + + defp preload_themes(nil), do: nil + defp preload_themes(endgame), do: Repo.preload(endgame, :themes) + + defp escape_like(value) do + value + |> String.replace("\\", "\\\\") + |> String.replace("%", "\\%") + |> String.replace("_", "\\_") + end + @doc """ Creates a endgame. @@ -104,11 +161,24 @@ defmodule Chesstrainer.Endgames do {:error, %Ecto.Changeset{}} """ - def create_endgame(attrs, themes \\ []) do - %Endgame{} - |> Endgame.changeset(attrs) - |> Ecto.Changeset.put_assoc(:themes, themes) - |> Repo.insert() + def create_endgame(attrs, themes \\ []), do: insert_endgame(attrs, themes, 3) + + defp insert_endgame(attrs, themes, attempts) do + result = + %Endgame{} + |> Endgame.changeset(attrs) + |> Ecto.Changeset.put_assoc(:themes, themes) + |> Repo.insert() + + case result do + {:error, changeset} when attempts > 1 -> + if Keyword.has_key?(changeset.errors, :public_code), + do: insert_endgame(attrs, themes, attempts - 1), + else: result + + other -> + other + end end @doc """ diff --git a/lib/chesstrainer/endgames/endgame.ex b/lib/chesstrainer/endgames/endgame.ex index d0ef7bd..e305c11 100644 --- a/lib/chesstrainer/endgames/endgame.ex +++ b/lib/chesstrainer/endgames/endgame.ex @@ -8,9 +8,13 @@ defmodule Chesstrainer.Endgames.Endgame do alias Chesstrainer.Key + @public_code_alphabet ~c"0123456789abcdefghjkmnpqrstvwxyz" + @public_code_length 10 + @primary_key {:id, :binary_id, autogenerate: true} @foreign_key_type :binary_id schema "endgames" do + field :public_code, :string field :fen, :string field :color, Ecto.Enum, values: [:white, :black] field :key, :string @@ -42,7 +46,33 @@ defmodule Chesstrainer.Endgames.Endgame do end end) |> unique_constraint(:fen, message: "FEN already exists") + |> unique_constraint(:public_code) |> put_key() + |> put_public_code() + end + + @doc """ + Generates a public code: a short, random identifier for player-facing URLs. + + 10 characters of Crockford base32 (no `i`, `l`, `o` or `u`) give roughly 50 + bits, so collisions are vanishingly rare; the unique index is the backstop. + """ + @spec generate_public_code() :: String.t() + def generate_public_code do + @public_code_length + |> :crypto.strong_rand_bytes() + |> :binary.bin_to_list() + |> Enum.map(fn byte -> + Enum.at(@public_code_alphabet, rem(byte, length(@public_code_alphabet))) + end) + |> List.to_string() + end + + defp put_public_code(changeset) do + case get_field(changeset, :public_code) do + nil -> put_change(changeset, :public_code, generate_public_code()) + _ -> changeset + end end defp put_key(changeset) do diff --git a/lib/chesstrainer_web/live/endgame_live/form.ex b/lib/chesstrainer_web/live/endgame_live/form.ex index 59ff582..c8b0345 100644 --- a/lib/chesstrainer_web/live/endgame_live/form.ex +++ b/lib/chesstrainer_web/live/endgame_live/form.ex @@ -256,5 +256,5 @@ defmodule ChesstrainerWeb.EndgameLive.Form do defp rating_display(%Phoenix.HTML.FormField{value: value}), do: value defp return_path("index", _endgame), do: ~p"/admin/endgames" - defp return_path("show", endgame), do: ~p"/admin/endgames/#{endgame}" + defp return_path("show", endgame), do: ~p"/admin/endgames/#{endgame.id}" end diff --git a/lib/chesstrainer_web/live/endgame_live/index.ex b/lib/chesstrainer_web/live/endgame_live/index.ex index 2f8377e..1e78dd9 100644 --- a/lib/chesstrainer_web/live/endgame_live/index.ex +++ b/lib/chesstrainer_web/live/endgame_live/index.ex @@ -18,7 +18,63 @@ defmodule ChesstrainerWeb.EndgameLive.Index do + <.form + for={@search_form} + id="endgame-search-form" + phx-submit="endgame_search" + class="mb-6 flex items-end gap-2" + > +
+ <.input + field={@search_form[:query]} + type="text" + label="Find by ID or FEN" + autocomplete="off" + placeholder="Public code, database id, or FEN…" + class="input input-bordered w-full" + /> +
+ <.button variant="primary">Find + + +
+
+

Results for “{@search_query}”

+ +
+ +

+ No endgame matches “{@search_query}”. +

+ + + + + + + + + + + + + endgame.id}> + + + + + + + +
KeyColorResultRatingActions
{endgame.key}{endgame.color}{endgame.result}{round(endgame.rating)} + <.link navigate={~p"/admin/endgames/#{endgame.id}"}>Show +
+
+ <.filter_bar + :if={!@search_query} selected_themes={@selected_themes} theme_query={@theme_query} theme_results={@theme_results} @@ -26,7 +82,7 @@ defmodule ChesstrainerWeb.EndgameLive.Index do selected_key={@selected_key} /> - <.grouped_list :if={@groups != []} groups={@groups}> + <.grouped_list :if={!@search_query and @groups != []} groups={@groups}> <:header> Key @@ -40,13 +96,22 @@ defmodule ChesstrainerWeb.EndgameLive.Index do <:row :let={endgame}> endgame.id}> - + {endgame.key} - + {endgame.color} - + {endgame.result} @@ -57,14 +122,17 @@ defmodule ChesstrainerWeb.EndgameLive.Index do None - + {round(endgame.rating)}
- <.link navigate={~p"/admin/endgames/#{endgame}"}>Show - <.link navigate={~p"/endgames/#{endgame}/play"}>Play - <.link navigate={~p"/admin/endgames/#{endgame}/edit"}>Edit + <.link navigate={~p"/admin/endgames/#{endgame.id}"}>Show + <.link navigate={~p"/endgames/#{endgame.public_code}/play"}>Play + <.link navigate={~p"/admin/endgames/#{endgame.id}/edit"}>Edit <.link phx-click={JS.push("delete", value: %{id: endgame.id})} data-confirm="Are you sure?" @@ -77,7 +145,7 @@ defmodule ChesstrainerWeb.EndgameLive.Index do -

+

No endgames match these filters.

@@ -89,10 +157,37 @@ defmodule ChesstrainerWeb.EndgameLive.Index do {:ok, socket |> assign(:page_title, "Listing Endgames") + |> assign(:search_form, to_form(%{"query" => ""})) + |> assign(:search_query, nil) + |> assign(:search_results, []) |> init_state()} end @impl true + def handle_event("endgame_search", %{"query" => query}, socket) do + query = String.trim(query) + + case {query, Endgames.search(query)} do + {"", _results} -> + {:noreply, clear_search(socket)} + + {_query, [endgame]} -> + {:noreply, push_navigate(socket, to: ~p"/admin/endgames/#{endgame.id}")} + + {query, results} -> + {:noreply, + assign(socket, + search_form: to_form(%{"query" => query}), + search_query: query, + search_results: results + )} + end + end + + def handle_event("clear_search", _params, socket) do + {:noreply, clear_search(socket)} + end + def handle_event("delete", %{"id" => id}, socket) do endgame = Endgames.get_endgame!(id) {:ok, _} = Endgames.delete_endgame(endgame) @@ -103,4 +198,12 @@ defmodule ChesstrainerWeb.EndgameLive.Index do def handle_event(event, params, socket) do handle_filter_event(event, params, socket) end + + defp clear_search(socket) do + assign(socket, + search_form: to_form(%{"query" => ""}), + search_query: nil, + search_results: [] + ) + end end diff --git a/lib/chesstrainer_web/live/endgame_live/play.ex b/lib/chesstrainer_web/live/endgame_live/play.ex index 67ebf00..1268a3c 100644 --- a/lib/chesstrainer_web/live/endgame_live/play.ex +++ b/lib/chesstrainer_web/live/endgame_live/play.ex @@ -178,8 +178,8 @@ defmodule ChesstrainerWeb.EndgameLive.Play do end @impl true - def mount(%{"id" => id}, _session, socket) do - endgame = Endgames.get_endgame!(id) + def mount(%{"public_code" => public_code}, _session, socket) do + endgame = Endgames.get_endgame_by_public_code!(public_code) socket = socket diff --git a/lib/chesstrainer_web/live/endgame_live/player_index.ex b/lib/chesstrainer_web/live/endgame_live/player_index.ex index d941bf6..d5a01b7 100644 --- a/lib/chesstrainer_web/live/endgame_live/player_index.ex +++ b/lib/chesstrainer_web/live/endgame_live/player_index.ex @@ -32,14 +32,23 @@ defmodule ChesstrainerWeb.EndgameLive.PlayerIndex do <:row :let={endgame}> - endgame.id}> - + endgame.public_code}> + {endgame.color} - + {endgame.result} - + {round(endgame.rating)} @@ -51,7 +60,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayerIndex do None - <.link navigate={~p"/endgames/#{endgame}/play"}>Play + <.link navigate={~p"/endgames/#{endgame.public_code}/play"}>Play diff --git a/lib/chesstrainer_web/live/endgame_live/show.ex b/lib/chesstrainer_web/live/endgame_live/show.ex index 3b7c4a3..73b4f84 100644 --- a/lib/chesstrainer_web/live/endgame_live/show.ex +++ b/lib/chesstrainer_web/live/endgame_live/show.ex @@ -33,10 +33,10 @@ defmodule ChesstrainerWeb.EndgameLive.Show do <.button navigate={~p"/admin/endgames"}> <.icon name="hero-arrow-left" /> - <.button navigate={~p"/endgames/#{@endgame}/play"}> + <.button navigate={~p"/endgames/#{@endgame.public_code}/play"}> <.icon name="hero-play" /> Play (opens trainer) - <.button variant="primary" navigate={~p"/admin/endgames/#{@endgame}/edit?return_to=show"}> + <.button variant="primary" navigate={~p"/admin/endgames/#{@endgame.id}/edit?return_to=show"}> <.icon name="hero-pencil-square" /> Edit endgame @@ -47,6 +47,19 @@ defmodule ChesstrainerWeb.EndgameLive.Show do <.list> <:item title="Fen">{@endgame.fen} <:item title="Key">{@endgame.key} + <:item title="Public code"> + {@endgame.public_code} + + <:item title="Color">{@endgame.color} <:item title="Rating">{round(@endgame.rating)} <:item title="Message">{@endgame.message} @@ -56,6 +69,16 @@ defmodule ChesstrainerWeb.EndgameLive.Show do <:item title="Attempted">{@endgame.times_attempted} <:item title="Solved">{@endgame.times_solved} + + """ end diff --git a/lib/chesstrainer_web/router.ex b/lib/chesstrainer_web/router.ex index ad1ac98..f5ad13c 100644 --- a/lib/chesstrainer_web/router.ex +++ b/lib/chesstrainer_web/router.ex @@ -80,7 +80,7 @@ defmodule ChesstrainerWeb.Router do live_session :current_user, on_mount: [{ChesstrainerWeb.UserAuth, :mount_current_scope}] do - live "/endgames/:id/play", EndgameLive.Play, :play + live "/endgames/:public_code/play", EndgameLive.Play, :play live "/users/register", UserLive.Registration, :new live "/users/log-in", UserLive.Login, :new end diff --git a/priv/repo/migrations/20261103213742_add_public_code_to_endgames.exs b/priv/repo/migrations/20261103213742_add_public_code_to_endgames.exs new file mode 100644 index 0000000..186dd72 --- /dev/null +++ b/priv/repo/migrations/20261103213742_add_public_code_to_endgames.exs @@ -0,0 +1,47 @@ +defmodule Chesstrainer.Repo.Migrations.AddPublicCodeToEndgames do + use Ecto.Migration + + @alphabet ~c"0123456789abcdefghjkmnpqrstvwxyz" + @length 10 + + def up do + alter table(:endgames) do + add :public_code, :string + end + + flush() + + repo().query!("SELECT id FROM endgames").rows + |> Enum.reduce(MapSet.new(), fn [id], used -> + code = Stream.repeatedly(&generate_code/0) |> Enum.find(&(not MapSet.member?(used, &1))) + + repo().query!("UPDATE endgames SET public_code = $1 WHERE id = $2", [code, id]) + + MapSet.put(used, code) + end) + + alter table(:endgames) do + modify :public_code, :string, null: false + end + + create unique_index(:endgames, [:public_code]) + end + + def down do + drop unique_index(:endgames, [:public_code]) + + alter table(:endgames) do + remove :public_code + end + end + + # Inlined rather than calling the schema, so the migration stays frozen even + # if the app's generator changes. `rem(byte, 32)` is unbiased: 256 = 8 * 32. + defp generate_code do + @length + |> :crypto.strong_rand_bytes() + |> :binary.bin_to_list() + |> Enum.map(fn byte -> Enum.at(@alphabet, rem(byte, length(@alphabet))) end) + |> List.to_string() + end +end diff --git a/priv/repo/seeds.exs b/priv/repo/seeds.exs index 02c166c..c18b74a 100644 --- a/priv/repo/seeds.exs +++ b/priv/repo/seeds.exs @@ -34,6 +34,7 @@ Repo.insert_all( endgame |> Map.put(:fen, fen) |> Map.put(:id, Ecto.UUID.generate()) + |> Map.put(:public_code, Endgame.generate_public_code()) |> Map.put(:key, key) |> Map.merge(%{inserted_at: now, updated_at: now}) end), diff --git a/test/chesstrainer/endgames_test.exs b/test/chesstrainer/endgames_test.exs index 7fe9eca..b0d2c74 100644 --- a/test/chesstrainer/endgames_test.exs +++ b/test/chesstrainer/endgames_test.exs @@ -174,6 +174,28 @@ defmodule Chesstrainer.EndgamesTest do end end + describe "public code" do + test "create_endgame/1 assigns a 10-character lowercase Crockford code" do + endgame = create_endgame!(@kr) + + assert String.length(endgame.public_code) == 10 + assert endgame.public_code =~ ~r/^[0-9abcdefghjkmnpqrstvwxyz]{10}$/ + end + + test "create_endgame/1 gives each endgame a distinct code" do + one = create_endgame!(@kr) + two = create_endgame!(@kr_other) + + refute one.public_code == two.public_code + end + + test "get_endgame_by_public_code!/1 finds the endgame" do + endgame = create_endgame!(@kr) + + assert Endgames.get_endgame_by_public_code!(endgame.public_code).id == endgame.id + end + end + describe "rating default" do test "a new endgame changeset defaults rating to 1500" do changeset = Endgames.change_endgame(%Endgame{}) @@ -182,6 +204,60 @@ defmodule Chesstrainer.EndgamesTest do end end + describe "search/1" do + test "finds an endgame by its public code" do + endgame = create_endgame!(@kr) + create_endgame!(@kq) + + assert [found] = Endgames.search(endgame.public_code) + assert found.id == endgame.id + end + + test "finds an endgame by its database id" do + endgame = create_endgame!(@kr) + + assert [found] = Endgames.search(endgame.id) + assert found.id == endgame.id + end + + test "finds an endgame by an exactly matching FEN, ignoring surrounding whitespace" do + endgame = create_endgame!(@kr) + + assert [found] = Endgames.search(" #{@kr} ") + assert found.id == endgame.id + end + + test "normalizes a fullmove 0 FEN before matching" do + endgame = create_endgame!("8/8/3k4/8/8/3K1R2/8/8 w - - 0 0") + + assert [found] = Endgames.search("8/8/3k4/8/8/3K1R2/8/8 w - - 0 0") + assert found.id == endgame.id + end + + test "finds endgames containing a FEN fragment" do + kr = create_endgame!(@kr) + kq = create_endgame!(@kq) + + assert Enum.sort(Enum.map(Endgames.search("3k4"), & &1.id)) == Enum.sort([kr.id, kq.id]) + end + + test "preloads themes" do + {:ok, lucena} = Themes.create_theme(%{name: "Lucena", category: :endgame}) + create_endgame!(@kr, [lucena]) + + assert [found] = Endgames.search(@kr) + assert Enum.map(found.themes, & &1.name) == ["Lucena"] + end + + test "returns no results for an unknown search or a blank query" do + create_endgame!(@kr) + + assert Endgames.search("8/8/8/8/8/8/8/8 w - - 0 1") == [] + assert Endgames.search("not an identifier") == [] + assert Endgames.search(" ") == [] + end + end + describe "listing and filtering" do test "list_keys/0 returns the distinct keys sorted" do create_endgame!(@kr) diff --git a/test/chesstrainer_web/live/endgame_live/form_test.exs b/test/chesstrainer_web/live/endgame_live/form_test.exs index b9f2bac..9c6ce2c 100644 --- a/test/chesstrainer_web/live/endgame_live/form_test.exs +++ b/test/chesstrainer_web/live/endgame_live/form_test.exs @@ -38,7 +38,7 @@ defmodule ChesstrainerWeb.EndgameLive.FormTest do attrs = %{fen: @fen, color: :white, result: :win, rating: 1625} {:ok, endgame} = Endgames.create_endgame(attrs) - {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame}/edit") + {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame.id}/edit") html = view |> element("#endgame-form input[name='endgame[rating]']") |> render() @@ -103,7 +103,7 @@ defmodule ChesstrainerWeb.EndgameLive.FormTest do attrs = %{fen: @fen, color: :white, result: :win, rating: 1500} {:ok, endgame} = Endgames.create_endgame(attrs, [theme]) - {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame}/edit") + {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame.id}/edit") assert render(view) =~ "Lucena" diff --git a/test/chesstrainer_web/live/endgame_live/index_test.exs b/test/chesstrainer_web/live/endgame_live/index_test.exs index 0fb9ee4..40c0622 100644 --- a/test/chesstrainer_web/live/endgame_live/index_test.exs +++ b/test/chesstrainer_web/live/endgame_live/index_test.exs @@ -43,16 +43,68 @@ defmodule ChesstrainerWeb.EndgameLive.IndexTest do {:ok, view, html} = live(conn, ~p"/admin/endgames") # collapsed: the endgame row (and its themes) are not rendered yet - refute html =~ ~p"/endgames/#{endgame}/play" + refute html =~ ~p"/endgames/#{endgame.public_code}/play" refute html =~ "Lucena" view |> element("#key-group-K-v-K button") |> render_click() html = render(view) - assert html =~ ~p"/endgames/#{endgame}/play" + assert html =~ ~p"/endgames/#{endgame.public_code}/play" assert html =~ "Lucena" end + describe "search" do + test "opens the endgame found by public code", %{conn: conn} do + endgame = endgame_fixture() + + {:ok, view, _html} = live(conn, ~p"/admin/endgames") + + assert {:error, {:live_redirect, %{to: path}}} = + view + |> form("#endgame-search-form", %{query: endgame.public_code}) + |> render_submit() + + assert path == "/admin/endgames/#{endgame.id}" + end + + test "opens the endgame found by database id", %{conn: conn} do + endgame = endgame_fixture() + + {:ok, view, _html} = live(conn, ~p"/admin/endgames") + + assert {:error, {:live_redirect, %{to: path}}} = + view |> form("#endgame-search-form", %{query: endgame.id}) |> render_submit() + + assert path == "/admin/endgames/#{endgame.id}" + end + + test "lists every endgame containing a FEN fragment", %{conn: conn} do + kr = endgame_fixture(fen: "8/8/3k4/8/8/3K1R2/8/8 w - - 0 1") + kq = endgame_fixture(fen: "8/8/3k4/8/8/3K1Q2/8/8 w - - 0 1") + + {:ok, view, _html} = live(conn, ~p"/admin/endgames") + + html = view |> form("#endgame-search-form", %{query: "3k4"}) |> render_submit() + + assert html =~ ~s{/admin/endgames/#{kr.id}} + assert html =~ ~s{/admin/endgames/#{kq.id}} + end + + test "reports when nothing matches, and clears back to the grouped list", %{conn: conn} do + endgame_fixture() + + {:ok, view, _html} = live(conn, ~p"/admin/endgames") + + html = view |> form("#endgame-search-form", %{query: "no such endgame"}) |> render_submit() + assert html =~ "No endgame matches" + + view |> element("#clear-endgame-search") |> render_click() + + assert has_element?(view, "#key-group-K-v-K") + refute render(view) =~ "No endgame matches" + end + end + test "filters by theme", %{conn: conn} do lucena = theme_fixture(%{name: "Lucena"}) philidor = theme_fixture(%{name: "Philidor"}) diff --git a/test/chesstrainer_web/live/endgame_live/play_test.exs b/test/chesstrainer_web/live/endgame_live/play_test.exs index cb84591..302e9c0 100644 --- a/test/chesstrainer_web/live/endgame_live/play_test.exs +++ b/test/chesstrainer_web/live/endgame_live/play_test.exs @@ -69,6 +69,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do {:ok, key} = Chesstrainer.Key.from_fen(fen) Chesstrainer.Repo.insert!(%Chesstrainer.Endgames.Endgame{ + public_code: Chesstrainer.Endgames.Endgame.generate_public_code(), fen: fen, color: :black, key: key, @@ -95,7 +96,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(after_reply, category: :win, moves: grading_moves()) seed_tablebase(after_losing, category: :draw, moves: [losing_reply]) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") %{proxy: {ref, _topic, _}} = view assert_receive {^ref, {:push_event, "init_board", _payload}}, 100 @@ -137,7 +138,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture(color: :white) seed_tablebase(endgame.fen) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert has_element?(view, "#endgame-board") assert_init_board(view, endgame.fen, "white", "white") @@ -147,7 +148,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture(color: :black) seed_tablebase(endgame.fen) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert_init_board(view, endgame.fen, "black", "black") end @@ -163,7 +164,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen) - {:ok, _view, html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, _view, html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert html =~ "KQ v K" assert html =~ "White to move" @@ -176,6 +177,14 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do live(conn, ~p"/endgames/00000000-0000-0000-0000-000000000000/play") end end + + test "does not resolve by database id", %{conn: conn} do + endgame = endgame_fixture() + + assert_raise Ecto.NoResultsError, fn -> + live(conn, "/endgames/#{endgame.id}/play") + end + end end describe "current scope" do @@ -187,7 +196,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do {:ok, view, _html} = conn |> log_in_user(user) - |> live(~p"/endgames/#{endgame}/play") + |> live(~p"/endgames/#{endgame.public_code}/play") assert :sys.get_state(view.pid).socket.assigns.current_scope.user.id == user.id end @@ -196,7 +205,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert :sys.get_state(view.pid).socket.assigns.current_scope == nil end @@ -211,7 +220,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do Ratelimiters.lichess_add_cooldown() on_exit(fn -> Ratelimiters.lichess_reset_cooldown() end) - {:ok, view, html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert html =~ "Tablebase unavailable" @@ -222,7 +231,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do test "blocks an out-of-range endgame as not covered", %{conn: conn} do endgame = insert_out_of_range_endgame() - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") html = render(view) assert html =~ "Tablebase unavailable" @@ -235,7 +244,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") view |> render_hook("chess_fen_invalid", %{ @@ -254,7 +263,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d7", "Qd7+") html = render(view) @@ -267,7 +276,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d5", "Qd5") @@ -278,7 +287,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d4", "Qd4") @@ -289,7 +298,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -315,7 +324,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(fen_after, category: :loss, moves: [reply]) seed_tablebase(fen_after_reply, category: :win, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -341,7 +350,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d4", "Qd4") @@ -357,7 +366,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen) - {:ok, _view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, _view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert Endgames.get_endgame!(endgame.id).times_attempted == 1 end @@ -369,7 +378,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, moves: grading_moves()) seed_tablebase(fen_after, checkmate: true, moves: []) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -389,7 +398,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do moves = [%Tablebase.Move{uci: "a7a8q", san: "a8=Q", category: :loss, dtz: -1}] seed_tablebase(endgame.fen, moves: moves) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "a7", @@ -409,7 +418,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d4", "Qd4") @@ -430,7 +439,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, moves: grading_moves()) seed_tablebase(fen_after, checkmate: true, moves: []) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -452,7 +461,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d4", "Qd4") @@ -469,7 +478,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, moves: grading_moves()) seed_tablebase(fen_after, checkmate: true, moves: []) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -494,7 +503,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, moves: grading_moves()) seed_tablebase(fen_after, checkmate: true, moves: []) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play = fn -> render_hook(view, "endgame_move_played", %{ @@ -527,7 +536,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture(rating: 1800) seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d4", "Qd4") @@ -545,7 +554,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture(result: :draw) seed_tablebase(endgame.fen, category: :draw, moves: []) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert has_element?(view, "#endgame-board") assert render(view) =~ "Make a move" @@ -559,7 +568,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, category: :draw, moves: draw_moves()) seed_tablebase(fen_after, category: :draw, moves: [reply]) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -581,7 +590,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture(result: :draw) seed_tablebase(endgame.fen, category: :draw, moves: draw_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -603,7 +612,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture(result: :draw) seed_tablebase(endgame.fen, category: :draw, moves: draw_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -627,7 +636,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, category: :draw, moves: draw_moves()) seed_tablebase(fen_after, category: :draw, moves: [reply]) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -651,7 +660,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do endgame = endgame_fixture() seed_tablebase(endgame.fen, moves: grading_moves()) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") play_move(view, endgame, "d1", "d7", "Qd7+") assert render(view) =~ "Qd7+" @@ -694,7 +703,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do seed_tablebase(endgame.fen, category: :draw, moves: moves) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "d1", @@ -730,7 +739,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayTest do moves = [%Tablebase.Move{uci: "a7a8q", san: "a8=Q", category: :loss, dtz: -1}] seed_tablebase(endgame.fen, moves: moves) - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") render_hook(view, "endgame_move_played", %{ "from" => "a7", diff --git a/test/chesstrainer_web/live/endgame_live/player_index_test.exs b/test/chesstrainer_web/live/endgame_live/player_index_test.exs index 25c2d2c..09bb671 100644 --- a/test/chesstrainer_web/live/endgame_live/player_index_test.exs +++ b/test/chesstrainer_web/live/endgame_live/player_index_test.exs @@ -23,11 +23,22 @@ defmodule ChesstrainerWeb.EndgameLive.PlayerIndexTest do view |> element("#key-group-K-v-K button") |> render_click() html = render(view) - assert html =~ ~p"/endgames/#{endgame}/play" - assert html =~ ~p"/endgames/#{other}/play" + assert html =~ ~p"/endgames/#{endgame.public_code}/play" + assert html =~ ~p"/endgames/#{other.public_code}/play" assert html =~ "Lucena" end + test "links to the public code, never the database id", %{conn: conn} do + endgame = endgame_fixture() + + {:ok, view, _html} = live(conn, ~p"/endgames") + view |> element("#key-group-K-v-K button") |> render_click() + + html = render(view) + assert html =~ ~s{/endgames/#{endgame.public_code}/play} + refute html =~ endgame.id + end + test "filters by theme", %{conn: conn} do lucena = theme_fixture(%{name: "Lucena"}) philidor = theme_fixture(%{name: "Philidor"}) @@ -49,7 +60,7 @@ defmodule ChesstrainerWeb.EndgameLive.PlayerIndexTest do test "navigating to a play page renders the board", %{conn: conn} do endgame = endgame_fixture() - {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame}/play") + {:ok, view, _html} = live(conn, ~p"/endgames/#{endgame.public_code}/play") assert has_element?(view, "#endgame-board") assert has_element?(view, ~s{a[href="/endgames"]}) diff --git a/test/chesstrainer_web/live/endgame_live/show_test.exs b/test/chesstrainer_web/live/endgame_live/show_test.exs new file mode 100644 index 0000000..9a42cdb --- /dev/null +++ b/test/chesstrainer_web/live/endgame_live/show_test.exs @@ -0,0 +1,26 @@ +defmodule ChesstrainerWeb.EndgameLive.ShowTest do + use ChesstrainerWeb.ConnCase + + import Phoenix.LiveViewTest + import Chesstrainer.EndgamesFixtures + + setup :register_and_log_in_admin + + test "shows the public code alongside the database id", %{conn: conn} do + endgame = endgame_fixture() + + {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame.id}") + + assert has_element?(view, "li.list-row", "Public code") + assert has_element?(view, "li.list-row", endgame.public_code) + assert has_element?(view, "h1", endgame.id) + end + + test "links to the player surface by public code", %{conn: conn} do + endgame = endgame_fixture() + + {:ok, view, _html} = live(conn, ~p"/admin/endgames/#{endgame.id}") + + assert has_element?(view, ~s{a[href="/endgames/#{endgame.public_code}/play"]}) + end +end