Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(server): handle numeric 'Image Description' and 'Description' values #11636

Merged
merged 2 commits into from
Aug 7, 2024
Merged

fix(server): handle numeric 'Image Description' and 'Description' values #11636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da77694
Made 'Image Description' and 'Description' type safe during exif parsing
jo-gross Aug 7, 2024
c749693
add test + update types
michelheusschen Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion server/src/interfaces/metadata.interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export interface ExifDuration {
Scale?: number;
}

export interface ImmichTags extends Omit<Tags, 'FocalLength' | 'Duration'> {
export interface ImmichTags extends Omit<Tags, 'FocalLength' | 'Duration' | 'Description' | 'ImageDescription'> {
ContentIdentifier?: string;
MotionPhoto?: number;
MotionPhotoVersion?: number;
Expand All @@ -19,6 +19,10 @@ export interface ImmichTags extends Omit<Tags, 'FocalLength' | 'Duration'> {
EmbeddedVideoType?: string;
EmbeddedVideoFile?: BinaryField;
MotionPhotoVideo?: BinaryField;

// Type is wrong, can also be number.
Description?: string | number;
ImageDescription?: string | number;
}

export interface IMetadataRepository {
Expand Down
12 changes: 12 additions & 0 deletions server/src/services/metadata.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,6 +753,18 @@ describe(MetadataService.name, () => {
}),
);
});

it('handles a numeric description', async () => {
assetMock.getByIds.mockResolvedValue([assetStub.image]);
metadataMock.readTags.mockResolvedValue({ Description: 1000 });

await sut.handleMetadataExtraction({ id: assetStub.image.id });
expect(assetMock.upsertExif).toHaveBeenCalledWith(
expect.objectContaining({
description: '1000',
}),
);
});
});

describe('handleQueueSidecar', () => {
Expand Down
2 changes: 1 addition & 1 deletion server/src/services/metadata.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@ export class MetadataService implements OnEvents {
bitsPerSample: this.getBitsPerSample(tags),
colorspace: tags.ColorSpace ?? null,
dateTimeOriginal: this.getDateTimeOriginal(tags) ?? asset.fileCreatedAt,
description: (tags.ImageDescription || tags.Description || '').trim(),
description: String(tags.ImageDescription || tags.Description || '').trim(),
exifImageHeight: validate(tags.ImageHeight),
exifImageWidth: validate(tags.ImageWidth),
exposureTime: tags.ExposureTime ?? null,
Expand Down
Loading