feat: set person birth date (web only) (#3721)

* Person birth date (data layer)

* Person birth date (data layer)

* Person birth date (service layer)

* Person birth date (service layer, API)

* Person birth date (service layer, API)

* Person birth date (UI) (wip)

* Person birth date (UI) (wip)

* Person birth date (UI) (wip)

* Person birth date (UI) (wip)

* UI: Use "date of birth" everywhere

* UI: better modal dialog

Similar to the API key modal.

* UI: set date of birth from people page

* Use typed events for modal dispatcher

* Date of birth tests (wip)

* Regenerate API

* Code formatting

* Fix Svelte typing

* Fix Svelte typing

* Fix person model [skip ci]

* Minor refactoring [skip ci]

* Typed event dispatcher [skip ci]

* Refactor typed event dispatcher [skip ci]

* Fix unchanged birthdate check [skip ci]

* Remove unnecessary custom transformer [skip ci]

* PersonUpdate: call search index update job only when needed

* Regenerate API

* Code formatting

* Fix tests

* Fix DTO

* Regenerate API

* chore: verbiage and view mode

* feat: show current age

* test: person e2e

* fix: show name for birth date selection

---------

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

server/immich-openapi-specs.json

@@ -6176,6 +6176,12 @@
       },
       "PeopleUpdateItem": {
         "properties": {
+          "birthDate": {
+            "description": "Person date of birth.",
+            "format": "date",
+            "nullable": true,
+            "type": "string"
+          },
           "featureFaceAssetId": {
             "description": "Asset is used to get the feature face thumbnail.",
             "type": "string"
@@ -6200,6 +6206,11 @@
       },
       "PersonResponseDto": {
         "properties": {
+          "birthDate": {
+            "format": "date",
+            "nullable": true,
+            "type": "string"
+          },
           "id": {
             "type": "string"
           },
@@ -6214,6 +6225,7 @@
           }
         },
         "required": [
+          "birthDate",
           "id",
           "name",
           "thumbnailPath",
@@ -6223,6 +6235,12 @@
       },
       "PersonUpdateDto": {
         "properties": {
+          "birthDate": {
+            "description": "Person date of birth.",
+            "format": "date",
+            "nullable": true,
+            "type": "string"
+          },
           "featureFaceAssetId": {
             "description": "Asset is used to get the feature face thumbnail.",
             "type": "string"

server/src/domain/person/person.dto.ts

@@ -1,7 +1,16 @@
 import { AssetFaceEntity, PersonEntity } from '@app/infra/entities';
 import { ApiProperty } from '@nestjs/swagger';
 import { Transform, Type } from 'class-transformer';
-import { IsArray, IsBoolean, IsNotEmpty, IsOptional, IsString, ValidateNested } from 'class-validator';
+import {
+  IsArray,
+  IsBoolean,
+  IsDate,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  ValidateIf,
+  ValidateNested,
+} from 'class-validator';
 import { toBoolean, ValidateUUID } from '../domain.util';
 
 export class PersonUpdateDto {
@@ -12,6 +21,16 @@ export class PersonUpdateDto {
   @IsString()
   name?: string;
 
+  /**
+   * Person date of birth.
+   */
+  @IsOptional()
+  @IsDate()
+  @Type(() => Date)
+  @ValidateIf((value) => value !== null)
+  @ApiProperty({ format: 'date' })
+  birthDate?: Date | null;
+
   /**
    * Asset is used to get the feature face thumbnail.
    */
@@ -49,6 +68,15 @@ export class PeopleUpdateItem {
   @IsString()
   name?: string;
 
+  /**
+   * Person date of birth.
+   */
+  @IsOptional()
+  @IsDate()
+  @Type(() => Date)
+  @ApiProperty({ format: 'date' })
+  birthDate?: Date | null;
+
   /**
    * Asset is used to get the feature face thumbnail.
    */
@@ -78,6 +106,8 @@ export class PersonSearchDto {
 export class PersonResponseDto {
   id!: string;
   name!: string;
+  @ApiProperty({ format: 'date' })
+  birthDate!: Date | null;
   thumbnailPath!: string;
   isHidden!: boolean;
 }
@@ -96,6 +126,7 @@ export function mapPerson(person: PersonEntity): PersonResponseDto {
   return {
     id: person.id,
     name: person.name,
+    birthDate: person.birthDate,
     thumbnailPath: person.thumbnailPath,
     isHidden: person.isHidden,
   };

server/src/domain/person/person.service.spec.ts

@@ -18,6 +18,7 @@ import { PersonService } from './person.service';
 const responseDto: PersonResponseDto = {
   id: 'person-1',
   name: 'Person 1',
+  birthDate: null,
   thumbnailPath: '/path/to/thumbnail.jpg',
   isHidden: false,
 };
@@ -68,6 +69,7 @@ describe(PersonService.name, () => {
           {
             id: 'person-1',
             name: '',
+            birthDate: null,
             thumbnailPath: '/path/to/thumbnail.jpg',
             isHidden: true,
           },
@@ -142,6 +144,24 @@ describe(PersonService.name, () => {
       });
     });
 
+    it("should update a person's date of birth", async () => {
+      personMock.getById.mockResolvedValue(personStub.noBirthDate);
+      personMock.update.mockResolvedValue(personStub.withBirthDate);
+      personMock.getAssets.mockResolvedValue([assetStub.image]);
+
+      await expect(sut.update(authStub.admin, 'person-1', { birthDate: new Date('1976-06-30') })).resolves.toEqual({
+        id: 'person-1',
+        name: 'Person 1',
+        birthDate: new Date('1976-06-30'),
+        thumbnailPath: '/path/to/thumbnail.jpg',
+        isHidden: false,
+      });
+
+      expect(personMock.getById).toHaveBeenCalledWith('admin_id', 'person-1');
+      expect(personMock.update).toHaveBeenCalledWith({ id: 'person-1', birthDate: new Date('1976-06-30') });
+      expect(jobMock.queue).not.toHaveBeenCalled();
+    });
+
     it('should update a person visibility', async () => {
       personMock.getById.mockResolvedValue(personStub.hidden);
       personMock.update.mockResolvedValue(personStub.withName);

server/src/domain/person/person.service.ts

@@ -63,11 +63,13 @@ export class PersonService {
   async update(authUser: AuthUserDto, id: string, dto: PersonUpdateDto): Promise<PersonResponseDto> {
     let person = await this.findOrFail(authUser, id);
 
-    if (dto.name != undefined || dto.isHidden !== undefined) {
-      person = await this.repository.update({ id, name: dto.name, isHidden: dto.isHidden });
-      const assets = await this.repository.getAssets(authUser.id, id);
-      const ids = assets.map((asset) => asset.id);
-      await this.jobRepository.queue({ name: JobName.SEARCH_INDEX_ASSET, data: { ids } });
+    if (dto.name !== undefined || dto.birthDate !== undefined || dto.isHidden !== undefined) {
+      person = await this.repository.update({ id, name: dto.name, birthDate: dto.birthDate, isHidden: dto.isHidden });
+      if (this.needsSearchIndexUpdate(dto)) {
+        const assets = await this.repository.getAssets(authUser.id, id);
+        const ids = assets.map((asset) => asset.id);
+        await this.jobRepository.queue({ name: JobName.SEARCH_INDEX_ASSET, data: { ids } });
+      }
     }
 
     if (dto.featureFaceAssetId) {
@@ -104,6 +106,7 @@ export class PersonService {
         await this.update(authUser, person.id, {
           isHidden: person.isHidden,
           name: person.name,
+          birthDate: person.birthDate,
           featureFaceAssetId: person.featureFaceAssetId,
         }),
           results.push({ id: person.id, success: true });
@@ -170,6 +173,15 @@ export class PersonService {
     return results;
   }
 
+  /**
+   * Returns true if the given person update is going to require an update of the search index.
+   * @param dto the Person going to be updated
+   * @private
+   */
+  private needsSearchIndexUpdate(dto: PersonUpdateDto): boolean {
+    return dto.name !== undefined || dto.isHidden !== undefined;
+  }
+
   private async findOrFail(authUser: AuthUserDto, id: string) {
     const person = await this.repository.getById(authUser.id, id);
     if (!person) {

server/src/infra/entities/person.entity.ts

@@ -30,6 +30,9 @@ export class PersonEntity {
   @Column({ default: '' })
   name!: string;
 
+  @Column({ type: 'date', nullable: true })
+  birthDate!: Date | null;
+
   @Column({ default: '' })
   thumbnailPath!: string;
 

server/src/infra/migrations/1692112147855-AddPersonBirthDate.ts

@@ -0,0 +1,13 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+
+export class AddPersonBirthDate1692112147855 implements MigrationInterface {
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+      await queryRunner.query(`ALTER TABLE "person" ADD "birthDate" date`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+      await queryRunner.query(`ALTER TABLE "person" DROP COLUMN "birthDate"`);
+    }
+
+}

server/test/e2e/person.e2e-spec.ts

@@ -0,0 +1,81 @@
+import { IPersonRepository, LoginResponseDto } from '@app/domain';
+import { AppModule, PersonController } from '@app/immich';
+import { INestApplication } from '@nestjs/common';
+import { Test, TestingModule } from '@nestjs/testing';
+import request from 'supertest';
+import { errorStub, uuidStub } from '../fixtures';
+import { api, db } from '../test-utils';
+
+describe(`${PersonController.name}`, () => {
+  let app: INestApplication;
+  let server: any;
+  let loginResponse: LoginResponseDto;
+  let accessToken: string;
+
+  beforeAll(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile();
+
+    app = await moduleFixture.createNestApplication().init();
+    server = app.getHttpServer();
+  });
+
+  beforeEach(async () => {
+    await db.reset();
+    await api.adminSignUp(server);
+    loginResponse = await api.adminLogin(server);
+    accessToken = loginResponse.accessToken;
+  });
+
+  afterAll(async () => {
+    await db.disconnect();
+    await app.close();
+  });
+
+  describe('PUT /person/:id', () => {
+    it('should require authentication', async () => {
+      const { status, body } = await request(server).put(`/person/${uuidStub.notFound}`);
+      expect(status).toBe(401);
+      expect(body).toEqual(errorStub.unauthorized);
+    });
+
+    it('should not accept invalid dates', async () => {
+      for (const birthDate of [false, 'false', '123567', 123456]) {
+        const { status, body } = await request(server)
+          .put(`/person/${uuidStub.notFound}`)
+          .set('Authorization', `Bearer ${accessToken}`)
+          .send({ birthDate });
+        expect(status).toBe(400);
+        expect(body).toEqual(errorStub.badRequest);
+      }
+    });
+    it('should update a date of birth', async () => {
+      const personRepository = app.get<IPersonRepository>(IPersonRepository);
+      const person = await personRepository.create({ ownerId: loginResponse.userId });
+      const { status, body } = await request(server)
+        .put(`/person/${person.id}`)
+        .set('Authorization', `Bearer ${accessToken}`)
+        .send({ birthDate: '1990-01-01T05:00:00.000Z' });
+      expect(status).toBe(200);
+      expect(body).toMatchObject({ birthDate: '1990-01-01' });
+    });
+
+    it('should clear a date of birth', async () => {
+      const personRepository = app.get<IPersonRepository>(IPersonRepository);
+      const person = await personRepository.create({
+        birthDate: new Date('1990-01-01'),
+        ownerId: loginResponse.userId,
+      });
+
+      expect(person.birthDate).toBeDefined();
+
+      const { status, body } = await request(server)
+        .put(`/person/${person.id}`)
+        .set('Authorization', `Bearer ${accessToken}`)
+        .send({ birthDate: null });
+      expect(status).toBe(200);
+      expect(body).toMatchObject({ birthDate: null });
+    });
+  });
+});

server/test/fixtures/person.stub.ts

@@ -9,6 +9,7 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: '',
+    birthDate: null,
     thumbnailPath: '/path/to/thumbnail.jpg',
     faces: [],
     isHidden: false,
@@ -20,6 +21,7 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: '',
+    birthDate: null,
     thumbnailPath: '/path/to/thumbnail.jpg',
     faces: [],
     isHidden: true,
@@ -31,6 +33,31 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: 'Person 1',
+    birthDate: null,
+    thumbnailPath: '/path/to/thumbnail.jpg',
+    faces: [],
+    isHidden: false,
+  }),
+  noBirthDate: Object.freeze<PersonEntity>({
+    id: 'person-1',
+    createdAt: new Date('2021-01-01'),
+    updatedAt: new Date('2021-01-01'),
+    ownerId: userStub.admin.id,
+    owner: userStub.admin,
+    name: 'Person 1',
+    birthDate: null,
+    thumbnailPath: '/path/to/thumbnail.jpg',
+    faces: [],
+    isHidden: false,
+  }),
+  withBirthDate: Object.freeze<PersonEntity>({
+    id: 'person-1',
+    createdAt: new Date('2021-01-01'),
+    updatedAt: new Date('2021-01-01'),
+    ownerId: userStub.admin.id,
+    owner: userStub.admin,
+    name: 'Person 1',
+    birthDate: new Date('1976-06-30'),
     thumbnailPath: '/path/to/thumbnail.jpg',
     faces: [],
     isHidden: false,
@@ -42,6 +69,7 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: '',
+    birthDate: null,
     thumbnailPath: '',
     faces: [],
     isHidden: false,
@@ -53,6 +81,7 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: '',
+    birthDate: null,
     thumbnailPath: '/new/path/to/thumbnail.jpg',
     faces: [],
     isHidden: false,
@@ -64,6 +93,7 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: 'Person 1',
+    birthDate: null,
     thumbnailPath: '/path/to/thumbnail',
     faces: [],
     isHidden: false,
@@ -75,6 +105,7 @@ export const personStub = {
     ownerId: userStub.admin.id,
     owner: userStub.admin,
     name: 'Person 2',
+    birthDate: null,
     thumbnailPath: '/path/to/thumbnail',
     faces: [],
     isHidden: false,