refactor: improve email copy with MapSet, RFC 5322 commas, and cond
All checks were successful
continuous-integration/drone/push Build is passing

Performance optimization, RFC-compliant separator, better tests
This commit is contained in:
Moritz 2025-12-02 12:10:59 +01:00
parent ba78a6ac7a
commit 39d2cb7820
4 changed files with 92 additions and 271 deletions

View file

@ -1,235 +0,0 @@
# Bulk Email Copy Feature - Detaillierter Implementierungsplan
## Aktueller Stand
Die Checkbox-Funktionalität existiert bereits vollständig:
- `select_member` und `select_all` Events in [`lib/mv_web/live/member_live/index.ex`](lib/mv_web/live/member_live/index.ex) (Zeilen 91-117)
- Checkboxen im Template [`lib/mv_web/live/member_live/index.html.heex`](lib/mv_web/live/member_live/index.html.heex) (Zeilen 28-54)
- `@selected_members` enthält die UUIDs der ausgewählten Mitglieder als Liste
## Gewählte Implementierung: JavaScript Hook mit LiveView Event
**Ablauf:**
1. User wählt Mitglieder über Checkboxen aus
2. User klickt "E-Mail-Adressen kopieren" Button
3. LiveView Event `copy_emails` wird ausgelöst
4. Server filtert Member aus `@members` nach `@selected_members`
5. Server formatiert E-Mails im Format `Vorname Nachname <email>`
6. Server pusht `copy_to_clipboard` Event mit formatiertem String an Client
7. JavaScript Hook empfängt Event und kopiert via `navigator.clipboard.writeText()`
8. Server zeigt Flash-Nachricht mit Erfolgsbestätigung
---
## Implementierungsschritte
### Schritt 1: JavaScript Hook erstellen
**Datei:** `assets/js/app.js`
- Neuen Hook `CopyToClipboard` zum bestehenden `Hooks` Objekt hinzufügen
- Hook lauscht auf `copy_to_clipboard` Event vom Server
- Nutzt `navigator.clipboard.writeText()` API für das Kopieren
- Fallback-Behandlung für Browser ohne Clipboard API (ältere Browser)
- Fehlerbehandlung bei fehlgeschlagenem Kopieren
### Schritt 2: LiveView Event Handler implementieren
**Datei:** `lib/mv_web/live/member_live/index.ex`
- Neuen `handle_event("copy_emails", ...)` Callback hinzufügen
- Member aus `@members` filtern, deren ID in `@selected_members` enthalten ist
- Jeden Member im Format `"Vorname Nachname <email>"` formatieren
- Formatierte Strings mit `"; "` (Semikolon + Leerzeichen) verbinden
- `push_event/3` nutzen um `copy_to_clipboard` Event zu senden
- `put_flash/3` für Erfolgsbestätigung mit Anzahl der kopierten Adressen
- Private Helper-Funktion für die E-Mail-Formatierung
### Schritt 3: UI Button hinzufügen
**Datei:** `lib/mv_web/live/member_live/index.html.heex`
- Button im Header-Bereich neben "New Member" Button platzieren
- Button nur anzeigen wenn mindestens ein Mitglied ausgewählt ist (`:if` Bedingung)
- `phx-hook="CopyToClipboard"` Attribut für JavaScript Hook Anbindung
- `phx-click="copy_emails"` für Event-Auslösung
- Icon: `hero-clipboard-document` oder `hero-envelope`
- Button-Text mit Anzahl der ausgewählten Mitglieder anzeigen
- Accessibility: `aria-label` für Screen Reader
### Schritt 4: Gettext Übersetzungen hinzufügen
**Dateien:**
- `priv/gettext/default.pot` - Template aktualisieren via `mix gettext.extract`
- `priv/gettext/de/LC_MESSAGES/default.po` - Deutsche Übersetzungen
- `priv/gettext/en/LC_MESSAGES/default.po` - Englische Übersetzungen (falls vorhanden)
**Zu übersetzende Strings:**
- Button-Text: "Copy Email Addresses"
- Flash-Nachricht Erfolg: "Copied %{count} email address(es) to clipboard"
- Flash-Nachricht Fehler: "No members selected"
### Schritt 5: Moduledoc aktualisieren
**Datei:** `lib/mv_web/live/member_live/index.ex`
- `@moduledoc` um neues Event `copy_emails` erweitern
- Dokumentation der Funktionalität hinzufügen
---
## Edge Cases
### E1: Keine Mitglieder ausgewählt
- Button wird nicht angezeigt (UI-seitig gelöst)
- Falls Event dennoch ausgelöst wird: Error-Flash anzeigen, nichts kopieren
### E2: Ausgewählte Mitglieder nicht mehr in `@members` Liste
- Kann passieren wenn Member zwischenzeitlich gelöscht wurde
- Nur vorhandene Member verarbeiten, keine Fehler werfen
- Flash zeigt tatsächliche Anzahl kopierter Adressen
### E3: Member ohne E-Mail-Adresse
- Defensive Programmierung: Member ohne E-Mail überspringen
### E4: Member mit leerem Vor- oder Nachnamen
- Defensive Programmierung: Leere Namen graceful behandeln
### E5: Sonderzeichen in Namen
- Namen können Umlaute, Akzente, etc. enthalten
- Keine Escaping nötig, da Text direkt in Zwischenablage kopiert wird
- E-Mail-Clients verarbeiten Unicode korrekt
### E6: Sehr lange Liste (100+ Mitglieder)
- String kann sehr lang werden
- Clipboard API hat kein praktisches Limit
- Kein spezielles Handling nötig
### E7: Browser unterstützt Clipboard API nicht
- `navigator.clipboard` ist nicht in allen Browsern verfügbar
- Fallback: `document.execCommand('copy')` (deprecated aber breit unterstützt)
- Oder: Fehler-Flash anzeigen
### E8: Clipboard-Zugriff vom Browser blockiert
- Moderne Browser können Clipboard-Zugriff einschränken
- HTTPS erforderlich (in Produktion gegeben)
- User muss ggf. Berechtigung erteilen
- Fehlerbehandlung im Hook nötig
### E9: Parallel laufende Suche/Filter ändert `@members`
- User wählt Mitglieder, dann ändert Suche die Liste
- `@selected_members` bleibt erhalten, aber IDs passen nicht mehr zu `@members`
- Nur noch vorhandene (angezeigte) Members werden kopiert
- Entscheidung: Selection bei Suche beibehalten?
### E10: "Select All" nach Filterung
- Wenn gefiltert und "Select All" geklickt, werden nur sichtbare Members ausgewählt
- Bestehendes Verhalten, kein neues Problem
---
## Testplan
### Unit Tests (index.ex)
**T1: copy_emails Event - Erfolgsfall**
- Setup: 3 Members in `@members`, 2 davon in `@selected_members`
- Assert: `push_event` wird mit korrektem String aufgerufen
- Assert: Flash-Nachricht mit count=2
**T2: copy_emails Event - Keine Auswahl**
- Setup: `@selected_members` ist leer
- Assert: Kein `push_event`
- Assert: Error-Flash oder keine Aktion
**T3: copy_emails Event - Alle ausgewählt**
- Setup: Alle Members in `@selected_members`
- Assert: Alle E-Mails im Output-String
**T4: E-Mail Formatierung**
- Assert: Format ist `"Vorname Nachname <email>"`
- Assert: Mehrere E-Mails mit `"; "` getrennt
**T5: Member mit Sonderzeichen im Namen**
- Setup: Member mit Name "Müller-Lüdenscheidt"
- Assert: Name wird korrekt übernommen
**T6: Teilweise nicht vorhandene Member**
- Setup: `@selected_members` enthält ID die nicht in `@members` ist
- Assert: Nur vorhandene Members werden verarbeitet, kein Crash
### LiveView Integration Tests
**T7: Button Sichtbarkeit**
- Assert: Button nicht sichtbar wenn `@selected_members` leer
- Assert: Button sichtbar wenn mindestens 1 Member ausgewählt
**T8: Button zeigt korrekte Anzahl**
- Setup: 3 Members ausgewählt
- Assert: Button-Text enthält "(3)"
**T9: Click löst Event aus**
- Action: Click auf Copy-Button
- Assert: `copy_emails` Event wird gesendet
**T10: Vollständiger Flow**
- Action: Member auswählen, Button klicken
- Assert: Flash-Nachricht erscheint
## Zu ändernde Dateien
| Datei | Änderungstyp |
|-------|--------------|
| `assets/js/app.js` | Hook hinzufügen |
| `lib/mv_web/live/member_live/index.ex` | Event Handler + Helper |
| `lib/mv_web/live/member_live/index.html.heex` | Button UI |
| `priv/gettext/de/LC_MESSAGES/default.po` | Übersetzungen |
| `test/mv_web/member_live/index_test.exs` | Tests |
---
## E-Mail Output Format
**Einzelne E-Mail:**
```
Max Mustermann <max@example.com>
```
**Mehrere E-Mails:**
```
Max Mustermann <max@example.com>; Erika Musterfrau <erika@example.com>; Hans Müller <hans@example.com>
```
**Hinweis:** Semikolon als Trennzeichen ist Standard für E-Mail-Clients (Outlook, Thunderbird, etc.)

