passing sortOrder and size (#665)

Signed-off-by: Amardeepsingh Siglani <[email protected]>
opensearch-project · Jul 24, 2023 · 15f2e2f · 15f2e2f
1 parent 91068ef
commit 15f2e2f
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 10 deletions.
diff --git a/public/services/AlertsService.ts b/public/services/AlertsService.ts
@@ -23,14 +23,19 @@ export default class AlertsService {
     detectorParams: GetAlertsParams
   ): Promise<ServerResponse<GetAlertsResponse>> => {
     const { detectorType, detector_id } = detectorParams;
-    let query: GetAlertsParams | {} = {};
+    let query: GetAlertsParams | {} = {
+      sortOrder: 'desc',
+      size: 10000,
+    };
 
     if (detector_id) {
       query = {
+        ...query,
         detector_id,
       };
     } else if (detectorType) {
       query = {
+        ...query,
         detectorType,
       };
     }

diff --git a/public/services/FindingsService.ts b/public/services/FindingsService.ts
@@ -19,14 +19,19 @@ export default class FindingsService {
     detectorParams: GetFindingsParams
   ): Promise<ServerResponse<GetFindingsResponse>> => {
     const { detectorType, detectorId } = detectorParams;
-    let query: GetFindingsParams | {} = {};
+    let query: GetFindingsParams | {} = {
+      sortOrder: 'desc',
+      size: 10000,
+    };
 
     if (detectorId) {
       query = {
+        ...query,
         detectorId,
       };
     } else if (detectorType) {
       query = {
+        ...query,
         detectorType,
       };
     }

diff --git a/server/clusters/addAlertsMethods.ts b/server/clusters/addAlertsMethods.ts
@@ -8,12 +8,20 @@ import { METHOD_NAMES, API, BASE_API_PATH } from '../utils/constants';
 export function addAlertsMethods(securityAnalytics: any, createAction: any): void {
   securityAnalytics[METHOD_NAMES.GET_ALERTS] = createAction({
     url: {
-      fmt: `${API.GET_ALERTS}?detector_id=<%=detector_id%>`,
+      fmt: `${API.GET_ALERTS}?detector_id=<%=detector_id%>&sortOrder=<%=sortOrder%>&size=<%=size%>`,
       req: {
         detector_id: {
           type: 'string',
           required: false,
         },
+        sortOrder: {
+          type: 'string',
+          required: false,
+        },
+        size: {
+          type: 'number',
+          required: false,
+        },
       },
     },
     needBody: false,

diff --git a/server/clusters/addFindingsMethods.ts b/server/clusters/addFindingsMethods.ts
@@ -8,12 +8,20 @@ import { METHOD_NAMES, API } from '../utils/constants';
 export function addFindingsMethods(securityAnalytics: any, createAction: any): void {
   securityAnalytics[METHOD_NAMES.GET_FINDINGS] = createAction({
     url: {
-      fmt: `${API.GET_FINDINGS}?detector_id=<%=detectorId%>`,
+      fmt: `${API.GET_FINDINGS}?detector_id=<%=detectorId%>&sortOrder=<%=sortOrder%>&size=<%=size%>`,
       req: {
         detectorId: {
           type: 'string',
           required: false,
         },
+        sortOrder: {
+          type: 'string',
+          required: false,
+        },
+        size: {
+          type: 'number',
+          required: false,
+        },
       },
     },
     needBody: false,

diff --git a/server/models/interfaces/Alerts.ts b/server/models/interfaces/Alerts.ts
@@ -3,15 +3,19 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export type GetAlertsParams =
+export type GetAlertsParams = {
+  sortOrder?: string;
+  size?: number;
+} & (
   | {
       detector_id: string;
       detectorType?: string;
     }
   | {
       detectorType: string;
       detector_id?: string;
-    };
+    }
+);
 
 export interface GetAlertsResponse {
   alerts: AlertResponse[];

diff --git a/server/models/interfaces/Findings.ts b/server/models/interfaces/Findings.ts
@@ -5,15 +5,19 @@
 
 import { Finding } from '../../../public/pages/Findings/models/interfaces';
 
-export type GetFindingsParams =
+export type GetFindingsParams = {
+  sortOrder?: string;
+  size?: number;
+} & (
   | {
       detectorId: string;
       detectorType?: string;
     }
   | {
       detectorType: string;
       detectorId?: string;
-    };
+    }
+);
 
 export interface GetFindingsResponse {
   total_findings: number;

diff --git a/server/routes/AlertRoutes.ts b/server/routes/AlertRoutes.ts
@@ -18,6 +18,8 @@ export function setupAlertsRoutes(services: NodeServices, router: IRouter) {
         query: schema.object({
           detectorType: schema.maybe(schema.string()),
           detector_id: schema.maybe(schema.string()),
+          sortOrder: schema.maybe(schema.string()),
+          size: schema.maybe(schema.number()),
         }),
       },
     },

diff --git a/server/routes/FindingsRoutes.ts b/server/routes/FindingsRoutes.ts
@@ -18,6 +18,8 @@ export function setupFindingsRoutes(services: NodeServices, router: IRouter) {
         query: schema.object({
           detectorType: schema.maybe(schema.string()),
           detectorId: schema.maybe(schema.string()),
+          sortOrder: schema.maybe(schema.string()),
+          size: schema.maybe(schema.number()),
         }),
       },
     },

diff --git a/server/services/AlertService.ts b/server/services/AlertService.ts
@@ -36,15 +36,21 @@ export default class AlertService {
     response: OpenSearchDashboardsResponseFactory
   ): Promise<IOpenSearchDashboardsResponse<ServerResponse<GetAlertsResponse> | ResponseError>> => {
     try {
-      const { detectorType, detector_id } = request.query;
+      const { detectorType, detector_id, sortOrder, size } = request.query;
+      const defaultParams = {
+        sortOrder,
+        size,
+      };
       let params: GetAlertsParams;
 
       if (detector_id) {
         params = {
+          ...defaultParams,
           detector_id,
         };
       } else if (detectorType) {
         params = {
+          ...defaultParams,
           detectorType,
         };
       } else {

diff --git a/server/services/FindingsService.ts b/server/services/FindingsService.ts
@@ -33,15 +33,21 @@ export default class FindingsService {
     IOpenSearchDashboardsResponse<ServerResponse<GetFindingsResponse> | ResponseError>
   > => {
     try {
-      const { detectorType, detectorId } = request.query;
+      const { detectorType, detectorId, sortOrder, size } = request.query;
+      const defaultParams = {
+        sortOrder,
+        size,
+      };
       let params: GetFindingsParams;
 
       if (detectorId) {
         params = {
+          ...defaultParams,
           detectorId,
         };
       } else if (detectorType) {
         params = {
+          ...defaultParams,
           detectorType,
         };
       } else {