Merge branch 'main' of https://github.com/weaviate/typescript-client into snyk-upgrade-a63fa331a63835838a38b91e294853e3

Author: tsmith023

package-lock.json

@@ -51,12 +51,12 @@
   },
   "homepage": "https://github.com/weaviate/typescript-client#readme",
   "dependencies": {
-    "abort-controller-x": "^0.4.3",
-    "graphql": "^16.11.0",
+    "abort-controller-x": "^0.5.0",
+    "graphql": "^16.12.0",
     "graphql-request": "^6.1.0",
     "long": "^5.3.2",
     "nice-grpc": "^2.1.13",
-    "nice-grpc-client-middleware-retry": "^3.1.11",
+    "nice-grpc-client-middleware-retry": "^3.1.12",
     "nice-grpc-common": "^2.0.2",
     "uuid": "^9.0.1"
   },

package.json

@@ -6,7 +6,14 @@ import BackupRestorer from './backupRestorer.js';
 
 export type Backend = 'filesystem' | 's3' | 'gcs' | 'azure';
 export type BackupStatus = 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
-export type BackupCompressionLevel = 'DefaultCompression' | 'BestSpeed' | 'BestCompression';
+export type BackupCompressionLevel =
+  | 'DefaultCompression'
+  | 'BestSpeed'
+  | 'BestCompression'
+  | 'ZstdBestSpeed'
+  | 'ZstdDefaultCompression'
+  | 'ZstdBestCompression'
+  | 'NoCompression';
 
 export interface Backup {
   creator: () => BackupCreator;

src/backup/index.ts

@@ -693,7 +693,6 @@ describe('creates backup with valid compression config values', () => {
       .withWaitForCompletion(true)
       .withConfig({
         CPUPercentage: 80,
-        ChunkSize: 512,
         CompressionLevel: 'BestSpeed',
       })
       .do()
@@ -754,44 +753,6 @@ describe('fails creating backup with invalid compression config', () => {
       });
   });
 
-  it('fails creating backup with ChunkSize too high', () => {
-    return client.backup
-      .creator()
-      .withIncludeClassNames(PIZZA_CLASS_NAME)
-      .withBackend(BACKEND)
-      .withBackupId(BACKUP_ID)
-      .withConfig({
-        ChunkSize: 513, // Max is 512
-      })
-      .do()
-      .then(() => {
-        throw new Error('should fail on create backup');
-      })
-      .catch((err: Error) => {
-        expect(err.message).toContain('422');
-        expect(err.message).toContain('ChunkSize');
-      });
-  });
-
-  it('fails creating backup with ChunkSize too low', () => {
-    return client.backup
-      .creator()
-      .withIncludeClassNames(PIZZA_CLASS_NAME)
-      .withBackend(BACKEND)
-      .withBackupId(BACKUP_ID)
-      .withConfig({
-        ChunkSize: 1, // Min is 2
-      })
-      .do()
-      .then(() => {
-        throw new Error('should fail on create backup');
-      })
-      .catch((err: Error) => {
-        expect(err.message).toContain('422');
-        expect(err.message).toContain('ChunkSize');
-      });
-  });
-
   it('cleans up', () => cleanupTestFood(client));
 });
 

src/backup/journey.test.ts

@@ -28,6 +28,7 @@ import {
   BackupReturn,
   BackupStatusArgs,
   BackupStatusReturn,
+  ListBackupOptions,
 } from './types.js';
 
 export const backup = (connection: Connection): Backup => {
@@ -117,7 +118,6 @@ export const backup = (connection: Connection): Backup => {
       }
       if (args.config) {
         builder = builder.withConfig({
-          ChunkSize: args.config.chunkSize,
           CompressionLevel: args.config.compressionLevel,
           CPUPercentage: args.config.cpuPercentage,
         });
@@ -205,8 +205,12 @@ export const backup = (connection: Connection): Backup => {
           }
         : parseResponse(res);
     },
-    list: (backend: Backend): Promise<BackupReturn[]> => {
-      return connection.get<BackupReturn[]>(`/backups/${backend}`);
+    list: (backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]> => {
+      let url = `/backups/${backend}`;
+      if (opts?.startedAtAsc) {
+        url += '?order=asc';
+      }
+      return connection.get<BackupReturn[]>(url);
     },
   };
 };
@@ -261,7 +265,8 @@ export interface Backup {
   /** List existing backups (completed and in-progress) created in a given backend.
    *
    * @param {Backend} backend Backend whence to list backups.
+   * @param {ListBackupOptions} [opts] The options available when listing backups.
    * @returns {Promise<BackupReturn[]>} The response from Weaviate.
-   * */
-  list(backend: Backend): Promise<BackupReturn[]>;
+   */
+  list(backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]>;
 }

src/collections/backup/client.ts

@@ -228,6 +228,36 @@ describe('Integration testing of backups', () => {
     });
   });
 
+  requireAtLeast(1, 33, 2).it('get all backups in ascending order', async () => {
+    await clientPromise.then(async (client) => {
+      await client.collections.create({ name: 'TestListBackupsAsc' }).then((col) => col.data.insert());
+
+      const wantBackups: string[] = [];
+      for (let i = 0; i < 3; i++) {
+        wantBackups.push(
+          await client.backup
+            .create({
+              backupId: randomBackupId(),
+              backend: 'filesystem',
+              includeCollections: ['TestListBackupsAsc'],
+              waitForCompletion: true,
+            })
+            .then((res) => res.id)
+        );
+      }
+
+      const sortAscending = true;
+      const gotBackups = await client.backup.list('filesystem', { startedAtAsc: sortAscending });
+
+      // There may be other backups created in other tests;
+      expect(gotBackups.length).toBeGreaterThanOrEqual(wantBackups.length);
+      // Expect the backups to be sorted in ascending order
+      expect(
+        gotBackups.every((value, idx, a) => idx === 0 || a[idx - 1].startedAt! <= value.startedAt!)
+      ).toBe(sortAscending);
+    });
+  });
+
   function randomBackupId() {
     return 'backup-id-' + Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
   }

src/collections/backup/integration.test.ts

@@ -21,11 +21,17 @@ export type BackupReturn = BackupStatusReturn & {
   backend: Backend;
   /** The collections that were included in the backup */
   collections: string[];
+  /** Timestamp when the backup process started  */
+  startedAt?: Date;
+  /** Timestamp when the backup process completed (successfully or with failure) */
+  completedAt?: Date;
+  /** Size of the backup in Gibs */
+  size?: number;
 };
 
 /** Configuration options available when creating a backup */
 export type BackupConfigCreate = {
-  /** The size of the chunks to use for the backup. */
+  /** Deprecated: This parameter no longer has any effect. (The size of the chunks to use for the backup.) */
   chunkSize?: number;
   /** The standard of compression to use for the backup. */
   compressionLevel?: BackupCompressionLevel;
@@ -72,3 +78,8 @@ export type BackupCancelArgs = {
   /** The backend to use for the backup. */
   backend: Backend;
 };
+
+/** The options available when listing backups. */
+export type ListBackupOptions = {
+  startedAtAsc?: boolean;
+};