feat(server): create a person with optional values (#7706)

* feat: create person dto

* chore: open api

* fix: e2e

* fix: web usage

e2e/src/api/specs/person.e2e-spec.ts

@@ -5,7 +5,15 @@ import { app, utils } from 'src/utils';
 import request from 'supertest';
 import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
 
-describe('/activity', () => {
+const invalidBirthday = [
+  // TODO: enable after replacing `@Type(() => Date)`
+  // { birthDate: 'false', response: 'Invalid date' },
+  // { birthDate: '123567', response: 'Invalid date },
+  // { birthDate: 123_567, response: ['Birth date cannot be in the future'] },
+  { birthDate: new Date(9999, 0, 0).toISOString(), response: ['Birth date cannot be in the future'] },
+];
+
+describe('/person', () => {
   let admin: LoginResponseDto;
   let visiblePerson: PersonResponseDto;
   let hiddenPerson: PersonResponseDto;
@@ -14,10 +22,6 @@ describe('/activity', () => {
   beforeAll(async () => {
     await utils.resetDatabase();
     admin = await utils.adminSetup();
-  });
-
-  beforeEach(async () => {
-    await utils.resetDatabase(['person']);
 
     [visiblePerson, hiddenPerson, multipleAssetsPerson] = await Promise.all([
       utils.createPerson(admin.accessToken, {
@@ -141,6 +145,41 @@ describe('/activity', () => {
     });
   });
 
+  describe('POST /person', () => {
+    it('should require authentication', async () => {
+      const { status, body } = await request(app).post(`/person`);
+      expect(status).toBe(401);
+      expect(body).toEqual(errorDto.unauthorized);
+    });
+
+    it('should not accept invalid birth dates', async () => {
+      for (const { birthDate, response } of invalidBirthday) {
+        const { status, body } = await request(app)
+          .post(`/person`)
+          .set('Authorization', `Bearer ${admin.accessToken}`)
+          .send({ birthDate });
+        expect(status).toBe(400);
+        expect(body).toEqual(errorDto.badRequest(response));
+      }
+    });
+
+    it('should create a person', async () => {
+      const { status, body } = await request(app)
+        .post(`/person`)
+        .set('Authorization', `Bearer ${admin.accessToken}`)
+        .send({
+          name: 'New Person',
+          birthDate: '1990-01-01T05:00:00.000Z',
+        });
+      expect(status).toBe(201);
+      expect(body).toMatchObject({
+        id: expect.any(String),
+        name: 'New Person',
+        birthDate: '1990-01-01T05:00:00.000Z',
+      });
+    });
+  });
+
   describe('PUT /person/:id', () => {
     it('should require authentication', async () => {
       const { status, body } = await request(app).put(`/person/${uuidDto.notFound}`);
@@ -164,17 +203,9 @@ describe('/activity', () => {
     }
 
     it('should not accept invalid birth dates', async () => {
-      for (const { birthDate, response } of [
-        { birthDate: false, response: 'Not found or no person.write access' },
-        { birthDate: 'false', response: ['birthDate must be a Date instance'] },
-        {
-          birthDate: '123567',
-          response: 'Not found or no person.write access',
-        },
-        { birthDate: 123_567, response: 'Not found or no person.write access' },
-      ]) {
+      for (const { birthDate, response } of invalidBirthday) {
         const { status, body } = await request(app)
-          .put(`/person/${uuidDto.notFound}`)
+          .put(`/person/${visiblePerson.id}`)
           .set('Authorization', `Bearer ${admin.accessToken}`)
           .send({ birthDate });
         expect(status).toBe(400);
@@ -192,15 +223,8 @@ describe('/activity', () => {
     });
 
     it('should clear a date of birth', async () => {
-      // TODO ironically this uses the update endpoint to create the person
-      const person = await utils.createPerson(admin.accessToken, {
-        birthDate: new Date('1990-01-01').toISOString(),
-      });
-
-      expect(person.birthDate).toBeDefined();
-
       const { status, body } = await request(app)
-        .put(`/person/${person.id}`)
+        .put(`/person/${visiblePerson.id}`)
         .set('Authorization', `Bearer ${admin.accessToken}`)
         .send({ birthDate: null });
       expect(status).toBe(200);

e2e/src/utils.ts

@@ -5,7 +5,7 @@ import {
   CreateAssetDto,
   CreateLibraryDto,
   CreateUserDto,
-  PersonUpdateDto,
+  PersonCreateDto,
   SharedLinkCreateDto,
   ValidateLibraryDto,
   createAlbum,
@@ -20,7 +20,6 @@ import {
   login,
   setAdminOnboarding,
   signUpAdmin,
-  updatePerson,
   validate,
 } from '@immich/sdk';
 import { BrowserContext } from '@playwright/test';
@@ -252,16 +251,11 @@ export const utils = {
   deleteAssets: (accessToken: string, ids: string[]) =>
     deleteAssets({ assetBulkDeleteDto: { ids } }, { headers: asBearerAuth(accessToken) }),
 
-  createPerson: async (accessToken: string, dto?: PersonUpdateDto) => {
-    // TODO fix createPerson to accept a body
-    const person = await createPerson({ headers: asBearerAuth(accessToken) });
+  createPerson: async (accessToken: string, dto?: PersonCreateDto) => {
+    const person = await createPerson({ personCreateDto: dto || {} }, { headers: asBearerAuth(accessToken) });
     await utils.setPersonThumbnail(person.id);
 
-    if (!dto) {
-      return person;
-    }
-
-    return updatePerson({ id: person.id, personUpdateDto: dto }, { headers: asBearerAuth(accessToken) });
+    return person;
   },
 
   createFace: async ({ assetId, personId }: { assetId: string; personId: string }) => {