@fastify/elasticsearch 2.1.0 → 3.1.0

package/.github/workflows/ci.yml

@@ -1,49 +1,80 @@
 name: CI
-'on':
+
+on:
   push:
     paths-ignore:
-      - docs/**
+      - 'docs/**'
       - '*.md'
   pull_request:
     paths-ignore:
-      - docs/**
+      - 'docs/**'
       - '*.md'
+
 jobs:
+  dependency-review:
+    name: Dependency Review
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+
+      - name: Dependency review
+        uses: actions/dependency-review-action@v3
+
   test:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     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
+        node-version: [14, 16, 18]
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js
+      - name: Check out repo
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+
+      - name: Setup Node ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Install Dependencies
-        run: |
-          npm install --ignore-scripts
-      - name: Run Tests
+
+      - name: Configure sysctl limits
         run: |
-          npm test
+          sudo swapoff -a
+          sudo sysctl -w vm.swappiness=1
+          sudo sysctl -w fs.file-max=262144
+          sudo sysctl -w vm.max_map_count=262144
+
+      - name: Runs Elasticsearch
+        uses: elastic/elastic-github-actions/elasticsearch@562b8b6ae4677da97273ff6bc4d630ce96ecbaa5
+        with:
+          stack-version: 8.3.2
+          security-enabled: false
+
+      - name: Install dependencies
+        run: npm i --ignore-scripts
+
+      - name: Run tests
+        run: npm test
+
   automerge:
+    name: Automerge Dependabot PRs
+    if: >
+        github.event_name == 'pull_request' &&
+        github.event.pull_request.user.login == 'dependabot[bot]'
     needs: test
-    runs-on: ubuntu-latest
     permissions:
       pull-requests: write
       contents: write
+    runs-on: ubuntu-latest
     steps:
       - uses: fastify/github-action-merge-dependabot@v3
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
+          target: major

package/.taprc

@@ -0,0 +1,2 @@
+files:
+  - test/**/*.test.js

package/README.md

