feat: integrity check jobs (missing files, orphaned files, checksums) #24205
+3,952
−28
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
refactor: rename checksum_fail to checksum_mismatched
refactor: combine the stream query
chore: lint & format
feat: update summary after job runs
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
insertish
changed the title
insertish
commented
Dec 3, 2025
| }); | ||
| }); | ||
|
|
||
| describe('POST /integrity/summary (& jobs)', async () => { |
Contributor
Author
There was a problem hiding this comment.
Move to separate test file
| }); | ||
| } | ||
| } | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Move to separate controller
| export class MaintenanceAuthDto { | ||
| username!: string; | ||
| } | ||
|
|
Contributor
Author
There was a problem hiding this comment.
Create separate dto file
Comment on lines
36
to
+71
|
|
||
| case ManualJobName.IntegrityMissingFiles: { | ||
| return { name: JobName.IntegrityMissingFilesQueueAll }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityOrphanFiles: { | ||
| return { name: JobName.IntegrityOrphanedFilesQueueAll }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityChecksumFiles: { | ||
| return { name: JobName.IntegrityChecksumFiles }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityMissingFilesRefresh: { | ||
| return { name: JobName.IntegrityMissingFilesQueueAll, data: { refreshOnly: true } }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityOrphanFilesRefresh: { | ||
| return { name: JobName.IntegrityOrphanedFilesQueueAll, data: { refreshOnly: true } }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityChecksumFilesRefresh: { | ||
| return { name: JobName.IntegrityChecksumFiles, data: { refreshOnly: true } }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityMissingFilesDeleteAll: { | ||
| return { name: JobName.IntegrityReportDelete, data: { type: IntegrityReportType.MissingFile } }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityOrphanFilesDeleteAll: { | ||
| return { name: JobName.IntegrityReportDelete, data: { type: IntegrityReportType.OrphanFile } }; | ||
| } | ||
|
|
||
| case ManualJobName.IntegrityChecksumFilesDeleteAll: { | ||
| return { name: JobName.IntegrityReportDelete, data: { type: IntegrityReportType.ChecksumFail } }; | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Should this just be its own route? createJob only accepts the name right now
| Unique, | ||
| } from 'src/sql-tools'; | ||
|
|
||
| @Table('integrity_report') |
Contributor
Author
There was a problem hiding this comment.
Maybe this should be called integrity_report_files or something, in case we want to then handle integrity_report_database_rows or other report types which don't deal with files?
Comment on lines
+100
to
+117
| // debug: run on boot | ||
| setTimeout(() => { | ||
| void this.jobRepository.queue({ | ||
| name: JobName.IntegrityOrphanedFilesQueueAll, | ||
| data: {}, | ||
| }); | ||
|
|
||
| void this.jobRepository.queue({ | ||
| name: JobName.IntegrityMissingFilesQueueAll, | ||
| data: {}, | ||
| }); | ||
|
|
||
| void this.jobRepository.queue({ | ||
| name: JobName.IntegrityChecksumFiles, | ||
| data: {}, | ||
| }); | ||
| }, 1000); | ||
| } |
Contributor
Author
There was a problem hiding this comment.
Remove this before merge.
|
|
||
| await this.eventRepository.emit('AssetTrashAll', { | ||
| assetIds: ids, | ||
| userId: '', // ??? |
| for (const property of properties) { | ||
| const reports = this.integrityRepository.streamIntegrityReportsByProperty(property, type); | ||
| for await (const report of chunk(reports, JOBS_LIBRARY_PAGINATION_SIZE)) { | ||
| // todo: queue sub-job here instead? |
Comment on lines
173
to
191
| // .onRef('integrity_report.path', '=', 'allPaths.path') | ||
| ) | ||
| .select([ | ||
| 'allPaths.path as path', | ||
| 'allPaths.assetId', | ||
| 'allPaths.fileAssetId', | ||
| 'integrity_report.path as reportId', | ||
| ]) | ||
| .stream(); | ||
| } | ||
|
|
||
| @GenerateSql({ params: [DummyValue.DATE, DummyValue.DATE], stream: true }) | ||
| streamAssetChecksums(startMarker?: Date, endMarker?: Date) { | ||
| return this.db | ||
| .selectFrom('asset') | ||
| .leftJoin('integrity_report', (join) => | ||
| join | ||
| .onRef('integrity_report.assetId', '=', 'asset.id') | ||
| // .onRef('integrity_report.path', '=', 'asset.originalPath') |
| eb.ref('asset.id').$castTo<string | null>().as('assetId'), | ||
| sql<string | null>`null::uuid`.as('fileAssetId'), | ||
| ]) | ||
| .unionAll( |
Contributor
Author
There was a problem hiding this comment.
May have a major performance impact
Contributor
Author
There was a problem hiding this comment.
Current impact:
Type: Nested Loop (Left); ; Cost: 0.00 - 51.62
Type: Append; ; Cost: 0.00 - 41.43
Type: Seq Scan; Rel: asset ; Cost: 0.00 - 11.60
Type: Seq Scan; Rel: asset ; Cost: 0.00 - 12.00
Type: Seq Scan; Rel: asset_file ; Cost: 0.00 - 15.20
Type: Materialize; ; Cost: 0.00 - 1.05
Type: Seq Scan; Rel: integrity_report ; Cost: 0.00 - 1.05
Without the union:
Type: Hash Join (Left); ; Cost: 1.06 - 18.22
Type: Seq Scan; Rel: asset_file ; Cost: 0.00 - 15.20
Type: Hash; ; Cost: 1.05 - 1.05
Type: Seq Scan; Rel: integrity_report ; Cost: 0.00 - 1.05
Doesn't appear much performance is left on the table
- No indication the entire
assetorasset_filetable is loaded into memory but I could be wrong - Integrity report is loaded entirely into memory in either case
- Likely negligible performance difference between Nested Loop/Hash Join? This seems like something the database optimises itself on the fly, I'm not too knowledgeable on this -- https://stackoverflow.com/a/49024533
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR desc TODO
Description
Fixes # (issue)
How Has This Been Tested?
Screenshots (if appropriate)
Checklist:
src/services/uses repositories implementations for database calls, filesystem operations, etc.src/repositories/is pretty basic/simple and does not have any immich specific logic (that belongs insrc/services/)Please describe to which degree, if any, an LLM was used in creating this pull request.
...