Add swap indexes feature for v0.30.0 (#1384)

Add swap indexes feature for v0.30.0 (#1384)

Author: bidoubiwa

README.md

@@ -584,6 +584,12 @@ client.index('myIndex').fetchInfo(): Promise<Index>
 client.index('myIndex').fetchPrimaryKey(): Promise<string | undefined>
 ```
 
+##### Swap two indexes
+
+```ts
+client.swapIndexes(params: SwapIndexesParams): Promise<EnqueuedTask>
+```
+
 ### Settings <!-- omit in toc -->
 
 #### [Get settings](https://docs.meilisearch.com/reference/api/settings.html#get-settings)

src/clients/client.ts

@@ -29,6 +29,7 @@ import {
   KeysResults,
   TasksResults,
   EnqueuedTaskObject,
+  SwapIndexesParams,
   CancelTasksQuery,
   DeleteTasksQuery,
 } from '../types'
@@ -186,6 +187,19 @@ class Client {
     }
   }
 
+  /**
+   * Swaps a list of index tuples.
+   *
+   * @memberof MeiliSearch
+   * @method swapIndexes
+   * @param {SwapIndexesParams} params - List of indexes tuples to swap.
+   * @returns {Promise<EnqueuedTask>} - Promise returning object of the enqueued task
+   */
+  async swapIndexes(params: SwapIndexesParams): Promise<EnqueuedTask> {
+    const url = '/swap-indexes'
+    return await this.httpRequest.post(url, params)
+  }
+
   ///
   /// TASKS
   ///

src/types/types.ts

@@ -231,6 +231,7 @@ export const enum TaskTypes {
   DOCUMENTS_ADDITION_OR_UPDATE = 'documentAdditionOrUpdate',
   DOCUMENT_DELETION = 'documentDeletion',
   SETTINGS_UPDATE = 'settingsUpdate',
+  INDEXES_SWAP = 'indexSwap',
   TASK_DELETION = 'taskDeletion',
   SNAPSHOT_CREATION = 'snapshotCreation',
   TASK_CANCELATION = 'taskCancelation',
@@ -305,6 +306,9 @@ export type TaskObject = Omit<EnqueuedTaskObject, 'taskUid'> & {
     // Distinct attribute on settings actions
     distinctAttribute: DistinctAttribute
 
+    // Object containing the payload originating the `indexSwap` task creation
+    swaps: SwapIndexesParams
+
     // Number of tasks that matched the originalQuery filter
     matchedTasks?: number
 
@@ -323,6 +327,10 @@ export type TaskObject = Omit<EnqueuedTaskObject, 'taskUid'> & {
   finishedAt: string
 }
 
+export type SwapIndexesParams = Array<{
+  indexes: string[]
+}>
+
 type CursorResults<T> = {
   results: T[]
   limit: number
@@ -542,6 +550,9 @@ export const enum ErrorStatusCode {
   /** @see https://docs.meilisearch.com/errors/#dump_not_found */
   DUMP_NOT_FOUND = 'dump_not_found',
 
+  /** @see https://docs.meilisearch.com/errors/#duplicate_index_found */
+  DUPLICATE_INDEX_FOUND = 'duplicate_index_found',
+
   /** @see https://docs.meilisearch.com/errors/#missing_master_key */
   MISSING_MASTER_KEY = 'missing_master_key',
 

tests/client.test.ts

@@ -1,4 +1,4 @@
-import { ErrorStatusCode, Health, Version, Stats } from '../src'
+import { ErrorStatusCode, Health, Version, Stats, TaskTypes } from '../src'
 import { PACKAGE_VERSION } from '../src/package-version'
 import {
   clearAllIndexes,
@@ -18,6 +18,14 @@ const indexPk = {
   primaryKey: 'id',
 }
 
+const index = {
+  uid: 'movies_test',
+}
+
+const index2 = {
+  uid: 'movies_test2',
+}
+
 afterAll(() => {
   return clearAllIndexes(config)
 })
@@ -365,6 +373,72 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
           ErrorStatusCode.INDEX_NOT_FOUND
         )
       })
+
+      test(`${permission} key: Swap two indexes`, async () => {
+        const client = await getClient(permission)
+        await client
+          .index(index.uid)
+          .addDocuments([{ id: 1, title: `index_1` }])
+        const { taskUid } = await client
+          .index(index2.uid)
+          .addDocuments([{ id: 1, title: 'index_2' }])
+        await client.waitForTask(taskUid)
+        const swaps = [
+          {
+            indexes: [index.uid, index2.uid],
+          },
+        ]
+
+        const swapTask = await client.swapIndexes(swaps)
+        const resolvedTask = await client.waitForTask(swapTask.taskUid)
+        const docIndex1 = await client.index(index.uid).getDocument(1)
+        const docIndex2 = await client.index(index2.uid).getDocument(1)
+
+        expect(docIndex1.title).toEqual('index_2')
+        expect(docIndex2.title).toEqual('index_1')
+        expect(resolvedTask.type).toEqual(TaskTypes.INDEXES_SWAP)
+        expect(resolvedTask.details.swaps).toEqual(swaps)
+      })
+
+      test(`${permission} key: Swap two indexes with one that does not exist`, async () => {
+        const client = await getClient(permission)
+
+        const { taskUid } = await client
+          .index(index2.uid)
+          .addDocuments([{ id: 1, title: 'index_2' }])
+
+        await client.waitForTask(taskUid)
+        const swaps = [
+          {
+            indexes: ['does_not_exist', index2.uid],
+          },
+        ]
+
+        const swapTask = await client.swapIndexes(swaps)
+        const resolvedTask = await client.waitForTask(swapTask.taskUid)
+
+        expect(resolvedTask.type).toEqual(TaskTypes.INDEXES_SWAP)
+        expect(resolvedTask.error?.code).toEqual(
+          ErrorStatusCode.INDEX_NOT_FOUND
+        )
+        expect(resolvedTask.details.swaps).toEqual(swaps)
+      })
+
+      // Should be fixed by rc1
+      test(`${permission} key: Swap two one index with itself`, async () => {
+        const client = await getClient(permission)
+
+        const swaps = [
+          {
+            indexes: [index.uid, index.uid],
+          },
+        ]
+
+        await expect(client.swapIndexes(swaps)).rejects.toHaveProperty(
+          'code',
+          ErrorStatusCode.DUPLICATE_INDEX_FOUND
+        )
+      })
     })
 
     describe('Test on base routes', () => {