@@ -1,8 +1,7 @@
-# fastify-elasticsearch
+# @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)
+[![NPM version](https://img.shields.io/npm/v/@fastify/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@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.  
@@ -12,7 +11,7 @@ Under the hood, the official [elasticsearch](https://www.npmjs.com/package/@elas
 ## Install
 
 ```
-npm i fastify-elasticsearch
+npm i @fastify/elasticsearch
 ```
 
 ## Usage
@@ -22,7 +21,7 @@ The plugin accepts the [same options](https://github.com/elastic/elasticsearch-j
 ```js
 const fastify = require('fastify')()
 
-fastify.register(require('fastify-elasticsearch'), { node: 'http://localhost:9200' })
+fastify.register(require('@fastify/elasticsearch'), { node: 'http://localhost:9200' })
 
 fastify.get('/user', async function (req, reply) {
   const { body } = await this.elastic.search({
@@ -35,14 +34,14 @@ fastify.get('/user', async function (req, reply) {
   return body.hits.hits
 })
 
-fastify.listen(3000, err => {
+fastify.listen({ port: 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:
+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'), {
+fastify.register(require('@fastify/elasticsearch'), {
   node: 'http://localhost:9200',
   healthcheck: false
 })
@@ -52,12 +51,12 @@ If you need to connect to different clusters, you can also pass a `namespace` op
 ```js
 const fastify = require('fastify')()
 
-fastify.register(require('fastify-elasticsearch'), {
+fastify.register(require('@fastify/elasticsearch'), {
   node: 'http://localhost:9200',
   namespace: 'cluster1'
 })
 
-fastify.register(require('fastify-elasticsearch'), {
+fastify.register(require('@fastify/elasticsearch'), {
   node: 'http://localhost:9201',
   namespace: 'cluster2'
 })
@@ -73,7 +72,7 @@ fastify.get('/user', async function (req, reply) {
   return body.hits.hits
 })
 
-fastify.listen(3000, err => {
+fastify.listen({ port: 3000 }, err => {
   if (err) throw err
 })
 ```
@@ -85,7 +84,7 @@ If it is not, you can pass a custom client via the `client` option.
 const fastify = require('fastify')()
 const { Client } = require('@elastic/elasticsearch')
 
-fastify.register(require('fastify-elasticsearch'), {
+fastify.register(require('@fastify/elasticsearch'), {
   client: new Client({ node: 'http://localhost:9200' })
 })
 
@@ -100,7 +99,7 @@ fastify.get('/user', async function (req, reply) {
   return body.hits.hits
 })
 
-fastify.listen(3000, err => {
+fastify.listen({ port: 3000 }, err => {
   if (err) throw err
 })
 ```

package/es-docker.sh

@@ -6,5 +6,6 @@
 exec docker run \
   --rm \
   -e "discovery.type=single-node" \
+  -e "xpack.security.enabled=false" \
   -p 9200:9200 \
-  docker.elastic.co/elasticsearch/elasticsearch:7.4.0
+  docker.elastic.co/elasticsearch/elasticsearch:8.3.2

package/index.js

@@ -2,6 +2,7 @@
 
 const fp = require('fastify-plugin')
 const { Client } = require('@elastic/elasticsearch')
+const isElasticsearchClient = require('./lib/isElasticsearchClient')
 
 async function fastifyElasticsearch (fastify, options) {
   const { namespace, healthcheck } = options
@@ -25,19 +26,24 @@ async function fastifyElasticsearch (fastify, options) {
 
     fastify.elastic[namespace] = client
 
-    fastify.addHook('onClose', (instance, done) => {
-      instance.elastic[namespace].close(done)
+    fastify.addHook('onClose', async (instance) => {
+      // v8 client.close returns a promise and does not accept a callback
+      await instance.elastic[namespace].close()
     })
   } else {
     fastify
       .decorate('elastic', client)
-      .addHook('onClose', (instance, done) => {
-        instance.elastic.close(done)
+      .addHook('onClose', async (instance) => {
+        await instance.elastic.close()
       })
   }
 }
 
 module.exports = fp(fastifyElasticsearch, {
-  fastify: '3.x',
-  name: 'fastify-elasticsearch'
+  fastify: '4.x',
+  name: '@fastify/elasticsearch'
 })
+module.exports.default = fastifyElasticsearch
+module.exports.fastifyElasticsearch = fastifyElasticsearch
+
+module.exports.isElasticsearchClient = isElasticsearchClient

package/lib/isElasticsearchClient.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+module.exports = function isElasticsearchClient (value) {
+  return value instanceof Client
+}

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@fastify/elasticsearch",
-  "version": "2.1.0",
+  "version": "3.1.0",
   "description": "Fastify plugin for elastic search",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "scripts": {
-    "lint": "standard | snazzy",
-    "test": "npm run lint && npm run unit",
-    "unit": "tap test.js"
+    "lint": "standard",
+    "test": "npm run test:unit && npm run test:typescript",
+    "test:unit": "tap",
+    "test:typescript": "tsd"
   },
   "repository": {
     "type": "git",
@@ -25,19 +27,17 @@
     "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"
+    "@elastic/elasticsearch": "^8.2.1",
+    "fastify-plugin": "^4.0.0"
   },
   "devDependencies": {
-    "fastify": "^3.0.0-rc.1",
-    "pre-commit": "^1.2.2",
-    "snazzy": "^9.0.0",
+    "@types/node": "^18.6.4",
+    "@fastify/pre-commit": "^2.0.2",
+    "fastify": "^4.0.0-rc.2",
     "standard": "^17.0.0",
-    "tap": "^16.0.0"
+    "tap": "^16.0.0",
+    "tsd": "^0.22.0"
   },
   "publishConfig": {
     "access": "public"

package/{test.js → test/index.test.js}

@@ -3,19 +3,21 @@
 const { test } = require('tap')
 const { Client } = require('@elastic/elasticsearch')
 const Fastify = require('fastify')
-const fastifyElasticsearch = require('./index')
+const fastifyElasticsearch = require('..')
+const isElasticsearchClient = require('..').isElasticsearchClient
 
 test('with reachable cluster', async t => {
   const fastify = Fastify()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch, { node: 'http://localhost:9200' })
 
   await fastify.ready()
-  t.strictEqual(fastify.elastic.name, 'elasticsearch-js')
-  await fastify.close()
+  t.equal(fastify.elastic.name, 'elasticsearch-js')
 })
 
 test('with unreachable cluster', async t => {
   const fastify = Fastify()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch, { node: 'http://localhost:9201' })
 
   try {
@@ -23,12 +25,12 @@ test('with unreachable cluster', async t => {
     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()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch, {
     node: 'http://localhost:9201',
     healthcheck: false
@@ -36,15 +38,15 @@ test('with unreachable cluster and healthcheck disabled', async t => {
 
   try {
     await fastify.ready()
-    t.strictEqual(fastify.elastic.name, 'elasticsearch-js')
+    t.equal(fastify.elastic.name, 'elasticsearch-js')
   } catch (err) {
     t.fail('should not error')
   }
-  await fastify.close()
 })
 
 test('namespaced', async t => {
   const fastify = Fastify()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch, {
     node: 'http://localhost:9200',
     namespace: 'cluster'
@@ -52,11 +54,14 @@ test('namespaced', async t => {
 
   await fastify.ready()
   t.strictEqual(fastify.elastic.cluster.name, 'elasticsearch-js')
+  t.equal(isElasticsearchClient(fastify.elastic), false)
+  t.equal(isElasticsearchClient(fastify.elastic.cluster), true)
   await fastify.close()
 })
 
 test('namespaced (errored)', async t => {
   const fastify = Fastify()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch, {
     node: 'http://localhost:9200',
     namespace: 'cluster'
@@ -72,7 +77,6 @@ test('namespaced (errored)', async t => {
     t.fail('should not boot successfully')
   } catch (err) {
     t.ok(err)
-    await fastify.close()
   }
 })
 
@@ -83,15 +87,18 @@ test('custom client', async t => {
   })
 
   const fastify = Fastify()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch, { client })
 
   await fastify.ready()
+  t.equal(isElasticsearchClient(fastify.elastic), true)
   t.strictEqual(fastify.elastic.name, 'custom')
   await fastify.close()
 })
 
 test('Missing configuration', async t => {
   const fastify = Fastify()
+  t.teardown(() => fastify.close())
   fastify.register(fastifyElasticsearch)
 
   try {
@@ -99,6 +106,5 @@ test('Missing configuration', async t => {
     t.fail('should not boot successfully')
   } catch (err) {
     t.ok(err)
-    await fastify.close()
   }
 })

package/types/index.d.ts

@@ -0,0 +1,27 @@
+import type { FastifyPluginAsync } from 'fastify';
+import type { Client, ClientOptions } from '@elastic/elasticsearch';
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    elastic: Client & Record<string, Client>;
+    isElasticsearchClient(value: unknown): value is Client
+  }
+}
+
+type FastifyElasticsearch = FastifyPluginAsync<fastifyElasticsearch.FastifyElasticsearchOptions> & {
+  isElasticsearchClient: (value: any) => value is Client
+}
+
+declare namespace fastifyElasticsearch {
+  export interface FastifyElasticsearchOptions extends ClientOptions {
+    namespace?: string;
+    healthcheck?: boolean;
+    client?: Client;
+  }
+
+  export const fastifyElasticsearch: FastifyElasticsearch
+  export { fastifyElasticsearch as default }
+}
+
+declare function fastifyElasticsearch(...params: Parameters<FastifyElasticsearch>): ReturnType<FastifyElasticsearch>
+export = fastifyElasticsearch

package/types/index.test-d.ts

@@ -0,0 +1,13 @@
+import fastifyElasticsearch from '..';
+import Fastify from 'fastify';
+import { expectAssignable, expectType } from 'tsd';
+import { Client } from '@elastic/elasticsearch';
+
+
+const fastify = Fastify()
+fastify.register(fastifyElasticsearch, { node: 'http://localhost:9200' })
+
+expectType<boolean>(fastify.isElasticsearchClient(fastify.elastic))
+expectType<boolean>(fastify.isElasticsearchClient(fastify.elastic.asyncSearch))
+expectType<boolean>(fastify.isElasticsearchClient(fastify.elastic.aasdf))
+expectAssignable<(value: any) => value is Client>(fastifyElasticsearch.isElasticsearchClient)