feat: add BackupGetter to the public API

Author: bevzzz

src/backup/index.ts

@@ -1,6 +1,7 @@
 import Connection from '../connection/index.js';
 import BackupCreateStatusGetter from './backupCreateStatusGetter.js';
 import BackupCreator from './backupCreator.js';
+import BackupGetter from './backupGetter.js';
 import BackupRestoreStatusGetter from './backupRestoreStatusGetter.js';
 import BackupRestorer from './backupRestorer.js';
 
@@ -13,6 +14,7 @@ export interface Backup {
   createStatusGetter: () => BackupCreateStatusGetter;
   restorer: () => BackupRestorer;
   restoreStatusGetter: () => BackupRestoreStatusGetter;
+  getter: () => BackupGetter;
 }
 
 const backup = (client: Connection): Backup => {
@@ -21,11 +23,13 @@ const backup = (client: Connection): Backup => {
     createStatusGetter: () => new BackupCreateStatusGetter(client),
     restorer: () => new BackupRestorer(client, new BackupRestoreStatusGetter(client)),
     restoreStatusGetter: () => new BackupRestoreStatusGetter(client),
+    getter: () => new BackupGetter(client),
   };
 };
 
 export default backup;
 export { default as BackupCreateStatusGetter } from './backupCreateStatusGetter.js';
 export { default as BackupCreator } from './backupCreator.js';
+export { default as BackupGetter } from './backupGetter.js';
 export { default as BackupRestoreStatusGetter } from './backupRestoreStatusGetter.js';
 export { default as BackupRestorer } from './backupRestorer.js';

src/backup/journey.test.ts

@@ -7,6 +7,7 @@ import {
 import weaviate, { WeaviateClient } from '../v2/index.js';
 import { Backend } from './index.js';
 
+import { requireAtLeast } from '../../test/version';
 const {
   createTestFoodSchemaAndData,
   cleanupTestFood,
@@ -950,55 +951,61 @@ describe('fails restoring backup with invalid compression config', () => {
   it('cleans up', () => cleanupTestFood(client));
 });
 
-// describe("get all exising backups", () => {
-//   const BACKEND: Backend = 'filesystem';
-//   const BACKUP_ID = randomBackupId()
-//   const BACKUP_ID_PIZZA = BACKUP_ID + "-pizza";
-//   const BACKUP_ID_SOUP = BACKUP_ID + "-soup";
-
-//   const client = weaviate.client({
-//     scheme: "http",
-//     host: "localhost:8080",
-//   });
-
-//   it("sets up", () => createTestFoodSchemaAndData(client));
-
-//   it("creates backup pizza", () => {
-//     return client.backup.creator()
-//       .withIncludeClassNames(PIZZA_CLASS_NAME)
-//       .withBackend(BACKEND)
-//       .withBackupId(BACKUP_ID_PIZZA)
-//       .withWaitForCompletion(true)
-//       .do()
-//       .catch((err: any) => {throw new Error("should not fail on create backup: " + err)});
-//   });
-
-//   it("creates backup soup", () => {
-//     return client.backup.creator()
-//       .withIncludeClassNames(SOUP_CLASS_NAME)
-//       .withBackend(BACKEND)
-//       .withBackupId(BACKUP_ID_SOUP)
-//       .withWaitForCompletion(true)
-//       .do()
-//       .catch((err: any) => {throw new Error("should not fail on create backup: " + err)});
-//   });
-
-//   it("get all", () => {
-//     return client.backup.getter()
-//       .withBackend(BACKEND)
-//       .do()
-//       .then(allResponse => {
-//         expect(allResponse).toHaveLength(2);
-//         expect(allResponse).toEqual(expect.arrayContaining([
-//           expect.objectContaining({id: BACKUP_ID_PIZZA}),
-//           expect.objectContaining({id: BACKUP_ID_SOUP}),
-//         ]));
-//       })
-//       .catch((err: any) => {throw new Error("should not fail on getting all: " + err)});
-//   });
-
-//   it("cleans up", () => cleanupTestFood(client));
-// });
+requireAtLeast(1, 30, 0).describe('get all exising backups', () => {
+  const BACKEND: Backend = 'filesystem';
+  const BACKUP_ID = randomBackupId();
+  const BACKUP_ID_PIZZA = BACKUP_ID + '-pizza';
+  const BACKUP_ID_SOUP = BACKUP_ID + '-soup';
+
+  const client = weaviate.client({
+    scheme: 'http',
+    host: 'localhost:8080',
+  });
+
+  it('sets up', () => createTestFoodSchemaAndData(client));
+
+  it('creates backup pizza', () => {
+    return client.backup
+      .creator()
+      .withIncludeClassNames(PIZZA_CLASS_NAME)
+      .withBackend(BACKEND)
+      .withBackupId(BACKUP_ID_PIZZA)
+      .withWaitForCompletion(true)
+      .do()
+      .catch((err: any) => {
+        throw new Error('should not fail on create backup: ' + err);
+      });
+  });
+
+  it('creates backup soup', () => {
+    return client.backup
+      .creator()
+      .withIncludeClassNames(SOUP_CLASS_NAME)
+      .withBackend(BACKEND)
+      .withBackupId(BACKUP_ID_SOUP)
+      .withWaitForCompletion(true)
+      .do()
+      .catch((err: any) => {
+        throw new Error('should not fail on create backup: ' + err);
+      });
+  });
+
+  it('get all', () => {
+    return client.backup
+      .getter()
+      .withBackend(BACKEND)
+      .do()
+      .then((allResponse) => {
+        const relevant = allResponse.filter(b => b.id === BACKUP_ID_SOUP || b.id === BACKUP_ID_PIZZA);
+        expect(relevant).toHaveLength(2);
+      })
+      .catch((err: any) => {
+        throw new Error('should not fail on getting all: ' + err);
+      });
+  });
+
+  it('cleans up', () => cleanupTestFood(client));
+});
 
 function assertThatAllPizzasExist(client: WeaviateClient) {
   return assertThatAllFoodObjectsExist(client, 'Pizza', 4);