refactor: migrate library spec to factories (#16711)

server/test/fixtures/asset.stub.ts

@@ -6,7 +6,6 @@ import { AssetFileType, AssetStatus, AssetType } from 'src/enum';
 import { StorageAsset } from 'src/types';
 import { authStub } from 'test/fixtures/auth.stub';
 import { fileStub } from 'test/fixtures/file.stub';
-import { libraryStub } from 'test/fixtures/library.stub';
 import { userStub } from 'test/fixtures/user.stub';
 
 const previewFile: AssetFileEntity = {
@@ -396,7 +395,6 @@ export const assetStub = {
     livePhotoVideo: null,
     livePhotoVideoId: null,
     libraryId: 'library-id',
-    library: libraryStub.externalLibrary1,
     tags: [],
     sharedLinks: [],
     originalFileName: 'asset-id.jpg',
@@ -751,7 +749,6 @@ export const assetStub = {
     livePhotoVideo: null,
     livePhotoVideoId: null,
     libraryId: 'library-id',
-    library: libraryStub.externalLibrary1,
     tags: [],
     sharedLinks: [],
     originalFileName: 'photo.jpg',

server/test/fixtures/library.stub.ts

@@ -1,77 +0,0 @@
-import { LibraryEntity } from 'src/entities/library.entity';
-import { userStub } from 'test/fixtures/user.stub';
-
-export const libraryStub = {
-  externalLibrary1: Object.freeze<LibraryEntity>({
-    id: 'library-id',
-    name: 'test_library',
-    assets: [],
-    owner: userStub.admin,
-    ownerId: 'admin_id',
-    importPaths: [],
-    createdAt: new Date('2023-01-01'),
-    updatedAt: new Date('2023-01-01'),
-    refreshedAt: null,
-    exclusionPatterns: [],
-  }),
-  externalLibrary2: Object.freeze<LibraryEntity>({
-    id: 'library-id2',
-    name: 'test_library2',
-    assets: [],
-    owner: userStub.admin,
-    ownerId: 'admin_id',
-    importPaths: [],
-    createdAt: new Date('2021-01-01'),
-    updatedAt: new Date('2022-01-01'),
-    refreshedAt: null,
-    exclusionPatterns: [],
-  }),
-  externalLibraryWithImportPaths1: Object.freeze<LibraryEntity>({
-    id: 'library-id-with-paths1',
-    name: 'library-with-import-paths1',
-    assets: [],
-    owner: userStub.admin,
-    ownerId: 'admin_id',
-    importPaths: ['/foo', '/bar'],
-    createdAt: new Date('2023-01-01'),
-    updatedAt: new Date('2023-01-01'),
-    refreshedAt: null,
-    exclusionPatterns: [],
-  }),
-  externalLibraryWithImportPaths2: Object.freeze<LibraryEntity>({
-    id: 'library-id-with-paths2',
-    name: 'library-with-import-paths2',
-    assets: [],
-    owner: userStub.admin,
-    ownerId: 'admin_id',
-    importPaths: ['/xyz', '/asdf'],
-    createdAt: new Date('2023-01-01'),
-    updatedAt: new Date('2023-01-01'),
-    refreshedAt: null,
-    exclusionPatterns: [],
-  }),
-  patternPath: Object.freeze<LibraryEntity>({
-    id: 'library-id1337',
-    name: 'importpath-exclusion-library1',
-    assets: [],
-    owner: userStub.admin,
-    ownerId: 'user-id',
-    importPaths: ['/xyz', '/asdf'],
-    createdAt: new Date('2023-01-01'),
-    updatedAt: new Date('2023-01-01'),
-    refreshedAt: null,
-    exclusionPatterns: ['**/dir1/**'],
-  }),
-  hasImmichPaths: Object.freeze<LibraryEntity>({
-    id: 'library-id1337',
-    name: 'importpath-exclusion-library1',
-    assets: [],
-    owner: userStub.admin,
-    ownerId: 'user-id',
-    importPaths: ['upload/thumbs', 'xyz', 'upload/library'],
-    createdAt: new Date('2023-01-01'),
-    updatedAt: new Date('2023-01-01'),
-    refreshedAt: null,
-    exclusionPatterns: ['**/dir1/**'],
-  }),
-};

server/test/small.factory.ts

@@ -1,5 +1,5 @@
 import { randomUUID } from 'node:crypto';
-import { Asset, AuthUser, User } from 'src/database';
+import { Asset, AuthUser, Library, User } from 'src/database';
 import { OnThisDayData } from 'src/entities/memory.entity';
 import { AssetStatus, AssetType, MemoryType } from 'src/enum';
 import { ActivityItem, MemoryItem } from 'src/types';
@@ -13,7 +13,11 @@ export const newDate = () => new Date();
 export const newUpdateId = () => 'uuid-v7';
 export const newSha1 = () => Buffer.from('this is a fake hash');
 
-const authUser = (authUser: Partial<AuthUser>) => ({
+const authFactory = (user: Partial<AuthUser> = {}) => ({
+  user: authUserFactory(user),
+});
+
+const authUserFactory = (authUser: Partial<AuthUser>) => ({
   id: newUuid(),
   isAdmin: false,
   name: 'Test User',
@@ -23,7 +27,7 @@ const authUser = (authUser: Partial<AuthUser>) => ({
   ...authUser,
 });
 
-const user = (user: Partial<User>) => ({
+const userFactory = (user: Partial<User> = {}) => ({
   id: newUuid(),
   name: 'Test User',
   email: 'test@immich.cloud',
@@ -32,75 +36,95 @@ const user = (user: Partial<User>) => ({
   ...user,
 });
 
-export const factory = {
-  auth: (user: Partial<AuthUser> = {}) => ({
-    user: authUser(user),
-  }),
-  authUser,
-  user,
-  asset: (asset: Partial<Asset> = {}) => ({
-    id: newUuid(),
-    createdAt: newDate(),
-    updatedAt: newDate(),
-    deletedAt: null,
-    updateId: newUpdateId(),
-    status: AssetStatus.ACTIVE,
-    checksum: newSha1(),
-    deviceAssetId: '',
-    deviceId: '',
-    duplicateId: null,
-    duration: null,
-    encodedVideoPath: null,
-    fileCreatedAt: newDate(),
-    fileModifiedAt: newDate(),
-    isArchived: false,
-    isExternal: false,
-    isFavorite: false,
-    isOffline: false,
-    isVisible: true,
-    libraryId: null,
-    livePhotoVideoId: null,
-    localDateTime: newDate(),
-    originalFileName: 'IMG_123.jpg',
-    originalPath: `upload/12/34/IMG_123.jpg`,
-    ownerId: newUuid(),
-    sidecarPath: null,
-    stackId: null,
-    thumbhash: null,
-    type: AssetType.IMAGE,
-    ...asset,
-  }),
-  activity: (activity: Partial<ActivityItem> = {}) => {
-    const userId = activity.userId || newUuid();
-    return {
-      id: newUuid(),
-      comment: null,
-      isLiked: false,
-      userId,
-      user: user({ id: userId }),
-      assetId: newUuid(),
-      albumId: newUuid(),
-      createdAt: newDate(),
-      updatedAt: newDate(),
-      updateId: newUpdateId(),
-      ...activity,
-    };
-  },
-  memory: (memory: Partial<MemoryItem> = {}) => ({
+const assetFactory = (asset: Partial<Asset> = {}) => ({
+  id: newUuid(),
+  createdAt: newDate(),
+  updatedAt: newDate(),
+  deletedAt: null,
+  updateId: newUpdateId(),
+  status: AssetStatus.ACTIVE,
+  checksum: newSha1(),
+  deviceAssetId: '',
+  deviceId: '',
+  duplicateId: null,
+  duration: null,
+  encodedVideoPath: null,
+  fileCreatedAt: newDate(),
+  fileModifiedAt: newDate(),
+  isArchived: false,
+  isExternal: false,
+  isFavorite: false,
+  isOffline: false,
+  isVisible: true,
+  libraryId: null,
+  livePhotoVideoId: null,
+  localDateTime: newDate(),
+  originalFileName: 'IMG_123.jpg',
+  originalPath: `upload/12/34/IMG_123.jpg`,
+  ownerId: newUuid(),
+  sidecarPath: null,
+  stackId: null,
+  thumbhash: null,
+  type: AssetType.IMAGE,
+  ...asset,
+});
+
+const activityFactory = (activity: Partial<ActivityItem> = {}) => {
+  const userId = activity.userId || newUuid();
+  return {
     id: newUuid(),
+    comment: null,
+    isLiked: false,
+    userId,
+    user: userFactory({ id: userId }),
+    assetId: newUuid(),
+    albumId: newUuid(),
     createdAt: newDate(),
     updatedAt: newDate(),
     updateId: newUpdateId(),
-    deletedAt: null,
-    ownerId: newUuid(),
-    type: MemoryType.ON_THIS_DAY,
-    data: { year: 2024 } as OnThisDayData,
-    isSaved: false,
-    memoryAt: newDate(),
-    seenAt: null,
-    showAt: newDate(),
-    hideAt: newDate(),
-    assets: [],
-    ...memory,
-  }),
+    ...activity,
+  };
+};
+
+const libraryFactory = (library: Partial<Library> = {}) => ({
+  id: newUuid(),
+  createdAt: newDate(),
+  updatedAt: newDate(),
+  updateId: newUpdateId(),
+  deletedAt: null,
+  refreshedAt: null,
+  name: 'Library',
+  assets: [],
+  ownerId: newUuid(),
+  importPaths: [],
+  exclusionPatterns: [],
+  ...library,
+});
+
+const memoryFactory = (memory: Partial<MemoryItem> = {}) => ({
+  id: newUuid(),
+  createdAt: newDate(),
+  updatedAt: newDate(),
+  updateId: newUpdateId(),
+  deletedAt: null,
+  ownerId: newUuid(),
+  type: MemoryType.ON_THIS_DAY,
+  data: { year: 2024 } as OnThisDayData,
+  isSaved: false,
+  memoryAt: newDate(),
+  seenAt: null,
+  showAt: newDate(),
+  hideAt: newDate(),
+  assets: [],
+  ...memory,
+});
+
+export const factory = {
+  activity: activityFactory,
+  asset: assetFactory,
+  auth: authFactory,
+  authUser: authUserFactory,
+  library: libraryFactory,
+  memory: memoryFactory,
+  user: userFactory,
 };