Change update API to task API (#1113)

* Change updates to tasks

* Complete implementation of asynchronous index CRUD

* Add client tests

* Add index tests

* Add documents test

* Improve js doc

* Add distinct attributes tests

* Add distrinct attributes tests

* Remove unused variable from tests

* Add dump tests

* Add filterable attributes tests

* Add ranking rules tests

* Add settings tests

* Add sortable attr tests

* Add stop words

* Fix types for Tasks

* Add search tests

* Finish tests compatibility

* Fix tasks issues

* Fix tests

* Fix task type

* Add await in return statement

* Fix tests

* Fix node12 jest tests

* Fix tests environments

* Remove obsolete test

* Fix tests

* Fix document tests

* Update update information in readme

* Add type check test

* Fix types of env

* Put back express tests to check for CORS issues

* Remove env from typescript type test

* Rename test file

* Fix typing

Author: bidoubiwa

.github/workflows/pre-release-tests.yml

@@ -43,7 +43,22 @@ jobs:
         run: yarn test:env:esm
       - name: Run Node.js env
         run: yarn test:env:nodejs
-      - name: Run Browser env
-        run: yarn test:env:browser
       - name: Run node typescript env
         run: yarn test:env:node-ts
+  types_test:
+    runs-on: ubuntu-latest
+    name: types-test
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ./node_modules
+          key: ${{ hashFiles('yarn.lock') }}
+      - name: Setup node
+        uses: actions/setup-node@v2
+      - name: Install dependencies
+        run: yarn --dev
+      - name: Run style check
+        run: yarn types

.github/workflows/tests.yml

@@ -46,8 +46,6 @@ jobs:
         run: yarn test:env:esm
       - name: Run Node.js env
         run: yarn test:env:nodejs
-      - name: Run Browser env
-        run: yarn test:env:browser
       - name: Run node typescript env
         run: yarn test:env:node-ts
 
@@ -72,3 +70,21 @@ jobs:
         uses: ibiqlik/action-yamllint@v3
         with:
           config_file: .yamllint.yml
+
+  types_test:
+    runs-on: ubuntu-latest
+    name: types-test
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: |
+            ./node_modules
+          key: ${{ hashFiles('yarn.lock') }}
+      - name: Setup node
+        uses: actions/setup-node@v2
+      - name: Install dependencies
+        run: yarn --dev
+      - name: Run style check
+        run: yarn types

README.md

@@ -2,7 +2,8 @@ status = [
   'linter-check',
   'integration-tests (Node.js 12)',
   'integration-tests (Node.js 14)',
-  'integration-tests (Node.js 16)'
+  'integration-tests (Node.js 16)',
+  'types-test'
 ]
 # 1 hour timeout
 timeout-sec = 3600

bors.toml

@@ -1,6 +1,7 @@
 const config = {
   rootDir: '.',
   testMatch: ['<rootDir>/tests/**/*.ts?(x)'],
+  verbose: true,
   testPathIgnorePatterns: ['meilisearch-test-utils', 'env'],
   coverageThreshold: {
     global: {

jest.config.js

@@ -0,0 +1,6 @@
+{
+  "extension": "ts",
+  "verbose": true,
+  "ignore": ["tests/*", "*.tests.js", "fixtures/*"],
+  "exec": "yarn tsc"
+}

nodemon.json

@@ -34,11 +34,13 @@
     "watch": "yarn cleanup && rollup -c --watch",
     "postbuild": "yarn size && yarn typingsheader",
     "test": "yarn clear_jest && jest --runInBand",
+    "types:watch": "nodemon --config nodemon.json",
+    "types": "yarn tsc",
+    "test:env:browser": "yarn --cwd tests/env/express && yarn --cwd tests/env/express test",
     "test:watch": "yarn clear_jest && yarn test --watch",
     "test:coverage": "yarn test --coverage",
     "test:ci": "yarn test --ci",
-    "test:env": "yarn build && yarn test:env:browser && yarn test:env:nodejs && yarn test:env:esm && yarn test:env:node-ts",
-    "test:env:browser": "yarn --cwd tests/env/express && yarn --cwd tests/env/express test",
+    "test:env": "yarn build && yarn test:env:nodejs && yarn test:env:esm && yarn test:env:node-ts",
     "test:env:node-ts": "yarn --cwd tests/env/typescript-node start",
     "test:env:nodejs": "node tests/env/node/index.js",
     "test:env:esm": "yarn --cwd tests/env/esm && yarn --cwd tests/env/esm start",
@@ -94,6 +96,7 @@
     "jest-watch-typeahead": "^0.6.3",
     "kleur": "^4.1.4",
     "lint-staged": "11.1.2",
+    "nodemon": "^2.0.15",
     "prettier": "^2.2.1",
     "pretty-bytes": "^5.6.0",
     "rollup": "^2.60.0",

package.json

@@ -6,10 +6,13 @@ const config = {
 }
 
 const client = new MeiliSearch(config)
-const uid = 'movies'
+const indexUid = 'movies'
 
 const addDataset = async () => {
-  const index = await client.getOrCreateIndex(uid)
+  const index = await client.deleteIndex(indexUid)
+  const { uid } = await client.createIndex(indexUid)
+  await index.waitForTask(uid)
+
   const documents = await index.getDocuments()
 
   const dataset = [
@@ -25,8 +28,8 @@ const addDataset = async () => {
     { id: 6, title: 'Philadelphia', genres: ['Drama'] },
   ]
   if (documents.length === 0) {
-    const { updateId } = await index.addDocuments(dataset)
-    await index.waitForPendingUpdate(updateId)
+    const task = await index.addDocuments(dataset)
+    await index.waitForPendingUpdate(task.uid)
   }
 }
 
@@ -39,7 +42,7 @@ const addDataset = async () => {
       null,
       2
     )
-    const resp = await client.index(uid).search(
+    const resp = await client.index(indexUid).search(
       '',
       {
         attributesToHighlight: ['title'],

playgrounds/javascript/src/app.js

@@ -1,12 +1,6 @@
 import 'cross-fetch/polyfill'
 
-import {
-  Config,
-  IndexRequest,
-  EnqueuedUpdate,
-  IndexResponse,
-  IndexOptions,
-} from '../types'
+import { Config, EnqueuedTask } from '../types'
 
 import { httpResponseErrorHandler, httpErrorHandler } from '../errors'
 
@@ -15,7 +9,7 @@ class HttpRequests {
   url: URL
 
   constructor(config: Config) {
-    this.headers = config.headers || {}
+    this.headers = Object.assign({}, config.headers || {}) // assign to avoid referencing
     this.headers['Content-Type'] = 'application/json'
     if (config.apiKey) {
       this.headers['Authorization'] = `Bearer ${config.apiKey}`
@@ -53,7 +47,7 @@ class HttpRequests {
     }
 
     try {
-      const response: Response = await fetch(constructURL.toString(), {
+      const response: any = await fetch(constructURL.toString(), {
         ...config,
         method,
         body: JSON.stringify(body),
@@ -98,14 +92,7 @@ class HttpRequests {
     })
   }
 
-  async post(
-    url: string,
-    data: IndexRequest,
-    params?: { [key: string]: any },
-    config?: Record<string, any>
-  ): Promise<IndexResponse>
-
-  async post<T = any, R = EnqueuedUpdate>(
+  async post<T = any, R = EnqueuedTask>(
     url: string,
     data?: T,
     params?: { [key: string]: any },
@@ -127,14 +114,7 @@ class HttpRequests {
     })
   }
 
-  async put(
-    url: string,
-    data: IndexOptions | IndexRequest,
-    params?: { [key: string]: any },
-    config?: Record<string, any>
-  ): Promise<IndexResponse>
-
-  async put<T = any, R = EnqueuedUpdate>(
+  async put<T = any, R = EnqueuedTask>(
     url: string,
     data?: T,
     params?: { [key: string]: any },
@@ -161,7 +141,7 @@ class HttpRequests {
     data?: any,
     params?: { [key: string]: any },
     config?: Record<string, any>
-  ): Promise<void>
+  ): Promise<EnqueuedTask>
   async delete<T>(
     url: string,
     data?: any,