feat(server): xmp sidecar metadata (#2466)

* initial commit for XMP sidecar support * Added support for 'missing' metadata files to include those without sidecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards * didn't mean to commit default log level during testing * new sidecar logic for video metadata as well * Added xml mimetype for sidecars only * don't need capture group for this regex * wrong default value reverted * simplified the move here - keep it in the same try catch since the outcome is to move the media back anyway * simplified setter logic Co-authored-by: Jason Rasmussen <jrasm91@gmail.com> * simplified logic per suggestions * sidecar is now its own queue with a discover and sync, updated UI for the new job queueing * queue a sidecar job for every asset based on discovery or sync, though the logic is almost identical aside from linking the sidecar * now queue sidecar jobs for each assset, though logic is mostly the same between discovery and sync * simplified logic of filename extraction and asset instantiation * not sure how that got deleted.. * updated code per suggestions and comments in the PR * stat was not being used, removed the variable set * better type checking, using in-scope variables for exif getter instead of passing in every time * removed commented out test * ran and resolved all lints, formats, checks, and tests * resolved suggested change in PR * made getExifProperty more dynamic with multiple possible args for fallbacks, fixed typo, used generic in function for better type checking * better error handling and moving files back to positions on move or save failure * regenerated api * format fixes * Added XMP documentation * documentation typo * Merged in main * missed merge conflict * more changes due to a merge * Resolving conflicts * added icon for sidecar jobs --------- Co-authored-by: Jason Rasmussen <jrasm91@gmail.com> Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
2025-11-14 17:36:12 +00:00 · 2023-05-24 21:59:30 -04:00 · 2023-05-24 21:59:30 -04:00 · 7c1dae918d
commit 7c1dae918d
parent 1b54c4f8e7
35 changed files with 371 additions and 48 deletions
--- a/server/apps/immich/src/api-v1/asset/asset.controller.ts
+++ b/server/apps/immich/src/api-v1/asset/asset.controller.ts
@ -78,6 +78,7 @@ export class AssetController {
      [
        { name: 'assetData', maxCount: 1 },
        { name: 'livePhotoData', maxCount: 1 },
+        { name: 'sidecarData', maxCount: 1 },
      ],
      assetUploadOption,
    ),
@ -90,18 +91,24 @@ export class AssetController {
  async uploadFile(
    @GetAuthUser() authUser: AuthUserDto,
    @UploadedFiles(new ParseFilePipe({ validators: [new FileNotEmptyValidator(['assetData'])] }))
-    files: { assetData: ImmichFile[]; livePhotoData?: ImmichFile[] },
+    files: { assetData: ImmichFile[]; livePhotoData?: ImmichFile[]; sidecarData: ImmichFile[] },
    @Body(new ValidationPipe()) dto: CreateAssetDto,
    @Response({ passthrough: true }) res: Res,
  ): Promise<AssetFileUploadResponseDto> {
    const file = mapToUploadFile(files.assetData[0]);
    const _livePhotoFile = files.livePhotoData?.[0];
+    const _sidecarFile = files.sidecarData?.[0];
    let livePhotoFile;
    if (_livePhotoFile) {
      livePhotoFile = mapToUploadFile(_livePhotoFile);
    }

-    const responseDto = await this.assetService.uploadFile(authUser, dto, file, livePhotoFile);
+    let sidecarFile;
+    if (_sidecarFile) {
+      sidecarFile = mapToUploadFile(_sidecarFile);
+    }
+
+    const responseDto = await this.assetService.uploadFile(authUser, dto, file, livePhotoFile, sidecarFile);
    if (responseDto.duplicate) {
      res.status(200);
    }
--- a/server/apps/immich/src/api-v1/asset/asset.core.ts
+++ b/server/apps/immich/src/api-v1/asset/asset.core.ts
@ -12,6 +12,7 @@ export class AssetCore {
    dto: CreateAssetDto,
    file: UploadFile,
    livePhotoAssetId?: string,
+    sidecarFile?: UploadFile,
  ): Promise<AssetEntity> {
    const asset = await this.repository.create({
      owner: { id: authUser.id } as UserEntity,
@ -39,6 +40,7 @@ export class AssetCore {
      sharedLinks: [],
      originalFileName: parse(file.originalName).name,
      faces: [],
+      sidecarPath: sidecarFile?.originalPath || null,
    });

    await this.jobRepository.queue({ name: JobName.ASSET_UPLOADED, data: { asset } });
--- a/server/apps/immich/src/api-v1/asset/asset.service.spec.ts
+++ b/server/apps/immich/src/api-v1/asset/asset.service.spec.ts
@ -305,7 +305,7 @@ describe('AssetService', () => {

      expect(jobMock.queue).toHaveBeenCalledWith({
        name: JobName.DELETE_FILES,
-        data: { files: ['fake_path/asset_1.jpeg', undefined] },
+        data: { files: ['fake_path/asset_1.jpeg', undefined, undefined] },
      });
      expect(storageMock.moveFile).not.toHaveBeenCalled();
    });
@ -413,10 +413,12 @@ describe('AssetService', () => {
            undefined,
            undefined,
            undefined,
+            undefined,
            'fake_path/asset_1.mp4',
            undefined,
            undefined,
            undefined,
+            undefined,
          ],
        },
      });
@ -462,10 +464,12 @@ describe('AssetService', () => {
                'web-path-1',
                'resize-path-1',
                undefined,
+                undefined,
                'original-path-2',
                'web-path-2',
                'resize-path-2',
                'encoded-video-path-2',
+                undefined,
              ],
            },
          },
--- a/server/apps/immich/src/api-v1/asset/asset.service.ts
+++ b/server/apps/immich/src/api-v1/asset/asset.service.ts
@ -106,6 +106,7 @@ export class AssetService {
    dto: CreateAssetDto,
    file: UploadFile,
    livePhotoFile?: UploadFile,
+    sidecarFile?: UploadFile,
  ): Promise<AssetFileUploadResponseDto> {
    if (livePhotoFile) {
      livePhotoFile = {
@ -122,14 +123,14 @@ export class AssetService {
        livePhotoAsset = await this.assetCore.create(authUser, livePhotoDto, livePhotoFile);
      }

-      const asset = await this.assetCore.create(authUser, dto, file, livePhotoAsset?.id);
+      const asset = await this.assetCore.create(authUser, dto, file, livePhotoAsset?.id, sidecarFile);

      return { id: asset.id, duplicate: false };
    } catch (error: any) {
      // clean up files
      await this.jobRepository.queue({
        name: JobName.DELETE_FILES,
-        data: { files: [file.originalPath, livePhotoFile?.originalPath] },
+        data: { files: [file.originalPath, livePhotoFile?.originalPath, sidecarFile?.originalPath] },
      });

      // handle duplicates with a success response
@ -366,7 +367,13 @@ export class AssetService {
        await this.jobRepository.queue({ name: JobName.SEARCH_REMOVE_ASSET, data: { ids: [id] } });

        result.push({ id, status: DeleteAssetStatusEnum.SUCCESS });
-        deleteQueue.push(asset.originalPath, asset.webpPath, asset.resizePath, asset.encodedVideoPath);
+        deleteQueue.push(
+          asset.originalPath,
+          asset.webpPath,
+          asset.resizePath,
+          asset.encodedVideoPath,
+          asset.sidecarPath,
+        );

        // TODO refactor this to use cascades
        if (asset.livePhotoVideoId && !ids.includes(asset.livePhotoVideoId)) {
--- a/server/apps/immich/src/api-v1/asset/dto/create-asset.dto.ts
+++ b/server/apps/immich/src/api-v1/asset/dto/create-asset.dto.ts
@ -45,6 +45,9 @@ export class CreateAssetDto {

  @ApiProperty({ type: 'string', format: 'binary' })
  livePhotoData?: any;
+
+  @ApiProperty({ type: 'string', format: 'binary' })
+  sidecarData?: any;
 }

 export interface UploadFile {
--- a/server/apps/immich/src/config/asset-upload.config.ts
+++ b/server/apps/immich/src/config/asset-upload.config.ts
@ -60,6 +60,11 @@ function fileFilter(req: AuthRequest, file: any, cb: any) {
  ) {
    cb(null, true);
  } else {
+    // Additionally support XML but only for sidecar files
+    if (file.fieldname == 'sidecarData' && file.mimetype.match(/\/xml$/)) {
+      return cb(null, true);
+    }
+
    logger.error(`Unsupported file type ${extname(file.originalname)} file MIME type ${file.mimetype}`);
    cb(new BadRequestException(`Unsupported file type ${extname(file.originalname)}`), false);
  }
@ -95,6 +100,11 @@ function filename(req: AuthRequest, file: Express.Multer.File, cb: any) {
    return cb(null, sanitize(livePhotoFileName));
  }

+  if (file.fieldname === 'sidecarData') {
+    const sidecarFileName = `${fileNameUUID}.xmp`;
+    return cb(null, sanitize(sidecarFileName));
+  }
+
  const fileName = `${fileNameUUID}${req.body['fileExtension']}`;
  return cb(null, sanitize(fileName));
 }
--- a/server/apps/microservices/src/microservices.module.ts
+++ b/server/apps/microservices/src/microservices.module.ts
@ -13,7 +13,7 @@ import {
  ThumbnailGeneratorProcessor,
  VideoTranscodeProcessor,
 } from './processors';
-import { MetadataExtractionProcessor } from './processors/metadata-extraction.processor';
+import { MetadataExtractionProcessor, SidecarProcessor } from './processors/metadata-extraction.processor';

@Module({
  imports: [
@ -31,6 +31,7 @@ import { MetadataExtractionProcessor } from './processors/metadata-extraction.pr
    BackgroundTaskProcessor,
    SearchIndexProcessor,
    FacialRecognitionProcessor,
+    SidecarProcessor,
  ],
 })
 export class MicroservicesModule {}
--- a/server/apps/microservices/src/processors/metadata-extraction.processor.ts
+++ b/server/apps/microservices/src/processors/metadata-extraction.processor.ts
@ -10,6 +10,7 @@ import {
  QueueName,
  usePagination,
  WithoutProperty,
+  WithProperty,
 } from '@app/domain';
 import { AssetEntity, AssetType, ExifEntity } from '@app/infra/entities';
 import { Process, Processor } from '@nestjs/bull';
@ -98,13 +99,22 @@ export class MetadataExtractionProcessor {
    let asset = job.data.asset;

    try {
-      const exifData = await exiftool.read<ImmichTags>(asset.originalPath).catch((error: any) => {
+      const mediaExifData = await exiftool.read<ImmichTags>(asset.originalPath).catch((error: any) => {
        this.logger.warn(
          `The exifData parsing failed due to ${error} for asset ${asset.id} at ${asset.originalPath}`,
          error?.stack,
        );
        return null;
      });
+      const sidecarExifData = asset.sidecarPath
+        ? await exiftool.read<ImmichTags>(asset.sidecarPath).catch((error: any) => {
+            this.logger.warn(
+              `The exifData parsing failed due to ${error} for asset ${asset.id} at ${asset.originalPath}`,
+              error?.stack,
+            );
+            return null;
+          })
+        : {};

      const exifToDate = (exifDate: string | ExifDateTime | undefined) => {
        if (!exifDate) return null;
@ -126,31 +136,46 @@ export class MetadataExtractionProcessor {
        return exifDate.zone ?? null;
      };

-      const timeZone = exifTimeZone(exifData?.DateTimeOriginal ?? exifData?.CreateDate ?? asset.fileCreatedAt);
-      const fileCreatedAt = exifToDate(exifData?.DateTimeOriginal ?? exifData?.CreateDate ?? asset.fileCreatedAt);
-      const fileModifiedAt = exifToDate(exifData?.ModifyDate ?? asset.fileModifiedAt);
+      const getExifProperty = <T extends keyof ImmichTags>(...properties: T[]): any | null => {
+        for (const property of properties) {
+          const value = sidecarExifData?.[property] ?? mediaExifData?.[property];
+          if (value !== null && value !== undefined) {
+            return value;
+          }
+        }
+
+        return null;
+      };
+
+      const timeZone = exifTimeZone(getExifProperty('DateTimeOriginal', 'CreateDate') ?? asset.fileCreatedAt);
+      const fileCreatedAt = exifToDate(getExifProperty('DateTimeOriginal', 'CreateDate') ?? asset.fileCreatedAt);
+      const fileModifiedAt = exifToDate(getExifProperty('ModifyDate') ?? asset.fileModifiedAt);
      const fileStats = fs.statSync(asset.originalPath);
      const fileSizeInBytes = fileStats.size;

      const newExif = new ExifEntity();
      newExif.assetId = asset.id;
      newExif.fileSizeInByte = fileSizeInBytes;
-      newExif.make = exifData?.Make || null;
-      newExif.model = exifData?.Model || null;
-      newExif.exifImageHeight = exifData?.ExifImageHeight || exifData?.ImageHeight || null;
-      newExif.exifImageWidth = exifData?.ExifImageWidth || exifData?.ImageWidth || null;
-      newExif.exposureTime = exifData?.ExposureTime || null;
-      newExif.orientation = exifData?.Orientation?.toString() || null;
+      newExif.make = getExifProperty('Make');
+      newExif.model = getExifProperty('Model');
+      newExif.exifImageHeight = getExifProperty('ExifImageHeight', 'ImageHeight');
+      newExif.exifImageWidth = getExifProperty('ExifImageWidth', 'ImageWidth');
+      newExif.exposureTime = getExifProperty('ExposureTime');
+      newExif.orientation = getExifProperty('Orientation')?.toString();
      newExif.dateTimeOriginal = fileCreatedAt;
      newExif.modifyDate = fileModifiedAt;
      newExif.timeZone = timeZone;
-      newExif.lensModel = exifData?.LensModel || null;
-      newExif.fNumber = exifData?.FNumber || null;
-      newExif.focalLength = exifData?.FocalLength ? parseFloat(exifData.FocalLength) : null;
-      newExif.iso = exifData?.ISO || null;
-      newExif.latitude = exifData?.GPSLatitude || null;
-      newExif.longitude = exifData?.GPSLongitude || null;
-      newExif.livePhotoCID = exifData?.MediaGroupUUID || null;
+      newExif.lensModel = getExifProperty('LensModel');
+      newExif.fNumber = getExifProperty('FNumber');
+      const focalLength = getExifProperty('FocalLength');
+      newExif.focalLength = focalLength ? parseFloat(focalLength) : null;
+      // This is unusual - exifData.ISO should return a number, but experienced that sidecar XMP
+      // files MAY return an array of numbers instead.
+      const iso = getExifProperty('ISO');
+      newExif.iso = Array.isArray(iso) ? iso[0] : iso || null;
+      newExif.latitude = getExifProperty('GPSLatitude');
+      newExif.longitude = getExifProperty('GPSLongitude');
+      newExif.livePhotoCID = getExifProperty('MediaGroupUUID');

      if (newExif.livePhotoCID && !asset.livePhotoVideoId) {
        const motionAsset = await this.assetCore.findLivePhotoMatch({
@ -220,7 +245,7 @@ export class MetadataExtractionProcessor {
        }
      }

-      const exifData = await exiftool.read<ImmichTags>(asset.originalPath).catch((error: any) => {
+      const exifData = await exiftool.read<ImmichTags>(asset.sidecarPath || asset.originalPath).catch((error: any) => {
        this.logger.warn(
          `The exifData parsing failed due to ${error} for asset ${asset.id} at ${asset.originalPath}`,
          error?.stack,
@ -345,3 +370,83 @@ export class MetadataExtractionProcessor {
    return Duration.fromObject({ seconds: videoDurationInSecond }).toFormat('hh:mm:ss.SSS');
  }
 }
+
+@Processor(QueueName.SIDECAR)
+export class SidecarProcessor {
+  private logger = new Logger(SidecarProcessor.name);
+  private assetCore: AssetCore;
+
+  constructor(
+    @Inject(IAssetRepository) private assetRepository: IAssetRepository,
+    @Inject(IJobRepository) private jobRepository: IJobRepository,
+  ) {
+    this.assetCore = new AssetCore(assetRepository, jobRepository);
+  }
+
+  @Process(JobName.QUEUE_SIDECAR)
+  async handleQueueSidecar(job: Job<IBaseJob>) {
+    try {
+      const { force } = job.data;
+      const assetPagination = usePagination(JOBS_ASSET_PAGINATION_SIZE, (pagination) => {
+        return force
+          ? this.assetRepository.getWith(pagination, WithProperty.SIDECAR)
+          : this.assetRepository.getWithout(pagination, WithoutProperty.SIDECAR);
+      });
+
+      for await (const assets of assetPagination) {
+        for (const asset of assets) {
+          const name = force ? JobName.SIDECAR_SYNC : JobName.SIDECAR_DISCOVERY;
+          await this.jobRepository.queue({ name, data: { asset } });
+        }
+      }
+    } catch (error: any) {
+      this.logger.error(`Unable to queue sidecar scanning`, error?.stack);
+    }
+  }
+
+  @Process(JobName.SIDECAR_SYNC)
+  async handleSidecarSync(job: Job<IAssetJob>) {
+    const { asset } = job.data;
+    if (!asset.isVisible) {
+      return;
+    }
+
+    try {
+      const name = asset.type === AssetType.VIDEO ? JobName.EXTRACT_VIDEO_METADATA : JobName.EXIF_EXTRACTION;
+      await this.jobRepository.queue({ name, data: { asset } });
+    } catch (error: any) {
+      this.logger.error(`Unable to queue metadata extraction`, error?.stack);
+    }
+  }
+
+  @Process(JobName.SIDECAR_DISCOVERY)
+  async handleSidecarDiscovery(job: Job<IAssetJob>) {
+    let { asset } = job.data;
+    if (!asset.isVisible) {
+      return;
+    }
+
+    if (asset.sidecarPath) {
+      return;
+    }
+
+    try {
+      await fs.promises.access(`${asset.originalPath}.xmp`, fs.constants.W_OK);
+
+      try {
+        asset = await this.assetCore.save({ id: asset.id, sidecarPath: `${asset.originalPath}.xmp` });
+        // TODO: optimize to only queue assets with recent xmp changes
+        const name = asset.type === AssetType.VIDEO ? JobName.EXTRACT_VIDEO_METADATA : JobName.EXIF_EXTRACTION;
+        await this.jobRepository.queue({ name, data: { asset } });
+      } catch (error: any) {
+        this.logger.error(`Unable to sync sidecar`, error?.stack);
+      }
+    } catch (error: any) {
+      if (error.code == 'EACCES') {
+        this.logger.error(`Unable to queue metadata extraction, file is not writable`, error?.stack);
+      }
+
+      return;
+    }
+  }
+}
--- a/server/immich-openapi-specs.json
+++ b/server/immich-openapi-specs.json
@ -4913,6 +4913,9 @@
          },
          "recognize-faces-queue": {
            "$ref": "#/components/schemas/JobStatusDto"
+          },
+          "sidecar-queue": {
+            "$ref": "#/components/schemas/JobStatusDto"
          }
        },
        "required": [
@ -4924,7 +4927,8 @@
          "storage-template-migration-queue",
          "background-task-queue",
          "search-queue",
-          "recognize-faces-queue"
+          "recognize-faces-queue",
+          "sidecar-queue"
        ]
      },
      "JobName": {
@ -4938,7 +4942,8 @@
          "clip-encoding-queue",
          "background-task-queue",
          "storage-template-migration-queue",
-          "search-queue"
+          "search-queue",
+          "sidecar-queue"
        ]
      },
      "JobCommand": {
@ -5708,6 +5713,10 @@
            "type": "string",
            "format": "binary"
          },
+          "sidecarData": {
+            "type": "string",
+            "format": "binary"
+          },
          "deviceAssetId": {
            "type": "string"
          },
--- a/server/libs/domain/src/asset/asset.repository.ts
+++ b/server/libs/domain/src/asset/asset.repository.ts
@ -30,6 +30,11 @@ export enum WithoutProperty {
  CLIP_ENCODING = 'clip-embedding',
  OBJECT_TAGS = 'object-tags',
  FACES = 'faces',
+  SIDECAR = 'sidecar',
+}
+
+export enum WithProperty {
+  SIDECAR = 'sidecar',
 }

 export const IAssetRepository = 'IAssetRepository';
@ -37,6 +42,7 @@ export const IAssetRepository = 'IAssetRepository';
 export interface IAssetRepository {
  getByIds(ids: string[]): Promise<AssetEntity[]>;
  getWithout(pagination: PaginationOptions, property: WithoutProperty): Paginated<AssetEntity>;
+  getWith(pagination: PaginationOptions, property: WithProperty): Paginated<AssetEntity>;
  getFirstAssetForAlbumId(albumId: string): Promise<AssetEntity | null>;
  deleteAll(ownerId: string): Promise<void>;
  getAll(pagination: PaginationOptions, options?: AssetSearchOptions): Paginated<AssetEntity>;
--- a/server/libs/domain/src/job/job.constants.ts
+++ b/server/libs/domain/src/job/job.constants.ts
@ -8,6 +8,7 @@ export enum QueueName {
  BACKGROUND_TASK = 'background-task-queue',
  STORAGE_TEMPLATE_MIGRATION = 'storage-template-migration-queue',
  SEARCH = 'search-queue',
+  SIDECAR = 'sidecar-queue',
 }

 export enum JobCommand {
@ -72,6 +73,11 @@ export enum JobName {
  // clip
  QUEUE_ENCODE_CLIP = 'queue-clip-encode',
  ENCODE_CLIP = 'clip-encode',
+
+  // XMP sidecars
+  QUEUE_SIDECAR = 'queue-sidecar',
+  SIDECAR_DISCOVERY = 'sidecar-discovery',
+  SIDECAR_SYNC = 'sidecar-sync',
 }

 export const JOBS_ASSET_PAGINATION_SIZE = 1000;
--- a/server/libs/domain/src/job/job.repository.ts
+++ b/server/libs/domain/src/job/job.repository.ts
@ -50,6 +50,11 @@ export type JobItem =
  | { name: JobName.EXIF_EXTRACTION; data: IAssetJob }
  | { name: JobName.EXTRACT_VIDEO_METADATA; data: IAssetJob }

+  // Sidecar Scanning
+  | { name: JobName.QUEUE_SIDECAR; data: IBaseJob }
+  | { name: JobName.SIDECAR_DISCOVERY; data: IAssetJob }
+  | { name: JobName.SIDECAR_SYNC; data: IAssetJob }
+
  // Object Tagging
  | { name: JobName.QUEUE_OBJECT_TAGGING; data: IBaseJob }
  | { name: JobName.DETECT_OBJECTS; data: IAssetJob }
--- a/server/libs/domain/src/job/job.service.spec.ts
+++ b/server/libs/domain/src/job/job.service.spec.ts
@ -67,6 +67,7 @@ describe(JobService.name, () => {
        'thumbnail-generation-queue': expectedJobStatus,
        'video-conversion-queue': expectedJobStatus,
        'recognize-faces-queue': expectedJobStatus,
+        'sidecar-queue': expectedJobStatus,
      });
    });
  });
--- a/server/libs/domain/src/job/job.service.ts
+++ b/server/libs/domain/src/job/job.service.ts
@ -76,6 +76,9 @@ export class JobService {
      case QueueName.METADATA_EXTRACTION:
        return this.jobRepository.queue({ name: JobName.QUEUE_METADATA_EXTRACTION, data: { force } });

+      case QueueName.SIDECAR:
+        return this.jobRepository.queue({ name: JobName.QUEUE_SIDECAR, data: { force } });
+
      case QueueName.THUMBNAIL_GENERATION:
        return this.jobRepository.queue({ name: JobName.QUEUE_GENERATE_THUMBNAILS, data: { force } });

--- a/server/libs/domain/src/job/response-dto/all-job-status-response.dto.ts
+++ b/server/libs/domain/src/job/response-dto/all-job-status-response.dto.ts
@ -56,4 +56,7 @@ export class AllJobStatusResponseDto implements Record<QueueName, JobStatusDto>

  @ApiProperty({ type: JobStatusDto })
  [QueueName.RECOGNIZE_FACES]!: JobStatusDto;
+
+  @ApiProperty({ type: JobStatusDto })
+  [QueueName.SIDECAR]!: JobStatusDto;
 }
--- a/server/libs/domain/src/storage-template/storage-template.service.ts
+++ b/server/libs/domain/src/storage-template/storage-template.service.ts
@ -82,14 +82,32 @@ export class StorageTemplateService {
    if (asset.originalPath !== destination) {
      const source = asset.originalPath;

+      let sidecarMoved = false;
      try {
        await this.storageRepository.moveFile(asset.originalPath, destination);
+
+        let sidecarDestination;
        try {
-          await this.assetRepository.save({ id: asset.id, originalPath: destination });
+          if (asset.sidecarPath) {
+            sidecarDestination = `${destination}.xmp`;
+            await this.storageRepository.moveFile(asset.sidecarPath, sidecarDestination);
+            sidecarMoved = true;
+          }
+
+          await this.assetRepository.save({ id: asset.id, originalPath: destination, sidecarPath: sidecarDestination });
          asset.originalPath = destination;
+          asset.sidecarPath = sidecarDestination || null;
        } catch (error: any) {
          this.logger.warn('Unable to save new originalPath to database, undoing move', error?.stack);
+
+          // Either sidecar move failed or the save failed. Eithr way, move media back
          await this.storageRepository.moveFile(destination, source);
+
+          if (asset.sidecarPath && sidecarDestination && sidecarMoved) {
+            // If the sidecar was moved, that means the saved failed. So move both the sidecar and the
+            // media back into their original positions
+            await this.storageRepository.moveFile(sidecarDestination, asset.sidecarPath);
+          }
        }
      } catch (error: any) {
        this.logger.error(`Problem applying storage template`, error?.stack, { id: asset.id, source, destination });
--- a/server/libs/domain/test/asset.repository.mock.ts
+++ b/server/libs/domain/test/asset.repository.mock.ts
@ -4,6 +4,7 @@ export const newAssetRepositoryMock = (): jest.Mocked<IAssetRepository> => {
  return {
    getByIds: jest.fn(),
    getWithout: jest.fn(),
+    getWith: jest.fn(),
    getFirstAssetForAlbumId: jest.fn(),
    getAll: jest.fn().mockResolvedValue({
      items: [],
--- a/server/libs/domain/test/fixtures.ts
+++ b/server/libs/domain/test/fixtures.ts
@ -163,6 +163,7 @@ export const assetEntityStub = {
    tags: [],
    sharedLinks: [],
    faces: [],
+    sidecarPath: null,
  }),
  image: Object.freeze<AssetEntity>({
    id: 'asset-id',
@ -191,6 +192,7 @@ export const assetEntityStub = {
    sharedLinks: [],
    originalFileName: 'asset-id.ext',
    faces: [],
+    sidecarPath: null,
  }),
  video: Object.freeze<AssetEntity>({
    id: 'asset-id',
@ -219,6 +221,7 @@ export const assetEntityStub = {
    tags: [],
    sharedLinks: [],
    faces: [],
+    sidecarPath: null,
  }),
  livePhotoMotionAsset: Object.freeze({
    id: 'live-photo-motion-asset',
@ -252,6 +255,7 @@ export const assetEntityStub = {
    checksum: Buffer.from('file hash', 'utf8'),
    originalPath: '/original/path.ext',
    resizePath: '/uploads/user-id/thumbs/path.ext',
+    sidecarPath: null,
    type: AssetType.IMAGE,
    webpPath: null,
    encodedVideoPath: null,
@ -719,6 +723,7 @@ export const sharedLinkStub = {
          tags: [],
          sharedLinks: [],
          faces: [],
+          sidecarPath: null,
        },
      ],
    },
--- a/server/libs/infra/src/entities/asset.entity.ts
+++ b/server/libs/infra/src/entities/asset.entity.ts
@ -95,6 +95,9 @@ export class AssetEntity {
  @Column({ type: 'varchar' })
  originalFileName!: string;

+  @Column({ type: 'varchar', nullable: true })
+  sidecarPath!: string | null;
+
  @OneToOne(() => ExifEntity, (exifEntity) => exifEntity.asset)
  exifInfo?: ExifEntity;

--- a/server/libs/infra/src/migrations/1684273840676-AddSidecarFile.ts
+++ b/server/libs/infra/src/migrations/1684273840676-AddSidecarFile.ts
@ -0,0 +1,14 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class AddSidecarFile1684273840676 implements MigrationInterface {
+    name = 'AddSidecarFile1684273840676'
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "assets" ADD "sidecarPath" character varying`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "assets" DROP COLUMN "sidecarPath"`);
+    }
+
+}
--- a/server/libs/infra/src/repositories/asset.repository.ts
+++ b/server/libs/infra/src/repositories/asset.repository.ts
@ -7,6 +7,7 @@ import {
  Paginated,
  PaginationOptions,
  WithoutProperty,
+  WithProperty,
 } from '@app/domain';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
@ -161,6 +162,13 @@ export class AssetRepository implements IAssetRepository {
        };
        break;

+      case WithoutProperty.SIDECAR:
+        where = [
+          { sidecarPath: IsNull(), isVisible: true },
+          { sidecarPath: '', isVisible: true },
+        ];
+        break;
+
      default:
        throw new Error(`Invalid getWithout property: ${property}`);
    }
@ -175,6 +183,27 @@ export class AssetRepository implements IAssetRepository {
    });
  }

+  getWith(pagination: PaginationOptions, property: WithProperty): Paginated<AssetEntity> {
+    let where: FindOptionsWhere<AssetEntity> | FindOptionsWhere<AssetEntity>[] = {};
+
+    switch (property) {
+      case WithProperty.SIDECAR:
+        where = [{ sidecarPath: Not(IsNull()), isVisible: true }];
+        break;
+
+      default:
+        throw new Error(`Invalid getWith property: ${property}`);
+    }
+
+    return paginate(this.repository, pagination, {
+      where,
+      order: {
+        // Ensures correct order when paginating
+        createdAt: 'ASC',
+      },
+    });
+  }
+
  getFirstAssetForAlbumId(albumId: string): Promise<AssetEntity | null> {
    return this.repository.findOne({
      where: { albums: { id: albumId } },
--- a/server/libs/infra/src/repositories/job.repository.ts
+++ b/server/libs/infra/src/repositories/job.repository.ts
@ -15,6 +15,7 @@ export class JobRepository implements IJobRepository {
    [QueueName.VIDEO_CONVERSION]: this.videoTranscode,
    [QueueName.BACKGROUND_TASK]: this.backgroundTask,
    [QueueName.SEARCH]: this.searchIndex,
+    [QueueName.SIDECAR]: this.sidecar,
  };

  constructor(
@ -27,6 +28,7 @@ export class JobRepository implements IJobRepository {
    @InjectQueue(QueueName.THUMBNAIL_GENERATION) private generateThumbnail: Queue,
    @InjectQueue(QueueName.VIDEO_CONVERSION) private videoTranscode: Queue<IAssetJob | IBaseJob>,
    @InjectQueue(QueueName.SEARCH) private searchIndex: Queue,
+    @InjectQueue(QueueName.SIDECAR) private sidecar: Queue<IBaseJob>,
  ) {}

  async getQueueStatus(name: QueueName): Promise<QueueStatus> {
@ -83,6 +85,12 @@ export class JobRepository implements IJobRepository {
        await this.metadataExtraction.add(item.name, item.data);
        break;

+      case JobName.QUEUE_SIDECAR:
+      case JobName.SIDECAR_DISCOVERY:
+      case JobName.SIDECAR_SYNC:
+        await this.sidecar.add(item.name, item.data);
+        break;
+
      case JobName.QUEUE_RECOGNIZE_FACES:
      case JobName.RECOGNIZE_FACES:
        await this.recognizeFaces.add(item.name, item.data);