From 14d785cec9897efa74c5db4d6c33adaba4dff9e8 Mon Sep 17 00:00:00 2001
From: xCJPECKOVERx <cjpeckover@hotmail.ca>
Date: Mon, 9 Jun 2025 11:11:43 -0400
Subject: [PATCH] feat(server): Add album filter to search (#18985)

* - updated dtos
- added inAlbums to search builder
- only check isNotInAlbum if albumIds is blank/empty

* - consider inAlbums as OR

* - make open-api-dart

* - lint & format

* - remove inAlbums groupBy clause

* - merge main open-api

* - make open-api

* - inAlbums filter AND instead of OR
---
 .../lib/model/metadata_search_dto.dart        | Bin 29009 -> 29363 bytes
 .../openapi/lib/model/random_search_dto.dart  | Bin 21559 -> 21913 bytes
 .../openapi/lib/model/smart_search_dto.dart   | Bin 21645 -> 21999 bytes
 .../lib/model/statistics_search_dto.dart      | Bin 18875 -> 19229 bytes
 open-api/immich-openapi-specs.json            |  28 ++++++++++++++++++
 open-api/typescript-sdk/src/fetch-client.ts   |   4 +++
 server/src/dtos/search.dto.ts                 |   3 ++
 server/src/repositories/search.repository.ts  |   7 ++++-
 server/src/utils/database.ts                  |  17 ++++++++++-
 9 files changed, 57 insertions(+), 2 deletions(-)

diff --git a/mobile/openapi/lib/model/metadata_search_dto.dart b/mobile/openapi/lib/model/metadata_search_dto.dart
index 7f1184467b1d6c8c9c5ded2832fc6ebf2199aca6..520777a45de3aa412f5c1e2de0c47bbd7b98fdf1 100644
GIT binary patch
delta 212
zcmcckh;j2%#tl7;tcf{ErMZ(YGD~jmVJv4B^~o$Qu?a3I%FIi*Qvl0(rW9|UD3-*y
zIf2d0U~-F<v@lFq2d+SKbDvp08wX5c@<v<X&HrqgI7DC~wkj}|j>6^!*PqPF3JO`p
x`FYVr>M#lQSOr^!l8nq^J($SmVoxz~F&NJZMZ@GZ=^9YCXQV}K?o2o#006KzPLKcq

delta 53
zcmV-50LuTf<pI&+0kDh#v#J4i1GA<rT>+CI3kb8I1}-qO1UF{}vxPl_2(uhU`2({)
LN)Q*b>tV<cJ75%P

