Merge #139

139: Changes related to the next Meilisearch release (v0.28.0) r=bidoubiwa a=meili-bot

This PR gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out.

⚠️ This PR should NOT be merged until:
  - the next release of Meilisearch (v0.28.0) is out.
  - the [`meilisearch-js`](https://github.com/meilisearch/meilisearch-js) dependency has been released to be compatible with Meilisearch v0.28.0.
  Once the release is out, the upgrade of the `meilisearch-js` dependency might be committed to this branch.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._

_Related to this issue: https://github.com/meilisearch/integration-guides/issues/205_


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

Author: 3 people

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"
   }
 }

playground/package.json

@@ -32,7 +32,7 @@
   "dependencies": {
     "@mdx-js/mdx": "^1.6.22",
     "@mdx-js/react": "^1.6.22",
-    "@meilisearch/instant-meilisearch": "^0.6.1",
+    "@meilisearch/instant-meilisearch": "^0.8.0",
     "gatsby": "^4.3.0",
     "gatsby-image": "^3.11.0",
     "gatsby-plugin-mdx": "^3.3.0",

playground/yarn.lock

@@ -1969,12 +1969,12 @@
   resolved "https://registry.yarnpkg.com/@mdx-js/util/-/util-2.0.0-next.8.tgz#66ecc27b78e07a3ea2eb1a8fc5a99dfa0ba96690"
   integrity sha512-T0BcXmNzEunFkuxrO8BFw44htvTPuAoKbLvTG41otyZBDV1Rs+JMddcUuaP5vXpTWtgD3grhcrPEwyx88RUumQ==
 
-"@meilisearch/instant-meilisearch@^0.6.1":
-  version "0.6.1"
-  resolved "https://registry.yarnpkg.com/@meilisearch/instant-meilisearch/-/instant-meilisearch-0.6.1.tgz#b657b611f8eb79a030ded16cd977dfe7df899b30"
-  integrity sha512-7BHvtB/IMZUvvWozfGCeS8nNPumMyYQ9OfJO09O2SqSxZfeuGqvxWJagMW5G4vo6xW2e9u7WzbwpV3YRfRc0lg==
+"@meilisearch/instant-meilisearch@^0.8.0":
+  version "0.8.0"
+  resolved "https://registry.yarnpkg.com/@meilisearch/instant-meilisearch/-/instant-meilisearch-0.8.0.tgz#c15db59446ed450f8ee22c079fcdf848b70bbab1"
+  integrity sha512-yqSm0oi7pqEHn5ZD3kIc8RE2wQGXn3bwXrZxHz9K1R7Ld72inax3PvdVZbVKSuyv4i2tnBh9WFT3YfrewL0Kew==
   dependencies:
-    meilisearch "0.25.0"
+    meilisearch "^0.27.0"
 
 "@microsoft/[email protected]":
   version "2.0.1"
@@ -8210,10 +8210,10 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
   integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g=
 
-meilisearch@0.25.0:
-  version "0.25.0"
-  resolved "https://registry.yarnpkg.com/meilisearch/-/meilisearch-0.25.0.tgz#8e980fbdd36b9fe6ed606205e262418f21e64d84"
-  integrity sha512-TSIJTh5lva7WHBaoG3arNYQXuIAQkcD3BY09h2nHhjHS/wzxWKJM45x5bEC67Grw8zXihVqqmWty4a4ps4S+tg==
+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"
 

src/agents.js

@@ -0,0 +1,11 @@
+const { version } = require('../package.json')
+
+const constructClientAgents = (clientAgents = []) => {
+  const gatsbyAgent = `Meilisearch Gatsby (v${version})`
+
+  return clientAgents.concat(gatsbyAgent)
+}
+
+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"