Merge #1250

1250: Improve Docker configuration in the package r=bidoubiwa a=meili-bot

_This PR is auto-generated._

Add a basic Docker configuration based on this [integration-guides issue](meilisearch/integration-guides#199). 


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

Author: 3 people

.github/workflows/tests.yml

@@ -50,7 +50,6 @@ jobs:
         run: yarn test:env:node-ts
       - name: Run Browser env
         run: yarn test:env:browser
-
   linter_check:
     runs-on: ubuntu-latest
     name: linter-check

CONTRIBUTING.md

@@ -40,6 +40,15 @@ To run this project, you will need:
 
 ### Setup
 
+You can set up your local environment natively or using `docker`, check out the [`docker-compose.yml`](/docker-compose.yml).
+
+Example of running all the checks with docker:
+```bash
+docker-compose run --rm package bash -c "yarn install && yarn test && yarn lint"
+```
+
+To install dependencies:
+
 ```bash
 yarn --dev
 ```

docker-compose.yml

@@ -0,0 +1,24 @@
+version: "3.8"
+
+services:
+  package:
+    image: node:16
+    tty: true
+    stdin_open: true
+    working_dir: /home/package
+    environment:
+      - MEILISEARCH_HOST=http://meilisearch:7700
+    depends_on:
+      - meilisearch
+    links:
+      - meilisearch
+    volumes:
+      - ./:/home/package
+
+  meilisearch:
+    image: getmeili/meilisearch:latest
+    ports:
+      - "7700"
+    environment:
+      - MEILI_MASTER_KEY=masterKey
+      - MEILI_NO_ANALYTICS=true

tests/client_tests.ts

@@ -13,6 +13,7 @@ import {
   config,
   MeiliSearch,
   BAD_HOST,
+  HOST,
 } from './meilisearch-test-utils'
 
 const indexNoPk = {
@@ -133,16 +134,18 @@ describe.each([
     }
   })
 
-  test(`${permission} key: host without HTTP should not throw Invalid URL Error`, async () => {
-    const client = new MeiliSearch({ host: 'meilisearch:7700' })
-    const health = await client.isHealthy()
-    expect(health).toBe(false)
+  test(`${permission} key: host without HTTP should not throw Invalid URL Error`, () => {
+    const strippedHost = HOST.replace('http://', '')
+    expect(() => {
+      new MeiliSearch({ host: strippedHost })
+    }).not.toThrow('The provided host is not valid.')
   })
 
-  test(`${permission} key: host without HTTP and port should not throw Invalid URL Error`, async () => {
-    const client = new MeiliSearch({ host: 'meilisearch' })
-    const health = await client.isHealthy()
-    expect(health).toBe(false)
+  test(`${permission} key: host without HTTP and port should not throw Invalid URL Error`, () => {
+    const strippedHost = HOST.replace('http://', '').replace(':7700', '')
+    expect(() => {
+      new MeiliSearch({ host: strippedHost })
+    }).not.toThrow('The provided host is not valid.')
   })
 
   test(`${permission} key: Empty string host should throw an error`, () => {

tests/meilisearch-test-utils.ts

@@ -3,8 +3,8 @@ import { Config, EnqueuedDump } from '../src/types'
 
 // testing
 const MASTER_KEY = 'masterKey'
-const HOST = 'http://127.0.0.1:7700'
-const BAD_HOST = HOST.slice(0, -1) + `1`
+const HOST = process.env.MEILISEARCH_HOST || 'http://127.0.0.1:7700'
+const BAD_HOST = 'http://127.0.0.1:7701'
 
 const config = {
   host: HOST,