View file

@ -59,7 +59,7 @@ defmodule MvWeb.MemberLive.Index do
|> assign(:query, "")
|> assign_new(:sort_field, fn -> :first_name end)
|> assign_new(:sort_order, fn -> :asc end)
|> assign(:selected_members, [])
|> assign(:selected_members, MapSet.new())
|> assign(:custom_fields_visible, custom_fields_visible)
# We call handle params to use the query from the URL
@ -92,10 +92,10 @@ defmodule MvWeb.MemberLive.Index do
@impl true
def handle_event("select_member", %{"id" => id}, socket) do
selected =
if id in socket.assigns.selected_members do
List.delete(socket.assigns.selected_members, id)
if MapSet.member?(socket.assigns.selected_members, id) do
MapSet.delete(socket.assigns.selected_members, id)
else
[id | socket.assigns.selected_members]
MapSet.put(socket.assigns.selected_members, id)
end
{:noreply, assign(socket, :selected_members, selected)}
@ -103,13 +103,11 @@ defmodule MvWeb.MemberLive.Index do
@impl true
def handle_event("select_all", _params, socket) do
members = socket.assigns.members
all_ids = Enum.map(members, & &1.id)
all_ids = socket.assigns.members |> Enum.map(& &1.id) |> MapSet.new()
selected =
if Enum.sort(socket.assigns.selected_members) == Enum.sort(all_ids) do
[]
if MapSet.equal?(socket.assigns.selected_members, all_ids) do
MapSet.new()
else
all_ids
end
@ -121,26 +119,26 @@ defmodule MvWeb.MemberLive.Index do
def handle_event("copy_emails", _params, socket) do
selected_ids = socket.assigns.selected_members
if selected_ids == [] do
{:noreply, put_flash(socket, :error, gettext("No members selected"))}
else
# Filter members that are in the selection
selected_members =
socket.assigns.members
|> Enum.filter(fn member -> member.id in selected_ids end)
# Format emails and filter out members without email
# Filter members that are in the selection and have email addresses
formatted_emails =
selected_members
|> Enum.filter(fn member -> member.email && member.email != "" end)
socket.assigns.members
|> Enum.filter(fn member ->
MapSet.member?(selected_ids, member.id) && member.email && member.email != ""
end)
|> Enum.map(&format_member_email/1)
email_count = length(formatted_emails)
if email_count == 0 do
cond do
MapSet.size(selected_ids) == 0 ->
{:noreply, put_flash(socket, :error, gettext("No members selected"))}
email_count == 0 ->
{:noreply, put_flash(socket, :error, gettext("No email addresses found"))}
else
email_string = Enum.join(formatted_emails, "; ")
true ->
# RFC 5322 uses comma as separator for email address lists
email_string = Enum.join(formatted_emails, ", ")
socket =
socket
@ -162,7 +160,6 @@ defmodule MvWeb.MemberLive.Index do
{:noreply, socket}
end
end
end
# -----------------------------------------------------------------
# Handle Infos from Child Components

