Use cat snapshot to get the number of snapshot for a repo (#1242)

Signed-off-by: Sandeep Kumawat <[email protected]> Co-authored-by: Sandeep Kumawat <[email protected]> (cherry picked from commit c459af0) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Jan 24, 2025 · b727003 · b727003
1 parent 3db302c
commit b727003
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 7 deletions.
diff --git a/package.json b/package.json
@@ -83,4 +83,4 @@
   "engines": {
     "yarn": "^1.21.1"
   }
-}
+}
diff --git a/server/models/interfaces.ts b/server/models/interfaces.ts
@@ -409,6 +409,22 @@ export interface GetSnapshotResponse {
   snapshots: GetSnapshot[];
 }
 
+export interface CatSnapshotsResponse {
+  snapshots: CatSnapshots[];
+}
+
+export interface CatSnapshots {
+  id: string;
+  status: string;
+  start_epoch: number;
+  end_epoch: number;
+  duration: number;
+  indices: number;
+  successful_shards: number;
+  failed_shards: number;
+  total_shards: number;
+}
+
 export interface CreateSnapshotResponse {
   snapshot: GetSnapshot;
 }

diff --git a/server/services/SnapshotManagementService.ts b/server/services/SnapshotManagementService.ts
@@ -26,6 +26,7 @@ import {
   AcknowledgedResponse,
   CreateSnapshotResponse,
   RestoreSnapshotResponse,
+  CatSnapshots,
 } from "../models/interfaces";
 import { FailedServerResponse, ServerResponse } from "../models/types";
 import { MDSEnabledClientService } from "./MDSEnabledClientService";
@@ -539,12 +540,8 @@ export default class SnapshotManagementService extends MDSEnabledClientService {
       })) as CatRepository[];
 
       for (let i = 0; i < res.length; i++) {
-        const getSnapshotRes: GetSnapshotResponse = (await callWithRequest("snapshot.get", {
-          repository: res[i].id,
-          snapshot: "_all",
-          ignore_unavailable: true,
-        })) as GetSnapshotResponse;
-        res[i].snapshotCount = getSnapshotRes.snapshots.length;
+        let catSnapshotResponse = await this._safecatSnapshotForRepo(callWithRequest, res[i].id);
+        res[i].snapshotCount = catSnapshotResponse?.length;
       }
 
       return response.custom({
@@ -559,6 +556,24 @@ export default class SnapshotManagementService extends MDSEnabledClientService {
     }
   };
 
+  private async _safecatSnapshotForRepo(
+    callWithRequest: (endpoint: string, clientParams: Record<string, any>, options?: LegacyCallAPIOptions | undefined) => Promise<unknown>,
+    repositoryName: string
+  ): Promise<CatSnapshots[] | undefined> {
+    try {
+      const catSnapshotRes: CatSnapshots[] = (await callWithRequest("cat.snapshots", {
+        format: "json",
+        repository: repositoryName,
+        ignore_unavailable: true,
+      })) as CatSnapshots[];
+
+      return catSnapshotRes;
+    } catch (err) {
+      console.error(`Index Management - SnapshotManagementService - _safeCatSnapshot:`, err);
+      return undefined;
+    }
+  }
+
   deleteRepository = async (
     context: RequestHandlerContext,
     request: OpenSearchDashboardsRequest,
-Original file line number
+Diff line change
@@ Expand Up / @@ -83,4 +83,4 @@ @@
       "engines": {
         "yarn": "^1.21.1"
       }
-    }
+    }