fix(speech): keep the old model when the new one can't be moved in

Deleting the old folder before the rename lost both copies when the rename
failed, e.g. a Windows antivirus lock.
This commit is contained in:
Kelvin Amoaba
2026-11-11 05:53:33 +00:00
parent 80026db12a
commit cc4da1d99c
4 changed files with 42 additions and 26 deletions
+9
View File
@@ -123,6 +123,15 @@ describe('ModelManager', () => {
modelId
)
expect(state.needsUpdate).toBe(true)
const failedSwap = new ModelManager(dir, openElectronSpeechDownloadRequest)
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: as above.
;(failedSwap as unknown as typeof internals).downloadModelFiles = async (_m, stagingDir) => {
rmSync(stagingDir, { recursive: true, force: true })
}
await expect(failedSwap.downloadModel(modelId)).rejects.toThrow('ENOENT')
expect(existsSync(`${modelDir}.previous`)).toBe(false)
expect((await failedSwap.getModelState(modelId)).needsUpdate).toBe(true)
} finally {
rmSync(dir, { recursive: true, force: true })
}
+5 -13
View File
@@ -1,5 +1,5 @@
import { existsSync, mkdirSync, rmSync } from 'node:fs'
import { rename, rm } from 'node:fs/promises'
import { rm } from 'node:fs/promises'
import { join, relative, resolve } from 'node:path'
import type { SpeechModelState, SpeechModelStatus } from '../../shared/speech-types'
import { SPEECH_MODEL_CATALOG, getCatalogModel, isLocalSpeechModel } from './model-catalog'
@@ -15,10 +15,8 @@ import { SpeechModelDownloadTransport } from './speech-model-download-transport'
import { hasSpeechModelFiles } from './speech-model-files'
import type { OpenSpeechDownloadRequest } from './speech-model-download-response'
import { getAppEnvironment } from '../../shared/app-environment'
import {
removeModelDownloadFiles,
removeModelDownloadStaging
} from './speech-model-download-cleanup'
import { removeModelDownloadStaging } from './speech-model-download-cleanup'
import { previousSpeechModelDir, swapInSpeechModelDir } from './speech-model-dir-swap'
type DownloadHandle = {
abort: () => void
@@ -184,8 +182,6 @@ export class ModelManager extends SpeechModelDownloadTransport {
}
}
this.activeDownloads.set(modelId, handle)
// Until the swap starts, modelDir holds only the old files, which are how the update is found again.
let replacingModelDir = false
try {
await this.downloadModelFiles(
@@ -200,9 +196,7 @@ export class ModelManager extends SpeechModelDownloadTransport {
return
}
replacingModelDir = true
await rm(modelDir, { recursive: true, force: true })
await rename(stagingDir, modelDir)
await swapInSpeechModelDir(stagingDir, modelDir)
this.updateState(modelId, 'ready')
if (getCatalogModel(modelId)?.files?.some((file) => file.endsWith('.gguf'))) {
downloadSileroVadInBackground(this)
@@ -212,9 +206,6 @@ export class ModelManager extends SpeechModelDownloadTransport {
console.error('[speech] Model download failed:', modelId, err)
this.updateState(modelId, 'error', undefined, String(err))
}
if (replacingModelDir) {
removeModelDownloadFiles(modelDir, stagingDir, legacyArchivePath)
}
if (!aborted) {
// Settings awaits real failures; cancellation stays quiet.
throw err
@@ -248,6 +239,7 @@ export class ModelManager extends SpeechModelDownloadTransport {
await rm(modelDir, { recursive: true, force: true })
}
await rm(`${modelDir}.partial`, { recursive: true, force: true })
await rm(previousSpeechModelDir(modelDir), { recursive: true, force: true })
await rm(join(this.modelsDir, `${modelId}.tar.bz2`), { force: true })
// Remove the migration source too or next launch resurrects the model.
if (this.migrationSourceDir) {
+28
View File
@@ -0,0 +1,28 @@
import { existsSync } from 'node:fs'
import { rename, rm } from 'node:fs/promises'
export function previousSpeechModelDir(modelDir: string): string {
return `${modelDir}.previous`
}
/** Moves the old download aside instead of deleting it, so a failed rename (e.g. a Windows file lock) keeps it. */
export async function swapInSpeechModelDir(stagingDir: string, modelDir: string): Promise<void> {
const previousDir = previousSpeechModelDir(modelDir)
// Left by an interrupted swap; the staged download is complete, so it is no longer needed.
await rm(previousDir, { recursive: true, force: true })
const hadPrevious = existsSync(modelDir)
if (hadPrevious) {
await rename(modelDir, previousDir)
}
try {
await rename(stagingDir, modelDir)
} catch (error) {
if (hadPrevious) {
await rename(previousDir, modelDir).catch((restoreError: unknown) => {
console.error('[speech] Failed to restore the previous model files:', restoreError)
})
}
throw error
}
await rm(previousDir, { recursive: true, force: true }).catch(() => undefined)
}
@@ -9,16 +9,3 @@ export function removeModelDownloadStaging(stagingDir: string, legacyArchivePath
}
}
}
export function removeModelDownloadFiles(
modelDir: string,
stagingDir: string,
legacyArchivePath: string
): void {
removeModelDownloadStaging(stagingDir, legacyArchivePath)
try {
rmSync(modelDir, { recursive: true, force: true })
} catch {
// best-effort
}
}