Dont fail if one bulk fails, collect results separately

This commit is contained in:
shamoon committed 2026-10-20 08:57:24 -07:00
1 parent 36c31b3a73
commit bf316cba8a
8 files changed
+289 -20

No files matched your search

@@ -1992,6 +1992,27 @@ describe('DocumentDetailComponent', () => {
pending.complete()
})
it('does not reload or discard local edits when zone OCR is skipped', () => {
component.documentId.set(doc.id)
component.document.set({ ...doc, __changedFields: ['title'] })
component.documentForm.patchValue({ title: 'Unsaved title' })
const modalSpy = jest.spyOn(modalService, 'open')
jest
.spyOn(documentService, 'runZoneOcr')
.mockReturnValue(of({ status: 'skipped', results: [] }))
const loadSpy = jest.spyOn(component as any, 'loadDocument')
const infoSpy = jest.spyOn(toastService, 'showInfo')
component.runZoneOcr()
modalSpy.mock.results[0].value.componentInstance.confirm()
expect(loadSpy).not.toHaveBeenCalled()
expect(component.documentForm.get('title').value).toBe('Unsaved title')
expect(component.zoneOcrRunning()).toBe(false)
expect(component.networkActive()).toBe(false)
expect(infoSpy).toHaveBeenCalledWith('Zone OCR skipped.')
})
it('should show an error when zone OCR fails', () => {
component.document.set(doc)
jest
@@ -1604,6 +1604,11 @@ export class DocumentDetailComponent
finish()
return
}
if (res.status === 'skipped') {
finish()
this.toastService.showInfo($localize`Zone OCR skipped.`)
return
}
const results = res.results ?? []
if (results.length) {
const failed = results.filter(
@@ -1286,6 +1286,93 @@ describe('BulkEditorComponent', () => {
) // listAllFilteredIds
})
it('finishes bulk zone OCR despite skipped and failed documents and refreshes the list', () => {
jest
.spyOn(documentListViewService, 'selected', 'get')
.mockReturnValue(new Set([3, 4, 5, 6]))
const modalSpy = jest.spyOn(modalService, 'open')
const refreshSpy = jest
.spyOn(component as any, 'handleOperationSuccess')
.mockImplementation(() => {})
const errorSpy = jest.spyOn(toastService, 'showError')
component.runZoneOcrSelected()
const modal = modalSpy.mock.results[0].value
modal.componentInstance.confirm()
const requests = [3, 4, 5, 6].map((id) =>
httpTestingController.expectOne(
`${environment.apiBaseUrl}documents/${id}/run-zone-ocr/`
)
)
requests[1].flush({
status: 'skipped',
reason: 'no_document_type',
results: [],
})
requests[2].flush({ status: 'skipped', reason: 'no_template', results: [] })
requests[3].flush(
{ error: 'OCR failed' },
{ status: 500, statusText: 'Server Error' }
)
expect(requests[0].cancelled).toBe(false)
expect(refreshSpy).not.toHaveBeenCalled()
requests[0].flush({ status: 'completed', results: [] })
expect(refreshSpy).toHaveBeenCalledWith(modal, false)
expect(errorSpy).toHaveBeenCalledWith(
'Zone OCR: 1 completed, 2 skipped, 1 failed. Failed documents: 6',
[{ document: 6, error: { error: 'OCR failed' } }]
)
})
it.each([
[403, 'Permission denied'],
[404, 'Document file not found'],
[500, 'OCR failed'],
])('reports a %s OCR error as a failure, not a skip', (status, message) => {
jest
.spyOn(documentListViewService, 'selected', 'get')
.mockReturnValue(new Set([3]))
const modalSpy = jest.spyOn(modalService, 'open')
jest
.spyOn(component as any, 'handleOperationSuccess')
.mockImplementation(() => {})
const errorSpy = jest.spyOn(toastService, 'showError')
component.runZoneOcrSelected()
modalSpy.mock.results[0].value.componentInstance.confirm()
httpTestingController
.expectOne(`${environment.apiBaseUrl}documents/3/run-zone-ocr/`)
.flush({ error: message }, { status, statusText: 'Error' })
expect(errorSpy).toHaveBeenCalledWith(
'Zone OCR: 0 completed, 0 skipped, 1 failed. Failed documents: 3',
[{ document: 3, error: { error: message } }]
)
})
it('reports a successful bulk zone OCR run', () => {
jest
.spyOn(documentListViewService, 'selected', 'get')
.mockReturnValue(new Set([3, 4]))
jest
.spyOn(documentService, 'runZoneOcr')
.mockReturnValue(of({ status: 'completed', results: [] }))
const modalSpy = jest.spyOn(modalService, 'open')
jest
.spyOn(component as any, 'handleOperationSuccess')
.mockImplementation(() => {})
const infoSpy = jest.spyOn(toastService, 'showInfo')
component.runZoneOcrSelected()
modalSpy.mock.results[0].value.componentInstance.confirm()
expect(infoSpy).toHaveBeenCalledWith(
'Zone OCR: 2 completed, 0 skipped, 0 failed.'
)
})
it('should support rotate', () => {
let modal: NgbModalRef
modalService.activeInstances.subscribe((m) => (modal = m[0]))
@@ -21,10 +21,12 @@ import {
import { saveAs } from 'file-saver'
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
import {
catchError,
first,
forkJoin,
map,
Observable,
of,
Subject,
switchMap,
takeUntil,
@@ -983,7 +985,39 @@ export class BulkEditorComponent
modal.componentInstance.buttonsEnabled.set(false)
this.executeDocumentAction(
modal,
forkJoin(ids.map((id) => this.documentService.runZoneOcr(id)))
forkJoin(
ids.map((id) =>
this.documentService.runZoneOcr(id).pipe(
map(({ status }) => ({ id, status })),
catchError((error) =>
of({ id, status: 'failed' as const, error })
)
)
)
).pipe(
tap((results) => {
const completed = results.filter(
(r) => r.status === 'completed'
).length
const skipped = results.filter(
(r) => r.status === 'skipped'
).length
const failed = results.filter((r) => r.status === 'failed')
const summary = $localize`Zone OCR: ${completed} completed, ${skipped} skipped, ${failed.length} failed.`
if (failed.length) {
const failedIds = failed.map((r) => r.id).join(', ')
this.toastService.showError(
`${summary} ${$localize`Failed documents: ${failedIds}`}`,
failed.map((r) => ({
document: r.id,
error: r.error.error ?? r.error.message,
}))
)
} else {
this.toastService.showInfo(summary)
}
})
)
)
})
}
+6
View File
@@ -162,3 +162,9 @@ export interface OcrZoneRunResult {
custom_field: string
value: string | number | null
}
export interface OcrZoneRunResponse {
status: 'completed' | 'skipped'
reason?: 'no_document_type' | 'no_template'
results: OcrZoneRunResult[]
}
@@ -12,7 +12,7 @@ import {
import { DocumentMetadata } from 'src/app/data/document-metadata'
import { DocumentSuggestions } from 'src/app/data/document-suggestions'
import { FilterRule } from 'src/app/data/filter-rule'
import { OcrZoneRunResult } from 'src/app/data/ocr-template'
import { OcrZoneRunResponse } from 'src/app/data/ocr-template'
import { Results, SelectionData } from 'src/app/data/results'
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
import { queryParamsFromFilterRules } from '../../utils/query-params'
@@ -361,8 +361,8 @@ export class DocumentService extends AbstractPaperlessService<Document> {
})
}
runZoneOcr(id: number): Observable<{ results: OcrZoneRunResult[] }> {
return this.http.post<{ results: OcrZoneRunResult[] }>(
runZoneOcr(id: number): Observable<OcrZoneRunResponse> {
return this.http.post<OcrZoneRunResponse>(
this.getResourceUrl(id, 'run-zone-ocr'),
{}
)