Changes related to the next Meilisearch release (v0.28.0)

README.md

@@ -453,7 +453,7 @@ Full usage example:
 
 **Supported Meilisearch versions**:
 
-This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 **Node / NPM versions**:
 

gatsby-node.js

@@ -1,5 +1,5 @@
 const { MeiliSearch } = require('meilisearch')
-
+const { constructClientAgents } = require('./src/agents')
 const {
   validatePluginOptions,
   validateIndexOptions,
@@ -27,6 +27,7 @@ exports.onPostBuild = async function ({ graphql, reporter }, config) {
       skipIndexing = false,
       batchSize = 1000,
       indexes,
+      clientAgents = [],
     } = config
 
     if (skipIndexing) {
@@ -59,14 +60,15 @@ exports.onPostBuild = async function ({ graphql, reporter }, config) {
         const client = new MeiliSearch({
           host: host,
           apiKey: apiKey,
+          clientAgents: constructClientAgents(clientAgents),
         })
 
         const index = client.index(currentIndex.indexUid)
         await index.delete()
 
         // Add settings to Index
         if (currentIndex.settings) {
-          const { uid: settingsUid } = await index.updateSettings(
+          const { taskUid: settingsUid } = await index.updateSettings(
             currentIndex.settings
           )
           index.waitForTask(settingsUid)
@@ -89,10 +91,11 @@ exports.onPostBuild = async function ({ graphql, reporter }, config) {
 
         // Wait for indexation to be completed
         for (const enqueuedUpdate of enqueuedUpdates) {
-          await index.waitForTask(enqueuedUpdate.uid)
-          const res = await index.getTask(enqueuedUpdate.uid)
-          if (res.status === 'failed') {
-            throw getErrorMsg(`${res.error.message} (${res.error.code})`)
+          await index.waitForTask(enqueuedUpdate.taskUid)
+          const task = await index.getTask(enqueuedUpdate.taskUid)
+
+          if (task.status === 'failed') {
+            throw getErrorMsg(`${task.error?.message} (${task.error?.code})`)
           }
         }
       })

package.json

@@ -56,6 +56,6 @@
     "wait-port": "^0.2.9"
   },
   "dependencies": {
-    "meilisearch": "^0.25.1"
+    "meilisearch": "^0.27.0"
   }
 }

src/agents.js

@@ -0,0 +1,11 @@
+const { version } = require('../package.json')
+
+const constructClientAgents = (clientAgents = []) => {
+  const instantMeilisearchAgent = `Meilisearch Gatsby (v${version})`
+
+  return clientAgents.concat(instantMeilisearchAgent)
+}
+
+module.exports = {
+  constructClientAgents,
+}

tests/index-to-meilisearch.test.js

@@ -1,7 +1,12 @@
 /* eslint-disable no-undef */
 const { MeiliSearch } = require('meilisearch')
 const { onPostBuild } = require('../gatsby-node.js')
-const { fakeConfig, fakeGraphql, fakeReporter } = require('./utils')
+const {
+  fakeConfig,
+  fakeGraphql,
+  fakeReporter,
+  clearAllIndexes,
+} = require('./utils')
 
 const activity = fakeReporter.activityTimer()
 
@@ -12,15 +17,10 @@ const client = new MeiliSearch({
 
 describe('Index to Meilisearch', () => {
   beforeEach(async () => {
-    try {
-      await Promise.all(
-        fakeConfig.indexes.map(
-          async index => await client.deleteIndex(index.indexUid)
-        )
-      )
-    } catch (e) {
-      return
-    }
+    return clearAllIndexes({
+      host: fakeConfig.host,
+      apiKey: fakeConfig.apiKey,
+    })
   })
 
   test('Should fail if the indexes field is not provided', async () => {
@@ -205,8 +205,9 @@ describe('Index to Meilisearch', () => {
         ],
       }
     )
-    const indexes = await client.getIndexes()
-    expect(indexes).toHaveLength(2)
+    const { results } = await client.getIndexes()
+
+    expect(results).toHaveLength(2)
   })
 
   test('Should delete index and recreate a new one', async () => {
@@ -252,7 +253,7 @@ describe('Index to Meilisearch', () => {
       .index(fakeConfig.indexes[0].indexUid)
       .search('Axolotl')
 
-    expect(firstQueryResult.nbHits).toBe(1)
+    expect(firstQueryResult.estimatedTotalHits).toBe(1)
 
     await onPostBuild(
       { graphql: fakeGraphql, reporter: fakeReporter },
@@ -271,7 +272,7 @@ describe('Index to Meilisearch', () => {
       .index(fakeConfig.indexes[0].indexUid)
       .search('Axolotl')
 
-    expect(secondQueryResult.nbHits).toBe(0)
+    expect(secondQueryResult.estimatedTotalHits).toBe(0)
   })
 
   test('Should succeed and index with good config format', async () => {

tests/utils.js

@@ -1,4 +1,5 @@
 /* eslint-disable no-undef */
+const { MeiliSearch } = require('meilisearch')
 
 const fakeConfig = {
   host: process.env.MEILI_HTTP_ADDR || 'http://localhost:7700',
@@ -54,8 +55,23 @@ const fakeReporter = {
   error: jest.fn(() => {}),
 }
 
+const clearAllIndexes = async config => {
+  const client = new MeiliSearch(config)
+
+  const { results } = await client.getRawIndexes()
+  const indexes = results.map(elem => elem.uid)
+
+  const taskIds = []
+  for (const indexUid of indexes) {
+    const { taskUid } = await client.index(indexUid).delete()
+    taskIds.push(taskUid)
+  }
+  await client.waitForTasks(taskIds)
+}
+
 module.exports = {
   fakeConfig,
   fakeGraphql,
+  clearAllIndexes,
   fakeReporter,
 }

yarn.lock

@@ -9387,10 +9387,10 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
   integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
 
-meilisearch@^0.25.1:
-  version "0.25.1"
-  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.25.1.tgz#0dc25ffad64e6e50eb3da6c0691b0ff54f8578bf"
-  integrity sha512-20jO0pK9BhghxHSkOLbdoYn58h/Z0PNL3JQcRq7ipNIeqrxkAetCZZ6ttJC3uxcz0jVglmiFoSXu3Z/lEOLOLQ==
+meilisearch@^0.27.0:
+  version "0.27.0"
+  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.27.0.tgz#8bd57ddb77b975f93e054cb977b951c488ece297"
+  integrity sha512-kZOZFIuSO7c6xRf+Y2/9/h6A9pl0sCl/G44X4KuaSwxGbruOZPhmxbeVEgLHBv4pUFvQ56rNVTA/2d/5GCU1YA==
   dependencies:
     cross-fetch "^3.1.5"