Skip to content

High performance self-hosted photo and video management solution.

fix(server): album statistics endpoint (#11924)

Jason Rasmussenef9a06be5c6a
diff --git a/e2e/src/api/specs/album.e2e-spec.ts b/e2e/src/api/specs/album.e2e-spec.ts
index 2a35eb3c92..9e925c4021 100644
--- a/e2e/src/api/specs/album.e2e-spec.ts
+++ b/e2e/src/api/specs/album.e2e-spec.ts
@@ -344,16 +344,16 @@ describe('/albums', () => {
});
});
- describe('GET /albums/count', () => {
+ describe('GET /albums/statistics', () => {
it('should require authentication', async () => {
- const { status, body } = await request(app).get('/albums/count');
+ const { status, body } = await request(app).get('/albums/statistics');
expect(status).toBe(401);
expect(body).toEqual(errorDto.unauthorized);
});
it('should return total count of albums the user has access to', async () => {
const { status, body } = await request(app)
- .get('/albums/count')
+ .get('/albums/statistics')
.set('Authorization', `Bearer ${user1.accessToken}`);
expect(status).toBe(200);
diff --git a/mobile/openapi/README.md b/mobile/openapi/README.md
index f2effe1c20..c49b5052d8 100644
--- a/mobile/openapi/README.md
+++ b/mobile/openapi/README.md
@@ -86,8 +86,8 @@ Class | Method | HTTP request | Description
*AlbumsApi* | [**addUsersToAlbum**](doc//AlbumsApi.md#adduserstoalbum) | **PUT** /albums/{id}/users |
*AlbumsApi* | [**createAlbum**](doc//AlbumsApi.md#createalbum) | **POST** /albums |
*AlbumsApi* | [**deleteAlbum**](doc//AlbumsApi.md#deletealbum) | **DELETE** /albums/{id} |
-*AlbumsApi* | [**getAlbumCount**](doc//AlbumsApi.md#getalbumcount) | **GET** /albums/count |
*AlbumsApi* | [**getAlbumInfo**](doc//AlbumsApi.md#getalbuminfo) | **GET** /albums/{id} |
+*AlbumsApi* | [**getAlbumStatistics**](doc//AlbumsApi.md#getalbumstatistics) | **GET** /albums/statistics |
*AlbumsApi* | [**getAllAlbums**](doc//AlbumsApi.md#getallalbums) | **GET** /albums |
*AlbumsApi* | [**removeAssetFromAlbum**](doc//AlbumsApi.md#removeassetfromalbum) | **DELETE** /albums/{id}/assets |
*AlbumsApi* | [**removeUserFromAlbum**](doc//AlbumsApi.md#removeuserfromalbum) | **DELETE** /albums/{id}/user/{userId} |
@@ -265,8 +265,8 @@ Class | Method | HTTP request | Description
- [ActivityStatisticsResponseDto](doc//ActivityStatisticsResponseDto.md)
- [AddUsersDto](doc//AddUsersDto.md)
- [AdminOnboardingUpdateDto](doc//AdminOnboardingUpdateDto.md)
- - [AlbumCountResponseDto](doc//AlbumCountResponseDto.md)
- [AlbumResponseDto](doc//AlbumResponseDto.md)
+ - [AlbumStatisticsResponseDto](doc//AlbumStatisticsResponseDto.md)
- [AlbumUserAddDto](doc//AlbumUserAddDto.md)
- [AlbumUserCreateDto](doc//AlbumUserCreateDto.md)
- [AlbumUserResponseDto](doc//AlbumUserResponseDto.md)
diff --git a/mobile/openapi/lib/api.dart b/mobile/openapi/lib/api.dart
index 6ee06d5304..a6f860dda2 100644
--- a/mobile/openapi/lib/api.dart
+++ b/mobile/openapi/lib/api.dart
@@ -73,8 +73,8 @@ part 'model/activity_response_dto.dart';
part 'model/activity_statistics_response_dto.dart';
part 'model/add_users_dto.dart';
part 'model/admin_onboarding_update_dto.dart';
-part 'model/album_count_response_dto.dart';
part 'model/album_response_dto.dart';
+part 'model/album_statistics_response_dto.dart';
part 'model/album_user_add_dto.dart';
part 'model/album_user_create_dto.dart';
part 'model/album_user_response_dto.dart';
diff --git a/mobile/openapi/lib/api/albums_api.dart b/mobile/openapi/lib/api/albums_api.dart
index fb81c04616..eb2bb7c0bd 100644
--- a/mobile/openapi/lib/api/albums_api.dart
+++ b/mobile/openapi/lib/api/albums_api.dart
@@ -218,10 +218,18 @@ class AlbumsApi {
}
}
- /// Performs an HTTP 'GET /albums/count' operation and returns the [Response].
- Future<Response> getAlbumCountWithHttpInfo() async {
+ /// Performs an HTTP 'GET /albums/{id}' operation and returns the [Response].
+ /// Parameters:
+ ///
+ /// * [String] id (required):
+ ///
+ /// * [String] key:
+ ///
+ /// * [bool] withoutAssets:
+ Future<Response> getAlbumInfoWithHttpInfo(String id, { String? key, bool? withoutAssets, }) async {
// ignore: prefer_const_declarations
- final path = r'/albums/count';
+ final path = r'/albums/{id}'
+ .replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
@@ -230,6 +238,13 @@ class AlbumsApi {
final headerParams = <String, String>{};
final formParams = <String, String>{};
+ if (key != null) {
+ queryParams.addAll(_queryParams('', 'key', key));
+ }
+ if (withoutAssets != null) {
+ queryParams.addAll(_queryParams('', 'withoutAssets', withoutAssets));
+ }
+
const contentTypes = <String>[];
@@ -244,8 +259,15 @@ class AlbumsApi {
);
}
- Future<AlbumCountResponseDto?> getAlbumCount() async {
- final response = await getAlbumCountWithHttpInfo();
+ /// Parameters:
+ ///
+ /// * [String] id (required):
+ ///
+ /// * [String] key:
+ ///
+ /// * [bool] withoutAssets:
+ Future<AlbumResponseDto?> getAlbumInfo(String id, { String? key, bool? withoutAssets, }) async {
+ final response = await getAlbumInfoWithHttpInfo(id, key: key, withoutAssets: withoutAssets, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@@ -253,24 +275,16 @@ class AlbumsApi {
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
- return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AlbumCountResponseDto',) as AlbumCountResponseDto;
+ return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AlbumResponseDto',) as AlbumResponseDto;
}
return null;
}
- /// Performs an HTTP 'GET /albums/{id}' operation and returns the [Response].
- /// Parameters:
- ///
- /// * [String] id (required):
- ///
- /// * [String] key:
- ///
- /// * [bool] withoutAssets:
- Future<Response> getAlbumInfoWithHttpInfo(String id, { String? key, bool? withoutAssets, }) async {
+ /// Performs an HTTP 'GET /albums/statistics' operation and returns the [Response].
+ Future<Response> getAlbumStatisticsWithHttpInfo() async {
// ignore: prefer_const_declarations
- final path = r'/albums/{id}'
- .replaceAll('{id}', id);
+ final path = r'/albums/statistics';
// ignore: prefer_final_locals
Object? postBody;
@@ -279,13 +293,6 @@ class AlbumsApi {
final headerParams = <String, String>{};
final formParams = <String, String>{};
- if (key != null) {
- queryParams.addAll(_queryParams('', 'key', key));
- }
- if (withoutAssets != null) {
- queryParams.addAll(_queryParams('', 'withoutAssets', withoutAssets));
- }
-
const contentTypes = <String>[];
@@ -300,15 +307,8 @@ class AlbumsApi {
);
}
- /// Parameters:
- ///
- /// * [String] id (required):
- ///
- /// * [String] key:
- ///
- /// * [bool] withoutAssets:
- Future<AlbumResponseDto?> getAlbumInfo(String id, { String? key, bool? withoutAssets, }) async {
- final response = await getAlbumInfoWithHttpInfo(id, key: key, withoutAssets: withoutAssets, );
+ Future<AlbumStatisticsResponseDto?> getAlbumStatistics() async {
+ final response = await getAlbumStatisticsWithHttpInfo();
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
@@ -316,7 +316,7 @@ class AlbumsApi {
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
- return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AlbumResponseDto',) as AlbumResponseDto;
+ return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'AlbumStatisticsResponseDto',) as AlbumStatisticsResponseDto;
}
return null;
diff --git a/mobile/openapi/lib/api_client.dart b/mobile/openapi/lib/api_client.dart
index 935324272d..c9ed2a508d 100644
--- a/mobile/openapi/lib/api_client.dart
+++ b/mobile/openapi/lib/api_client.dart
@@ -201,10 +201,10 @@ class ApiClient {
return AddUsersDto.fromJson(value);
case 'AdminOnboardingUpdateDto':
return AdminOnboardingUpdateDto.fromJson(value);
- case 'AlbumCountResponseDto':
- return AlbumCountResponseDto.fromJson(value);
case 'AlbumResponseDto':
return AlbumResponseDto.fromJson(value);
+ case 'AlbumStatisticsResponseDto':
+ return AlbumStatisticsResponseDto.fromJson(value);
case 'AlbumUserAddDto':
return AlbumUserAddDto.fromJson(value);
case 'AlbumUserCreateDto':
diff --git a/mobile/openapi/lib/model/album_count_response_dto.dart b/mobile/openapi/lib/model/album_statistics_response_dto.dart
similarity index 63%
rename from mobile/openapi/lib/model/album_count_response_dto.dart
rename to mobile/openapi/lib/model/album_statistics_response_dto.dart
index 531a17a083..90dbe52016 100644
--- a/mobile/openapi/lib/model/album_count_response_dto.dart
+++ b/mobile/openapi/lib/model/album_statistics_response_dto.dart
@@ -10,9 +10,9 @@
part of openapi.api;
-class AlbumCountResponseDto {
- /// Returns a new [AlbumCountResponseDto] instance.
- AlbumCountResponseDto({
+class AlbumStatisticsResponseDto {
+ /// Returns a new [AlbumStatisticsResponseDto] instance.
+ AlbumStatisticsResponseDto({
required this.notShared,
required this.owned,
required this.shared,
@@ -25,7 +25,7 @@ class AlbumCountResponseDto {
int shared;
@override
- bool operator ==(Object other) => identical(this, other) || other is AlbumCountResponseDto &&
+ bool operator ==(Object other) => identical(this, other) || other is AlbumStatisticsResponseDto &&
other.notShared == notShared &&
other.owned == owned &&
other.shared == shared;
@@ -38,7 +38,7 @@ class AlbumCountResponseDto {
(shared.hashCode);
@override
- String toString() => 'AlbumCountResponseDto[notShared=$notShared, owned=$owned, shared=$shared]';
+ String toString() => 'AlbumStatisticsResponseDto[notShared=$notShared, owned=$owned, shared=$shared]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
@@ -48,14 +48,14 @@ class AlbumCountResponseDto {
return json;
}
- /// Returns a new [AlbumCountResponseDto] instance and imports its values from
+ /// Returns a new [AlbumStatisticsResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
- static AlbumCountResponseDto? fromJson(dynamic value) {
+ static AlbumStatisticsResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
- return AlbumCountResponseDto(
+ return AlbumStatisticsResponseDto(
notShared: mapValueOfType<int>(json, r'notShared')!,
owned: mapValueOfType<int>(json, r'owned')!,
shared: mapValueOfType<int>(json, r'shared')!,
@@ -64,11 +64,11 @@ class AlbumCountResponseDto {
return null;
}
- static List<AlbumCountResponseDto> listFromJson(dynamic json, {bool growable = false,}) {
- final result = <AlbumCountResponseDto>[];
+ static List<AlbumStatisticsResponseDto> listFromJson(dynamic json, {bool growable = false,}) {
+ final result = <AlbumStatisticsResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
- final value = AlbumCountResponseDto.fromJson(row);
+ final value = AlbumStatisticsResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
@@ -77,12 +77,12 @@ class AlbumCountResponseDto {
return result.toList(growable: growable);
}
- static Map<String, AlbumCountResponseDto> mapFromJson(dynamic json) {
- final map = <String, AlbumCountResponseDto>{};
+ static Map<String, AlbumStatisticsResponseDto> mapFromJson(dynamic json) {
+ final map = <String, AlbumStatisticsResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
- final value = AlbumCountResponseDto.fromJson(entry.value);
+ final value = AlbumStatisticsResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
@@ -91,14 +91,14 @@ class AlbumCountResponseDto {
return map;
}
- // maps a json object with a list of AlbumCountResponseDto-objects as value to a dart map
- static Map<String, List<AlbumCountResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
- final map = <String, List<AlbumCountResponseDto>>{};
+ // maps a json object with a list of AlbumStatisticsResponseDto-objects as value to a dart map
+ static Map<String, List<AlbumStatisticsResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
+ final map = <String, List<AlbumStatisticsResponseDto>>{};
if (json is Map && json.isNotEmpty) {
// ignore: parameter_assignments
json = json.cast<String, dynamic>();
for (final entry in json.entries) {
- map[entry.key] = AlbumCountResponseDto.listFromJson(entry.value, growable: growable,);
+ map[entry.key] = AlbumStatisticsResponseDto.listFromJson(entry.value, growable: growable,);
}
}
return map;
diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json
index a9b08fc400..16c25562a6 100644
--- a/open-api/immich-openapi-specs.json
+++ b/open-api/immich-openapi-specs.json
@@ -660,16 +660,16 @@
]
}
},
- "/albums/count": {
+ "/albums/statistics": {
"get": {
- "operationId": "getAlbumCount",
+ "operationId": "getAlbumStatistics",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/AlbumCountResponseDto"
+ "$ref": "#/components/schemas/AlbumStatisticsResponseDto"
}
}
},
@@ -7505,25 +7505,6 @@
],
"type": "object"
},
- "AlbumCountResponseDto": {
- "properties": {
- "notShared": {
- "type": "integer"
- },
- "owned": {
- "type": "integer"
- },
- "shared": {
- "type": "integer"
- }
- },
- "required": [
- "notShared",
- "owned",
- "shared"
- ],
- "type": "object"
- },
"AlbumResponseDto": {
"properties": {
"albumName": {
@@ -7611,6 +7592,25 @@
],
"type": "object"
},
+ "AlbumStatisticsResponseDto": {
+ "properties": {
+ "notShared": {
+ "type": "integer"
+ },
+ "owned": {
+ "type": "integer"
+ },
+ "shared": {
+ "type": "integer"
+ }
+ },
+ "required": [
+ "notShared",
+ "owned",
+ "shared"
+ ],
+ "type": "object"
+ },
"AlbumUserAddDto": {
"properties": {
"role": {
diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts
index 8b503821f7..c6d8d3e3ba 100644
--- a/open-api/typescript-sdk/src/fetch-client.ts
+++ b/open-api/typescript-sdk/src/fetch-client.ts
@@ -268,7 +268,7 @@ export type CreateAlbumDto = {
assetIds?: string[];
description?: string;
};
-export type AlbumCountResponseDto = {
+export type AlbumStatisticsResponseDto = {
notShared: number;
owned: number;
shared: number;
@@ -1369,11 +1369,11 @@ export function createAlbum({ createAlbumDto }: {
body: createAlbumDto
})));
}
-export function getAlbumCount(opts?: Oazapfts.RequestOpts) {
+export function getAlbumStatistics(opts?: Oazapfts.RequestOpts) {
return oazapfts.ok(oazapfts.fetchJson<{
status: 200;
- data: AlbumCountResponseDto;
- }>("/albums/count", {
+ data: AlbumStatisticsResponseDto;
+ }>("/albums/statistics", {
...opts
}));
}
diff --git a/server/src/controllers/album.controller.ts b/server/src/controllers/album.controller.ts
index 06f2066c29..49ec5a82ea 100644
--- a/server/src/controllers/album.controller.ts
+++ b/server/src/controllers/album.controller.ts
@@ -2,9 +2,9 @@ import { Body, Controller, Delete, Get, Param, Patch, Post, Put, Query } from '@
import { ApiTags } from '@nestjs/swagger';
import {
AddUsersDto,
- AlbumCountResponseDto,
AlbumInfoDto,
AlbumResponseDto,
+ AlbumStatisticsResponseDto,
CreateAlbumDto,
GetAlbumsDto,
UpdateAlbumDto,
@@ -22,12 +22,6 @@ import { ParseMeUUIDPipe, UUIDParamDto } from 'src/validation';
export class AlbumController {
constructor(private service: AlbumService) {}
- @Get('count')
- @Authenticated({ permission: Permission.ALBUM_STATISTICS })
- getAlbumCount(@Auth() auth: AuthDto): Promise<AlbumCountResponseDto> {
- return this.service.getCount(auth);
- }
-
@Get()
@Authenticated({ permission: Permission.ALBUM_READ })
getAllAlbums(@Auth() auth: AuthDto, @Query() query: GetAlbumsDto): Promise<AlbumResponseDto[]> {
@@ -40,6 +34,12 @@ export class AlbumController {
return this.service.create(auth, dto);
}
+ @Get('statistics')
+ @Authenticated({ permission: Permission.ALBUM_STATISTICS })
+ getAlbumStatistics(@Auth() auth: AuthDto): Promise<AlbumStatisticsResponseDto> {
+ return this.service.getStatistics(auth);
+ }
+
@Authenticated({ permission: Permission.ALBUM_READ, sharedLink: true })
@Get(':id')
getAlbumInfo(
diff --git a/server/src/dtos/album.dto.ts b/server/src/dtos/album.dto.ts
index 8f5c996cae..b12847ee62 100644
--- a/server/src/dtos/album.dto.ts
+++ b/server/src/dtos/album.dto.ts
@@ -95,7 +95,7 @@ export class GetAlbumsDto {
assetId?: string;
}
-export class AlbumCountResponseDto {
+export class AlbumStatisticsResponseDto {
@ApiProperty({ type: 'integer' })
owned!: number;
diff --git a/server/src/services/album.service.spec.ts b/server/src/services/album.service.spec.ts
index 406302ece9..16b2d97fdd 100644
--- a/server/src/services/album.service.spec.ts
+++ b/server/src/services/album.service.spec.ts
@@ -43,12 +43,12 @@ describe(AlbumService.name, () => {
expect(sut).toBeDefined();
});
- describe('getCount', () => {
+ describe('getStatistics', () => {
it('should get the album count', async () => {
albumMock.getOwned.mockResolvedValue([]);
albumMock.getShared.mockResolvedValue([]);
albumMock.getNotShared.mockResolvedValue([]);
- await expect(sut.getCount(authStub.admin)).resolves.toEqual({
+ await expect(sut.getStatistics(authStub.admin)).resolves.toEqual({
owned: 0,
shared: 0,
notShared: 0,
diff --git a/server/src/services/album.service.ts b/server/src/services/album.service.ts
index 02dab1a740..b2b5ea32a2 100644
--- a/server/src/services/album.service.ts
+++ b/server/src/services/album.service.ts
@@ -1,9 +1,9 @@
import { BadRequestException, Inject, Injectable } from '@nestjs/common';
import {
AddUsersDto,
- AlbumCountResponseDto,
AlbumInfoDto,
AlbumResponseDto,
+ AlbumStatisticsResponseDto,
CreateAlbumDto,
GetAlbumsDto,
UpdateAlbumDto,
@@ -37,7 +37,7 @@ export class AlbumService {
@Inject(IAlbumUserRepository) private albumUserRepository: IAlbumUserRepository,
) {}
- async getCount(auth: AuthDto): Promise<AlbumCountResponseDto> {
+ async getStatistics(auth: AuthDto): Promise<AlbumStatisticsResponseDto> {
const [owned, shared, notShared] = await Promise.all([
this.albumRepository.getOwned(auth.user.id),
this.albumRepository.getShared(auth.user.id),
diff --git a/web/src/lib/components/shared-components/side-bar/more-information-albums.svelte b/web/src/lib/components/shared-components/side-bar/more-information-albums.svelte
index e47daaf86b..68c58ab155 100644
--- a/web/src/lib/components/shared-components/side-bar/more-information-albums.svelte
+++ b/web/src/lib/components/shared-components/side-bar/more-information-albums.svelte
@@ -1,13 +1,13 @@
<script lang="ts">
- import { type AlbumCountResponseDto, getAlbumCount } from '@immich/sdk';
+ import { type AlbumStatisticsResponseDto, getAlbumStatistics } from '@immich/sdk';
import LoadingSpinner from '$lib/components/shared-components/loading-spinner.svelte';
import { t } from 'svelte-i18n';
- export let albumCountType: keyof AlbumCountResponseDto;
+ export let albumType: keyof AlbumStatisticsResponseDto;
const handleAlbumCount = async () => {
try {
- return await getAlbumCount();
+ return await getAlbumStatistics();
} catch {
return { owned: 0, shared: 0, notShared: 0 };
}
@@ -18,6 +18,6 @@
<LoadingSpinner />
{:then data}
<div>
- <p>{$t('albums_count', { values: { count: data[albumCountType] } })}</p>
+ <p>{$t('albums_count', { values: { count: data[albumType] } })}</p>
</div>
{/await}
diff --git a/web/src/lib/components/shared-components/side-bar/side-bar.svelte b/web/src/lib/components/shared-components/side-bar/side-bar.svelte
index 6688a427dd..05ae856919 100644
--- a/web/src/lib/components/shared-components/side-bar/side-bar.svelte
+++ b/web/src/lib/components/shared-components/side-bar/side-bar.svelte
@@ -79,7 +79,7 @@
bind:isSelected={isSharingSelected}
>
<svelte:fragment slot="moreInformation">
- <MoreInformationAlbums albumCountType="shared" />
+ <MoreInformationAlbums albumType="shared" />
</svelte:fragment>
</SideBarLink>
{/if}
@@ -100,7 +100,7 @@
</SideBarLink>
<SideBarLink title={$t('albums')} routeId="/(user)/albums" icon={mdiImageAlbum} flippedLogo>
<svelte:fragment slot="moreInformation">
- <MoreInformationAlbums albumCountType="owned" />
+ <MoreInformationAlbums albumType="owned" />
</svelte:fragment>
</SideBarLink>