From 8aaae89f4c1d2749d99a05fe7e03b149f4af49b5 Mon Sep 17 00:00:00 2001 From: Sluijsens Date: Tue, 17 Nov 2026 08:50:14 +0100 Subject: [PATCH] Berichten: badge met aantal nieuwe berichten bij het menu-item (lichte unread-count-endpoint, 60 s verversing en bij focus, direct bijgewerkt bij openen) Co-Authored-By: Claude Sonnet 5.5 --- frontend/src/components/layout/Sidebar.tsx | 16 +++++++ .../src/features/contact/mocks/handlers.ts | 1 + .../contact/pages/MessagesPage.test.tsx | 45 +++++++++++++++++++ .../contact/services/useContactMessages.ts | 13 ++++-- frontend/src/i18n/locales/en/translation.json | 4 +- frontend/src/i18n/locales/nl/translation.json | 4 +- openapi/slpsoftware.v1.json | 35 +++++++++++++++ .../ContactAdminControllerTests.cs | 12 +++++ .../ContactAdminServiceTests.cs | 12 +++++ .../Controllers/ContactAdminControllers.cs | 6 +++ .../Models/ContactAdminModels.cs | 4 ++ .../Services/ContactAdminService.cs | 6 +++ 12 files changed, 153 insertions(+), 5 deletions(-) diff --git a/frontend/src/components/layout/Sidebar.tsx b/frontend/src/components/layout/Sidebar.tsx index f1680f3..b503cd1 100644 --- a/frontend/src/components/layout/Sidebar.tsx +++ b/frontend/src/components/layout/Sidebar.tsx @@ -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'; @@ -66,6 +67,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) => @@ -124,6 +126,20 @@ export function Sidebar({ onClose }: SidebarProps = {}) { > {t(item.labelKey)} + {item.requiredModule === 'Contact' && !!unreadMessages && unreadMessages > 0 && ( + <> + + + {t('nav.unreadMessages', { count: unreadMessages })} + + + )} ); })} diff --git a/frontend/src/features/contact/mocks/handlers.ts b/frontend/src/features/contact/mocks/handlers.ts index 7ef6079..cc63234 100644 --- a/frontend/src/features/contact/mocks/handlers.ts +++ b/frontend/src/features/contact/mocks/handlers.ts @@ -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 }); diff --git a/frontend/src/features/contact/pages/MessagesPage.test.tsx b/frontend/src/features/contact/pages/MessagesPage.test.tsx index 1aab87b..556d045 100644 --- a/frontend/src/features/contact/pages/MessagesPage.test.tsx +++ b/frontend/src/features/contact/pages/MessagesPage.test.tsx @@ -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); diff --git a/frontend/src/features/contact/services/useContactMessages.ts b/frontend/src/features/contact/services/useContactMessages.ts index 86d43bb..5ec6306 100644 --- a/frontend/src/features/contact/services/useContactMessages.ts +++ b/frontend/src/features/contact/services/useContactMessages.ts @@ -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({ queryKey: ['contact', 'messages', 'unreadCount'], enabled, - queryFn: async () => - (await api.get(`${BASE}?page=1&pageSize=1`)).unreadCount, + refetchInterval: UNREAD_REFRESH_MS, + refetchOnWindowFocus: true, + queryFn: async () => (await api.get<{ unreadCount: number }>(`${BASE}/unread-count`)).unreadCount, }); } diff --git a/frontend/src/i18n/locales/en/translation.json b/frontend/src/i18n/locales/en/translation.json index f547247..eac3b3d 100644 --- a/frontend/src/i18n/locales/en/translation.json +++ b/frontend/src/i18n/locales/en/translation.json @@ -15,7 +15,9 @@ "profile": "Profile", "settings": "Settings", "openMenu": "Open navigation", - "closeMenu": "Close navigation" + "closeMenu": "Close navigation", + "unreadMessages_one": "{{count}} new message", + "unreadMessages_other": "{{count}} new messages" }, "theme": { "switchToLight": "Switch to light theme", diff --git a/frontend/src/i18n/locales/nl/translation.json b/frontend/src/i18n/locales/nl/translation.json index 4830c87..00d0bd6 100644 --- a/frontend/src/i18n/locales/nl/translation.json +++ b/frontend/src/i18n/locales/nl/translation.json @@ -15,7 +15,9 @@ "profile": "Profiel", "settings": "Instellingen", "openMenu": "Navigatie openen", - "closeMenu": "Navigatie sluiten" + "closeMenu": "Navigatie sluiten", + "unreadMessages_one": "{{count}} nieuw bericht", + "unreadMessages_other": "{{count}} nieuwe berichten" }, "theme": { "switchToLight": "Overschakelen naar licht thema", diff --git a/openapi/slpsoftware.v1.json b/openapi/slpsoftware.v1.json index 087a0a7..c869f36 100644 --- a/openapi/slpsoftware.v1.json +++ b/openapi/slpsoftware.v1.json @@ -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": { @@ -1956,6 +1972,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": [ diff --git a/src/SlpModularCms.Modules.Contact.Tests/ContactAdminControllerTests.cs b/src/SlpModularCms.Modules.Contact.Tests/ContactAdminControllerTests.cs index 8a24dcd..e6ee45d 100644 --- a/src/SlpModularCms.Modules.Contact.Tests/ContactAdminControllerTests.cs +++ b/src/SlpModularCms.Modules.Contact.Tests/ContactAdminControllerTests.cs @@ -30,6 +30,17 @@ public class ContactAdminControllerTests ControllerContext = new ControllerContext { HttpContext = new DefaultHttpContext() }, }; + [Fact] + public async Task UnreadCount_ReturnsOnlyTheNumber_AndIsAdminOnlyLikeTheRestOfTheController() + { + _service.CountUnreadAsync(Arg.Any()).Returns(3); + + var result = await Messages().UnreadCount(CancellationToken.None); + + result.Should().BeOfType().Which.Value.Should().Be(new ContactUnreadCount(3)); + typeof(ContactMessagesAdminController).GetCustomAttribute()!.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}", diff --git a/src/SlpModularCms.Modules.Contact.Tests/ContactAdminServiceTests.cs b/src/SlpModularCms.Modules.Contact.Tests/ContactAdminServiceTests.cs index 19c8daf..6a3cc43 100644 --- a/src/SlpModularCms.Modules.Contact.Tests/ContactAdminServiceTests.cs +++ b/src/SlpModularCms.Modules.Contact.Tests/ContactAdminServiceTests.cs @@ -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() { diff --git a/src/SlpModularCms.Modules.Contact/Controllers/ContactAdminControllers.cs b/src/SlpModularCms.Modules.Contact/Controllers/ContactAdminControllers.cs index 2fd495e..9d83ab3 100644 --- a/src/SlpModularCms.Modules.Contact/Controllers/ContactAdminControllers.cs +++ b/src/SlpModularCms.Modules.Contact/Controllers/ContactAdminControllers.cs @@ -74,6 +74,12 @@ public class ContactMessagesAdminController(IContactAdminService service, IOptio return result is null ? ContactProblems.Invalid(options.Value.ProblemTypeBase, "query") : Ok(result); } + /// A light count for the badge in the menu; a separate route so the page does not have to fetch a list. + [HttpGet("unread-count")] + [ProducesResponseType(typeof(ContactUnreadCount), StatusCodes.Status200OK, "application/json")] + public async Task UnreadCount(CancellationToken cancellationToken) + => Ok(new ContactUnreadCount(await service.CountUnreadAsync(cancellationToken))); + [HttpGet("{id:guid}")] [ProducesResponseType(typeof(ContactMessageDetail), StatusCodes.Status200OK, "application/json")] [ProducesResponseType(StatusCodes.Status404NotFound)] diff --git a/src/SlpModularCms.Modules.Contact/Models/ContactAdminModels.cs b/src/SlpModularCms.Modules.Contact/Models/ContactAdminModels.cs index 7939cbd..9c2cda4 100644 --- a/src/SlpModularCms.Modules.Contact/Models/ContactAdminModels.cs +++ b/src/SlpModularCms.Modules.Contact/Models/ContactAdminModels.cs @@ -17,6 +17,10 @@ public record ContactMessageListItem( string Status, string MailStatus); +/// Only the number of new (unread) messages: a small answer for the badge in the admin menu. +[ExcludeFromCodeCoverage] +public record ContactUnreadCount(int UnreadCount); + [ExcludeFromCodeCoverage] public record ContactMessageList( IReadOnlyList Items, diff --git a/src/SlpModularCms.Modules.Contact/Services/ContactAdminService.cs b/src/SlpModularCms.Modules.Contact/Services/ContactAdminService.cs index a2a7340..64d6ac3 100644 --- a/src/SlpModularCms.Modules.Contact/Services/ContactAdminService.cs +++ b/src/SlpModularCms.Modules.Contact/Services/ContactAdminService.cs @@ -17,6 +17,9 @@ public interface IContactAdminService Task GetAsync(Guid id, CancellationToken cancellationToken); + /// The number of new messages of this site (spam and read ones do not count). + Task CountUnreadAsync(CancellationToken cancellationToken); + /// Null when the message does not exist. Task SetStatusAsync(Guid id, ContactMessageStatus status, CancellationToken cancellationToken); @@ -75,6 +78,9 @@ public sealed class ContactAdminService( page, pageSize, total, unread); } + public Task CountUnreadAsync(CancellationToken cancellationToken) + => repository.CountUnreadAsync(options.Value.EffectiveSiteId, cancellationToken); + public async Task GetAsync(Guid id, CancellationToken cancellationToken) { var message = await repository.GetAsync(options.Value.EffectiveSiteId, id, cancellationToken); -- 2.39.5