immich/server/test/medium/specs/sync/sync-user.spec.ts

import { Kysely } from 'kysely';
import { SyncEntityType, SyncRequestType } from 'src/enum';
import { UserRepository } from 'src/repositories/user.repository';
import { DB } from 'src/schema';
import { SyncTestContext } from 'test/medium.factory';
import { getKyselyDB } from 'test/utils';

let defaultDatabase: Kysely<DB>;

const setup = async (db?: Kysely<DB>) => {
  const ctx = new SyncTestContext(db || defaultDatabase);
  const { auth, user, session } = await ctx.newSyncAuthUser();
  return { auth, user, session, ctx };
};

beforeAll(async () => {
  defaultDatabase = await getKyselyDB();
});

describe(SyncEntityType.UserV1, () => {
  it('should detect and sync the first user', async () => {
    const { auth, ctx } = await setup(await getKyselyDB());

    const userRepo = ctx.get(UserRepository);
    const user = await userRepo.get(auth.user.id, { withDeleted: false });
    if (!user) {
      expect.fail('First user should exist');
    }

    const response = await ctx.syncStream(auth, [SyncRequestType.UsersV1]);
    expect(response).toHaveLength(1);
    expect(response).toEqual([
      {
        ack: expect.any(String),
        data: {
          deletedAt: user.deletedAt,
          email: user.email,
          hasProfileImage: user.profileImagePath !== '',
          id: user.id,
          name: user.name,
          avatarColor: user.avatarColor,
          profileChangedAt: user.profileChangedAt.toISOString(),
        },
        type: 'UserV1',
      },
    ]);

    await ctx.syncAckAll(auth, response);
    await expect(ctx.syncStream(auth, [SyncRequestType.UsersV1])).resolves.toEqual([]);
  });

  it('should detect and sync a soft deleted user', async () => {
    const { auth, ctx } = await setup(await getKyselyDB());

    const { user: deleted } = await ctx.newUser({ deletedAt: new Date().toISOString() });

    const response = await ctx.syncStream(auth, [SyncRequestType.UsersV1]);

    expect(response).toHaveLength(2);
    expect(response).toEqual(
      expect.arrayContaining([
        {
          ack: expect.any(String),
          data: expect.objectContaining({ id: auth.user.id }),
          type: 'UserV1',
        },
        {
          ack: expect.any(String),
          data: expect.objectContaining({ id: deleted.id }),
          type: 'UserV1',
        },
      ]),
    );

    await ctx.syncAckAll(auth, response);
    await expect(ctx.syncStream(auth, [SyncRequestType.UsersV1])).resolves.toEqual([]);
  });

  it('should detect and sync a deleted user', async () => {
    const { auth, user: authUser, ctx } = await setup(await getKyselyDB());

    const userRepo = ctx.get(UserRepository);

    const { user } = await ctx.newUser();
    await userRepo.delete({ id: user.id }, true);

    const response = await ctx.syncStream(auth, [SyncRequestType.UsersV1]);
    expect(response).toHaveLength(2);
    expect(response).toEqual([
      {
        ack: expect.any(String),
        data: {
          userId: user.id,
        },
        type: 'UserDeleteV1',
      },
      {
        ack: expect.any(String),
        data: expect.objectContaining({ id: authUser.id }),
        type: 'UserV1',
      },
    ]);

    await ctx.syncAckAll(auth, response);
    await expect(ctx.syncStream(auth, [SyncRequestType.UsersV1])).resolves.toEqual([]);
  });

  it('should sync a user and then an update to that same user', async () => {
    const { auth, user, ctx } = await setup(await getKyselyDB());

    const userRepo = ctx.get(UserRepository);

    const response = await ctx.syncStream(auth, [SyncRequestType.UsersV1]);
    expect(response).toHaveLength(1);
    expect(response).toEqual([
      {
        ack: expect.any(String),
        data: expect.objectContaining({ id: user.id }),
        type: 'UserV1',
      },
    ]);

    await ctx.syncAckAll(auth, response);

    const updated = await userRepo.update(auth.user.id, { name: 'new name' });

    const newResponse = await ctx.syncStream(auth, [SyncRequestType.UsersV1]);
    expect(newResponse).toHaveLength(1);
    expect(newResponse).toEqual([
      {
        ack: expect.any(String),
        data: expect.objectContaining({ id: user.id, name: updated.name }),
        type: 'UserV1',
      },
    ]);
  });
});