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
24 changes: 24 additions & 0 deletions src/composables/useWaveAudioPlayer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,30 @@ describe('useWaveAudioPlayer', () => {
expect(useToast().toasts).toEqual([])
})

it('resumes a retry from where a mid-playback failure stopped', async () => {
const { audio, player } = await createPlayer()
let position = 42
let mediaError: { code: number } | null = { code: 2 }
Object.defineProperty(audio, 'error', { get: () => mediaError })
Object.defineProperty(audio, 'currentTime', {
get: () => position,
set: (value: number) => {
position = value
}
})
vi.spyOn(audio, 'load').mockImplementation(() => {
mediaError = null
position = 0
})
vi.spyOn(audio, 'play').mockResolvedValue(undefined)

player.togglePlayPause()
await vi.waitFor(() => expect(audio.load).toHaveBeenCalledTimes(1))
audio.dispatchEvent(new Event('loadedmetadata'))

expect(position).toBe(42)
})

it('reports failures on the caller surface', async () => {
vi.mocked(useMediaControls).mockReset()
const player = useWaveAudioPlayer({
Expand Down
3 changes: 2 additions & 1 deletion src/composables/useWaveAudioPlayer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type { Surface } from '@/platform/telemetry/reportError'
import { api } from '@/scripts/api'
import { createToastId } from '@/types/toastId'
import { formatTime } from '@/utils/formatUtil'
import { reloadFailedMedia } from '@/utils/mediaReloadUtil'

interface WaveformBar {
height: number
Expand Down Expand Up @@ -142,7 +143,7 @@ export function useWaveAudioPlayer(options: UseWaveAudioPlayerOptions) {

const attempt = ++playAttempt
try {
if (audio.error) audio.load()
if (audio.error) reloadFailedMedia(audio)
await audio.play()
if (attempt === playAttempt) toast.dismiss(playbackErrorToastId)
} catch (error) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,69 @@ describe('AudioPreviewPlayer', () => {
)
})

it('resumes a retry from where a mid-playback failure stopped', async () => {
vi.spyOn(HTMLMediaElement.prototype, 'play').mockResolvedValue(undefined)
let position = 42
let mediaError: MediaError | null = fromPartial<MediaError>({ code: 2 })
vi.spyOn(HTMLMediaElement.prototype, 'error', 'get').mockImplementation(
() => mediaError
)
vi.spyOn(
HTMLMediaElement.prototype,
'currentTime',
'get'
).mockImplementation(() => position)
vi.spyOn(
HTMLMediaElement.prototype,
'currentTime',
'set'
).mockImplementation((value: number) => {
position = value
})
vi.spyOn(HTMLMediaElement.prototype, 'load').mockImplementation(() => {
mediaError = null
position = 0
})
const user = userEvent.setup()

renderPlayer('http://example.com/audio.mp3')
await user.click(screen.getByRole('button', { name: 'g.playPause' }))
await fireEvent.loadedMetadata(screen.getByTestId('audio-preview'))

expect(position).toBe(42)
})

it('does not carry a retry position over to a replaced source', async () => {
vi.spyOn(HTMLMediaElement.prototype, 'play').mockResolvedValue(undefined)
let position = 42
let mediaError: MediaError | null = fromPartial<MediaError>({ code: 2 })
vi.spyOn(HTMLMediaElement.prototype, 'error', 'get').mockImplementation(
() => mediaError
)
vi.spyOn(
HTMLMediaElement.prototype,
'currentTime',
'get'
).mockImplementation(() => position)
const seek = vi
.spyOn(HTMLMediaElement.prototype, 'currentTime', 'set')
.mockImplementation((value: number) => {
position = value
})
vi.spyOn(HTMLMediaElement.prototype, 'load').mockImplementation(() => {
mediaError = null
position = 0
})
const user = userEvent.setup()

const { rerender } = renderPlayer('http://example.com/a.mp3')
await user.click(screen.getByRole('button', { name: 'g.playPause' }))
await rerender({ modelValue: 'http://example.com/b.mp3' })
await fireEvent.loadedMetadata(screen.getByTestId('audio-preview'))

expect(seek).not.toHaveBeenCalledWith(42)
})

it('follows a pause that came from outside the player', async () => {
vi.spyOn(HTMLMediaElement.prototype, 'play').mockResolvedValue(undefined)
vi.spyOn(HTMLMediaElement.prototype, 'paused', 'get').mockReturnValue(
Expand Down Expand Up @@ -217,7 +280,10 @@ describe('AudioPreviewPlayer', () => {
message:
'Audio playback failed (MediaError 4): DEMUXER_ERROR_COULD_NOT_OPEN'
}),
expect.objectContaining({ errorType: 'error_playing_audio' })
expect.objectContaining({
errorType: 'error_playing_audio',
level: 'warning'
})
)
})

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ import MenuItemContent from '@/components/ui/menu/MenuItemContent.vue'
import Slider from '@/components/ui/slider/Slider.vue'

import { formatTime } from '@/utils/formatUtil'
import { reloadFailedMedia } from '@/utils/mediaReloadUtil'

const { t } = useI18n()
const toast = useToast()
Expand Down Expand Up @@ -199,7 +200,7 @@ const togglePlayPause = async () => {

isPlaying.value = true
try {
if (audio.error) audio.load()
if (audio.error) reloadFailedMedia(audio)
await audio.play()
if (attempt === playAttempt) toast.dismiss(playbackErrorToastId)
} catch (error) {
Expand Down
62 changes: 62 additions & 0 deletions src/utils/mediaReloadUtil.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { describe, expect, it, vi } from 'vitest'

import { reloadFailedMedia } from '@/utils/mediaReloadUtil'

function failedAt(position: number) {
const media = document.createElement('audio')
media.src = 'http://example.com/a.mp3'
let current = position
Object.defineProperty(media, 'currentTime', {
get: () => current,
set: (value: number) => {
current = value
}
})
vi.spyOn(media, 'load').mockImplementation(() => {
current = 0
})
return { media, position: () => current }
}

describe('reloadFailedMedia', () => {
it('reloads and seeks back to the failed position once metadata loads', () => {
const { media, position } = failedAt(42)

reloadFailedMedia(media)
expect(media.load).toHaveBeenCalledTimes(1)
expect(position()).toBe(0)
media.dispatchEvent(new Event('loadedmetadata'))

expect(position()).toBe(42)
})

it('does not seek a replaced source', () => {
const { media, position } = failedAt(42)

reloadFailedMedia(media)
media.src = 'http://example.com/b.mp3'
media.dispatchEvent(new Event('loadedmetadata'))

expect(position()).toBe(0)
})

it('keeps a position the user chose before metadata loaded', () => {
const { media, position } = failedAt(42)

reloadFailedMedia(media)
media.currentTime = 10
media.dispatchEvent(new Event('loadedmetadata'))

expect(position()).toBe(10)
})

it('keeps a seek the user started before metadata loaded', () => {
const { media, position } = failedAt(42)

reloadFailedMedia(media)
media.dispatchEvent(new Event('seeking'))
media.dispatchEvent(new Event('loadedmetadata'))

expect(position()).toBe(0)
})
})
19 changes: 19 additions & 0 deletions src/utils/mediaReloadUtil.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
export function reloadFailedMedia(media: HTMLMediaElement) {
const resumeAt = media.currentTime
const src = media.src
media.load()
if (!(resumeAt > 0)) return

const controller = new AbortController()
const { signal } = controller
media.addEventListener('seeking', () => controller.abort(), { signal })
media.addEventListener(
'loadedmetadata',
() => {
controller.abort()
if (media.src === src && media.currentTime === 0)
media.currentTime = resumeAt
},
{ signal }
)
}
Loading