feat(server): xmp sidecar metadata #2466

alex-phillips · 2023-05-17T23:46:10Z

This PR adds support for ingesting metadata from XMP sidecar files.

If an XMP sidecar exists with a media file, it is assumed that the XMP file takes priority and all metadata is read from the file.
XMP sidecars can now be uploaded with the initial media files via the API.
"All" metadata scans check for the presence of new sidecar files if the media file does not have a sidecar file associated with it. This allows the creation of metadata files from third party software such as Digikam or Adobe Lightroom.
"Missing" metadata scans include media assets that do not have a sidecar file associated with them. It attempts to find the sidecar in the filesystem and associates that sidecar file with the asset in the future.
The XMP sidecar path is stored along with the media asset with a reference to its filepath.

…idecar files, now detects sidecar files in the filesystem for media already ingested but the sidecar was created afterwards

vercel · 2023-05-17T23:46:15Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
immich	⬜️ Ignored (Inspect)	Visit Preview		May 24, 2023 9:32pm

…tcome is to move the media back anyway

server/apps/immich/src/api-v1/asset/asset.core.ts

server/apps/microservices/src/processors/metadata-extraction.processor.ts

server/libs/domain/src/storage-template/storage-template.service.ts

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

… the new job queueing

…h the logic is almost identical aside from linking the sidecar

…me between discovery and sync

jrasm91

Looking good! Have you run any of the linting checks? You should look at server/package.json or the contributing docs and run all the check commands to lint and format, and test the code (both web and UI).

server/apps/microservices/src/processors/metadata-extraction.processor.ts

server/libs/domain/src/job/job.repository.ts

server/libs/domain/src/storage-template/storage-template.service.ts

jrasm91 · 2023-05-20T00:01:47Z

server/apps/microservices/src/processors/metadata-extraction.processor.ts

