feat(admin): publishers in the Settings and Members tabs
- Settings: the Posting select offers Publishers only (newsletter) - Members: a Can publish checkbox in the add form (unchecked sends no flag, so adding an existing publisher again keeps it), a Publisher badge in the table, and a Make publisher / Make subscriber row action - api client: publisher on Member, the publishers post policy, setPublisher - the fake API keeps the flag on re-add and answers the member PATCH - tests for each
This commit is contained in:
parent
e850547b3d
commit
10f593e9bd
6 changed files with 137 additions and 4 deletions
|
|
@ -1,6 +1,6 @@
|
||||||
// Typed client for the Parsimony admin REST API (/api/v1).
|
// 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 JoinPolicy = 'open' | 'closed'
|
||||||
export type ArchivePolicy = 'public' | 'private' | 'off'
|
export type ArchivePolicy = 'public' | 'private' | 'off'
|
||||||
|
|
||||||
|
|
@ -20,6 +20,8 @@ export interface Member {
|
||||||
display_name: string
|
display_name: string
|
||||||
disabled: boolean
|
disabled: boolean
|
||||||
bounce_count: number
|
bounce_count: number
|
||||||
|
/** May post when the list's post policy is 'publishers'. */
|
||||||
|
publisher: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Held {
|
export interface Held {
|
||||||
|
|
@ -154,8 +156,11 @@ export const api = {
|
||||||
},
|
},
|
||||||
members: {
|
members: {
|
||||||
list: (listId: number) => request<Member[]>('GET', `/lists/${listId}/members`),
|
list: (listId: number) => request<Member[]>('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<Member>('POST', `/lists/${listId}/members`, b),
|
request<Member>('POST', `/lists/${listId}/members`, b),
|
||||||
|
setPublisher: (listId: number, address: string, publisher: boolean) =>
|
||||||
|
request<void>('PATCH', `/lists/${listId}/members/${enc(address)}`, { publisher }),
|
||||||
remove: (listId: number, address: string) =>
|
remove: (listId: number, address: string) =>
|
||||||
request<void>('DELETE', `/lists/${listId}/members/${enc(address)}`),
|
request<void>('DELETE', `/lists/${listId}/members/${enc(address)}`),
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -9,6 +9,7 @@ const member = (address: string, over: Partial<Member> = {}): Member => ({
|
||||||
display_name: '',
|
display_name: '',
|
||||||
disabled: false,
|
disabled: false,
|
||||||
bounce_count: 0,
|
bounce_count: 0,
|
||||||
|
publisher: false,
|
||||||
...over,
|
...over,
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
@ -105,6 +106,72 @@ describe('members tab', () => {
|
||||||
expect(screen.queryByRole('button', { name: /re-enable/i })).not.toBeInTheDocument()
|
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', () => {
|
describe('removing', () => {
|
||||||
async function open() {
|
async function open() {
|
||||||
const ctx = await setup([member('alice@example.com'), member('a+b@example.com')])
|
const ctx = await setup([member('alice@example.com'), member('a+b@example.com')])
|
||||||
|
|
|
||||||
|
|
@ -36,6 +36,15 @@ export function MembersTab() {
|
||||||
onError: (e: Error) => toast.error(e.message),
|
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 all = members.data ?? []
|
||||||
const q = filter.trim().toLowerCase()
|
const q = filter.trim().toLowerCase()
|
||||||
const shown = q ? all.filter((m) => m.address.includes(q) || m.display_name.toLowerCase().includes(q)) : all
|
const shown = q ? all.filter((m) => m.address.includes(q) || m.display_name.toLowerCase().includes(q)) : all
|
||||||
|
|
@ -76,6 +85,7 @@ export function MembersTab() {
|
||||||
<TableCell className="font-medium">{m.address}</TableCell>
|
<TableCell className="font-medium">{m.address}</TableCell>
|
||||||
<TableCell>{m.display_name}</TableCell>
|
<TableCell>{m.display_name}</TableCell>
|
||||||
<TableCell className="space-x-2">
|
<TableCell className="space-x-2">
|
||||||
|
{m.publisher && <Badge>Publisher</Badge>}
|
||||||
{m.disabled ? <Badge variant="destructive">Disabled</Badge> : <Badge variant="secondary">Active</Badge>}
|
{m.disabled ? <Badge variant="destructive">Disabled</Badge> : <Badge variant="secondary">Active</Badge>}
|
||||||
{m.bounce_count > 0 && (
|
{m.bounce_count > 0 && (
|
||||||
<span className="text-sm text-muted-foreground">
|
<span className="text-sm text-muted-foreground">
|
||||||
|
|
@ -89,6 +99,9 @@ export function MembersTab() {
|
||||||
Re-enable
|
Re-enable
|
||||||
</Button>
|
</Button>
|
||||||
)}
|
)}
|
||||||
|
<Button size="sm" variant="outline" disabled={setPublisher.isPending} onClick={() => setPublisher.mutate(m)}>
|
||||||
|
{m.publisher ? 'Make subscriber' : 'Make publisher'}
|
||||||
|
</Button>
|
||||||
<Button size="sm" variant="outline" onClick={() => setRemoving(m)}>
|
<Button size="sm" variant="outline" onClick={() => setRemoving(m)}>
|
||||||
Remove
|
Remove
|
||||||
</Button>
|
</Button>
|
||||||
|
|
@ -109,15 +122,19 @@ function AddMemberForm({ list }: { list: List }) {
|
||||||
const queryClient = useQueryClient()
|
const queryClient = useQueryClient()
|
||||||
const [address, setAddress] = useState('')
|
const [address, setAddress] = useState('')
|
||||||
const [name, setName] = useState('')
|
const [name, setName] = useState('')
|
||||||
|
const [publisher, setPublisher] = useState(false)
|
||||||
const [error, setError] = useState<string | null>(null)
|
const [error, setError] = useState<string | null>(null)
|
||||||
|
|
||||||
const add = useMutation({
|
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) => {
|
onSuccess: async (m) => {
|
||||||
await queryClient.invalidateQueries({ queryKey: ['members', list.id] })
|
await queryClient.invalidateQueries({ queryKey: ['members', list.id] })
|
||||||
toast.success(`Added ${m.address}`)
|
toast.success(`Added ${m.address}`)
|
||||||
setAddress('')
|
setAddress('')
|
||||||
setName('')
|
setName('')
|
||||||
|
setPublisher(false)
|
||||||
setError(null)
|
setError(null)
|
||||||
},
|
},
|
||||||
onError: (e: Error) => setError(e.message),
|
onError: (e: Error) => setError(e.message),
|
||||||
|
|
@ -144,6 +161,16 @@ function AddMemberForm({ list }: { list: List }) {
|
||||||
<Label htmlFor="member-name">Display name</Label>
|
<Label htmlFor="member-name">Display name</Label>
|
||||||
<Input id="member-name" value={name} onChange={(e) => setName(e.target.value)} autoComplete="off" />
|
<Input id="member-name" value={name} onChange={(e) => setName(e.target.value)} autoComplete="off" />
|
||||||
</div>
|
</div>
|
||||||
|
<div className="flex h-9 items-center gap-2">
|
||||||
|
<input
|
||||||
|
id="member-publisher"
|
||||||
|
type="checkbox"
|
||||||
|
className="size-4"
|
||||||
|
checked={publisher}
|
||||||
|
onChange={(e) => setPublisher(e.target.checked)}
|
||||||
|
/>
|
||||||
|
<Label htmlFor="member-publisher">Can publish</Label>
|
||||||
|
</div>
|
||||||
<Button type="submit" disabled={add.isPending}>
|
<Button type="submit" disabled={add.isPending}>
|
||||||
Add member
|
Add member
|
||||||
</Button>
|
</Button>
|
||||||
|
|
|
||||||
24
admin/src/tabs/SettingsTab.test.tsx
Normal file
24
admin/src/tabs/SettingsTab.test.tsx
Normal file
|
|
@ -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')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
@ -21,6 +21,7 @@ import { api, type ArchivePolicy, type JoinPolicy, type List, type PostPolicy }
|
||||||
const postOptions: Option<PostPolicy>[] = [
|
const postOptions: Option<PostPolicy>[] = [
|
||||||
{ value: 'members', label: 'Members only' },
|
{ value: 'members', label: 'Members only' },
|
||||||
{ value: 'moderated', label: 'Moderated (hold every post)' },
|
{ value: 'moderated', label: 'Moderated (hold every post)' },
|
||||||
|
{ value: 'publishers', label: 'Publishers only (newsletter)' },
|
||||||
]
|
]
|
||||||
const joinOptions: Option<JoinPolicy>[] = [
|
const joinOptions: Option<JoinPolicy>[] = [
|
||||||
{ value: 'open', label: 'Open (confirmed by email)' },
|
{ value: 'open', label: 'Open (confirmed by email)' },
|
||||||
|
|
|
||||||
|
|
@ -112,11 +112,20 @@ export function installFakeApi(state: FakeState) {
|
||||||
if (method === 'GET') return json(200, ms)
|
if (method === 'GET') return json(200, ms)
|
||||||
if (method === 'POST') {
|
if (method === 'POST') {
|
||||||
if (!/^[^@\s]+@[^@\s]+$/.test(body.address ?? '')) return err(400, 'a valid email address is required')
|
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]
|
state.members[id] = [...ms.filter((x) => x.address !== mem.address), mem]
|
||||||
return json(201, 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') {
|
if ((m = path.match(/^\/lists\/(\d+)\/members\/(.+)$/)) && method === 'DELETE') {
|
||||||
const id = Number(m[1])
|
const id = Number(m[1])
|
||||||
const addr = decodeURIComponent(m[2])
|
const addr = decodeURIComponent(m[2])
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue