refactor: server-info (#2038)

server/libs/domain/src/server-info/index.ts

@@ -0,0 +1,2 @@
+export * from './response-dto';
+export * from './server-info.service';

server/libs/domain/src/server-info/response-dto/index.ts

@@ -0,0 +1,5 @@
+export * from './server-info-response.dto';
+export * from './server-ping-response.dto';
+export * from './server-stats-response.dto';
+export * from './server-version-response.dto';
+export * from './usage-by-user-response.dto';

server/libs/domain/src/server-info/response-dto/server-info-response.dto.ts

@@ -0,0 +1,19 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class ServerInfoResponseDto {
+  diskSize!: string;
+  diskUse!: string;
+  diskAvailable!: string;
+
+  @ApiProperty({ type: 'integer', format: 'int64' })
+  diskSizeRaw!: number;
+
+  @ApiProperty({ type: 'integer', format: 'int64' })
+  diskUseRaw!: number;
+
+  @ApiProperty({ type: 'integer', format: 'int64' })
+  diskAvailableRaw!: number;
+
+  @ApiProperty({ type: 'number', format: 'float' })
+  diskUsagePercentage!: number;
+}

server/libs/domain/src/server-info/response-dto/server-ping-response.dto.ts

@@ -0,0 +1,10 @@
+import { ApiResponseProperty } from '@nestjs/swagger';
+
+export class ServerPingResponse {
+  constructor(res: string) {
+    this.res = res;
+  }
+
+  @ApiResponseProperty({ type: String, example: 'pong' })
+  res!: string;
+}

server/libs/domain/src/server-info/response-dto/server-stats-response.dto.ts

@@ -0,0 +1,27 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { UsageByUserDto } from './usage-by-user-response.dto';
+
+export class ServerStatsResponseDto {
+  @ApiProperty({ type: 'integer' })
+  photos = 0;
+
+  @ApiProperty({ type: 'integer' })
+  videos = 0;
+
+  @ApiProperty({ type: 'integer', format: 'int64' })
+  usage = 0;
+
+  @ApiProperty({
+    isArray: true,
+    type: UsageByUserDto,
+    title: 'Array of usage for each user',
+    example: [
+      {
+        photos: 1,
+        videos: 1,
+        diskUsageRaw: 1,
+      },
+    ],
+  })
+  usageByUser: UsageByUserDto[] = [];
+}

server/libs/domain/src/server-info/response-dto/server-version-response.dto.ts

@@ -0,0 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IServerVersion } from '@app/domain';
+
+export class ServerVersionReponseDto implements IServerVersion {
+  @ApiProperty({ type: 'integer' })
+  major!: number;
+  @ApiProperty({ type: 'integer' })
+  minor!: number;
+  @ApiProperty({ type: 'integer' })
+  patch!: number;
+}

server/libs/domain/src/server-info/response-dto/usage-by-user-response.dto.ts

@@ -0,0 +1,16 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class UsageByUserDto {
+  @ApiProperty({ type: 'string' })
+  userId!: string;
+  @ApiProperty({ type: 'string' })
+  userFirstName!: string;
+  @ApiProperty({ type: 'string' })
+  userLastName!: string;
+  @ApiProperty({ type: 'integer' })
+  photos!: number;
+  @ApiProperty({ type: 'integer' })
+  videos!: number;
+  @ApiProperty({ type: 'integer', format: 'int64' })
+  usage!: number;
+}

server/libs/domain/src/server-info/server-info.service.spec.ts

