fix: use a single boolean for ascending sorting

Author: gkampitakis

src/backup/index.ts

@@ -7,7 +7,6 @@ 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 BackupListOrder = 'asc' | 'desc';
 
 export interface Backup {
   creator: () => BackupCreator;

src/collections/backup/client.ts

@@ -2,7 +2,6 @@ import {
   Backend,
   BackupCreateStatusGetter,
   BackupCreator,
-  BackupListOrder,
   BackupRestoreStatusGetter,
   BackupRestorer,
 } from '../../backup/index.js';
@@ -206,10 +205,10 @@ export const backup = (connection: Connection): Backup => {
           }
         : parseResponse(res);
     },
-    list: (backend: Backend, order?: BackupListOrder): Promise<BackupReturn[]> => {
+    list: (backend: Backend, sortAscending?: boolean): Promise<BackupReturn[]> => {
       let url = `/backups/${backend}`;
-      if (order) {
-        url += `?order=${order}`;
+      if (sortAscending) {
+        url += '?order=asc';
       }
       return connection.get<BackupReturn[]>(url);
     },
@@ -266,8 +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 {BackupListOrder} [order] Order in which to list backups.
+   * @param {sortAscending} [boolean] Sort list of backups in ascending order based on creation time. Default is descending order.
    * @returns {Promise<BackupReturn[]>} The response from Weaviate.
    * */
-  list(backend: Backend, order?: BackupListOrder): Promise<BackupReturn[]>;
+  list(backend: Backend, sortAscending?: boolean): Promise<BackupReturn[]>;
 }

src/collections/backup/integration.test.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', 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);
   }