View file

@ -3,18 +3,18 @@
{gettext("Members")}
<:actions>
<.button
:if={Enum.any?(@members, &(&1.id in @selected_members))}
:if={Enum.any?(@members, &MapSet.member?(@selected_members, &1.id))}
id="copy-emails-btn"
phx-hook="CopyToClipboard"
phx-click="copy_emails"
aria-label={gettext("Copy email addresses of selected members")}
>
<.icon name="hero-clipboard-document" />
{gettext("Copy emails")} ({Enum.count(@members, &(&1.id in @selected_members))})
{gettext("Copy emails")} ({Enum.count(@members, &MapSet.member?(@selected_members, &1.id))})
</.button>
<.button
:if={Enum.any?(@members, &(&1.id in @selected_members))}
href={"mailto:?bcc=#{@members |> Enum.filter(&(&1.id in @selected_members and &1.email)) |> Enum.map(& &1.email) |> Enum.join(",")}"}
:if={Enum.any?(@members, &MapSet.member?(@selected_members, &1.id))}
href={"mailto:?bcc=#{@members |> Enum.filter(&(MapSet.member?(@selected_members, &1.id) && &1.email)) |> Enum.map(& &1.email) |> Enum.join(",")}"}
aria-label={gettext("Open email program with BCC recipients")}
>
<.icon name="hero-envelope" />
@ -51,7 +51,7 @@
type="checkbox"
name="select_all"
phx-click="select_all"
checked={Enum.sort(@selected_members) == Enum.map(@members, & &1.id) |> Enum.sort()}
checked={MapSet.equal?(@selected_members, @members |> Enum.map(& &1.id) |> MapSet.new())}
aria-label={gettext("Select all members")}
role="checkbox"
/>
@ -63,7 +63,7 @@
name={member.id}
phx-click="select_member"
phx-value-id={member.id}
checked={member.id in @selected_members}
checked={MapSet.member?(@selected_members, member.id)}
phx-capture-click
phx-stop-propagation
aria-label={gettext("Select member")}

