@fastify/elasticsearch 2.0.0

package/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10

package/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+'on':
+  push:
+    paths-ignore:
+      - docs/**
+      - '*.md'
+  pull_request:
+    paths-ignore:
+      - docs/**
+      - '*.md'
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 10
+          - 12
+          - 14
+          - 16
+    services:
+      elasticsearch:
+        image: docker.elastic.co/elasticsearch/elasticsearch:7.10.0
+        ports:
+          - '9200:9200'
+        env:
+          discovery.type: single-node
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install Dependencies
+        run: |
+          npm install --ignore-scripts
+      - name: Run Tests
+        run: |
+          npm test
+  automerge:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: fastify/github-action-merge-dependabot@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2019 Fastify
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,110 @@
+# fastify-elasticsearch
+
+![CI](https://github.com/fastify/fastify-elasticsearch/workflows/CI/badge.svg)
+[![NPM version](https://img.shields.io/npm/v/fastify-elasticsearch.svg?style=flat)](https://www.npmjs.com/package/fastify-elasticsearch)
+[![Known Vulnerabilities](https://snyk.io/test/github/fastify/fastify-elasticsearch/badge.svg)](https://snyk.io/test/github/fastify/fastify-elasticsearch)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+
+Fastify plugin for [Elasticsearch](https://www.elastic.co/elasticsearch/) for sharing the same ES client in every part of your server.  
+Under the hood, the official [elasticsearch](https://www.npmjs.com/package/@elastic/elasticsearch) module is used.
+
+
+## Install
+
+```
+npm i fastify-elasticsearch
+```
+
+## Usage
+Add it to your project with `register` and you are done!  
+The plugin accepts the [same options](https://github.com/elastic/elasticsearch-js#client-options) as the client.
+
+```js
+const fastify = require('fastify')()
+
+fastify.register(require('fastify-elasticsearch'), { node: 'http://localhost:9200' })
+
+fastify.get('/user', async function (req, reply) {
+  const { body } = await this.elastic.search({
+    index: 'tweets',
+    body: {
+      query: { match: { text: req.query.q }}
+    }
+  })
+
+  return body.hits.hits
+})
+
+fastify.listen(3000, err => {
+  if (err) throw err
+})
+```
+
+By default, `fastify-elasticsearch` will try to ping the cluster as soon as you start Fastify, but in some cases pinging may not be supported due to the user permissions. If you want, you can disable the initial ping with the `healthcheck` option:
+```js
+fastify.register(require('fastify-elasticsearch'), {
+  node: 'http://localhost:9200',
+  healthcheck: false
+})
+```
+
+If you need to connect to different clusters, you can also pass a `namespace` option:
+```js
+const fastify = require('fastify')()
+
+fastify.register(require('fastify-elasticsearch'), {
+  node: 'http://localhost:9200',
+  namespace: 'cluster1'
+})
+
+fastify.register(require('fastify-elasticsearch'), {
+  node: 'http://localhost:9201',
+  namespace: 'cluster2'
+})
+
+fastify.get('/user', async function (req, reply) {
+  const { body } = await this.elastic.cluster1.search({
+    index: 'tweets',
+    body: {
+      query: { match: { text: req.query.q }}
+    }
+  })
+
+  return body.hits.hits
+})
+
+fastify.listen(3000, err => {
+  if (err) throw err
+})
+```
+
+## Versioning
+By default the latest and greatest version of the Elasticsearch client is used, see the [compatibility](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html#_compatibility) table to understand if the embedded client is correct for you.  
+If it is not, you can pass a custom client via the `client` option.
+```js
+const fastify = require('fastify')()
+const { Client } = require('@elastic/elasticsearch')
+
+fastify.register(require('fastify-elasticsearch'), {
+  client: new Client({ node: 'http://localhost:9200' })
+})
+
+fastify.get('/user', async function (req, reply) {
+  const { body } = await this.elastic.search({
+    index: 'tweets',
+    body: {
+      query: { match: { text: req.query.q }}
+    }
+  })
+
+  return body.hits.hits
+})
+
+fastify.listen(3000, err => {
+  if (err) throw err
+})
+```
+
+## License
+
+Licensed under [MIT](./LICENSE).

package/es-docker.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# run this file to get a working ES instance
+# for running the test locally
+
+exec docker run \
+  --rm \
+  -e "discovery.type=single-node" \
+  -p 9200:9200 \
+  docker.elastic.co/elasticsearch/elasticsearch:7.4.0

package/index.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+const { Client } = require('@elastic/elasticsearch')
+
+async function fastifyElasticsearch (fastify, options) {
+  const { namespace, healthcheck } = options
+  delete options.namespace
+  delete options.healthcheck
+
+  const client = options.client || new Client(options)
+
+  if (healthcheck !== false) {
+    await client.ping()
+  }
+
+  if (namespace) {
+    if (!fastify.elastic) {
+      fastify.decorate('elastic', {})
+    }
+
+    if (fastify.elastic[namespace]) {
+      throw new Error(`Elasticsearch namespace already used: ${namespace}`)
+    }
+
+    fastify.elastic[namespace] = client
+
+    fastify.addHook('onClose', (instance, done) => {
+      instance.elastic[namespace].close(done)
+    })
+  } else {
+    fastify
+      .decorate('elastic', client)
+      .addHook('onClose', (instance, done) => {
+        instance.elastic.close(done)
+      })
+  }
+}
+
+module.exports = fp(fastifyElasticsearch, {
+  fastify: '3.x',
+  name: 'fastify-elasticsearch'
+})

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@fastify/elasticsearch",
+  "version": "2.0.0",
+  "description": "Fastify plugin for elastic search",
+  "main": "index.js",
+  "scripts": {
+    "lint": "standard | snazzy",
+    "test": "npm run lint && npm run unit",
+    "unit": "tap test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fastify/fastify-elasticsearch.git"
+  },
+  "keywords": [
+    "fastify",
+    "elastic",
+    "elasticsearch",
+    "elastic search",
+    "ES"
+  ],
+  "author": "Tommaso Allevi - @allevo",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/fastify/fastify-elasticsearch/issues"
+  },
+  "homepage": "https://github.com/fastify/fastify-elasticsearch#readme",
+  "engines": {
+    "node": ">=10.0.0"
+  },
+  "dependencies": {
+    "@elastic/elasticsearch": "^7.1.0",
+    "fastify-plugin": "^3.0.0"
+  },
+  "devDependencies": {
+    "fastify": "^3.0.0-rc.1",
+    "pre-commit": "^1.2.2",
+    "snazzy": "^9.0.0",
+    "standard": "^17.0.0",
+    "tap": "^16.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/test.js

@@ -0,0 +1,104 @@
+'use strict'
+
+const { test } = require('tap')
+const { Client } = require('@elastic/elasticsearch')
+const Fastify = require('fastify')
+const fastifyElasticsearch = require('./index')
+
+test('with reachable cluster', async t => {
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch, { node: 'http://localhost:9200' })
+
+  await fastify.ready()
+  t.strictEqual(fastify.elastic.name, 'elasticsearch-js')
+  await fastify.close()
+})
+
+test('with unreachable cluster', async t => {
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch, { node: 'http://localhost:9201' })
+
+  try {
+    await fastify.ready()
+    t.fail('should not boot successfully')
+  } catch (err) {
+    t.ok(err)
+    await fastify.close()
+  }
+})
+
+test('with unreachable cluster and healthcheck disabled', async t => {
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch, {
+    node: 'http://localhost:9201',
+    healthcheck: false
+  })
+
+  try {
+    await fastify.ready()
+    t.strictEqual(fastify.elastic.name, 'elasticsearch-js')
+  } catch (err) {
+    t.fail('should not error')
+  }
+  await fastify.close()
+})
+
+test('namespaced', async t => {
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch, {
+    node: 'http://localhost:9200',
+    namespace: 'cluster'
+  })
+
+  await fastify.ready()
+  t.strictEqual(fastify.elastic.cluster.name, 'elasticsearch-js')
+  await fastify.close()
+})
+
+test('namespaced (errored)', async t => {
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch, {
+    node: 'http://localhost:9200',
+    namespace: 'cluster'
+  })
+
+  fastify.register(fastifyElasticsearch, {
+    node: 'http://localhost:9200',
+    namespace: 'cluster'
+  })
+
+  try {
+    await fastify.ready()
+    t.fail('should not boot successfully')
+  } catch (err) {
+    t.ok(err)
+    await fastify.close()
+  }
+})
+
+test('custom client', async t => {
+  const client = new Client({
+    node: 'http://localhost:9200',
+    name: 'custom'
+  })
+
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch, { client })
+
+  await fastify.ready()
+  t.strictEqual(fastify.elastic.name, 'custom')
+  await fastify.close()
+})
+
+test('Missing configuration', async t => {
+  const fastify = Fastify()
+  fastify.register(fastifyElasticsearch)
+
+  try {
+    await fastify.ready()
+    t.fail('should not boot successfully')
+  } catch (err) {
+    t.ok(err)
+    await fastify.close()
+  }
+})