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

import { Kysely } from 'kysely';
import { SyncEntityType, SyncRequestType, UserMetadataKey } 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.UserMetadataV1, () => {
  it('should detect and sync new user metadata', async () => {
    const { auth, user, ctx } = await setup();

    const userRepo = ctx.get(UserRepository);
    await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.Onboarding, value: { isOnboarded: true } });

    const response = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);
    expect(response).toEqual([
      {
        ack: expect.any(String),
        data: {
          key: UserMetadataKey.Onboarding,
          userId: user.id,
          value: { isOnboarded: true },
        },
        type: 'UserMetadataV1',
      },
      expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
    ]);

    await ctx.syncAckAll(auth, response);
    await ctx.assertSyncIsComplete(auth, [SyncRequestType.UserMetadataV1]);
  });

  it('should update user metadata', async () => {
    const { auth, user, ctx } = await setup();

    const userRepo = ctx.get(UserRepository);
    await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.Onboarding, value: { isOnboarded: true } });

    const response = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);
    expect(response).toEqual([
      {
        ack: expect.any(String),
        data: {
          key: UserMetadataKey.Onboarding,
          userId: user.id,
          value: { isOnboarded: true },
        },
        type: 'UserMetadataV1',
      },
      expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
    ]);

    await ctx.syncAckAll(auth, response);

    await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.Onboarding, value: { isOnboarded: false } });

    const updatedResponse = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);
    expect(updatedResponse).toEqual([
      {
        ack: expect.any(String),
        data: {
          key: UserMetadataKey.Onboarding,
          userId: user.id,
          value: { isOnboarded: false },
        },
        type: 'UserMetadataV1',
      },
      expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
    ]);

    await ctx.syncAckAll(auth, updatedResponse);
    await ctx.assertSyncIsComplete(auth, [SyncRequestType.UserMetadataV1]);
  });
});

describe(SyncEntityType.UserMetadataDeleteV1, () => {
  it('should delete and sync user metadata', async () => {
    const { auth, user, ctx } = await setup();

    const userRepo = ctx.get(UserRepository);
    await userRepo.upsertMetadata(user.id, { key: UserMetadataKey.Onboarding, value: { isOnboarded: true } });

    const response = await ctx.syncStream(auth, [SyncRequestType.UserMetadataV1]);
    expect(response).toEqual([
      {
        ack: expect.any(String),
        data: {
          key: UserMetadataKey.Onboarding,
          userId: user.id,
          value: { isOnboarded: true },
        },
        type: 'UserMetadataV1',
      },
      expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
    ]);

    await ctx.syncAckAll(auth, response);

    await userRepo.deleteMetadata(auth.user.id, UserMetadataKey.Onboarding);

    await expect(ctx.syncStream(auth, [SyncRequestType.UserMetadataV1])).resolves.toEqual([
      {
        ack: expect.any(String),
        data: {
          userId: user.id,
          key: UserMetadataKey.Onboarding,
        },
        type: 'UserMetadataDeleteV1',
      },
      expect.objectContaining({ type: SyncEntityType.SyncCompleteV1 }),
    ]);
  });
});