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>

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;
 

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"`);
+    }
+
+}

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 } },

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);