feat(server): asset search endpoint (#4931)

* feat(server): GET /assets endpoint * chore: open api * chore: use dumb name * feat: search by make, model, lens, city, state, country * chore: open api * chore: pagination validation and tests * chore: pr feedback
2023-11-14 17:47:15 -05:00
parent 7a8f8e5472
commit 753dab8b3c
24 changed files with 3151 additions and 94 deletions
@@ -18,12 +18,15 @@ import {
 } from '@app/domain';
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
+import _ from 'lodash';
 import { DateTime } from 'luxon';
 import { And, FindOptionsRelations, FindOptionsWhere, In, IsNull, LessThan, Not, Repository } from 'typeorm';
 import { AssetEntity, AssetJobStatusEntity, AssetType, ExifEntity } from '../entities';
 import OptionalBetween from '../utils/optional-between.util';
 import { paginate } from '../utils/pagination.util';

+const DEFAULT_SEARCH_SIZE = 250;
+
 const truncateMap: Record<TimeBucketSize, string> = {
  [TimeBucketSize.DAY]: 'day',
  [TimeBucketSize.MONTH]: 'month',
@@ -50,6 +53,134 @@ export class AssetRepository implements IAssetRepository {
    await this.jobStatusRepository.upsert(jobStatus, { conflictPaths: ['assetId'] });
  }

+  search(options: AssetSearchOptions): Promise<AssetEntity[]> {
+    const {
+      id,
+      libraryId,
+      deviceAssetId,
+      type,
+      checksum,
+      ownerId,
+
+      isVisible,
+      isFavorite,
+      isExternal,
+      isReadOnly,
+      isOffline,
+      isArchived,
+      isMotion,
+      isEncoded,
+
+      createdBefore,
+      createdAfter,
+      updatedBefore,
+      updatedAfter,
+      trashedBefore,
+      trashedAfter,
+      takenBefore,
+      takenAfter,
+
+      originalFileName,
+      originalPath,
+      resizePath,
+      webpPath,
+      encodedVideoPath,
+
+      city,
+      state,
+      country,
+      make,
+      model,
+      lensModel,
+
+      withDeleted: _withDeleted,
+      withExif: _withExif,
+      withStacked,
+      withPeople,
+
+      order,
+    } = options;
+
+    const withDeleted = _withDeleted ?? (trashedAfter !== undefined || trashedBefore !== undefined);
+
+    const page = Math.max(options.page || 1, 1);
+    const size = Math.min(options.size || DEFAULT_SEARCH_SIZE, DEFAULT_SEARCH_SIZE);
+
+    const exifWhere = _.omitBy(
+      {
+        city,
+        state,
+        country,
+        make,
+        model,
+        lensModel,
+      },
+      _.isUndefined,
+    );
+
+    const withExif = Object.keys(exifWhere).length > 0 || _withExif;
+
+    const where = _.omitBy(
+      {
+        ownerId,
+        id,
+        libraryId,
+        deviceAssetId,
+        type,
+        checksum,
+        isVisible,
+        isFavorite,
+        isExternal,
+        isReadOnly,
+        isOffline,
+        isArchived,
+        livePhotoVideoId: isMotion && Not(IsNull()),
+        originalFileName,
+        originalPath,
+        resizePath,
+        webpPath,
+        encodedVideoPath: encodedVideoPath ?? (isEncoded && Not(IsNull())),
+        createdAt: OptionalBetween(createdAfter, createdBefore),
+        updatedAt: OptionalBetween(updatedAfter, updatedBefore),
+        deletedAt: OptionalBetween(trashedAfter, trashedBefore),
+        fileCreatedAt: OptionalBetween(takenAfter, takenBefore),
+        exifInfo: Object.keys(exifWhere).length > 0 ? exifWhere : undefined,
+      },
+      _.isUndefined,
+    );
+
+    const builder = this.repository.createQueryBuilder('asset');
+
+    if (withExif) {
+      if (_withExif) {
+        builder.leftJoinAndSelect('asset.exifInfo', 'exifInfo');
+      } else {
+        builder.leftJoin('asset.exifInfo', 'exifInfo');
+      }
+    }
+
+    if (withPeople) {
+      builder.leftJoinAndSelect('asset.faces', 'faces');
+      builder.leftJoinAndSelect('faces.person', 'person');
+    }
+
+    if (withStacked) {
+      builder.leftJoinAndSelect('asset.stack', 'stack');
+    }
+
+    if (withDeleted) {
+      builder.withDeleted();
+    }
+
+    builder
+      .where(where)
+      .skip(size * (page - 1))
+      .take(size)
+      .orderBy('asset.fileCreatedAt', order ?? 'DESC');
+
+    return builder.getMany();
+  }
+
  create(asset: AssetCreate): Promise<AssetEntity> {
    return this.repository.save(asset);
  }