refactor(server): move timeline operations to their own controller/service (#8325)

* move timeline operations to their own controller/service * chore: open api * move e2e tests
2024-03-29 04:20:40 +01:00
parent b8b3c487d4
commit b8c5363a15
20 changed files with 1285 additions and 1115 deletions
@@ -0,0 +1,86 @@
+import { BadRequestException, Inject } from '@nestjs/common';
+import { AccessCore, Permission } from 'src/cores/access.core';
+import { AssetResponseDto, SanitizedAssetResponseDto, mapAsset } from 'src/dtos/asset-response.dto';
+import { AuthDto } from 'src/dtos/auth.dto';
+import { TimeBucketAssetDto, TimeBucketDto, TimeBucketResponseDto } from 'src/dtos/time-bucket.dto';
+import { IAccessRepository } from 'src/interfaces/access.interface';
+import { IAssetRepository, TimeBucketOptions } from 'src/interfaces/asset.interface';
+import { IPartnerRepository } from 'src/interfaces/partner.interface';
+
+export class TimelineService {
+  private accessCore: AccessCore;
+
+  constructor(
+    @Inject(IAccessRepository) accessRepository: IAccessRepository,
+    @Inject(IAssetRepository) private repository: IAssetRepository,
+    @Inject(IPartnerRepository) private partnerRepository: IPartnerRepository,
+  ) {
+    this.accessCore = AccessCore.create(accessRepository);
+  }
+
+  async getTimeBuckets(auth: AuthDto, dto: TimeBucketDto): Promise<TimeBucketResponseDto[]> {
+    await this.timeBucketChecks(auth, dto);
+    const timeBucketOptions = await this.buildTimeBucketOptions(auth, dto);
+
+    return this.repository.getTimeBuckets(timeBucketOptions);
+  }
+
+  async getTimeBucket(
+    auth: AuthDto,
+    dto: TimeBucketAssetDto,
+  ): Promise<AssetResponseDto[] | SanitizedAssetResponseDto[]> {
+    await this.timeBucketChecks(auth, dto);
+    const timeBucketOptions = await this.buildTimeBucketOptions(auth, dto);
+    const assets = await this.repository.getTimeBucket(dto.timeBucket, timeBucketOptions);
+    return !auth.sharedLink || auth.sharedLink?.showExif
+      ? assets.map((asset) => mapAsset(asset, { withStack: true, auth }))
+      : assets.map((asset) => mapAsset(asset, { stripMetadata: true, auth }));
+  }
+
+  private async buildTimeBucketOptions(auth: AuthDto, dto: TimeBucketDto): Promise<TimeBucketOptions> {
+    const { userId, ...options } = dto;
+    let userIds: string[] | undefined = undefined;
+
+    if (userId) {
+      userIds = [userId];
+
+      if (dto.withPartners) {
+        const partners = await this.partnerRepository.getAll(auth.user.id);
+        const partnersIds = partners
+          .filter((partner) => partner.sharedBy && partner.sharedWith && partner.inTimeline)
+          .map((partner) => partner.sharedById);
+
+        userIds.push(...partnersIds);
+      }
+    }
+
+    return { ...options, userIds };
+  }
+
+  private async timeBucketChecks(auth: AuthDto, dto: TimeBucketDto) {
+    if (dto.albumId) {
+      await this.accessCore.requirePermission(auth, Permission.ALBUM_READ, [dto.albumId]);
+    } else {
+      dto.userId = dto.userId || auth.user.id;
+    }
+
+    if (dto.userId) {
+      await this.accessCore.requirePermission(auth, Permission.TIMELINE_READ, [dto.userId]);
+      if (dto.isArchived !== false) {
+        await this.accessCore.requirePermission(auth, Permission.ARCHIVE_READ, [dto.userId]);
+      }
+    }
+
+    if (dto.withPartners) {
+      const requestedArchived = dto.isArchived === true || dto.isArchived === undefined;
+      const requestedFavorite = dto.isFavorite === true || dto.isFavorite === false;
+      const requestedTrash = dto.isTrashed === true;
+
+      if (requestedArchived || requestedFavorite || requestedTrash) {
+        throw new BadRequestException(
+          'withPartners is only supported for non-archived, non-trashed, non-favorited assets',
+        );
+      }
+    }
+  }
+}