diff --git a/admin/src/lib/api.ts b/admin/src/lib/api.ts index 0f25352..7fd6ae8 100644 --- a/admin/src/lib/api.ts +++ b/admin/src/lib/api.ts @@ -1,6 +1,6 @@ // Typed client for the Parsimony admin REST API (/api/v1). -export type PostPolicy = 'members' | 'moderated' +export type PostPolicy = 'members' | 'moderated' | 'publishers' export type JoinPolicy = 'open' | 'closed' export type ArchivePolicy = 'public' | 'private' | 'off' @@ -20,6 +20,8 @@ export interface Member { display_name: string disabled: boolean bounce_count: number + /** May post when the list's post policy is 'publishers'. */ + publisher: boolean } export interface Held { @@ -154,8 +156,11 @@ export const api = { }, members: { list: (listId: number) => request('GET', `/lists/${listId}/members`), - add: (listId: number, b: { address: string; display_name?: string }) => + /** Without publisher an existing member keeps its flag. */ + add: (listId: number, b: { address: string; display_name?: string; publisher?: boolean }) => request('POST', `/lists/${listId}/members`, b), + setPublisher: (listId: number, address: string, publisher: boolean) => + request('PATCH', `/lists/${listId}/members/${enc(address)}`, { publisher }), remove: (listId: number, address: string) => request('DELETE', `/lists/${listId}/members/${enc(address)}`), }, diff --git a/admin/src/tabs/MembersTab.test.tsx b/admin/src/tabs/MembersTab.test.tsx index f69ca62..f5f42b0 100644 --- a/admin/src/tabs/MembersTab.test.tsx +++ b/admin/src/tabs/MembersTab.test.tsx @@ -9,6 +9,7 @@ const member = (address: string, over: Partial = {}): Member => ({ display_name: '', disabled: false, bounce_count: 0, + publisher: false, ...over, }) @@ -105,6 +106,72 @@ describe('members tab', () => { expect(screen.queryByRole('button', { name: /re-enable/i })).not.toBeInTheDocument() }) + describe('publishers', () => { + it('shows a Publisher badge on publishers only', async () => { + await setup([member('alice@example.com', { publisher: true }), member('bob@example.com')]) + const alice = (await screen.findByText('alice@example.com')).closest('tr')! + expect(within(alice).getByText('Publisher')).toBeInTheDocument() + const bob = screen.getByText('bob@example.com').closest('tr')! + expect(within(bob).queryByText('Publisher')).not.toBeInTheDocument() + }) + + it('adds a publisher with the Can publish checkbox, then clears it', async () => { + const { user, state } = await setup() + await user.type(screen.getByLabelText(/email address/i), 'dave@example.com') + await user.click(screen.getByRole('checkbox', { name: /can publish/i })) + await user.click(screen.getByRole('button', { name: /add member/i })) + const row = (await screen.findByText('dave@example.com')).closest('tr')! + expect(await within(row).findByText('Publisher')).toBeInTheDocument() + expect(state.members[1][0].publisher).toBe(true) + expect(screen.getByRole('checkbox', { name: /can publish/i })).not.toBeChecked() + }) + + it('adding without the checkbox leaves an existing publisher alone', async () => { + const { user, state } = await setup([member('dave@example.com', { publisher: true })]) + await screen.findByText('dave@example.com') + expect(screen.getByRole('checkbox', { name: /can publish/i })).not.toBeChecked() + await user.type(screen.getByLabelText(/email address/i), 'dave@example.com') + await user.type(screen.getByLabelText(/display name/i), 'Dave') + await user.click(screen.getByRole('button', { name: /add member/i })) + await waitFor(() => expect(state.members[1][0].display_name).toBe('Dave')) + expect(state.members[1][0].publisher).toBe(true) + }) + + it('re-enabling keeps the publisher flag', async () => { + const { user, state } = await setup([member('bob@example.com', { disabled: true, publisher: true })]) + const row = (await screen.findByText('bob@example.com')).closest('tr')! + await user.click(within(row).getByRole('button', { name: /re-enable/i })) + await waitFor(() => expect(state.members[1][0].disabled).toBe(false)) + expect(state.members[1][0].publisher).toBe(true) + }) + + it('makes a member a publisher and back', async () => { + const { user, state } = await setup([member('a+b@example.com')]) + let row = (await screen.findByText('a+b@example.com')).closest('tr')! + await user.click(within(row).getByRole('button', { name: /make publisher/i })) + await waitFor(() => expect(state.members[1][0].publisher).toBe(true)) + expect(state.calls).toContain('PATCH /lists/1/members/a%2Bb%40example.com') + row = screen.getByText('a+b@example.com').closest('tr')! + expect(await within(row).findByText('Publisher')).toBeInTheDocument() + expect(await screen.findByText(/a\+b@example.com can now publish/i)).toBeInTheDocument() + + await user.click(within(row).getByRole('button', { name: /make subscriber/i })) + await waitFor(() => expect(state.members[1][0].publisher).toBe(false)) + row = screen.getByText('a+b@example.com').closest('tr')! + await waitFor(() => expect(within(row).queryByText('Publisher')).not.toBeInTheDocument()) + expect(within(row).getByRole('button', { name: /make publisher/i })).toBeInTheDocument() + }) + + it('shows the server error of the row action', async () => { + const { user, state } = await setup([member('alice@example.com')]) + const row = (await screen.findByText('alice@example.com')).closest('tr')! + state.fail['PATCH /lists/1/members/alice%40example.com'] = { status: 500, error: 'locked' } + await user.click(within(row).getByRole('button', { name: /make publisher/i })) + expect(await screen.findByText('locked')).toBeInTheDocument() + expect(state.members[1][0].publisher).toBe(false) + }) + }) + describe('removing', () => { async function open() { const ctx = await setup([member('alice@example.com'), member('a+b@example.com')]) diff --git a/admin/src/tabs/MembersTab.tsx b/admin/src/tabs/MembersTab.tsx index 6a669ef..7a1e8bf 100644 --- a/admin/src/tabs/MembersTab.tsx +++ b/admin/src/tabs/MembersTab.tsx @@ -36,6 +36,15 @@ export function MembersTab() { onError: (e: Error) => toast.error(e.message), }) + const setPublisher = useMutation({ + mutationFn: (m: Member) => api.members.setPublisher(list.id, m.address, !m.publisher), + onSuccess: async (_, m) => { + await queryClient.invalidateQueries({ queryKey: key }) + toast.success(m.publisher ? `${m.address} is now a subscriber` : `${m.address} can now publish`) + }, + onError: (e: Error) => toast.error(e.message), + }) + const all = members.data ?? [] const q = filter.trim().toLowerCase() const shown = q ? all.filter((m) => m.address.includes(q) || m.display_name.toLowerCase().includes(q)) : all @@ -76,6 +85,7 @@ export function MembersTab() { {m.address} {m.display_name} + {m.publisher && Publisher} {m.disabled ? Disabled : Active} {m.bounce_count > 0 && ( @@ -89,6 +99,9 @@ export function MembersTab() { Re-enable )} + @@ -109,15 +122,19 @@ function AddMemberForm({ list }: { list: List }) { const queryClient = useQueryClient() const [address, setAddress] = useState('') const [name, setName] = useState('') + const [publisher, setPublisher] = useState(false) const [error, setError] = useState(null) const add = useMutation({ - mutationFn: () => api.members.add(list.id, { address: address.trim(), display_name: name.trim() }), + // Unchecked sends no flag, so adding an existing publisher again does not demote it. + mutationFn: () => + api.members.add(list.id, { address: address.trim(), display_name: name.trim(), ...(publisher ? { publisher: true } : {}) }), onSuccess: async (m) => { await queryClient.invalidateQueries({ queryKey: ['members', list.id] }) toast.success(`Added ${m.address}`) setAddress('') setName('') + setPublisher(false) setError(null) }, onError: (e: Error) => setError(e.message), @@ -144,6 +161,16 @@ function AddMemberForm({ list }: { list: List }) { setName(e.target.value)} autoComplete="off" /> +
+ setPublisher(e.target.checked)} + /> + +
diff --git a/admin/src/tabs/SettingsTab.test.tsx b/admin/src/tabs/SettingsTab.test.tsx new file mode 100644 index 0000000..4d5c5c5 --- /dev/null +++ b/admin/src/tabs/SettingsTab.test.tsx @@ -0,0 +1,24 @@ +import { screen, waitFor } from '@testing-library/react' +import { describe, expect, it } from 'vitest' +import { aList, installFakeApi, newState } from '@/test/fakeApi' +import { renderApp } from '@/test/render' + +describe('settings tab: newsletter', () => { + it('shows the publishers policy', async () => { + installFakeApi(newState({ lists: [aList({ id: 1, post_policy: 'publishers' })] })) + renderApp('/lists/1', { token: 'good' }) + await screen.findByLabelText(/^title$/i) + expect(screen.getByRole('combobox', { name: /posting/i })).toHaveTextContent('Publishers only (newsletter)') + }) + + it('turns a list into a newsletter', async () => { + const state = installFakeApi(newState({ lists: [aList({ id: 1 })] })) + const { user } = renderApp('/lists/1', { token: 'good' }) + await screen.findByLabelText(/^title$/i) + await user.click(screen.getByRole('combobox', { name: /posting/i })) + await user.click(await screen.findByRole('option', { name: 'Publishers only (newsletter)' })) + await user.click(screen.getByRole('button', { name: /save changes/i })) + await waitFor(() => expect(state.lists[0].post_policy).toBe('publishers')) + expect(state.lists[0].join_policy).toBe('open') + }) +}) diff --git a/admin/src/tabs/SettingsTab.tsx b/admin/src/tabs/SettingsTab.tsx index 4502b12..51ec6b5 100644 --- a/admin/src/tabs/SettingsTab.tsx +++ b/admin/src/tabs/SettingsTab.tsx @@ -21,6 +21,7 @@ import { api, type ArchivePolicy, type JoinPolicy, type List, type PostPolicy } const postOptions: Option[] = [ { value: 'members', label: 'Members only' }, { value: 'moderated', label: 'Moderated (hold every post)' }, + { value: 'publishers', label: 'Publishers only (newsletter)' }, ] const joinOptions: Option[] = [ { value: 'open', label: 'Open (confirmed by email)' }, diff --git a/admin/src/test/fakeApi.ts b/admin/src/test/fakeApi.ts index c8bbfaf..6f394f3 100644 --- a/admin/src/test/fakeApi.ts +++ b/admin/src/test/fakeApi.ts @@ -112,11 +112,20 @@ export function installFakeApi(state: FakeState) { if (method === 'GET') return json(200, ms) if (method === 'POST') { if (!/^[^@\s]+@[^@\s]+$/.test(body.address ?? '')) return err(400, 'a valid email address is required') - const mem: Member = { address: body.address.toLowerCase(), display_name: body.display_name ?? '', disabled: false, bounce_count: 0 } + const address = body.address.toLowerCase() + const publisher = body.publisher ?? ms.find((x) => x.address === address)?.publisher ?? false + const mem: Member = { address, display_name: body.display_name ?? '', disabled: false, bounce_count: 0, publisher } state.members[id] = [...ms.filter((x) => x.address !== mem.address), mem] return json(201, mem) } } + if ((m = path.match(/^\/lists\/(\d+)\/members\/(.+)$/)) && method === 'PATCH') { + const mem = (state.members[Number(m[1])] ?? []).find((x) => x.address === decodeURIComponent(m![2]).toLowerCase()) + if (!mem) return err(404, 'not found') + if (typeof body.publisher !== 'boolean') return err(400, 'publisher (true or false) is required') + mem.publisher = body.publisher + return json(204) + } if ((m = path.match(/^\/lists\/(\d+)\/members\/(.+)$/)) && method === 'DELETE') { const id = Number(m[1]) const addr = decodeURIComponent(m[2])