From 49ac4caea31462eed71fe0dfd0f2fbb8c1c2875d Mon Sep 17 00:00:00 2001 From: Dovid Levine Date: Tue, 17 Nov 2026 22:56:33 +0200 Subject: [PATCH] fix(settings): show the server's message when a request fails --- assets/src/admin/search/index.tsx | 21 ++--- assets/src/admin/settings/page.tsx | 6 +- assets/src/components/SiteSearchSettings.tsx | 30 +++---- assets/src/components/SiteSettings.tsx | 36 +++++---- assets/src/components/SiteTypeSettings.tsx | 15 ++-- .../src/components/deactivation-settings.tsx | 12 +-- tests/js/SearchPage.test.tsx | 11 ++- tests/js/SettingsPage.test.tsx | 17 ++-- tests/js/SiteSearchSettings.test.tsx | 12 ++- tests/js/SiteSettings.test.tsx | 80 +++++++++---------- tests/js/SiteTypeSettings.test.tsx | 4 +- tests/js/deactivation-settings.test.tsx | 15 ++-- 12 files changed, 145 insertions(+), 114 deletions(-) diff --git a/assets/src/admin/search/index.tsx b/assets/src/admin/search/index.tsx index 385aa502..5ee97e10 100644 --- a/assets/src/admin/search/index.tsx +++ b/assets/src/admin/search/index.tsx @@ -77,15 +77,14 @@ const OneSearchSettingsPage = () => { settings?.onesearch_indexable_entities?.entities || {} ); setEntitiesLoadFailed( false ); - } catch { + } catch ( error ) { // Saving now would overwrite the selections of every site. setEntitiesLoadFailed( true ); setNotice( { type: 'error', - message: __( - 'Error fetching indexable entities.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( 'Error fetching indexable entities.', 'onesearch' ), } ); } }; @@ -141,13 +140,15 @@ const OneSearchSettingsPage = () => { setPostTypeErrors( Array.isArray( data?.errors ) ? data.errors : [] ); - } catch { + } catch ( error ) { setNotice( { type: 'error', - message: __( - 'Error fetching post types from sites.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( + 'Error fetching post types from sites.', + 'onesearch' + ), } ); } }; diff --git a/assets/src/admin/settings/page.tsx b/assets/src/admin/settings/page.tsx index e36fefe8..25ead0d4 100644 --- a/assets/src/admin/settings/page.tsx +++ b/assets/src/admin/settings/page.tsx @@ -130,10 +130,12 @@ const SettingsPage = () => { ) }`, method: 'DELETE', } ); - } catch { + } catch ( error ) { setNotice( { type: 'error', - message: __( 'Failed to update shared sites', 'onesearch' ), + message: + ( error as { message?: string } )?.message || + __( 'Failed to update shared sites', 'onesearch' ), } ); return; } diff --git a/assets/src/components/SiteSearchSettings.tsx b/assets/src/components/SiteSearchSettings.tsx index bf1e8676..069decb5 100644 --- a/assets/src/components/SiteSearchSettings.tsx +++ b/assets/src/components/SiteSearchSettings.tsx @@ -208,13 +208,15 @@ const SiteSearchSettings = ( { // To trigger re-rendering of search configuration component. setReloadKey( ( k ) => k + 1 ); } ) - .catch( () => { + .catch( ( error: unknown ) => { setNotice( { type: 'error', - message: __( - 'Failed to auto-save disabled sites.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( + 'Failed to auto-save disabled sites.', + 'onesearch' + ), } ); } ); } @@ -246,13 +248,12 @@ const SiteSearchSettings = ( { ); } } ) - .catch( () => { + .catch( ( error: unknown ) => { setNotice( { type: 'error', - message: __( - 'Failed to load search settings.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( 'Failed to load search settings.', 'onesearch' ), } ); } ) .finally( () => { @@ -411,13 +412,12 @@ const SiteSearchSettings = ( { } ); setInitialSettings( settings.onesearch_sites_search_settings ); } ) - .catch( () => { + .catch( ( error: unknown ) => { setNotice( { type: 'error', - message: __( - 'Failed to save search settings.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( 'Failed to save search settings.', 'onesearch' ), } ); } ) .finally( () => { diff --git a/assets/src/components/SiteSettings.tsx b/assets/src/components/SiteSettings.tsx index 9c3e416b..8b600f93 100644 --- a/assets/src/components/SiteSettings.tsx +++ b/assets/src/components/SiteSettings.tsx @@ -57,13 +57,15 @@ const SiteSettings = () => { ), } ); } - } catch { + } catch ( error ) { setNotice( { type: 'error', - message: __( - 'Error regenerating API key. Please try again later.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( + 'Error regenerating API key. Please try again later.', + 'onesearch' + ), } ); } }, [] ); @@ -74,13 +76,15 @@ const SiteSettings = () => { onesearch_parent_site_url?: string; } >( { path: '/wp/v2/settings' } ); setGoverningSite( data?.onesearch_parent_site_url || '' ); - } catch { + } catch ( error ) { setNotice( { type: 'error', - message: __( - 'Failed to fetch governing site. Please try again later.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( + 'Failed to fetch governing site. Please try again later.', + 'onesearch' + ), } ); } }, [] ); @@ -109,13 +113,15 @@ const SiteSettings = () => { 'onesearch' ), } ); - } catch { + } catch ( error ) { setNotice( { type: 'error', - message: __( - 'Failed to disconnect governing site. Please try again later.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( + 'Failed to disconnect governing site. Please try again later.', + 'onesearch' + ), } ); } finally { setShowDisconnectionModal( false ); diff --git a/assets/src/components/SiteTypeSettings.tsx b/assets/src/components/SiteTypeSettings.tsx index d4908228..1ebac0bd 100644 --- a/assets/src/components/SiteTypeSettings.tsx +++ b/assets/src/components/SiteTypeSettings.tsx @@ -64,22 +64,19 @@ const SiteTypeSettings = () => { setIsSaving( true ); try { - const settings = await apiFetch< { - onesearch_site_type?: SiteType; - } >( { + await apiFetch( { path: '/wp/v2/settings', method: 'POST', data: { onesearch_site_type: value }, } ); - if ( ! settings?.onesearch_site_type ) { - throw new Error( 'No site type in response' ); - } - // Reload so the settings screen and menu match the new site type. window.location.reload(); - } catch { - setError( __( 'Error setting site type.', 'onesearch' ) ); + } catch ( err ) { + setError( + ( err as { message?: string } )?.message || + __( 'Error setting site type.', 'onesearch' ) + ); } finally { setIsSaving( false ); } diff --git a/assets/src/components/deactivation-settings.tsx b/assets/src/components/deactivation-settings.tsx index fa0c6e73..b9af3255 100644 --- a/assets/src/components/deactivation-settings.tsx +++ b/assets/src/components/deactivation-settings.tsx @@ -64,13 +64,15 @@ const DeactivationSettings = ( { type: 'success', message: __( 'Settings saved.', 'onesearch' ), } ); - } catch { + } catch ( error ) { setNotice( { type: 'error', - message: __( - 'Failed to save the setting. Please try again.', - 'onesearch' - ), + message: + ( error as { message?: string } )?.message || + __( + 'Failed to save the setting. Please try again.', + 'onesearch' + ), } ); } finally { setIsSaving( false ); diff --git a/tests/js/SearchPage.test.tsx b/tests/js/SearchPage.test.tsx index e693160f..e504d230 100644 --- a/tests/js/SearchPage.test.tsx +++ b/tests/js/SearchPage.test.tsx @@ -61,7 +61,11 @@ const mockRequests = ( { return allPostTypes; } if ( ! entitiesOk ) { - throw new Error( 'load failed' ); + throw { + code: 'rest_forbidden', + message: 'Sorry, you are not allowed to do that.', + data: { status: 403 }, + }; } return { onesearch_indexable_entities: { entities: {} } }; }; @@ -121,7 +125,7 @@ describe( 'search settings page', () => { ); } ); - it( 'flags the entities as failed to load after an error response', async () => { + it( "flags the entities as failed to load and shows the server's message", async () => { mockRequests( { entitiesOk: false } ); await mountPage(); @@ -130,6 +134,9 @@ describe( 'search settings page', () => { 'true' ); } ); + expect( + document.querySelector( '.components-snackbar' ) + ).toHaveTextContent( 'Sorry, you are not allowed to do that.' ); } ); it( 'passes on the sites that failed to return post types', async () => { diff --git a/tests/js/SettingsPage.test.tsx b/tests/js/SettingsPage.test.tsx index cdd3cdf1..56808b5e 100644 --- a/tests/js/SettingsPage.test.tsx +++ b/tests/js/SettingsPage.test.tsx @@ -260,7 +260,10 @@ describe( 'SettingsPage', () => { }, ] ); mockedApiFetch - .mockRejectedValueOnce( new Error( 'delete failed' ) ) + .mockResolvedValueOnce( { + governing_site_notified: true, + message: 'Brand site removed successfully.', + } ) .mockResolvedValueOnce( { shared_sites: [ { @@ -274,7 +277,7 @@ describe( 'SettingsPage', () => { fireEvent.click( screen.getByRole( 'button', { name: 'Delete Site' } ) ); - await screen.findAllByText( 'Failed to update shared sites' ); + await screen.findAllByText( 'Brand site removed successfully.' ); // The second notice arrives just before the first one's timer ends. act( () => { @@ -354,7 +357,7 @@ describe( 'SettingsPage', () => { expect( screen.queryByTestId( 'site-modal' ) ).not.toBeInTheDocument(); } ); - it( 'shows an error and leaves the brand site alone when deleting fails', async () => { + it( "shows the server's error and leaves the brand site alone when deleting fails", async () => { setSharedSites( [ { id: 'one', @@ -363,7 +366,11 @@ describe( 'SettingsPage', () => { api_key: 'brand-key', }, ] ); - mockedApiFetch.mockRejectedValueOnce( new Error( 'delete failed' ) ); + mockedApiFetch.mockRejectedValueOnce( { + code: 'onesearch_site_not_found', + message: 'The brand site was not found.', + data: { status: 404 }, + } ); render( ); @@ -372,7 +379,7 @@ describe( 'SettingsPage', () => { ); const notices = await screen.findAllByText( - 'Failed to update shared sites' + 'The brand site was not found.' ); expect( notices.length ).toBeGreaterThanOrEqual( 1 ); expect( screen.getByTestId( 'site-count' ) ).toHaveTextContent( '1' ); diff --git a/tests/js/SiteSearchSettings.test.tsx b/tests/js/SiteSearchSettings.test.tsx index 1807e1c8..3b64341a 100644 --- a/tests/js/SiteSearchSettings.test.tsx +++ b/tests/js/SiteSearchSettings.test.tsx @@ -310,7 +310,7 @@ describe( 'SiteSearchSettings', () => { it( 'shows error when settings fail to load', async () => { const setNotice = vi.fn(); - mockedApiFetch.mockRejectedValueOnce( new Error( 'load failed' ) ); + mockedApiFetch.mockRejectedValueOnce( {} ); render( { mockedApiFetch .mockResolvedValueOnce( { onesearch_sites_search_settings: {} } ) - .mockRejectedValueOnce( new Error( 'save failed' ) ) + .mockRejectedValueOnce( { + code: 'rest_invalid_param', + message: + 'Invalid parameter(s): onesearch_sites_search_settings', + data: { status: 400 }, + } ) .mockResolvedValueOnce( { onesearch_sites_search_settings: {} } ); render( @@ -355,7 +360,8 @@ describe( 'SiteSearchSettings', () => { await waitFor( () => { expect( setNotice ).toHaveBeenCalledWith( { type: 'error', - message: 'Failed to save search settings.', + message: + 'Invalid parameter(s): onesearch_sites_search_settings', } ); } ); } ); diff --git a/tests/js/SiteSettings.test.tsx b/tests/js/SiteSettings.test.tsx index 7761fb67..029e60d1 100644 --- a/tests/js/SiteSettings.test.tsx +++ b/tests/js/SiteSettings.test.tsx @@ -13,24 +13,19 @@ import SiteSettings from '@/components/SiteSettings'; const mockedApiFetch = apiFetch as MockedFunction< typeof apiFetch >; -const mockRequests = ( handlers: { +// Each fail option is what apiFetch rejects with. +const mockSiteSettingsApi = ( handlers: { governingSiteUrl?: string; regeneratedKey?: string; disconnectResponse?: Record< string, unknown >; - failGoverningSite?: boolean; - failRegenerate?: boolean; - failDisconnect?: boolean; + failGoverningSite?: unknown; + failRegenerate?: unknown; + failDisconnect?: unknown; } ) => - mockedApiFetch.mockImplementation( ( async ( { - path, - method = 'GET', - }: { - path?: string; - method?: string; - } ) => { + mockedApiFetch.mockImplementation( async ( { path, method = 'GET' } ) => { if ( path === '/onesearch/v1/secret-key' && method === 'POST' ) { if ( handlers.failRegenerate ) { - throw new Error( 'Request failed' ); + throw handlers.failRegenerate; } return { secret_key: handlers.regeneratedKey ?? '' }; @@ -38,7 +33,7 @@ const mockRequests = ( handlers: { if ( path === '/wp/v2/settings' && method === 'GET' ) { if ( handlers.failGoverningSite ) { - throw new Error( 'Request failed' ); + throw handlers.failGoverningSite; } return { @@ -48,20 +43,22 @@ const mockRequests = ( handlers: { if ( path === '/onesearch/v1/governing-site' && method === 'DELETE' ) { if ( handlers.failDisconnect ) { - throw new Error( 'Request failed' ); + throw handlers.failDisconnect; } return ( - handlers.disconnectResponse ?? { governing_site_notified: true } + handlers.disconnectResponse ?? { + governing_site_notified: true, + } ); } throw new Error( `Unexpected request: ${ method } ${ path }` ); - } ) as unknown as typeof apiFetch ); + } ); describe( 'SiteSettings', () => { it( 'loads the api key and governing site details', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); @@ -76,7 +73,7 @@ describe( 'SiteSettings', () => { } ); it( 'keeps the disconnect button disabled until a governing site connects', async () => { - mockRequests( {} ); + mockSiteSettingsApi( {} ); render( ); @@ -90,7 +87,7 @@ describe( 'SiteSettings', () => { } ); it( 'shows the api key and governing site connection cards', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); @@ -120,7 +117,7 @@ describe( 'SiteSettings', () => { } ); it( 'copies the api key to the clipboard and shows success feedback', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); @@ -145,7 +142,7 @@ describe( 'SiteSettings', () => { } ); it( 'regenerates the api key and reports success', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', regeneratedKey: 'new-secret', } ); @@ -167,7 +164,7 @@ describe( 'SiteSettings', () => { } ); it( 'disconnects from the governing site after confirmation', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); @@ -191,7 +188,7 @@ describe( 'SiteSettings', () => { } ); it( 'warns when the governing site could not be notified of the disconnection', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', disconnectResponse: { governing_site_notified: false, @@ -222,7 +219,7 @@ describe( 'SiteSettings', () => { } ); it( 'shows an error notice when copying the api key fails', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); navigator.clipboard.writeText = vi @@ -245,7 +242,7 @@ describe( 'SiteSettings', () => { } ); it( 'shows an error notice when the clipboard api is unavailable', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); const clipboard = navigator.clipboard; @@ -276,10 +273,14 @@ describe( 'SiteSettings', () => { } } ); - it( 'shows an error notice when disconnecting the governing site fails', async () => { - mockRequests( { + it( "shows the server's message when disconnecting the governing site fails", async () => { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', - failDisconnect: true, + failDisconnect: { + code: 'rest_forbidden', + message: 'Sorry, you are not allowed to do that.', + data: { status: 403 }, + }, } ); render( ); @@ -291,16 +292,15 @@ describe( 'SiteSettings', () => { fireEvent.click( screen.getByRole( 'button', { name: 'Disconnect' } ) ); expect( - await screen.findByText( - 'Failed to disconnect governing site. Please try again later.', - { selector: '.components-notice__content' } - ) + await screen.findByText( 'Sorry, you are not allowed to do that.', { + selector: '.components-notice__content', + } ) ).toBeInTheDocument(); } ); it( 'shows an error notice when loading the governing site fails', async () => { - mockRequests( { - failGoverningSite: true, + mockSiteSettingsApi( { + failGoverningSite: {}, } ); render( ); @@ -314,7 +314,7 @@ describe( 'SiteSettings', () => { } ); it( 'shows an error notice when regeneration returns no secret key', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', regeneratedKey: '', } ); @@ -335,9 +335,9 @@ describe( 'SiteSettings', () => { } ); it( 'shows an error notice when regenerating the api key fails', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', - failRegenerate: true, + failRegenerate: {}, } ); render( ); @@ -356,7 +356,7 @@ describe( 'SiteSettings', () => { } ); it( 'closes the disconnect modal when cancel is clicked', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); @@ -385,7 +385,7 @@ describe( 'SiteSettings', () => { } ); it( 'loads once on mount, and does not reload after regenerating', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', regeneratedKey: 'new-secret', } ); @@ -405,7 +405,7 @@ describe( 'SiteSettings', () => { } ); it( 'keeps the key field selectable for a manual copy', async () => { - mockRequests( { + mockSiteSettingsApi( { governingSiteUrl: 'https://governing.example.com/', } ); diff --git a/tests/js/SiteTypeSettings.test.tsx b/tests/js/SiteTypeSettings.test.tsx index d2bbfaa4..48d042f1 100644 --- a/tests/js/SiteTypeSettings.test.tsx +++ b/tests/js/SiteTypeSettings.test.tsx @@ -102,8 +102,6 @@ describe( 'SiteTypeSettings', () => { ); // WordPress renders notices in both accessibility region and visible content - expect( - await screen.findAllByText( 'Error setting site type.' ) - ).toHaveLength( 2 ); + expect( await screen.findAllByText( 'save failed' ) ).toHaveLength( 2 ); } ); } ); diff --git a/tests/js/deactivation-settings.test.tsx b/tests/js/deactivation-settings.test.tsx index bfe82304..8cb4c45b 100644 --- a/tests/js/deactivation-settings.test.tsx +++ b/tests/js/deactivation-settings.test.tsx @@ -66,10 +66,14 @@ describe( 'DeactivationSettings', () => { ); } ); - it( 'keeps the saved value and shows an error when saving fails', async () => { + it( "keeps the saved value and shows the server's message when saving fails", async () => { const setNotice = vi.fn(); window.OneSearchSettings.deleteDataOnDeactivation = true; - mockedApiFetch.mockRejectedValueOnce( new Error( 'Forbidden' ) ); + mockedApiFetch.mockRejectedValueOnce( { + code: 'rest_forbidden', + message: 'Sorry, you are not allowed to do that.', + data: { status: 403 }, + } ); render( ); @@ -79,9 +83,10 @@ describe( 'DeactivationSettings', () => { fireEvent.click( toggle ); await waitFor( () => - expect( setNotice ).toHaveBeenCalledWith( - expect.objectContaining( { type: 'error' } ) - ) + expect( setNotice ).toHaveBeenCalledWith( { + type: 'error', + message: 'Sorry, you are not allowed to do that.', + } ) ); expect( toggle ).toBeChecked(); } );