@@ -0,0 +1,209 @@
+import { newStorageRepositoryMock, newUserRepositoryMock } from '../../test';
+import { serverVersion } from '../domain.constant';
+import { IStorageRepository } from '../storage';
+import { IUserRepository } from '../user';
+import { ServerInfoService } from './server-info.service';
+
+describe(ServerInfoService.name, () => {
+  let sut: ServerInfoService;
+  let storageMock: jest.Mocked<IStorageRepository>;
+  let userMock: jest.Mocked<IUserRepository>;
+
+  beforeEach(() => {
+    storageMock = newStorageRepositoryMock();
+    userMock = newUserRepositoryMock();
+
+    sut = new ServerInfoService(userMock, storageMock);
+  });
+
+  it('should work', () => {
+    expect(sut).toBeDefined();
+  });
+
+  describe('getInfo', () => {
+    it('should return the disk space as B', async () => {
+      storageMock.checkDiskUsage.mockResolvedValue({ free: 200, available: 300, total: 500 });
+
+      await expect(sut.getInfo()).resolves.toEqual({
+        diskAvailable: '300 B',
+        diskAvailableRaw: 300,
+        diskSize: '500 B',
+        diskSizeRaw: 500,
+        diskUsagePercentage: 60,
+        diskUse: '300 B',
+        diskUseRaw: 300,
+      });
+
+      expect(storageMock.checkDiskUsage).toHaveBeenCalledWith('./upload');
+    });
+
+    it('should return the disk space as KiB', async () => {
+      storageMock.checkDiskUsage.mockResolvedValue({ free: 200_000, available: 300_000, total: 500_000 });
+
+      await expect(sut.getInfo()).resolves.toEqual({
+        diskAvailable: '293.0 KiB',
+        diskAvailableRaw: 300000,
+        diskSize: '488.3 KiB',
+        diskSizeRaw: 500000,
+        diskUsagePercentage: 60,
+        diskUse: '293.0 KiB',
+        diskUseRaw: 300000,
+      });
+
+      expect(storageMock.checkDiskUsage).toHaveBeenCalledWith('./upload');
+    });
+
+    it('should return the disk space as MiB', async () => {
+      storageMock.checkDiskUsage.mockResolvedValue({ free: 200_000_000, available: 300_000_000, total: 500_000_000 });
+
+      await expect(sut.getInfo()).resolves.toEqual({
+        diskAvailable: '286.1 MiB',
+        diskAvailableRaw: 300000000,
+        diskSize: '476.8 MiB',
+        diskSizeRaw: 500000000,
+        diskUsagePercentage: 60,
+        diskUse: '286.1 MiB',
+        diskUseRaw: 300000000,
+      });
+
+      expect(storageMock.checkDiskUsage).toHaveBeenCalledWith('./upload');
+    });
+
+    it('should return the disk space as GiB', async () => {
+      storageMock.checkDiskUsage.mockResolvedValue({
+        free: 200_000_000_000,
+        available: 300_000_000_000,
+        total: 500_000_000_000,
+      });
+
+      await expect(sut.getInfo()).resolves.toEqual({
+        diskAvailable: '279.4 GiB',
+        diskAvailableRaw: 300000000000,
+        diskSize: '465.7 GiB',
+        diskSizeRaw: 500000000000,
+        diskUsagePercentage: 60,
+        diskUse: '279.4 GiB',
+        diskUseRaw: 300000000000,
+      });
+
+      expect(storageMock.checkDiskUsage).toHaveBeenCalledWith('./upload');
+    });
+
+    it('should return the disk space as TiB', async () => {
+      storageMock.checkDiskUsage.mockResolvedValue({
+        free: 200_000_000_000_000,
+        available: 300_000_000_000_000,
+        total: 500_000_000_000_000,
+      });
+
+      await expect(sut.getInfo()).resolves.toEqual({
+        diskAvailable: '272.8 TiB',
+        diskAvailableRaw: 300000000000000,
+        diskSize: '454.7 TiB',
+        diskSizeRaw: 500000000000000,
+        diskUsagePercentage: 60,
+        diskUse: '272.8 TiB',
+        diskUseRaw: 300000000000000,
+      });
+
+      expect(storageMock.checkDiskUsage).toHaveBeenCalledWith('./upload');
+    });
+
+    it('should return the disk space as PiB', async () => {
+      storageMock.checkDiskUsage.mockResolvedValue({
+        free: 200_000_000_000_000_000,
+        available: 300_000_000_000_000_000,
+        total: 500_000_000_000_000_000,
+      });
+
+      await expect(sut.getInfo()).resolves.toEqual({
+        diskAvailable: '266.5 PiB',
+        diskAvailableRaw: 300000000000000000,
+        diskSize: '444.1 PiB',
+        diskSizeRaw: 500000000000000000,
+        diskUsagePercentage: 60,
+        diskUse: '266.5 PiB',
+        diskUseRaw: 300000000000000000,
+      });
+
+      expect(storageMock.checkDiskUsage).toHaveBeenCalledWith('./upload');
+    });
+  });
+
+  describe('ping', () => {
+    it('should respond with pong', () => {
+      expect(sut.ping()).toEqual({ res: 'pong' });
+    });
+  });
+
+  describe('getVersion', () => {
+    it('should respond the server version', () => {
+      expect(sut.getVersion()).toEqual(serverVersion);
+    });
+  });
+
+  describe('getStats', () => {
+    it('should total up usage by user', async () => {
+      userMock.getUserStats.mockResolvedValue([
+        {
+          userId: 'user1',
+          userFirstName: '1',
+          userLastName: 'User',
+          photos: 10,
+          videos: 11,
+          usage: 12345,
+        },
+        {
+          userId: 'user2',
+          userFirstName: '2',
+          userLastName: 'User',
+          photos: 10,
+          videos: 20,
+          usage: 123456,
+        },
+        {
+          userId: 'user3',
+          userFirstName: '3',
+          userLastName: 'User',
+          photos: 100,
+          videos: 0,
+          usage: 987654,
+        },
+      ]);
+
+      await expect(sut.getStats()).resolves.toEqual({
+        photos: 120,
+        videos: 31,
+        usage: 1123455,
+        usageByUser: [
+          {
+            photos: 10,
+            usage: 12345,
+            userFirstName: '1',
+            userId: 'user1',
+            userLastName: 'User',
+            videos: 11,
+          },
+          {
+            photos: 10,
+            usage: 123456,
+            userFirstName: '2',
+            userId: 'user2',
+            userLastName: 'User',
+            videos: 20,
+          },
+          {
+            photos: 100,
+            usage: 987654,
+            userFirstName: '3',
+            userId: 'user3',
+            userLastName: 'User',
+            videos: 0,
+          },
+        ],
+      });
+
+      expect(userMock.getUserStats).toHaveBeenCalled();
+    });
+  });
+});

