Merge #1603

1603: Feat/snapshots r=brunoocasali a=brunoocasali

Add the ability to create snapshots according to the v1.5 spec.

Co-authored-by: Bruno Casali <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -549,6 +549,8 @@ faceted_search_1: |-
   client.index('books').search('classic', { facets: ['genres', 'rating', 'language'] })
 post_dump_1: |-
   client.createDump()
+create_snapshot_1: |-
+  client.createSnapshot()
 phrase_search_1: |-
   client.index('movies')
     .search('"african american" horror')

README.md

@@ -1039,6 +1039,13 @@ client.getVersion(): Promise<Version>
 client.createDump(): Promise<EnqueuedTask>
 ```
 
+### Snapshots <!-- omit in toc -->
+
+#### [Trigger a snapshot on-demand process](https://www.meilisearch.com/docs/reference/api/snapshots#create-a-snapshot)
+
+```ts
+client.createSnapshot(): Promise<EnqueuedTask>
+```
 ---
 
 Meilisearch provides and maintains many SDKs and integration tools like this one. We want to provide everyone with an **amazing search experience for any kind of project**. For a full overview of everything we create and maintain, take a look at the [integration-guides](https://github.com/meilisearch/integration-guides) repository.

src/clients/client.ts

@@ -443,6 +443,22 @@ class Client {
     return new EnqueuedTask(task)
   }
 
+  ///
+  /// SNAPSHOTS
+  ///
+
+  /**
+   * Creates a snapshot
+   *
+   * @returns Promise returning object of the enqueued task
+   */
+  async createSnapshot(): Promise<EnqueuedTask> {
+    const url = `snapshots`
+    const task = await this.httpRequest.post<undefined, EnqueuedTaskObject>(url)
+
+    return new EnqueuedTask(task)
+  }
+
   ///
   /// TOKENS
   ///

tests/snapshots.test.ts

@@ -0,0 +1,70 @@
+import { ErrorStatusCode } from '../src/types'
+import {
+  clearAllIndexes,
+  config,
+  MeiliSearch,
+  BAD_HOST,
+  getClient,
+} from './utils/meilisearch-test-utils'
+
+beforeEach(async () => {
+  await clearAllIndexes(config)
+})
+
+describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
+  'Test on snapshot',
+  ({ permission }) => {
+    test(`${permission} key: create a new snapshot`, async () => {
+      const client = await getClient(permission)
+      const { taskUid } = await client.createSnapshot()
+
+      await client.waitForTask(taskUid)
+    })
+  }
+)
+
+describe.each([{ permission: 'Search' }])(
+  'Test on snapshot with search api key should not have access',
+  ({ permission }) => {
+    test(`${permission} key: try to create snapshot with search key and be denied`, async () => {
+      const client = await getClient(permission)
+      await expect(client.createSnapshot()).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.INVALID_API_KEY
+      )
+    })
+  }
+)
+
+describe.each([{ permission: 'No' }])(
+  'Test on snapshot without api key should not have access',
+  ({ permission }) => {
+    test(`${permission} key: try to create snapshot with no key and be denied`, async () => {
+      const client = await getClient(permission)
+      await expect(client.createSnapshot()).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
+      )
+    })
+  }
+)
+
+describe.each([
+  { host: BAD_HOST, trailing: false },
+  { host: `${BAD_HOST}/api`, trailing: false },
+  { host: `${BAD_HOST}/trailing/`, trailing: true },
+])('Tests on url construction', ({ host, trailing }) => {
+  test(`Test createSnapshot route`, async () => {
+    const route = `snapshots`
+    const client = new MeiliSearch({ host })
+    const strippedHost = trailing ? host.slice(0, -1) : host
+
+    await expect(client.createSnapshot()).rejects.toHaveProperty(
+      'message',
+      `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace(
+        'http://',
+        ''
+      )}`
+    )
+  })
+})