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>

mobile/openapi/doc/AllJobStatusResponseDto.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **backgroundTaskQueue** | [**JobStatusDto**](JobStatusDto.md) |  | 
 **searchQueue** | [**JobStatusDto**](JobStatusDto.md) |  | 
 **recognizeFacesQueue** | [**JobStatusDto**](JobStatusDto.md) |  | 
+**sidecarQueue** | [**JobStatusDto**](JobStatusDto.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

mobile/openapi/doc/AssetApi.md

@@ -1443,7 +1443,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **uploadFile**
-> AssetFileUploadResponseDto uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, isArchived, isVisible, duration)
+> AssetFileUploadResponseDto uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, sidecarData, isArchived, isVisible, duration)
 
 
 
@@ -1476,12 +1476,13 @@ final isFavorite = true; // bool |
 final fileExtension = fileExtension_example; // String | 
 final key = key_example; // String | 
 final livePhotoData = BINARY_DATA_HERE; // MultipartFile | 
+final sidecarData = BINARY_DATA_HERE; // MultipartFile | 
 final isArchived = true; // bool | 
 final isVisible = true; // bool | 
 final duration = duration_example; // String | 
 
 try {
-    final result = api_instance.uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, isArchived, isVisible, duration);
+    final result = api_instance.uploadFile(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension, key, livePhotoData, sidecarData, isArchived, isVisible, duration);
     print(result);
 } catch (e) {
     print('Exception when calling AssetApi->uploadFile: $e\n');
@@ -1502,6 +1503,7 @@ Name | Type | Description  | Notes
  **fileExtension** | **String**|  | 
  **key** | **String**|  | [optional] 
  **livePhotoData** | **MultipartFile**|  | [optional] 
+ **sidecarData** | **MultipartFile**|  | [optional] 
  **isArchived** | **bool**|  | [optional] 
  **isVisible** | **bool**|  | [optional] 
  **duration** | **String**|  | [optional] 

mobile/openapi/lib/api/asset_api.dart

@@ -1396,12 +1396,14 @@ class AssetApi {
   ///
   /// * [MultipartFile] livePhotoData:
   ///
+  /// * [MultipartFile] sidecarData:
+  ///
   /// * [bool] isArchived:
   ///
   /// * [bool] isVisible:
   ///
   /// * [String] duration:
-  Future<Response> uploadFileWithHttpInfo(AssetTypeEnum assetType, MultipartFile assetData, String deviceAssetId, String deviceId, String fileCreatedAt, String fileModifiedAt, bool isFavorite, String fileExtension, { String? key, MultipartFile? livePhotoData, bool? isArchived, bool? isVisible, String? duration, }) async {
+  Future<Response> uploadFileWithHttpInfo(AssetTypeEnum assetType, MultipartFile assetData, String deviceAssetId, String deviceId, String fileCreatedAt, String fileModifiedAt, bool isFavorite, String fileExtension, { String? key, MultipartFile? livePhotoData, MultipartFile? sidecarData, bool? isArchived, bool? isVisible, String? duration, }) async {
     // ignore: prefer_const_declarations
     final path = r'/asset/upload';
 
@@ -1434,6 +1436,11 @@ class AssetApi {
       mp.fields[r'livePhotoData'] = livePhotoData.field;
       mp.files.add(livePhotoData);
     }
+    if (sidecarData != null) {
+      hasFields = true;
+      mp.fields[r'sidecarData'] = sidecarData.field;
+      mp.files.add(sidecarData);
+    }
     if (deviceAssetId != null) {
       hasFields = true;
       mp.fields[r'deviceAssetId'] = parameterToString(deviceAssetId);
@@ -1507,13 +1514,15 @@ class AssetApi {
   ///
   /// * [MultipartFile] livePhotoData:
   ///
+  /// * [MultipartFile] sidecarData:
+  ///
   /// * [bool] isArchived:
   ///
   /// * [bool] isVisible:
   ///
   /// * [String] duration:
-  Future<AssetFileUploadResponseDto?> uploadFile(AssetTypeEnum assetType, MultipartFile assetData, String deviceAssetId, String deviceId, String fileCreatedAt, String fileModifiedAt, bool isFavorite, String fileExtension, { String? key, MultipartFile? livePhotoData, bool? isArchived, bool? isVisible, String? duration, }) async {
-    final response = await uploadFileWithHttpInfo(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension,  key: key, livePhotoData: livePhotoData, isArchived: isArchived, isVisible: isVisible, duration: duration, );
+  Future<AssetFileUploadResponseDto?> uploadFile(AssetTypeEnum assetType, MultipartFile assetData, String deviceAssetId, String deviceId, String fileCreatedAt, String fileModifiedAt, bool isFavorite, String fileExtension, { String? key, MultipartFile? livePhotoData, MultipartFile? sidecarData, bool? isArchived, bool? isVisible, String? duration, }) async {
+    final response = await uploadFileWithHttpInfo(assetType, assetData, deviceAssetId, deviceId, fileCreatedAt, fileModifiedAt, isFavorite, fileExtension,  key: key, livePhotoData: livePhotoData, sidecarData: sidecarData, isArchived: isArchived, isVisible: isVisible, duration: duration, );
     if (response.statusCode >= HttpStatus.badRequest) {
       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
     }

mobile/openapi/lib/model/all_job_status_response_dto.dart

@@ -22,6 +22,7 @@ class AllJobStatusResponseDto {
     required this.backgroundTaskQueue,
     required this.searchQueue,
     required this.recognizeFacesQueue,
+    required this.sidecarQueue,
   });
 
   JobStatusDto thumbnailGenerationQueue;
@@ -42,6 +43,8 @@ class AllJobStatusResponseDto {
 
   JobStatusDto recognizeFacesQueue;
 
+  JobStatusDto sidecarQueue;
+
   @override
   bool operator ==(Object other) => identical(this, other) || other is AllJobStatusResponseDto &&
      other.thumbnailGenerationQueue == thumbnailGenerationQueue &&
@@ -52,7 +55,8 @@ class AllJobStatusResponseDto {
      other.storageTemplateMigrationQueue == storageTemplateMigrationQueue &&
      other.backgroundTaskQueue == backgroundTaskQueue &&
      other.searchQueue == searchQueue &&
-     other.recognizeFacesQueue == recognizeFacesQueue;
+     other.recognizeFacesQueue == recognizeFacesQueue &&
+     other.sidecarQueue == sidecarQueue;
 
   @override
   int get hashCode =>
@@ -65,10 +69,11 @@ class AllJobStatusResponseDto {
     (storageTemplateMigrationQueue.hashCode) +
     (backgroundTaskQueue.hashCode) +
     (searchQueue.hashCode) +
-    (recognizeFacesQueue.hashCode);
+    (recognizeFacesQueue.hashCode) +
+    (sidecarQueue.hashCode);
 
   @override
-  String toString() => 'AllJobStatusResponseDto[thumbnailGenerationQueue=$thumbnailGenerationQueue, metadataExtractionQueue=$metadataExtractionQueue, videoConversionQueue=$videoConversionQueue, objectTaggingQueue=$objectTaggingQueue, clipEncodingQueue=$clipEncodingQueue, storageTemplateMigrationQueue=$storageTemplateMigrationQueue, backgroundTaskQueue=$backgroundTaskQueue, searchQueue=$searchQueue, recognizeFacesQueue=$recognizeFacesQueue]';
+  String toString() => 'AllJobStatusResponseDto[thumbnailGenerationQueue=$thumbnailGenerationQueue, metadataExtractionQueue=$metadataExtractionQueue, videoConversionQueue=$videoConversionQueue, objectTaggingQueue=$objectTaggingQueue, clipEncodingQueue=$clipEncodingQueue, storageTemplateMigrationQueue=$storageTemplateMigrationQueue, backgroundTaskQueue=$backgroundTaskQueue, searchQueue=$searchQueue, recognizeFacesQueue=$recognizeFacesQueue, sidecarQueue=$sidecarQueue]';
 
   Map<String, dynamic> toJson() {
     final json = <String, dynamic>{};
@@ -81,6 +86,7 @@ class AllJobStatusResponseDto {
       json[r'background-task-queue'] = this.backgroundTaskQueue;
       json[r'search-queue'] = this.searchQueue;
       json[r'recognize-faces-queue'] = this.recognizeFacesQueue;
+      json[r'sidecar-queue'] = this.sidecarQueue;
     return json;
   }
 
@@ -112,6 +118,7 @@ class AllJobStatusResponseDto {
         backgroundTaskQueue: JobStatusDto.fromJson(json[r'background-task-queue'])!,
         searchQueue: JobStatusDto.fromJson(json[r'search-queue'])!,
         recognizeFacesQueue: JobStatusDto.fromJson(json[r'recognize-faces-queue'])!,
+        sidecarQueue: JobStatusDto.fromJson(json[r'sidecar-queue'])!,
       );
     }
     return null;
@@ -168,6 +175,7 @@ class AllJobStatusResponseDto {
     'background-task-queue',
     'search-queue',
     'recognize-faces-queue',
+    'sidecar-queue',
   };
 }
 

mobile/openapi/lib/model/job_name.dart

@@ -32,6 +32,7 @@ class JobName {
   static const backgroundTaskQueue = JobName._(r'background-task-queue');
   static const storageTemplateMigrationQueue = JobName._(r'storage-template-migration-queue');
   static const searchQueue = JobName._(r'search-queue');
+  static const sidecarQueue = JobName._(r'sidecar-queue');
 
   /// List of all possible values in this [enum][JobName].
   static const values = <JobName>[
@@ -44,6 +45,7 @@ class JobName {
     backgroundTaskQueue,
     storageTemplateMigrationQueue,
     searchQueue,
+    sidecarQueue,
   ];
 
   static JobName? fromJson(dynamic value) => JobNameTypeTransformer().decode(value);
@@ -91,6 +93,7 @@ class JobNameTypeTransformer {
         case r'background-task-queue': return JobName.backgroundTaskQueue;
         case r'storage-template-migration-queue': return JobName.storageTemplateMigrationQueue;
         case r'search-queue': return JobName.searchQueue;
+        case r'sidecar-queue': return JobName.sidecarQueue;
         default:
           if (!allowNull) {
             throw ArgumentError('Unknown enum value to decode: $data');

mobile/openapi/test/all_job_status_response_dto_test.dart

@@ -61,6 +61,11 @@ void main() {
       // TODO
     });
 
+    // JobStatusDto sidecarQueue
+    test('to test the property `sidecarQueue`', () async {
+      // TODO
+    });
+
 
   });
 

mobile/openapi/test/asset_api_test.dart

@@ -158,7 +158,7 @@ void main() {
       // TODO
     });
 
-    //Future<AssetFileUploadResponseDto> uploadFile(AssetTypeEnum assetType, MultipartFile assetData, String deviceAssetId, String deviceId, String fileCreatedAt, String fileModifiedAt, bool isFavorite, String fileExtension, { String key, MultipartFile livePhotoData, bool isArchived, bool isVisible, String duration }) async
+    //Future<AssetFileUploadResponseDto> uploadFile(AssetTypeEnum assetType, MultipartFile assetData, String deviceAssetId, String deviceId, String fileCreatedAt, String fileModifiedAt, bool isFavorite, String fileExtension, { String key, MultipartFile livePhotoData, MultipartFile sidecarData, bool isArchived, bool isVisible, String duration }) async
     test('test uploadFile', () async {
       // TODO
     });