+
+@Processor(QueueName.SIDECAR)
+export class SidecarProcessor {
+  private logger = new Logger(SidecarProcessor.name);
+  private assetCore: AssetCore;
+


The code in domain/ is basically refactored code, this code here hasn't been updated and doesn't have any tests for it yet. Eventually the thought is to move all the logic out of this file into a domain/media/media.service.ts file. If you're up for that, it would be the place to put it. Otherwise, I can move it after it's merged (refactored processors are in processors.ts and a new service would need to be exported in domain.module.ts). If not, no worries.

server/apps/microservices/src/processors/metadata-extraction.processor.ts

jrasm91 · 2023-05-20T00:23:37Z

Can you attach a few screenshots? One of the files in library/ (with xmp) and one of the new job? Thanks.

alex-phillips · 2023-05-20T11:36:48Z

Screenshot of sidecars in place after library upload:

Screenshot of the new jobs section:

…d of passing in every time

…lbacks, fixed typo, used generic in function for better type checking

…ave failure

vercel · 2023-05-21T13:46:54Z

@alex-phillips is attempting to deploy a commit to the immich Team on Vercel.

A member of the Team first needs to authorize it.

alextran1502 · 2023-05-21T16:03:03Z

Can you help update the documentation on how we can use this feature?

alex-phillips · 2023-05-22T21:14:08Z

Can you help update the documentation on how we can use this feature?

Added documentation and included some of the images in it as well. Let me know if I should elaborate on anything or include more details.

alextran1502 · 2023-05-22T21:31:33Z

@alex-phillips Thank you. There are some typo in the documentation, you can copy and paste the paragraph below to fix

There are 2 administrator jobs associated with sidecar files: `SYNC` and `DISCOVER`. The sync job will re-scan all media with existing sidecar files and queue them for a metadata refresh. This is a great use case when third-party applications are used to modify the metadata of media. The discover job will attempt to scan the filesystem for new sidecar files for all media that does not currently have a sidecar file associated with it.

Can you also help resolve the conflicts?

Thank you

alextran1502 · 2023-05-24T15:33:59Z

Is there something wrong with the merge conflict? Looks like there are problems after the conflicts are resolved.

web/src/lib/components/admin-page/jobs/jobs-panel.svelte

server/apps/microservices/src/processors/metadata-extraction.processor.ts

web/src/lib/components/admin-page/jobs/jobs-panel.svelte

alextran1502

Thank you for the high-quality PR! And sorry for the constant new changes to the main branch :P

alextran1502

Thank you for the high-quality PR! And sorry for the constant new changes to the main branch :P

alex-phillips added 4 commits May 17, 2023 10:21

initial commit for XMP sidecar support

df6df1a

Added support for 'missing' metadata files to include those without s…

8ed2003

…idecar 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

50454e9

new sidecar logic for video metadata as well

5732251

alex-phillips mentioned this pull request May 17, 2023

Added support for uploading sidecars with media files immich-app/CLI#85

Merged

alex-phillips added 5 commits May 17, 2023 19:50

Merge branch 'main' into xmp-sidecars

c33eaf9

Added xml mimetype for sidecars only

5e3ab35

don't need capture group for this regex

f9920ee

wrong default value reverted

1803ec5

simplified the move here - keep it in the same try catch since the ou…

84602b7

…tcome is to move the media back anyway

jrasm91 reviewed May 18, 2023

View reviewed changes

alex-phillips and others added 7 commits May 17, 2023 20:41

simplified setter logic

bda9918

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

simplified logic per suggestions

4346d1b

sidecar is now its own queue with a discover and sync, updated UI for…

9e8aab2

… the new job queueing

queue a sidecar job for every asset based on discovery or sync, thoug…

4b84ebe

…h the logic is almost identical aside from linking the sidecar

now queue sidecar jobs for each assset, though logic is mostly the sa…

39ef43c

…me between discovery and sync

simplified logic of filename extraction and asset instantiation

8b0a773

not sure how that got deleted..

43ce0b7

jrasm91 reviewed May 20, 2023

View reviewed changes

updated code per suggestions and comments in the PR

9ffb38a

alex-phillips added 7 commits May 20, 2023 08:06

stat was not being used, removed the variable set

36e780f

better type checking, using in-scope variables for exif getter instea…

ef9ebac

…d of passing in every time

removed commented out test

33b4d3c

ran and resolved all lints, formats, checks, and tests

208653f

resolved suggested change in PR

f141da9

made getExifProperty more dynamic with multiple possible args for fal…

5aed905

…lbacks, fixed typo, used generic in function for better type checking

better error handling and moving files back to positions on move or s…

0d51233

…ave failure

jrasm91 approved these changes May 20, 2023

View reviewed changes

Merged in main

40a5fa5

vercel bot temporarily deployed to Preview May 20, 2023 19:44 Inactive

regenerated api

f3f255d

Merge branch 'main' into xmp-sidecars

52be700

vercel bot temporarily deployed to Preview May 21, 2023 13:51 Inactive

format fixes

7a2be55

Added XMP documentation

faa2d8f

vercel bot temporarily deployed to Preview May 22, 2023 21:14 Inactive

documentation typo

a89e4eb

vercel bot temporarily deployed to Preview May 23, 2023 01:50 Inactive

alex-phillips added 2 commits May 23, 2023 12:02

Merged in main

acfc04b

merged in main

327a912

jrasm91 reviewed May 24, 2023

View reviewed changes

web/src/lib/components/admin-page/jobs/jobs-panel.svelte Outdated Show resolved Hide resolved

missed merge conflict

6b7136f

jrasm91 reviewed May 24, 2023

View reviewed changes

server/apps/microservices/src/processors/metadata-extraction.processor.ts Outdated Show resolved Hide resolved

jrasm91 reviewed May 24, 2023

View reviewed changes

web/src/lib/components/admin-page/jobs/jobs-panel.svelte Show resolved Hide resolved

alex-phillips added 4 commits May 24, 2023 16:58

more changes due to a merge

9dc4549

merged in main

1337eaf

Resolving conflicts

1602d5a

added icon for sidecar jobs

b90d482

alextran1502 approved these changes May 25, 2023

View reviewed changes

alextran1502 merged commit 7c1dae9 into immich-app:main May 25, 2023
18 checks passed

jrasm91 mentioned this pull request May 29, 2023

[BUG] Sidecar metadata not getting backed up on iOS Immich #1941

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(server): xmp sidecar metadata #2466

feat(server): xmp sidecar metadata #2466

alex-phillips commented May 17, 2023 •

edited

vercel bot commented May 17, 2023 •

edited

jrasm91 left a comment

jrasm91 May 20, 2023

jrasm91 commented May 20, 2023

alex-phillips commented May 20, 2023

vercel bot commented May 21, 2023

alextran1502 commented May 21, 2023 •

edited

alex-phillips commented May 22, 2023

alextran1502 commented May 22, 2023

alextran1502 commented May 24, 2023

alextran1502 left a comment

alextran1502 left a comment

feat(server): xmp sidecar metadata #2466

feat(server): xmp sidecar metadata #2466

Conversation

alex-phillips commented May 17, 2023 • edited

vercel bot commented May 17, 2023 • edited

jrasm91 left a comment

Choose a reason for hiding this comment

jrasm91 May 20, 2023

Choose a reason for hiding this comment

jrasm91 commented May 20, 2023

alex-phillips commented May 20, 2023

vercel bot commented May 21, 2023

alextran1502 commented May 21, 2023 • edited

alex-phillips commented May 22, 2023

alextran1502 commented May 22, 2023

alextran1502 commented May 24, 2023

alextran1502 left a comment

Choose a reason for hiding this comment

alextran1502 left a comment

Choose a reason for hiding this comment

alex-phillips commented May 17, 2023 •

edited

vercel bot commented May 17, 2023 •

edited

alextran1502 commented May 21, 2023 •

edited