feat: add topNodesLimit parameter to bandwidth stats commands

Author: kastov

libs/contract/commands/bandwidth-stats/nodes/get-stats-nodes-usage.command.ts

@@ -16,6 +16,7 @@ export namespace GetStatsNodesUsageCommand {
     export const RequestQuerySchema = z.object({
         start: z.string().date(),
         end: z.string().date(),
+        topNodesLimit: z.coerce.number().min(1).default(20),
     });
 
     export type RequestQuery = z.infer<typeof RequestQuerySchema>;

libs/contract/commands/bandwidth-stats/users/get-stats-user-usage.command.ts

@@ -22,6 +22,7 @@ export namespace GetStatsUserUsageCommand {
     export const RequestQuerySchema = z.object({
         start: z.string().date(),
         end: z.string().date(),
+        topNodesLimit: z.coerce.number().min(1).default(20),
     });
 
     export type RequestQuery = z.infer<typeof RequestQuerySchema>;

libs/contract/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remnawave/backend-contract",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "public": true,
   "license": "AGPL-3.0-only",
   "description": "A contract library for Remnawave Backend. It can be used in backend and frontend.",

src/modules/nodes-usage-history/nodes-usage-history.controller.ts

@@ -39,16 +39,26 @@ export class NodesUsageHistoryController {
         description: 'Start date',
         required: true,
     })
+    @ApiQuery({
+        name: 'topNodesLimit',
+        type: Number,
+        description: 'Limit of top nodes to return',
+        required: true,
+    })
     @Endpoint({
         command: GetStatsNodesUsageCommand,
         httpCode: HttpStatus.OK,
     })
     async getStatsNodesUsage(
         @Query() query: GetStatsNodesUsageRequestQueryDto,
     ): Promise<GetStatsNodesUsageResponseDto> {
-        const { start, end } = query;
+        const { start, end, topNodesLimit } = query;
 
-        const result = await this.nodesUsageHistoryService.getStatsNodesUsage(start, end);
+        const result = await this.nodesUsageHistoryService.getStatsNodesUsage(
+            start,
+            end,
+            topNodesLimit,
+        );
 
         const data = errorHandler(result);
         return {

src/modules/nodes-usage-history/nodes-usage-history.service.ts

@@ -17,6 +17,7 @@ export class NodesUsageHistoryService {
     async getStatsNodesUsage(
         start: string,
         end: string,
+        topNodesLimit: number,
     ): Promise<TResult<GetStatsNodesUsageResponseModel>> {
         try {
             const { startDate, endDate, dates } = getDateRangeArrayUtil(
@@ -33,6 +34,7 @@ export class NodesUsageHistoryService {
             const topNodes = await this.nodeUsageHistoryRepository.getTopNodesByTraffic(
                 startDate,
                 endDate,
+                topNodesLimit,
             );
 
             const nodesUsage = await this.nodeUsageHistoryRepository.getNodesUsageByRange(

src/modules/nodes-user-usage-history/bandwidth-stats-users.controller.ts

@@ -97,6 +97,12 @@ export class BandwidthStatsUsersController {
         description: 'Start date',
         required: true,
     })
+    @ApiQuery({
+        name: 'topNodesLimit',
+        type: Number,
+        description: 'Limit of top nodes to return',
+        required: true,
+    })
     @Endpoint({
         command: GetStatsUserUsageCommand,
         httpCode: HttpStatus.OK,
@@ -109,6 +115,7 @@ export class BandwidthStatsUsersController {
             paramData.uuid,
             query.start,
             query.end,
+            query.topNodesLimit,
         );
 
         const data = errorHandler(result);

src/modules/nodes-user-usage-history/nodes-user-usage-history.service.ts

@@ -91,6 +91,7 @@ export class NodesUserUsageHistoryService {
         uuid: string,
         start: string,
         end: string,
+        topNodesLimit: number,
     ): Promise<TResult<GetStatsUserUsageResponseModel>> {
         try {
             const user = await this.queryBus.execute(new GetUserByUniqueFieldQuery({ uuid }));
@@ -114,6 +115,7 @@ export class NodesUserUsageHistoryService {
                 user.response.tId,
                 startDate,
                 endDate,
+                topNodesLimit,
             );
 
             const nodesUsage = await this.nodeUserUsageHistoryRepository.getUserNodesUsageByRange(