diff --git a/mobile/openapi/lib/model/random_search_dto.dart b/mobile/openapi/lib/model/random_search_dto.dart
index 0284212efcbe90e9339f6c4597ee2f8f5c2ac972..c5914f9fa36ac0f1b35d14fe04618243b7cc746b 100644
GIT binary patch
delta 204
zcmdnKf^p_*#tm(Ztcf{ErMZ*mGD&W3W2|Ko^~o$Qu?a3I%FIi*Qvl0(rW9}f$9!LD
z@^KAmVVH;xTuyWIRkhPBP-6=8L^m(cc48BOsk2pqv2+wRKQesJq^zKjRh*v}U8D|^
qP>)rxRVc~GEY^dGY(8z$D<}rzS)pi{yw6huYS|mlsLc^>_jv({flS~4

delta 44
zcmV+{0Mq}Os{yyD0kDPvv!nri0<${=+9I<{C&L7@C@ew-vwkw~0<)GihY_>7N8b&R
Cv=Qe3

diff --git a/mobile/openapi/lib/model/smart_search_dto.dart b/mobile/openapi/lib/model/smart_search_dto.dart
index a915d97b319af940626a3be2d2aef171bded918e..c221340553f9f21fc81ce2927a1764b485fa40da 100644
GIT binary patch
delta 215
zcmeBO$@qRX<A!EN*2J8o(%i|4%#xd%8GD&TeKLznY=TRQGV{{y6u@$xDaD()S^g<a
zzOE@P3=`3T%V}<ARKLn10+Z0oNG#59&QD3zRM6ghLEDE7E@P_#Q=_A>S;pu!ld^(B
zR&jn_bdfqtLOoW&R-q&#vse!%vYFAeLr@IHvqI4@`GB_u)cLQyqc(TCvG4%^NuEr)

delta 44
zcmV+{0Mq~Ps{xIv0kDGsv!MZv0<%a2`69D-C(Q)2UMxliv$!(r0<+9Df)TUpM+6S6
C;}UoP

diff --git a/mobile/openapi/lib/model/statistics_search_dto.dart b/mobile/openapi/lib/model/statistics_search_dto.dart
index 0fe0770b6dc2f4acc5523194d141e7c3d27c1070..55de23ba3225d653cbd33dbb01dd4341d53c38af 100644
GIT binary patch
delta 215
zcmdlznQ`tk#toAgSrc=TN^>XgXOi4JiP3;b)F-pJ#3s0;C^IkJP5~_EnNqxYFY_0f
z$)?KE!Y~mXxSZzZl?sk5A}|TPjKty$=lqmZO$F`EPgI&%;WD-=Ff}>~o71%BGAS!4
zWEJP<MHi{VB-CRSY!yl}GK=+KBAfr}%;gt@@vKlZOm=nDfI7d>A!_q18%16KmWNFw

delta 44
zcmV+{0Mq}SmI1qy0kDz*v#<d$0<-!9?;NuqAvpxIawU8PvjQuf0<*|1mk+c2Js}N?
CtPuJD

diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index 352fe768f..775fe117a 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -10866,6 +10866,13 @@
       },
       "MetadataSearchDto": {
         "properties": {
+          "albumIds": {
+            "items": {
+              "format": "uuid",
+              "type": "string"
+            },
+            "type": "array"
+          },
           "checksum": {
             "type": "string"
           },
@@ -11785,6 +11792,13 @@
       },
       "RandomSearchDto": {
         "properties": {
+          "albumIds": {
+            "items": {
+              "format": "uuid",
+              "type": "string"
+            },
+            "type": "array"
+          },
           "city": {
             "nullable": true,
             "type": "string"
@@ -12833,6 +12847,13 @@
       },
       "SmartSearchDto": {
         "properties": {
+          "albumIds": {
+            "items": {
+              "format": "uuid",
+              "type": "string"
+            },
+            "type": "array"
+          },
           "city": {
             "nullable": true,
             "type": "string"
@@ -13029,6 +13050,13 @@
       },
       "StatisticsSearchDto": {
         "properties": {
+          "albumIds": {
+            "items": {
+              "format": "uuid",
+              "type": "string"
+            },
+            "type": "array"
+          },
           "city": {
             "nullable": true,
             "type": "string"
diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts
index 0308ecb9e..fee00acff 100644
--- a/open-api/typescript-sdk/src/fetch-client.ts
+++ b/open-api/typescript-sdk/src/fetch-client.ts
@@ -853,6 +853,7 @@ export type SearchExploreResponseDto = {
     items: SearchExploreItem[];
 };
 export type MetadataSearchDto = {
+    albumIds?: string[];
     checksum?: string;
     city?: string | null;
     country?: string | null;
@@ -929,6 +930,7 @@ export type PlacesResponseDto = {
     name: string;
 };
 export type RandomSearchDto = {
+    albumIds?: string[];
     city?: string | null;
     country?: string | null;
     createdAfter?: string;
@@ -962,6 +964,7 @@ export type RandomSearchDto = {
     withStacked?: boolean;
 };
 export type SmartSearchDto = {
+    albumIds?: string[];
     city?: string | null;
     country?: string | null;
     createdAfter?: string;
@@ -996,6 +999,7 @@ export type SmartSearchDto = {
     withExif?: boolean;
 };
 export type StatisticsSearchDto = {
+    albumIds?: string[];
     city?: string | null;
     country?: string | null;
     createdAfter?: string;
diff --git a/server/src/dtos/search.dto.ts b/server/src/dtos/search.dto.ts
index 81d74e0a7..d0427ef32 100644
--- a/server/src/dtos/search.dto.ts
+++ b/server/src/dtos/search.dto.ts
@@ -95,6 +95,9 @@ class BaseSearchDto {
   @ValidateUUID({ each: true, optional: true })
   tagIds?: string[];
 
+  @ValidateUUID({ each: true, optional: true })
+  albumIds?: string[];
+
   @Optional()
   @IsInt()
   @Max(5)
diff --git a/server/src/repositories/search.repository.ts b/server/src/repositories/search.repository.ts
index 14150d424..068de1eb4 100644
--- a/server/src/repositories/search.repository.ts
+++ b/server/src/repositories/search.repository.ts
@@ -91,6 +91,10 @@ export interface SearchTagOptions {
   tagIds?: string[];
 }
 
+export interface SearchAlbumOptions {
+  albumIds?: string[];
+}
+
 export interface SearchOrderOptions {
   orderDirection?: 'asc' | 'desc';
 }
@@ -108,7 +112,8 @@ type BaseAssetSearchOptions = SearchDateOptions &
   SearchStatusOptions &
   SearchUserIdOptions &
   SearchPeopleOptions &
-  SearchTagOptions;
+  SearchTagOptions &
+  SearchAlbumOptions;
 
 export type AssetSearchOptions = BaseAssetSearchOptions & SearchRelationOptions;
 
diff --git a/server/src/utils/database.ts b/server/src/utils/database.ts
index d8171dc95..d7417becf 100644
--- a/server/src/utils/database.ts
+++ b/server/src/utils/database.ts
@@ -228,6 +228,20 @@ export function hasPeople<O>(qb: SelectQueryBuilder<DB, 'assets', O>, personIds:
   );
 }
 
+export function inAlbums<O>(qb: SelectQueryBuilder<DB, 'assets', O>, albumIds: string[]) {
+  return qb.innerJoin(
+    (eb) =>
+      eb
+        .selectFrom('albums_assets_assets')
+        .select('assetsId')
+        .where('albumsId', '=', anyUuid(albumIds!))
+        .groupBy('assetsId')
+        .having((eb) => eb.fn.count('albumsId').distinct(), '=', albumIds.length)
+        .as('has_album'),
+    (join) => join.onRef('has_album.assetsId', '=', 'assets.id'),
+  );
+}
+
 export function hasTags<O>(qb: SelectQueryBuilder<DB, 'assets', O>, tagIds: string[]) {
   return qb.innerJoin(
     (eb) =>
@@ -292,6 +306,7 @@ export function searchAssetBuilder(kysely: Kysely<DB>, options: AssetSearchBuild
     .withPlugin(joinDeduplicationPlugin)
     .selectFrom('assets')
     .where('assets.visibility', '=', visibility)
+    .$if(!!options.albumIds && options.albumIds.length > 0, (qb) => inAlbums(qb, options.albumIds!))
     .$if(!!options.tagIds && options.tagIds.length > 0, (qb) => hasTags(qb, options.tagIds!))
     .$if(!!options.personIds && options.personIds.length > 0, (qb) => hasPeople(qb, options.personIds!))
     .$if(!!options.createdBefore, (qb) => qb.where('assets.createdAt', '<=', options.createdBefore!))
@@ -368,7 +383,7 @@ export function searchAssetBuilder(kysely: Kysely<DB>, options: AssetSearchBuild
     .$if(options.isMotion !== undefined, (qb) =>
       qb.where('assets.livePhotoVideoId', options.isMotion ? 'is not' : 'is', null),
     )
-    .$if(!!options.isNotInAlbum, (qb) =>
+    .$if(!!options.isNotInAlbum && (!options.albumIds || options.albumIds.length === 0), (qb) =>
       qb.where((eb) =>
         eb.not(eb.exists((eb) => eb.selectFrom('albums_assets_assets').whereRef('assetsId', '=', 'assets.id'))),
       ),