server/libs/domain/src/server-info/server-info.service.ts

@@ -0,0 +1,60 @@
+import { Inject, Injectable } from '@nestjs/common';
+import { APP_UPLOAD_LOCATION, serverVersion } from '../domain.constant';
+import { asHumanReadable } from '../domain.util';
+import { IStorageRepository } from '../storage';
+import { IUserRepository, UserStatsQueryResponse } from '../user';
+import { ServerInfoResponseDto, ServerPingResponse, ServerStatsResponseDto, UsageByUserDto } from './response-dto';
+
+@Injectable()
+export class ServerInfoService {
+  constructor(
+    @Inject(IUserRepository) private userRepository: IUserRepository,
+    @Inject(IStorageRepository) private storageRepository: IStorageRepository,
+  ) {}
+
+  async getInfo(): Promise<ServerInfoResponseDto> {
+    const diskInfo = await this.storageRepository.checkDiskUsage(APP_UPLOAD_LOCATION);
+
+    const usagePercentage = (((diskInfo.total - diskInfo.free) / diskInfo.total) * 100).toFixed(2);
+
+    const serverInfo = new ServerInfoResponseDto();
+    serverInfo.diskAvailable = asHumanReadable(diskInfo.available);
+    serverInfo.diskSize = asHumanReadable(diskInfo.total);
+    serverInfo.diskUse = asHumanReadable(diskInfo.total - diskInfo.free);
+    serverInfo.diskAvailableRaw = diskInfo.available;
+    serverInfo.diskSizeRaw = diskInfo.total;
+    serverInfo.diskUseRaw = diskInfo.total - diskInfo.free;
+    serverInfo.diskUsagePercentage = parseFloat(usagePercentage);
+    return serverInfo;
+  }
+
+  ping(): ServerPingResponse {
+    return new ServerPingResponse('pong');
+  }
+
+  getVersion() {
+    return serverVersion;
+  }
+
+  async getStats(): Promise<ServerStatsResponseDto> {
+    const userStats: UserStatsQueryResponse[] = await this.userRepository.getUserStats();
+    const serverStats = new ServerStatsResponseDto();
+
+    for (const user of userStats) {
+      const usage = new UsageByUserDto();
+      usage.userId = user.userId;
+      usage.userFirstName = user.userFirstName;
+      usage.userLastName = user.userLastName;
+      usage.photos = user.photos;
+      usage.videos = user.videos;
+      usage.usage = user.usage;
+
+      serverStats.photos += usage.photos;
+      serverStats.videos += usage.videos;
+      serverStats.usage += usage.usage;
+      serverStats.usageByUser.push(usage);
+    }
+
+    return serverStats;
+  }
+}