Merge #683

683: Improve dump tests r=bidoubiwa a=bidoubiwa

Add test util `waitForDumpProcessing`. It is a function only existing for test purposes. Naming can change. 

Fix failing tests

Co-authored-by: Charlotte Vermandel <[email protected]>
Co-authored-by: cvermand <[email protected]>

Author: bors[bot]

tests/dump_tests.ts

@@ -6,6 +6,7 @@ import {
   privateClient,
   publicClient,
   anonymousClient,
+  waitForDumpProcessing,
 } from './meilisearch-test-utils'
 
 beforeAll(async () => {
@@ -17,18 +18,18 @@ describe.each([
   { client: privateClient, permission: 'Private' },
 ])('Test on dump', ({ client, permission }) => {
   test(`${permission} key: create a new dump`, async () => {
-    await client.createDump().then((response) => {
-      expect(response.uid).toBeDefined()
-      expect(response.status).toEqual('in_progress')
-    })
+    const response = await client.createDump()
+    expect(response.uid).toBeDefined()
+    expect(response.status).toEqual('in_progress')
+    await waitForDumpProcessing(response.uid, client)
   })
 
   test(`${permission} key: get dump status`, async () => {
     const enqueuedDump = await client.createDump()
-    await client.getDumpStatus(enqueuedDump.uid).then((response) => {
-      expect(response.uid).toEqual(enqueuedDump.uid)
-      expect(response.status).toBeDefined()
-    })
+    await waitForDumpProcessing(enqueuedDump.uid, client)
+    const response = await client.getDumpStatus(enqueuedDump.uid)
+    expect(response.uid).toEqual(enqueuedDump.uid)
+    expect(response.status).toBeDefined()
   })
 })
 

tests/env/express/tests/client.test.js

@@ -4,6 +4,7 @@ describe('MeiliSearch JS Browser test', () => {
   })
 
   it('Should have generated a meilisearch client and displayed', async () => {
+    jest.setTimeout(100 * 1000)
     await page.waitForSelector("#indexes")
     await expect(
       page.content()

tests/meilisearch-test-utils.ts

@@ -1,5 +1,6 @@
 import MeiliSearch from '../src/meilisearch'
 import * as Types from '../src/types'
+import { sleep } from '../src/utils'
 
 // testing
 const MASTER_KEY = 'masterKey'
@@ -49,6 +50,25 @@ const clearAllIndexes = async (config: Types.Config): Promise<void> => {
   await expect(client.listIndexes()).resolves.toHaveLength(0)
 }
 
+async function waitForDumpProcessing(
+  dumpId: string,
+  client: MeiliSearch,
+  {
+    timeOutMs = 5000,
+    intervalMs = 50,
+  }: { timeOutMs?: number; intervalMs?: number } = {}
+): Promise<Types.EnqueuedDump> {
+  const startingTime = Date.now()
+  while (Date.now() - startingTime < timeOutMs) {
+    const response = await client.getDumpStatus(dumpId)
+    if (response.status !== 'in_progress') return response
+    await sleep(intervalMs)
+  }
+  throw new Types.MeiliSearchTimeOutError(
+    `timeout of ${timeOutMs}ms has exceeded on process ${dumpId} when waiting for the dump creation process to be done.`
+  )
+}
+
 export {
   clearAllIndexes,
   config,
@@ -60,4 +80,5 @@ export {
   PRIVATE_KEY,
   MASTER_KEY,
   MeiliSearch,
+  waitForDumpProcessing,
 }