Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"@floating-ui/react": "^0.27.19",
"@primer/octicons-react": "^19.27.0",
"gd-eventlog": "^0.1.27",
"incyclist-services": "^1.9.28",
"incyclist-services": "^1.9.29",
"leaflet": "^1.9.4",
"leaflet-geosearch": "^4.4.0",
"react": "^19.2.6",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import React, { useCallback, useEffect, useRef, useState } from 'react'
import { getWorkoutListPageService } from 'incyclist-services'
import { EventLogger } from 'gd-eventlog'
import { ErrorBoundary } from '../../../atoms'
import { WorkoutImportDialogView } from './WorkoutImportDialogView'

const logger = new EventLogger('WorkoutImportDialog')

/**
* Smart import dialog. The phase and its data come from the workout list page service
* (`getImportDisplayProps()`, refreshed on every 'import-update'), the dialog only reports user actions.
*
* The parent owns the open/closed state: it mounts this component to open the dialog and
* unmounts it from `onClose`. Every way out (Done, Close, Cancel, Esc, outside click, unmount)
* ends the import flow in the service exactly once.
*
* props: `source` ('button' | 'page-drop', used for logging only), `onClose`
*/
export const WorkoutImportDialog = ({ source, onClose }) => {
const service = getWorkoutListPageService()
const [displayProps, setDisplayProps] = useState(() => service.getImportDisplayProps())

const refPhase = useRef(displayProps?.phase)
const refClosed = useRef(false)
refPhase.current = displayProps?.phase

useEffect(() => {
logger.logEvent({ message: 'dialog opened', source, phase: refPhase.current })
}, [source])

useEffect(() => {
const observer = service.getPageObserver()
const onUpdate = () => { setDisplayProps(service.getImportDisplayProps()) }

observer?.on('import-update', onUpdate)
return () => { observer?.off('import-update', onUpdate) }
}, [service])

const finish = useCallback((action) => {
if (refClosed.current)
return false
refClosed.current = true
logger.logEvent({ message: 'dialog closed', phase: refPhase.current, action })
service.onImportClose()
return true
}, [service])

// unmounted by the parent without a close action (e.g. navigation)
useEffect(() => () => { finish('unmount') }, [finish])

const handleClose = useCallback((action) => {
if (finish(action))
onClose?.()
}, [finish, onClose])

const onFiles = useCallback((files) => { service.onImportFiles(files, 'dialog') }, [service])
const onPickAnother = useCallback(() => { service.onImportOpen() }, [service])
const onSetGroup = useCallback((group) => {
const result = service.getImportDisplayProps()?.result ?? displayProps?.result
if (!result)
return
const isNew = !(displayProps?.knownGroups ?? []).includes(group)
logger.logEvent({ message: 'import group changed', group, isNew, eventSource: 'user' })
service.onImportSetGroup(result.id, group)
}, [service, displayProps])

return (
<ErrorBoundary>
<WorkoutImportDialogView
displayProps={displayProps}
onClose={handleClose}
onFiles={onFiles}
onPickAnother={onPickAnother}
onSetGroup={onSetGroup}
/>
</ErrorBoundary>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
import React from 'react'
import { describe, test, expect, vi, beforeEach } from 'vitest'
import { render, screen, fireEvent, act } from '@testing-library/react'
import { WorkoutImportDialog } from './WorkoutImportDialog'

const { service, observer, state } = vi.hoisted(() => {
const listeners = {}
return {
state: { props: { phase: 'landing', knownGroups: [] } },
observer: {
listeners,
on: vi.fn((evt, cb) => { (listeners[evt] ??= []).push(cb) }),
off: vi.fn((evt, cb) => { listeners[evt] = (listeners[evt] ?? []).filter(l => l !== cb) }),
},
service: {
getImportDisplayProps: vi.fn(),
getPageObserver: vi.fn(),
onImportFiles: vi.fn(),
onImportOpen: vi.fn(),
onImportSetGroup: vi.fn(),
onImportClose: vi.fn(),
},
}
})

vi.mock('incyclist-services', async (importOriginal) => {
const actual = await importOriginal()
return { ...actual, getWorkoutListPageService: () => service }
})

vi.mock('./WorkoutImportDialogView', () => ({
WorkoutImportDialogView: ({ displayProps, onClose, onFiles, onPickAnother, onSetGroup }) => (
<div>
<span>phase:{displayProps.phase}</span>
<button onClick={() => onFiles(['f'])}>files</button>
<button onClick={onPickAnother}>another</button>
<button onClick={() => onSetGroup('Sweet')}>group</button>
<button onClick={() => onClose('done')}>done</button>
<button onClick={() => onClose('esc')}>esc</button>
</div>
),
}))

const emit = (evt) => act(() => { (observer.listeners[evt] ?? []).forEach(l => l()) })

describe('WorkoutImportDialog', () => {

beforeEach(() => {
vi.clearAllMocks()
observer.listeners['import-update'] = []
state.props = { phase: 'landing', knownGroups: ['Sweet', 'VO2'] }
service.getImportDisplayProps.mockImplementation(() => state.props)
service.getPageObserver.mockReturnValue(observer)
})

test('renders the initial phase from the service', () => {
render(<WorkoutImportDialog source='button' onClose={vi.fn()} />)
expect(screen.getByText('phase:landing')).toBeTruthy()
})

test('renders the phase the service is already in (drop)', () => {
state.props = { phase: 'importing', knownGroups: [] }
render(<WorkoutImportDialog source='page-drop' onClose={vi.fn()} />)
expect(screen.getByText('phase:importing')).toBeTruthy()
})

test('re-reads the display props on import-update', () => {
render(<WorkoutImportDialog source='button' onClose={vi.fn()} />)
state.props = { phase: 'result', result: { id: 'w1' }, knownGroups: ['Sweet'] }
emit('import-update')
expect(screen.getByText('phase:result')).toBeTruthy()
})

test('onFiles and onPickAnother go to the service', () => {
render(<WorkoutImportDialog source='button' onClose={vi.fn()} />)
fireEvent.click(screen.getByText('files'))
expect(service.onImportFiles).toHaveBeenCalledWith(['f'], 'dialog')
fireEvent.click(screen.getByText('another'))
expect(service.onImportOpen).toHaveBeenCalledTimes(1)
})

test('onSetGroup passes the result id and the group', () => {
state.props = { phase: 'result', result: { id: 'w1', group: 'VO2' }, knownGroups: ['Sweet', 'VO2'] }
render(<WorkoutImportDialog source='button' onClose={vi.fn()} />)
fireEvent.click(screen.getByText('group'))
expect(service.onImportSetGroup).toHaveBeenCalledWith('w1', 'Sweet')
})

test('close ends the import, then reports onClose; unmount does not close again', () => {
const onClose = vi.fn()
const order = []
service.onImportClose.mockImplementation(() => order.push('service'))
onClose.mockImplementation(() => order.push('parent'))

const { unmount } = render(<WorkoutImportDialog source='button' onClose={onClose} />)
fireEvent.click(screen.getByText('done'))
expect(order).toEqual(['service', 'parent'])

unmount()
expect(service.onImportClose).toHaveBeenCalledTimes(1)
})

test('unmount without a close action closes the import once and does not call onClose', () => {
const onClose = vi.fn()
const { unmount } = render(<WorkoutImportDialog source='button' onClose={onClose} />)
unmount()
expect(service.onImportClose).toHaveBeenCalledTimes(1)
expect(onClose).not.toHaveBeenCalled()
})

test('removes the import-update listener on unmount', () => {
const { unmount } = render(<WorkoutImportDialog source='button' onClose={vi.fn()} />)
const cb = observer.on.mock.calls.find(c => c[0] === 'import-update')[1]
unmount()
expect(observer.off).toHaveBeenCalledWith('import-update', cb)
})
})
Loading
Loading