From a30fa478acce765504c354ea319ee009d8fa63f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Deluan=20Quint=C3=A3o?= Date: Wed, 23 Jul 2025 19:43:42 -0400 Subject: [PATCH] feat(ui): reset activity panel error icon to normal state when clicked (#4379) * ui: reset activity icon after viewing error * refactor: improve ActivityPanel error acknowledgment logic Replaced boolean errorAcknowledged state with acknowledgedError string state to track which specific error was acknowledged. This prevents icon flickering when error messages change and simplifies the logic by removing the need for useEffect. Key changes: - Changed from errorAcknowledged boolean to acknowledgedError string state - Added derived isErrorVisible computed value for cleaner logic - Removed useEffect dependency on scanStatus.error changes - Updated handleMenuOpen to store actual error string instead of boolean flag - Fixed test mock to return proper error state matching test expectations This change addresses code review feedback and follows React best practices by using derived state instead of imperative effects. --- ui/src/layout/ActivityPanel.jsx | 21 +++++++--- ui/src/layout/ActivityPanel.test.jsx | 61 ++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 5 deletions(-) create mode 100644 ui/src/layout/ActivityPanel.test.jsx diff --git a/ui/src/layout/ActivityPanel.jsx b/ui/src/layout/ActivityPanel.jsx index 6b50cee0c..18af8dc93 100644 --- a/ui/src/layout/ActivityPanel.jsx +++ b/ui/src/layout/ActivityPanel.jsx @@ -75,14 +75,25 @@ const ActivityPanel = () => { scanStatus.scanning, scanStatus.elapsedTime, ) - const classes = useStyles({ up: up && !scanStatus.error }) + const [acknowledgedError, setAcknowledgedError] = useState(null) + const isErrorVisible = + scanStatus.error && scanStatus.error !== acknowledgedError + const classes = useStyles({ + up: up && (!scanStatus.error || !isErrorVisible), + }) const translate = useTranslate() const notify = useNotify() const [anchorEl, setAnchorEl] = useState(null) const open = Boolean(anchorEl) useInitialScanStatus() - const handleMenuOpen = (event) => setAnchorEl(event.currentTarget) + const handleMenuOpen = (event) => { + if (scanStatus.error) { + setAcknowledgedError(scanStatus.error) + } + setAnchorEl(event.currentTarget) + } + const handleMenuClose = () => setAnchorEl(null) const triggerScan = (full) => () => subsonic.startScan({ fullScan: full }) @@ -111,10 +122,10 @@ const ActivityPanel = () => {
- {!up || scanStatus.error ? ( - + {!up || isErrorVisible ? ( + ) : ( - + )} diff --git a/ui/src/layout/ActivityPanel.test.jsx b/ui/src/layout/ActivityPanel.test.jsx new file mode 100644 index 000000000..c506fd08b --- /dev/null +++ b/ui/src/layout/ActivityPanel.test.jsx @@ -0,0 +1,61 @@ +import React from 'react' +import { render, screen, fireEvent } from '@testing-library/react' +import { Provider } from 'react-redux' +import { createStore, combineReducers } from 'redux' +import { describe, it, beforeEach } from 'vitest' + +import ActivityPanel from './ActivityPanel' +import { activityReducer } from '../reducers' +import config from '../config' +import subsonic from '../subsonic' + +vi.mock('../subsonic', () => ({ + default: { + getScanStatus: vi.fn(() => + Promise.resolve({ + json: { + 'subsonic-response': { + status: 'ok', + scanStatus: { error: 'Scan failed' }, + }, + }, + }), + ), + startScan: vi.fn(), + }, +})) + +describe('', () => { + let store + + beforeEach(() => { + store = createStore(combineReducers({ activity: activityReducer }), { + activity: { + scanStatus: { + scanning: false, + folderCount: 0, + count: 0, + error: 'Scan failed', + elapsedTime: 0, + }, + serverStart: { version: config.version, startTime: Date.now() }, + }, + }) + }) + + it('clears the error icon after opening the panel', () => { + render( + + + , + ) + + const button = screen.getByRole('button') + expect(screen.getByTestId('activity-error-icon')).toBeInTheDocument() + + fireEvent.click(button) + + expect(screen.getByTestId('activity-ok-icon')).toBeInTheDocument() + expect(screen.getByText('Scan failed')).toBeInTheDocument() + }) +})