Ghost/apps/admin-x-settings/test/acceptance/email/defaultRecipients.test.ts
Sag 5dfee47fca
🐛 Fixed default recipients setting not showing label filters (#20480)
fixes https://linear.app/tryghost/issue/SLO-171

- problem: when the Default Recipient setting is set to "Specific
people" and is filtered by a label, we were not able to render the label
correctly
- cause: during the rendering, we look for labels by `id`, but they're
stored by `slug` in the database setting
`editor_default_email_recipients_filter`
- solution: allow to look by the relevant key, by introducing a
programmatic `key` to search for

Before the fix:
https://github.com/TryGhost/Ghost/assets/6225080/aed5fc31-6409-4986-aafe-557073c7f355


After the fix:
https://github.com/TryGhost/Ghost/assets/6225080/f35b2607-5f22-42be-b1bb-92f35ccc9ab7
2024-06-27 17:47:26 +02:00

137 lines
6.2 KiB
TypeScript

import {chooseOptionInSelect, mockApi, responseFixtures, updatedSettingsResponse} from '@tryghost/admin-x-framework/test/acceptance';
import {expect, test} from '@playwright/test';
import {globalDataRequests} from '../../utils/acceptance';
test.describe('Default recipient settings', async () => {
test('Supports editing default recipients', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
editSettings: {method: 'PUT', path: '/settings/', response: updatedSettingsResponse([
{key: 'editor_default_email_recipients', value: 'filter'},
{key: 'editor_default_email_recipients_filter', value: 'status:-free'}
])}
}});
await page.goto('/');
const section = page.getByTestId('default-recipients');
await expect(section.getByText('Whoever has access to the post')).toHaveCount(1);
await section.getByRole('button', {name: 'Edit'}).click();
await chooseOptionInSelect(section.getByTestId('default-recipients-select'), 'All members');
await section.getByRole('button', {name: 'Save'}).click();
expect(lastApiRequests.editSettings?.body).toEqual({
settings: [
{key: 'editor_default_email_recipients', value: 'filter'},
{key: 'editor_default_email_recipients_filter', value: 'status:free,status:-free'}
]
});
await section.getByRole('button', {name: 'Edit'}).click();
await chooseOptionInSelect(section.getByTestId('default-recipients-select'), 'Usually nobody');
await section.getByRole('button', {name: 'Save'}).click();
expect(lastApiRequests.editSettings?.body).toEqual({
settings: [
{key: 'editor_default_email_recipients', value: 'filter'},
{key: 'editor_default_email_recipients_filter', value: null}
]
});
await section.getByRole('button', {name: 'Edit'}).click();
await chooseOptionInSelect(section.getByTestId('default-recipients-select'), 'Paid-members only');
await section.getByRole('button', {name: 'Save'}).click();
await expect(section.getByTestId('default-recipients-select')).toHaveCount(0);
await expect(section.getByText('Paid-members only')).toHaveCount(1);
expect(lastApiRequests.editSettings?.body).toEqual({
settings: [
{key: 'editor_default_email_recipients', value: 'filter'},
{key: 'editor_default_email_recipients_filter', value: 'status:-free'}
]
});
});
test('Supports selecting specific tiers, labels and offers', async ({page}) => {
const {lastApiRequests} = await mockApi({page, requests: {
...globalDataRequests,
browseTiers: {method: 'GET', path: '/tiers/?filter=&limit=20', response: responseFixtures.tiers},
browseLabels: {method: 'GET', path: '/labels/?filter=&limit=20', response: responseFixtures.labels},
browseOffers: {method: 'GET', path: '/offers/?filter=&limit=20', response: responseFixtures.offers},
editSettings: {method: 'PUT', path: '/settings/', response: updatedSettingsResponse([
{
key: 'editor_default_email_recipients',
value: 'filter'
},
{
key: 'editor_default_email_recipients_filter',
value: '645453f4d254799990dd0e22,label:first-label,offer_redemptions:6487ea6464fca78ec2fff5fe'
}
])}
}});
await page.goto('/');
const section = page.getByTestId('default-recipients');
await section.getByRole('button', {name: 'Edit'}).click();
await chooseOptionInSelect(section.getByTestId('default-recipients-select'), 'Specific people');
await section.getByLabel('Filter').click();
await section.locator('[data-testid="select-option"]', {hasText: 'Basic Supporter'}).click();
await section.locator('[data-testid="select-option"]', {hasText: 'first-label'}).click();
await section.locator('[data-testid="select-option"]', {hasText: 'First offer'}).click();
await section.getByRole('button', {name: 'Save'}).click();
await expect(section.getByText('Specific people')).toHaveCount(1);
expect(lastApiRequests.editSettings?.body).toEqual({
settings: [
{
key: 'editor_default_email_recipients',
value: 'filter'
},
{
key: 'editor_default_email_recipients_filter',
value: '645453f4d254799990dd0e22,label:first-label,offer_redemptions:6487ea6464fca78ec2fff5fe'
}
]
});
});
test('renders existing default recipients filters correctly', async ({page}) => {
await mockApi({page, requests: {
...globalDataRequests,
browseTiers: {method: 'GET', path: '/tiers/?filter=&limit=20', response: responseFixtures.tiers},
browseLabels: {method: 'GET', path: '/labels/?filter=&limit=20', response: responseFixtures.labels},
browseOffers: {method: 'GET', path: '/offers/?filter=&limit=20', response: responseFixtures.offers},
browseSettings: {...globalDataRequests.browseSettings, response: updatedSettingsResponse([
{
key: 'editor_default_email_recipients',
value: 'filter'
},
{
key: 'editor_default_email_recipients_filter',
value: '645453f4d254799990dd0e22,label:first-label,offer_redemptions:6487ea6464fca78ec2fff5fe'
}
])}
}});
await page.goto('/');
const section = page.getByTestId('default-recipients');
await section.getByRole('button', {name: 'Edit'}).click();
await expect(section.getByText('Specific people')).toHaveCount(1);
await expect(section.getByText('Basic Supporter')).toHaveCount(1);
await expect(section.getByText('first-label')).toHaveCount(1);
await expect(section.getByText('First offer')).toHaveCount(1);
});
});