Merge pull request 'Berichten: badge met aantal nieuwe berichten' (#18) from feature/messages-badge into master
Continuous Integration / config-asf (push) Successful in 6s
Continuous Integration / config-sls (push) Successful in 7s
Continuous Integration / changes (push) Successful in 11s
Continuous Integration / frontend-prepare (push) Successful in 28s
Continuous Integration / frontend-build (push) Successful in 57s
Continuous Integration / backend-build (push) Successful in 1m31s
Continuous Integration / vulnerability-scan (push) Successful in 1m45s
Continuous Integration / frontend-lint (push) Successful in 33s
Continuous Integration / frontend-test (push) Successful in 2m32s
Continuous Integration / backend-test (push) Successful in 3m8s
Continuous Integration / publish-sls-production (push) Skipped
Continuous Integration / deploy-sls-production (push) Skipped
Continuous Integration / publish-sls-test (push) Successful in 1m58s
Continuous Integration / publish-asf-test (push) Successful in 2m1s
Continuous Integration / deploy-sls-test (push) Successful in 1m22s
Continuous Integration / deploy-asf-test (push) Successful in 1m20s
Continuous Integration / smoke-sls-test (push) Successful in 15s
Continuous Integration / smoke-asf-test (push) Successful in 15s
Continuous Integration / compile-sites (push) Successful in 10m1s
Deploy (SCP) / deploy (push) Successful in 1m13s
Continuous Integration / config-asf (push) Successful in 6s
Continuous Integration / config-sls (push) Successful in 7s
Continuous Integration / changes (push) Successful in 11s
Continuous Integration / frontend-prepare (push) Successful in 28s
Continuous Integration / frontend-build (push) Successful in 57s
Continuous Integration / backend-build (push) Successful in 1m31s
Continuous Integration / vulnerability-scan (push) Successful in 1m45s
Continuous Integration / frontend-lint (push) Successful in 33s
Continuous Integration / frontend-test (push) Successful in 2m32s
Continuous Integration / backend-test (push) Successful in 3m8s
Continuous Integration / publish-sls-production (push) Skipped
Continuous Integration / deploy-sls-production (push) Skipped
Continuous Integration / publish-sls-test (push) Successful in 1m58s
Continuous Integration / publish-asf-test (push) Successful in 2m1s
Continuous Integration / deploy-sls-test (push) Successful in 1m22s
Continuous Integration / deploy-asf-test (push) Successful in 1m20s
Continuous Integration / smoke-sls-test (push) Successful in 15s
Continuous Integration / smoke-asf-test (push) Successful in 15s
Continuous Integration / compile-sites (push) Successful in 10m1s
Deploy (SCP) / deploy (push) Successful in 1m13s
This commit was merged in pull request #18.
This commit is contained in:
@@ -7,6 +7,7 @@ import { useAuth } from '@/features/auth/context/auth-context';
|
||||
import { useAvailabilityStatus } from '@/features/availability/services/useAvailability';
|
||||
import { useSystemCapabilities } from '@/features/system/services/useSystemCapabilities';
|
||||
import { useContactSettings } from '@/features/contact/services/useContactSettings';
|
||||
import { useUnreadContactCount } from '@/features/contact/services/useContactMessages';
|
||||
import { LanguageSwitcher } from '@/i18n/LanguageSwitcher';
|
||||
import { BrandLogo } from './BrandLogo';
|
||||
import { ThemeToggle } from './ThemeToggle';
|
||||
@@ -74,6 +75,7 @@ export function Sidebar({ onClose }: SidebarProps = {}) {
|
||||
// while the host switch is off its routes answer 404). Only asked for roles that may see the entry.
|
||||
const mayManageContact = (role === 'Owner' || role === 'Administrator') && !!capabilities?.modules.includes('Contact');
|
||||
const { data: contactSettings } = useContactSettings({ enabled: mayManageContact });
|
||||
const { data: unreadMessages } = useUnreadContactCount(mayManageContact && !!contactSettings);
|
||||
const systemUnavailable = availability?.status === 'NotAvailable';
|
||||
const visibleItems = NAV_ITEMS.filter(
|
||||
(item) =>
|
||||
@@ -132,6 +134,20 @@ export function Sidebar({ onClose }: SidebarProps = {}) {
|
||||
>
|
||||
<Icon className="size-4" />
|
||||
{t(item.labelKey)}
|
||||
{item.requiredModule === 'Contact' && !!unreadMessages && unreadMessages > 0 && (
|
||||
<>
|
||||
<span
|
||||
className="ml-auto inline-flex min-w-5 items-center justify-center rounded-full bg-primary px-1.5 text-xs font-semibold leading-5 text-primary-foreground"
|
||||
aria-hidden="true"
|
||||
data-testid="nav-messages-badge"
|
||||
>
|
||||
{unreadMessages > 99 ? '99+' : unreadMessages}
|
||||
</span>
|
||||
<span className="sr-only" data-testid="nav-messages-badge-text">
|
||||
{t('nav.unreadMessages', { count: unreadMessages })}
|
||||
</span>
|
||||
</>
|
||||
)}
|
||||
</Link>
|
||||
);
|
||||
})}
|
||||
|
||||
@@ -140,6 +140,7 @@ export const contactHandlers = [
|
||||
unreadCount: messages.filter((m) => m.status === 'new').length,
|
||||
});
|
||||
}),
|
||||
http.get(`${BASE}/unread-count`, () => HttpResponse.json({ unreadCount: messages.filter((m) => m.status === 'new').length })),
|
||||
http.get(`${BASE}/:id`, ({ params }) => {
|
||||
const m = messages.find((x) => x.id === params.id);
|
||||
return m ? HttpResponse.json(m) : new HttpResponse(null, { status: 404 });
|
||||
|
||||
@@ -13,6 +13,7 @@ import {
|
||||
resetMockContact,
|
||||
} from '@/features/contact/mocks/handlers';
|
||||
import { _resetSetupStatusCache } from '@/router';
|
||||
import { UNREAD_REFRESH_MS } from '@/features/contact/services/useContactMessages';
|
||||
|
||||
const LONG = { timeout: 10000 };
|
||||
|
||||
@@ -43,6 +44,50 @@ async function openSettings() {
|
||||
await screen.findByTestId('contact-panel-settings');
|
||||
}
|
||||
|
||||
describe('Unread badge on the Berichten menu item', () => {
|
||||
it('shows the number of new messages, with an accessible name, and not by colour alone', async () => {
|
||||
capabilities(WITH_CONTACT);
|
||||
renderApp('/dashboard');
|
||||
|
||||
const badge = await screen.findByTestId('nav-messages-badge', {}, LONG);
|
||||
expect(badge).toHaveTextContent('1');
|
||||
expect(badge).toHaveAttribute('aria-hidden', 'true');
|
||||
expect(screen.getByTestId('nav-messages')).toHaveAccessibleName(/Berichten.*1 nieuw bericht|Messages.*1 new message/);
|
||||
});
|
||||
|
||||
it('is hidden at zero and shows 99+ above 99', async () => {
|
||||
capabilities(WITH_CONTACT);
|
||||
server.use(http.get(`${API_BASE}/api/v1/contact-messages/unread-count`, () => HttpResponse.json({ unreadCount: 0 })));
|
||||
renderApp('/dashboard');
|
||||
await screen.findByTestId('nav-messages', {}, LONG);
|
||||
await new Promise((r) => setTimeout(r, 300));
|
||||
expect(screen.queryByTestId('nav-messages-badge')).not.toBeInTheDocument();
|
||||
});
|
||||
|
||||
it('shows 99+ for a hundred or more', async () => {
|
||||
capabilities(WITH_CONTACT);
|
||||
server.use(http.get(`${API_BASE}/api/v1/contact-messages/unread-count`, () => HttpResponse.json({ unreadCount: 250 })));
|
||||
renderApp('/dashboard');
|
||||
|
||||
expect(await screen.findByTestId('nav-messages-badge', {}, LONG)).toHaveTextContent('99+');
|
||||
expect(screen.getByTestId('nav-messages-badge-text')).toHaveTextContent(/250/);
|
||||
});
|
||||
|
||||
it('follows at once when a message is opened (and so marked as read)', async () => {
|
||||
capabilities(WITH_CONTACT);
|
||||
renderApp('/messages');
|
||||
expect(await screen.findByTestId('nav-messages-badge', {}, LONG)).toHaveTextContent('1');
|
||||
|
||||
await userEvent.click(await screen.findByTestId(`contact-row-${MSG_NEW}`, {}, LONG));
|
||||
|
||||
await waitFor(() => expect(screen.queryByTestId('nav-messages-badge')).not.toBeInTheDocument(), LONG);
|
||||
});
|
||||
|
||||
it('asks the light endpoint every minute and when the window gets focus', () => {
|
||||
expect(UNREAD_REFRESH_MS).toBe(60_000);
|
||||
});
|
||||
});
|
||||
|
||||
describe('Berichten navigation', () => {
|
||||
it('shows the sidebar entry when the module is loaded and the API answers', async () => {
|
||||
capabilities(WITH_CONTACT);
|
||||
|
||||
@@ -22,13 +22,20 @@ export function useContactMessages(filter: ContactFilter, page: number) {
|
||||
});
|
||||
}
|
||||
|
||||
/** Only the unread counter, for the dashboard tile (one item is enough: the counter is part of every list answer). */
|
||||
/**
|
||||
* Only the unread counter, for the menu badge and the dashboard tile (a light endpoint). It is refreshed every minute and
|
||||
* when the window gets focus again; React Query stops the interval while the tab is hidden. Opening or marking a message
|
||||
* invalidates it (the key lives under ['contact', 'messages']), so the badge follows at once.
|
||||
*/
|
||||
export const UNREAD_REFRESH_MS = 60_000;
|
||||
|
||||
export function useUnreadContactCount(enabled: boolean) {
|
||||
return useQuery<number, Error>({
|
||||
queryKey: ['contact', 'messages', 'unreadCount'],
|
||||
enabled,
|
||||
queryFn: async () =>
|
||||
(await api.get<ContactMessageList>(`${BASE}?page=1&pageSize=1`)).unreadCount,
|
||||
refetchInterval: UNREAD_REFRESH_MS,
|
||||
refetchOnWindowFocus: true,
|
||||
queryFn: async () => (await api.get<{ unreadCount: number }>(`${BASE}/unread-count`)).unreadCount,
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@@ -16,7 +16,9 @@
|
||||
"settings": "Settings",
|
||||
"openMenu": "Open navigation",
|
||||
"closeMenu": "Close navigation",
|
||||
"hero": "Hero"
|
||||
"hero": "Hero",
|
||||
"unreadMessages_one": "{{count}} new message",
|
||||
"unreadMessages_other": "{{count}} new messages"
|
||||
},
|
||||
"theme": {
|
||||
"title": "Theme",
|
||||
|
||||
@@ -16,7 +16,9 @@
|
||||
"settings": "Instellingen",
|
||||
"openMenu": "Navigatie openen",
|
||||
"closeMenu": "Navigatie sluiten",
|
||||
"hero": "Hero"
|
||||
"hero": "Hero",
|
||||
"unreadMessages_one": "{{count}} nieuw bericht",
|
||||
"unreadMessages_other": "{{count}} nieuwe berichten"
|
||||
},
|
||||
"theme": {
|
||||
"title": "Thema",
|
||||
|
||||
@@ -393,6 +393,22 @@
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"ContactUnreadCount": {
|
||||
"properties": {
|
||||
"unreadCount": {
|
||||
"format": "int32",
|
||||
"pattern": "^-?(?:0|[1-9]\\d*)$",
|
||||
"type": [
|
||||
"integer",
|
||||
"string"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"unreadCount"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"CreateCmsInstanceRequest": {
|
||||
"properties": {
|
||||
"apiKey": {
|
||||
@@ -2562,6 +2578,25 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/api/v1/contact-messages/unread-count": {
|
||||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ContactUnreadCount"
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "OK"
|
||||
}
|
||||
},
|
||||
"tags": [
|
||||
"ContactMessagesAdmin"
|
||||
]
|
||||
}
|
||||
},
|
||||
"/api/v1/contact-messages/{id}": {
|
||||
"delete": {
|
||||
"parameters": [
|
||||
|
||||
@@ -30,6 +30,17 @@ public class ContactAdminControllerTests
|
||||
ControllerContext = new ControllerContext { HttpContext = new DefaultHttpContext() },
|
||||
};
|
||||
|
||||
[Fact]
|
||||
public async Task UnreadCount_ReturnsOnlyTheNumber_AndIsAdminOnlyLikeTheRestOfTheController()
|
||||
{
|
||||
_service.CountUnreadAsync(Arg.Any<CancellationToken>()).Returns(3);
|
||||
|
||||
var result = await Messages().UnreadCount(CancellationToken.None);
|
||||
|
||||
result.Should().BeOfType<OkObjectResult>().Which.Value.Should().Be(new ContactUnreadCount(3));
|
||||
typeof(ContactMessagesAdminController).GetCustomAttribute<AuthorizeAttribute>()!.Policy.Should().Be("AdminOnly");
|
||||
}
|
||||
|
||||
private ContactSettingsController Settings(Guid? userId = null)
|
||||
{
|
||||
var http = new DefaultHttpContext();
|
||||
@@ -242,6 +253,7 @@ public class ContactAdminControllerTests
|
||||
.Should().BeEquivalentTo(
|
||||
[
|
||||
"GET contact-messages",
|
||||
"GET contact-messages/unread-count",
|
||||
"GET contact-messages/{id:guid}",
|
||||
"PATCH contact-messages/{id:guid}",
|
||||
"DELETE contact-messages/{id:guid}",
|
||||
|
||||
@@ -161,6 +161,18 @@ public class ContactAdminServiceTests
|
||||
(await h.Sut.ListAsync("read", 1, 25, CancellationToken.None))!.UnreadCount.Should().Be(2);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task TheLightUnreadCount_IsTheSameNumber_ForThisSiteOnly()
|
||||
{
|
||||
using var h = new AdminHarness();
|
||||
h.Add(ContactMessageStatus.New);
|
||||
h.Add(ContactMessageStatus.Read);
|
||||
h.Add(ContactMessageStatus.Spam);
|
||||
h.Add(ContactMessageStatus.New, site: "another-site");
|
||||
|
||||
(await h.Sut.CountUnreadAsync(CancellationToken.None)).Should().Be(1);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task OtherSitesMessages_AreInvisible()
|
||||
{
|
||||
|
||||
@@ -74,6 +74,12 @@ public class ContactMessagesAdminController(IContactAdminService service, IOptio
|
||||
return result is null ? ContactProblems.Invalid(options.Value.ProblemTypeBase, "query") : Ok(result);
|
||||
}
|
||||
|
||||
/// <summary>A light count for the badge in the menu; a separate route so the page does not have to fetch a list.</summary>
|
||||
[HttpGet("unread-count")]
|
||||
[ProducesResponseType(typeof(ContactUnreadCount), StatusCodes.Status200OK, "application/json")]
|
||||
public async Task<IActionResult> UnreadCount(CancellationToken cancellationToken)
|
||||
=> Ok(new ContactUnreadCount(await service.CountUnreadAsync(cancellationToken)));
|
||||
|
||||
[HttpGet("{id:guid}")]
|
||||
[ProducesResponseType(typeof(ContactMessageDetail), StatusCodes.Status200OK, "application/json")]
|
||||
[ProducesResponseType(StatusCodes.Status404NotFound)]
|
||||
|
||||
@@ -17,6 +17,10 @@ public record ContactMessageListItem(
|
||||
string Status,
|
||||
string MailStatus);
|
||||
|
||||
/// <summary>Only the number of new (unread) messages: a small answer for the badge in the admin menu.</summary>
|
||||
[ExcludeFromCodeCoverage]
|
||||
public record ContactUnreadCount(int UnreadCount);
|
||||
|
||||
[ExcludeFromCodeCoverage]
|
||||
public record ContactMessageList(
|
||||
IReadOnlyList<ContactMessageListItem> Items,
|
||||
|
||||
@@ -17,6 +17,9 @@ public interface IContactAdminService
|
||||
|
||||
Task<ContactMessageDetail?> GetAsync(Guid id, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>The number of new messages of this site (spam and read ones do not count).</summary>
|
||||
Task<int> CountUnreadAsync(CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Null when the message does not exist.</summary>
|
||||
Task<ContactMessageDetail?> SetStatusAsync(Guid id, ContactMessageStatus status, CancellationToken cancellationToken);
|
||||
|
||||
@@ -75,6 +78,9 @@ public sealed class ContactAdminService(
|
||||
page, pageSize, total, unread);
|
||||
}
|
||||
|
||||
public Task<int> CountUnreadAsync(CancellationToken cancellationToken)
|
||||
=> repository.CountUnreadAsync(options.Value.EffectiveSiteId, cancellationToken);
|
||||
|
||||
public async Task<ContactMessageDetail?> GetAsync(Guid id, CancellationToken cancellationToken)
|
||||
{
|
||||
var message = await repository.GetAsync(options.Value.EffectiveSiteId, id, cancellationToken);
|
||||
|
||||
Reference in New Issue
Block a user