merge main

bidoubiwa · bidoubiwa · commit a3d29a76b2e4 · 2021-11-15T13:49:15.000+01:00
diff --git a/.github/release-draft-template.yml b/.github/release-draft-template.yml
@@ -8,11 +8,15 @@ version-resolver:
       - 'breaking-change'
   default: patch
 categories:
-  - title: 'Breaking changes ⚠️'
+  - title: '⚠️ Breaking changes'
     label: 'breaking-change'
+  - title: '🚀 Enhancements'
+    label: 'enhancement'
+  - title: '🐛 Bug Fixes'
+    label: 'bug'
+  - title: '🔒 Security'
+    label: 'security'
 template: |
-  ## Changes
-
   $CHANGES
 
   Thanks again to $CONTRIBUTORS! 🎉
diff --git a/.github/workflows/pre-release-tests.yml b/.github/workflows/pre-release-tests.yml
@@ -4,16 +4,16 @@ name: Pre-Release Tests
 # Will only run for PRs and pushes to bump-meilisearch-v*
 on:
   push:
-    branches: bump-meilisearch-v*
+    branches: [bump-meilisearch-v*]
   pull_request:
-    branches: bump-meilisearch-v*
+    branches: [bump-meilisearch-v*]
 
 jobs:
   integration_tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '12', '14' ]
+        node: ["12", "14", "16"]
     name: integration-tests-against-rc (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v2
@@ -24,7 +24,7 @@ jobs:
             ./node_modules
           key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
       - name: print version
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: 12
           registry-url: https://registry.npmjs.org/
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [ '12', '14' ]
+        node: ["12", "14", "16"]
     name: integration-tests (Node.js ${{ matrix.node }})
     steps:
       - uses: actions/checkout@v2
@@ -29,7 +29,7 @@ jobs:
             ./node_modules
           key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
       - name: print version
@@ -63,7 +63,7 @@ jobs:
             ./node_modules
           key: ${{ hashFiles('yarn.lock') }}
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
       - name: Install dependencies
         run: yarn --dev
       - name: Run style check
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,6 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 
 <!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
 
-- [Hacktoberfest](#hacktoberfest)
 - [Assumptions](#assumptions)
 - [How to Contribute](#how-to-contribute)
 - [Development Workflow](#development-workflow)
@@ -13,16 +12,6 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
 
 <!-- /MarkdownTOC -->
 
-## Hacktoberfest
-
-It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest-2021/)! 🥳
-
-🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!
-
-✅ To be accepted it has either to have been merged, approved or tagged with the `hacktoberfest-accepted` label.
-
-🧐 Don't forget to check the [quality standards](https://hacktoberfest.digitalocean.com/resources/qualitystandards)! Low-quality PRs might get marked as `spam` or `invalid`, and will not count toward your participation in Hacktoberfest.
-
 ## Assumptions
 
 1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) (PR) workflow.**
@@ -45,7 +34,7 @@ It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest
 
 To run this project, you will need:
 
-- Node.js >= v12 and node < 15
+- Node.js >= v12 and node <= 16
 - Yarn
 
 
@@ -95,7 +84,7 @@ Some notes on GitHub PRs:
 
 - [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
+- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
 - All PRs must be reviewed and approved by at least one maintainer.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-js/releases/).
 
@@ -106,24 +95,24 @@ MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org
 ### Automation to Rebase and Merge the PRs
 
 This project integrates a bot that helps us manage pull requests merging.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md)._
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
 
 ### Automated Changelogs
 
 This project integrates a tool to create automated changelogs.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/guides/release-drafter.md)._
+_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/release-drafter.md)._
 
 ### How to Publish the Release
 
-⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/guides/integration-release.md).
+⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
 
 Make a PR modifying the file [`package.json`](/package.json) with the right version.
 
 ```javascript
 "version": "X.X.X",
 ```
 
-Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-js/releases).
+Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-js/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.
 
 GitHub Actions will be triggered and push the package to [npm](https://www.npmjs.com/package/meilisearch).
 
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta
 
 ## 🔧 Installation
 
-We only guarantee that the package works with `node` >= 12 and `node` < 15.
+We only guarantee that the package works with `node` >= 12 and `node` <= 16.
 
 With `npm`:
 
@@ -206,8 +206,7 @@ All the supported options are described in the [search parameters](https://docs.
 await index.search(
   'wonder',
   {
-    attributesToHighlight: ['*'],
-    filter: 'id >= 1'
+    attributesToHighlight: ['*']
   }
 )
 ```
diff --git a/bors.toml b/bors.toml
@@ -1,7 +1,8 @@
 status = [
   'linter-check',
   'integration-tests (Node.js 12)',
-  'integration-tests (Node.js 14)'
+  'integration-tests (Node.js 14)',
+  'integration-tests (Node.js 16)'
 ]
 # 1 hour timeout
 timeout-sec = 3600
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "meilisearch",
-  "version": "0.22.2",
+  "version": "0.22.3",
   "description": "The MeiliSearch JS client for Node.js and the browser.",
   "keywords": [
     "meilisearch",
@@ -68,7 +68,7 @@
     "cross-fetch": "^3.1.4"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.15.8",
+    "@babel/preset-env": "^7.16.0",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-commonjs": "21.0.1",
     "@rollup/plugin-json": "^4.0.2",
@@ -96,7 +96,7 @@
     "lint-staged": "11.1.2",
     "prettier": "^2.2.1",
     "pretty-bytes": "^5.6.0",
-    "rollup": "^2.58.0",
+    "rollup": "^2.59.0",
     "rollup-plugin-terser": "^7.0.0",
     "rollup-plugin-typescript2": "^0.30.0",
     "shx": "^0.3.2",
diff --git a/playgrounds/javascript/index.html b/playgrounds/javascript/index.html
@@ -1,18 +1,24 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1, shrink-to-fit=no"
-    />
-    <meta name="theme-color" content="#000000" />
-  </head>
-  <body>
 
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+  <meta name="theme-color" content="#000000" />
+</head>
 
+<body>
+
+
+  <h2 class="errors_title">Errors:</h2>
+  <div class="errors"></div>
+
+  <h2>Movies index:</h2>
+  <div class="indexes"></div>
+  <h2>Search response:</h2>
+  <div class="hits"></div>
+  <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4"></script>
+  <script src="/src/app.js"></script>
+</body>
 
-    <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4"></script>
-    <script src="/src/app.js"></script>
-  </body>
 </html>
diff --git a/playgrounds/javascript/src/app.js b/playgrounds/javascript/src/app.js
@@ -31,21 +31,31 @@ const addDataset = async () => {
 }
 
 ;(async () => {
-  await addDataset()
   try {
-    const index = await client.getOrCreateIndex('movies')
-
-    const resp = await index.search(
-      'Moana',
+    await addDataset()
+    const indexes = await client.getIndexes()
+    document.querySelector('.indexes').innerText = JSON.stringify(
+      indexes,
+      null,
+      2
+    )
+    const resp = await client.index(uid).search(
+      '',
       {
-        limit: 1,
         attributesToHighlight: ['title'],
       },
       'POST'
     )
     console.log({ resp })
     console.log({ hit: resp.hits[0] })
+    document.querySelector('.hits').innerText = JSON.stringify(
+      resp.hits,
+      null,
+      2
+    )
+    document.querySelector('.errors_title').style.display = 'none'
   } catch (e) {
     console.error(e)
+    document.querySelector('.errors').innerText = JSON.stringify(e, null, 2)
   }
 })()
diff --git a/src/errors/http-error-handler.ts b/src/errors/http-error-handler.ts
@@ -7,7 +7,7 @@ async function httpResponseErrorHandler(response: Response): Promise<Response> {
     let err
     try {
       err = await response.json()
-    } catch (e) {
+    } catch (e: any) {
       throw new MeiliSearchCommunicationError(
         response.statusText,
         response,
diff --git a/src/errors/meilisearch-api-error.ts b/src/errors/meilisearch-api-error.ts
@@ -16,6 +16,8 @@ const MeiliSearchApiError = class extends Error {
     this.link = error.link
     this.message = error.message
     this.httpStatus = status
+    // Make errors comparison possible. ex: error instanceof MeiliSearchApiError.
+    Object.setPrototypeOf(this, MeiliSearchApiError.prototype)
 
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, MeiliSearchApiError)
diff --git a/src/errors/meilisearch-communication-error.ts b/src/errors/meilisearch-communication-error.ts
@@ -34,6 +34,7 @@ class MeiliSearchCommunicationError extends Error {
         'Failed to fetch',
         `request to ${url} failed, reason: connect ECONNREFUSED`
       )
+      this.stack = this.stack?.replace('Not Found', `Not Found: ${url}`)
     } else {
       if (Error.captureStackTrace) {
         Error.captureStackTrace(this, MeiliSearchCommunicationError)
diff --git a/src/lib/http-requests.ts b/src/lib/http-requests.ts
@@ -67,7 +67,7 @@ class HttpRequests {
       } catch (_) {
         return
       }
-    } catch (e) {
+    } catch (e: any) {
       const stack = e.stack
       httpErrorHandler(e, stack, constructURL.toString())
     }
diff --git a/src/lib/indexes.ts b/src/lib/indexes.ts
@@ -7,7 +7,11 @@
 
 'use strict'
 
-import { MeiliSearchTimeOutError, MeiliSearchError } from '../errors'
+import {
+  MeiliSearchTimeOutError,
+  MeiliSearchError,
+  MeiliSearchApiError,
+} from '../errors'
 
 import {
   Config,
@@ -256,7 +260,7 @@ class Index<T = Record<string, any>> {
     try {
       await this.delete()
       return true
-    } catch (e) {
+    } catch (e: any) {
       if (e.code === ErrorStatusCode.INDEX_NOT_FOUND) {
         return false
       }
diff --git a/src/lib/meilisearch.ts b/src/lib/meilisearch.ts
@@ -90,7 +90,7 @@ class MeiliSearch {
     try {
       const index = await this.getIndex(uid)
       return index
-    } catch (e) {
+    } catch (e: any) {
       if (e.code === ErrorStatusCode.INDEX_NOT_FOUND) {
         return this.createIndex(uid, options)
       }
@@ -163,7 +163,7 @@ class MeiliSearch {
     try {
       await this.deleteIndex(uid)
       return true
-    } catch (e) {
+    } catch (e: any) {
       if (e.code === ErrorStatusCode.INDEX_NOT_FOUND) {
         return false
       }
@@ -212,7 +212,7 @@ class MeiliSearch {
       const url = `health`
       await this.httpRequest.get(url)
       return true
-    } catch (e) {
+    } catch (e: any) {
       return false
     }
   }
diff --git a/tests/client_tests.ts b/tests/client_tests.ts
diff --git a/tests/env/typescript-node/package.json b/tests/env/typescript-node/package.json
diff --git a/tests/env/typescript-node/yarn.lock b/tests/env/typescript-node/yarn.lock
diff --git a/tests/meilisearch-test-utils.ts b/tests/meilisearch-test-utils.ts
diff --git a/tests/search_tests.ts b/tests/search_tests.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta`
`43`	`43`
`44`	`44`	`## 🔧 Installation`
`45`	`45`
`46`		-We only guarantee that the package works with `node` >= 12 and `node` < 15.
	`46`	+We only guarantee that the package works with `node` >= 12 and `node` <= 16.
`47`	`47`
`48`	`48`	With `npm`:
`49`	`49`
`@@ -206,8 +206,7 @@ All the supported options are described in the [search parameters](https://docs.`
`206`	`206`	`await index.search(`
`207`	`207`	`'wonder',`
`208`	`208`	`{`
`209`		`- attributesToHighlight: ['*'],`
`210`		`- filter: 'id >= 1'`
	`209`	`+ attributesToHighlight: ['*']`
`211`	`210`	`}`
`212`	`211`	`)`
`213`	`212`	```