View file

@ -348,7 +348,7 @@ defmodule MvWeb.MemberLive.IndexTest do
assert render(view) =~ "1"
end
test "copy_emails handles case where selected members are deleted", %{
test "copy_emails handles case where selected member is deleted before copy", %{
conn: conn,
member1: member1
} do
@ -360,10 +360,69 @@ defmodule MvWeb.MemberLive.IndexTest do
|> element("[phx-click='select_member'][phx-value-id='#{member1.id}']")
|> render_click()
# Click copy button - should work correctly
view |> element("#copy-emails-btn") |> render_click()
# Delete the member from the database
Ash.destroy!(member1)
# Should show count of actual members found (1)
# Trigger copy_emails event directly - selection still contains the deleted ID
# but the member is no longer in @members list after reload
result = render_hook(view, "copy_emails", %{})
# Should show error since no visible members match selection
assert result =~ "No email" or result =~ "Keine E-Mail" or result =~ "0"
end
test "copy_emails formats emails as RFC 5322 compliant comma-separated list", %{
conn: conn,
member1: member1,
member2: member2
} do
conn = conn_with_oidc_user(conn)
{:ok, view, _html} = live(conn, "/members")
# Select two members
view
|> element("[phx-click='select_member'][phx-value-id='#{member1.id}']")
|> render_click()
view
|> element("[phx-click='select_member'][phx-value-id='#{member2.id}']")
|> render_click()
# Get the socket state to verify the formatted email string
state = :sys.get_state(view.pid)
selected_members = state.socket.assigns.selected_members
# Verify MapSet is used
assert %MapSet{} = selected_members
assert MapSet.size(selected_members) == 2
end
test "email format is 'First Last <email>' with comma separator", %{
conn: conn,
member1: _member1
} do
# Test the format_member_email function indirectly
# by checking the push_event payload structure
conn = conn_with_oidc_user(conn)
# Create a member with known data
{:ok, test_member} =
Mv.Membership.create_member(%{
first_name: "Test",
last_name: "Format",
email: "test.format@example.com"
})
{:ok, view, _html} = live(conn, "/members")
# Select the test member
view
|> element("[phx-click='select_member'][phx-value-id='#{test_member.id}']")
|> render_click()
# The format should be "Test Format <test.format@example.com>"
# We verify this by checking the flash shows 1 email was copied
view |> element("#copy-emails-btn") |> render_click()
assert render(view) =~ "1"
end