@elastic/elasticsearch 7.11.0 → 7.14.1

package/lib/Transport.js

@@ -24,12 +24,14 @@ const os = require('os')
 const { gzip, unzip, createGzip } = require('zlib')
 const buffer = require('buffer')
 const ms = require('ms')
+const { EventEmitter } = require('events')
 const {
   ConnectionError,
   RequestAbortedError,
   NoLivingConnectionsError,
   ResponseError,
-  ConfigurationError
+  ConfigurationError,
+  ProductNotSupportedError
 } = require('./errors')
 
 const noop = () => {}
@@ -38,6 +40,9 @@ const clientVersion = require('../package.json').version
 const userAgent = `elasticsearch-js/${clientVersion} (${os.platform()} ${os.release()}-${os.arch()}; Node.js ${process.version})`
 const MAX_BUFFER_LENGTH = buffer.constants.MAX_LENGTH
 const MAX_STRING_LENGTH = buffer.constants.MAX_STRING_LENGTH
+const kProductCheck = Symbol('product check')
+const kApiVersioning = Symbol('api versioning')
+const kEventEmitter = Symbol('event emitter')
 
 class Transport {
   constructor (opts) {
@@ -64,6 +69,9 @@ class Transport {
     this.generateRequestId = opts.generateRequestId || generateRequestId()
     this.name = opts.name
     this.opaqueIdPrefix = opts.opaqueIdPrefix
+    this[kProductCheck] = 0 // 0 = to be checked, 1 = checking, 2 = checked-ok, 3 checked-notok, 4 checked-nodefault
+    this[kApiVersioning] = process.env.ELASTIC_CLIENT_APIVERSIONING === 'true'
+    this[kEventEmitter] = new EventEmitter()
 
     this.nodeFilter = opts.nodeFilter || defaultNodeFilter
     if (typeof opts.nodeSelector === 'function') {
@@ -81,7 +89,11 @@ class Transport {
     this._isSniffing = false
 
     if (opts.sniffOnStart === true) {
-      this.sniff({ reason: Transport.sniffReasons.SNIFF_ON_START })
+      // timer needed otherwise it will clash
+      // with the product check testing
+      setTimeout(() => {
+        this.sniff({ reason: Transport.sniffReasons.SNIFF_ON_START })
+      }, 10)
     }
   }
 
@@ -91,7 +103,7 @@ class Transport {
       callback = options
       options = {}
     }
-    var p = null
+    let p = null
 
     // promises support
     if (callback === undefined) {
@@ -147,9 +159,10 @@ class Transport {
     // the size of the stream, we risk to take too much memory.
     // Furthermore, copying everytime the stream is very a expensive operation.
     const maxRetries = isStream(params.body) || isStream(params.bulkBody)
-      ? 0 : (typeof options.maxRetries === 'number' ? options.maxRetries : this.maxRetries)
+      ? 0
+      : (typeof options.maxRetries === 'number' ? options.maxRetries : this.maxRetries)
     const compression = options.compression !== undefined ? options.compression : this.compression
-    var request = { abort: noop }
+    let request = { abort: noop }
     const transportReturn = {
       then (onFulfilled, onRejected) {
         return p.then(onFulfilled, onRejected)
@@ -162,6 +175,9 @@ class Transport {
         request.abort()
         debug('Aborting request', params)
         return this
+      },
+      finally (onFinally) {
+        return p.finally(onFinally)
       }
     }
 
@@ -291,7 +307,8 @@ class Transport {
       //    - the request is not a HEAD request
       //    - the payload is not an empty string
       if (result.headers['content-type'] !== undefined &&
-          result.headers['content-type'].indexOf('application/json') > -1 &&
+          (result.headers['content-type'].indexOf('application/json') > -1 ||
+          result.headers['content-type'].indexOf('application/vnd.elasticsearch+json') > -1) &&
           isHead === false &&
           payload !== ''
       ) {
@@ -302,8 +319,8 @@ class Transport {
           return callback(err, result)
         }
       } else {
-        // cast to boolean if the request method was HEAD
-        result.body = isHead === true ? true : payload
+        // cast to boolean if the request method was HEAD and there was no error
+        result.body = isHead === true && result.statusCode < 400 ? true : payload
       }
 
       // we should ignore the statusCode if the user has configured the `ignore` field with
@@ -343,91 +360,130 @@ class Transport {
       }
     }
 
-    this.emit('serialization', null, result)
-    const headers = Object.assign({}, this.headers, lowerCaseHeaders(options.headers))
+    const prepareRequest = () => {
+      this.emit('serialization', null, result)
+      const headers = Object.assign({}, this.headers, lowerCaseHeaders(options.headers))
 
-    if (options.opaqueId !== undefined) {
-      headers['x-opaque-id'] = this.opaqueIdPrefix !== null
-        ? this.opaqueIdPrefix + options.opaqueId
-        : options.opaqueId
-    }
+      if (options.opaqueId !== undefined) {
+        headers['x-opaque-id'] = this.opaqueIdPrefix !== null
+          ? this.opaqueIdPrefix + options.opaqueId
+          : options.opaqueId
+      }
 
-    // handle json body
-    if (params.body != null) {
-      if (shouldSerialize(params.body) === true) {
-        try {
-          params.body = this.serializer.serialize(params.body)
-        } catch (err) {
-          this.emit('request', err, result)
-          process.nextTick(callback, err, result)
-          return transportReturn
+      // handle json body
+      if (params.body != null) {
+        if (shouldSerialize(params.body) === true) {
+          try {
+            params.body = this.serializer.serialize(params.body)
+          } catch (err) {
+            this.emit('request', err, result)
+            process.nextTick(callback, err, result)
+            return transportReturn
+          }
+        }
+
+        if (params.body !== '') {
+          headers['content-type'] = headers['content-type'] || (this[kApiVersioning] ? 'application/vnd.elasticsearch+json; compatible-with=7' : 'application/json')
+        }
+
+      // handle ndjson body
+      } else if (params.bulkBody != null) {
+        if (shouldSerialize(params.bulkBody) === true) {
+          try {
+            params.body = this.serializer.ndserialize(params.bulkBody)
+          } catch (err) {
+            this.emit('request', err, result)
+            process.nextTick(callback, err, result)
+            return transportReturn
+          }
+        } else {
+          params.body = params.bulkBody
+        }
+        if (params.body !== '') {
+          headers['content-type'] = headers['content-type'] || (this[kApiVersioning] ? 'application/vnd.elasticsearch+x-ndjson; compatible-with=7' : 'application/x-ndjson')
         }
       }
 
-      if (params.body !== '') {
-        headers['content-type'] = headers['content-type'] || 'application/json'
+      params.headers = headers
+      // serializes the querystring
+      if (options.querystring == null) {
+        params.querystring = this.serializer.qserialize(params.querystring)
+      } else {
+        params.querystring = this.serializer.qserialize(
+          Object.assign({}, params.querystring, options.querystring)
+        )
       }
 
-    // handle ndjson body
-    } else if (params.bulkBody != null) {
-      if (shouldSerialize(params.bulkBody) === true) {
-        try {
-          params.body = this.serializer.ndserialize(params.bulkBody)
-        } catch (err) {
-          this.emit('request', err, result)
-          process.nextTick(callback, err, result)
-          return transportReturn
+      // handles request timeout
+      params.timeout = toMs(options.requestTimeout || this.requestTimeout)
+      if (options.asStream === true) params.asStream = true
+      meta.request.params = params
+      meta.request.options = options
+
+      // handle compression
+      if (params.body !== '' && params.body != null) {
+        if (isStream(params.body) === true) {
+          if (compression === 'gzip') {
+            params.headers['content-encoding'] = compression
+            params.body = params.body.pipe(createGzip())
+          }
+          makeRequest()
+        } else if (compression === 'gzip') {
+          gzip(params.body, (err, buffer) => {
+            /* istanbul ignore next */
+            if (err) {
+              this.emit('request', err, result)
+              return callback(err, result)
+            }
+            params.headers['content-encoding'] = compression
+            params.headers['content-length'] = '' + Buffer.byteLength(buffer)
+            params.body = buffer
+            makeRequest()
+          })
+        } else {
+          params.headers['content-length'] = '' + Buffer.byteLength(params.body)
+          makeRequest()
         }
       } else {
-        params.body = params.bulkBody
-      }
-      if (params.body !== '') {
-        headers['content-type'] = headers['content-type'] || 'application/x-ndjson'
+        makeRequest()
       }
     }
 
-    params.headers = headers
-    // serializes the querystring
-    if (options.querystring == null) {
-      params.querystring = this.serializer.qserialize(params.querystring)
-    } else {
-      params.querystring = this.serializer.qserialize(
-        Object.assign({}, params.querystring, options.querystring)
-      )
-    }
-
-    // handles request timeout
-    params.timeout = toMs(options.requestTimeout || this.requestTimeout)
-    if (options.asStream === true) params.asStream = true
-    meta.request.params = params
-    meta.request.options = options
-
-    // handle compression
-    if (params.body !== '' && params.body != null) {
-      if (isStream(params.body) === true) {
-        if (compression === 'gzip') {
-          params.headers['content-encoding'] = compression
-          params.body = params.body.pipe(createGzip())
-        }
-        makeRequest()
-      } else if (compression === 'gzip') {
-        gzip(params.body, (err, buffer) => {
-          /* istanbul ignore next */
-          if (err) {
+    // still need to check the product or waiting for the check to finish
+    if (this[kProductCheck] === 0 || this[kProductCheck] === 1) {
+      // let pass info requests
+      if (params.method === 'GET' && params.path === '/') {
+        prepareRequest()
+      } else {
+        // wait for product check to finish
+        this[kEventEmitter].once('product-check', (error, status) => {
+          if (status === false) {
+            const err = error || new ProductNotSupportedError(result)
+            if (this[kProductCheck] === 4) {
+              err.message = 'The client noticed that the server is not a supported distribution of Elasticsearch'
+            }
             this.emit('request', err, result)
-            return callback(err, result)
+            process.nextTick(callback, err, result)
+          } else {
+            prepareRequest()
           }
-          params.headers['content-encoding'] = compression
-          params.headers['content-length'] = '' + Buffer.byteLength(buffer)
-          params.body = buffer
-          makeRequest()
         })
-      } else {
-        params.headers['content-length'] = '' + Buffer.byteLength(params.body)
-        makeRequest()
+        // the very first request triggers the product check
+        if (this[kProductCheck] === 0) {
+          this.productCheck()
+        }
       }
+    // the product check is finished and it's not Elasticsearch
+    } else if (this[kProductCheck] === 3 || this[kProductCheck] === 4) {
+      const err = new ProductNotSupportedError(result)
+      if (this[kProductCheck] === 4) {
+        err.message = 'The client noticed that the server is not a supported distribution of Elasticsearch'
+      }
+      this.emit('request', err, result)
+      process.nextTick(callback, err, result)
+    // the product check finished and it's Elasticsearch
     } else {
-      makeRequest()
+      prepareRequest()
     }
 
     return transportReturn
@@ -487,6 +543,65 @@ class Transport {
       callback(null, hosts)
     })
   }
+
+  productCheck () {
+    debug('Start product check')
+    this[kProductCheck] = 1
+    this.request({
+      method: 'GET',
+      path: '/'
+    }, (err, result) => {
+      this[kProductCheck] = 3
+      if (err) {
+        debug('Product check failed', err)
+        if (err.statusCode === 401 || err.statusCode === 403) {
+          this[kProductCheck] = 2
+          process.emitWarning('The client is unable to verify that the server is Elasticsearch due to security privileges on the server side. Some functionality may not be compatible if the server is running an unsupported product.')
+          this[kEventEmitter].emit('product-check', null, true)
+        } else {
+          this[kProductCheck] = 0
+          this[kEventEmitter].emit('product-check', err, false)
+        }
+      } else {
+        debug('Checking elasticsearch version', result.body, result.headers)
+        if (result.body.version == null || typeof result.body.version.number !== 'string') {
+          debug('Can\'t access Elasticsearch version')
+          return this[kEventEmitter].emit('product-check', null, false)
+        }
+        const tagline = result.body.tagline
+        const version = result.body.version.number.split('.')
+        const major = Number(version[0])
+        const minor = Number(version[1])
+        if (major < 6) {
+          return this[kEventEmitter].emit('product-check', null, false)
+        } else if (major >= 6 && major < 7) {
+          if (tagline !== 'You Know, for Search') {
+            debug('Bad tagline')
+            return this[kEventEmitter].emit('product-check', null, false)
+          }
+        } else if (major === 7 && minor < 14) {
+          if (tagline !== 'You Know, for Search') {
+            debug('Bad tagline')
+            return this[kEventEmitter].emit('product-check', null, false)
+          }
+
+          if (result.body.version.build_flavor !== 'default') {
+            debug('Bad build_flavor')
+            this[kProductCheck] = 4
+            return this[kEventEmitter].emit('product-check', null, false)
+          }
+        } else {
+          if (result.headers['x-elastic-product'] !== 'Elasticsearch') {
+            debug('x-elastic-product not recognized')
+            return this[kEventEmitter].emit('product-check', null, false)
+          }
+        }
+        debug('Valid Elasticsearch distribution')
+        this[kProductCheck] = 2
+        this[kEventEmitter].emit('product-check', null, true)
+      }
+    })
+  }
 }
 
 Transport.sniffReasons = {
@@ -525,7 +640,7 @@ function defaultNodeFilter (node) {
 }
 
 function roundRobinSelector () {
-  var current = -1
+  let current = -1
   return function _roundRobinSelector (connections) {
     if (++current >= connections.length) {
       current = 0
@@ -540,8 +655,8 @@ function randomSelector (connections) {
 }
 
 function generateRequestId () {
-  var maxInt = 2147483647
-  var nextReqId = 0
+  const maxInt = 2147483647
+  let nextReqId = 0
   return function genReqId (params, options) {
     return (nextReqId = (nextReqId + 1) & maxInt)
   }

package/lib/errors.d.ts

@@ -81,3 +81,10 @@ export declare class RequestAbortedError<TResponse = Record<string, any>, TConte
   meta: ApiResponse<TResponse, TContext>;
   constructor(message: string, meta: ApiResponse);
 }
+
+export declare class ProductNotSupportedError<TResponse = Record<string, any>, TContext = Context> extends ElasticsearchClientError {
+  name: string;
+  message: string;
+  meta: ApiResponse<TResponse, TContext>;
+  constructor(meta: ApiResponse);
+}

package/lib/errors.js

@@ -90,7 +90,16 @@ class ResponseError extends ElasticsearchClientError {
     super('Response Error')
     Error.captureStackTrace(this, ResponseError)
     this.name = 'ResponseError'
-    this.message = (meta.body && meta.body.error && meta.body.error.type) || 'Response Error'
+    if (meta.body && meta.body.error && meta.body.error.type) {
+      if (Array.isArray(meta.body.error.root_cause)) {
+        this.message = meta.body.error.type + ': '
+        this.message += meta.body.error.root_cause.map(entry => `[${entry.type}] Reason: ${entry.reason}`).join('; ')
+      } else {
+        this.message = meta.body.error.type
+      }
+    } else {
+      this.message = 'Response Error'
+    }
     this.meta = meta
   }
 
@@ -108,6 +117,10 @@ class ResponseError extends ElasticsearchClientError {
   get headers () {
     return this.meta.headers
   }
+
+  toString () {
+    return JSON.stringify(this.meta.body)
+  }
 }
 
 class RequestAbortedError extends ElasticsearchClientError {
@@ -120,6 +133,16 @@ class RequestAbortedError extends ElasticsearchClientError {
   }
 }
 
+class ProductNotSupportedError extends ElasticsearchClientError {
+  constructor (meta) {
+    super('Product Not Supported Error')
+    Error.captureStackTrace(this, ProductNotSupportedError)
+    this.name = 'ProductNotSupportedError'
+    this.message = 'The client noticed that the server is not Elasticsearch and we do not support this unknown product.'
+    this.meta = meta
+  }
+}
+
 module.exports = {
   ElasticsearchClientError,
   TimeoutError,
@@ -129,5 +152,6 @@ module.exports = {
   DeserializationError,
   ConfigurationError,
   ResponseError,
-  RequestAbortedError
+  RequestAbortedError,
+  ProductNotSupportedError
 }

package/lib/pool/BaseConnectionPool.js

@@ -128,7 +128,7 @@ class BaseConnectionPool {
    */
   empty (callback) {
     debug('Emptying the connection pool')
-    var openConnections = this.size
+    let openConnections = this.size
     this.connections.forEach(connection => {
       connection.close(() => {
         if (--openConnections === 0) {
@@ -201,7 +201,7 @@ class BaseConnectionPool {
     const ids = Object.keys(nodes)
     const hosts = []
 
-    for (var i = 0, len = ids.length; i < len; i++) {
+    for (let i = 0, len = ids.length; i < len; i++) {
       const node = nodes[ids[i]]
       // If there is no protocol in
       // the `publish_address` new URL will throw
@@ -210,7 +210,7 @@ class BaseConnectionPool {
       //   - hostname/ip:port
       // if we encounter the second case, we should
       // use the hostname instead of the ip
-      var address = node.http.publish_address
+      let address = node.http.publish_address
       const parts = address.split('/')
       // the url is in the form of hostname/ip:port
       if (parts.length > 1) {

package/lib/pool/ConnectionPool.js

@@ -80,7 +80,7 @@ class ConnectionPool extends BaseConnectionPool {
       // list a node that no longer exist. The following check verify
       // that the connection is still part of the pool before
       // marking it as dead.
-      for (var i = 0; i < this.size; i++) {
+      for (let i = 0; i < this.size; i++) {
         if (this.connections[i].id === id) {
           this.dead.push(id)
           break
@@ -138,7 +138,7 @@ class ConnectionPool extends BaseConnectionPool {
         path: '/',
         timeout: this.pingTimeout
       }, (err, response) => {
-        var isAlive = true
+        let isAlive = true
         const statusCode = response !== null ? response.statusCode : 0
         if (err != null ||
            (statusCode === 502 || statusCode === 503 || statusCode === 504)) {
@@ -170,8 +170,7 @@ class ConnectionPool extends BaseConnectionPool {
         isAlive: true,
         connection
       })
-      // eslint-disable-next-line standard/no-callback-literal
-      callback(true, connection)
+      callback(true, connection) // eslint-disable-line
     }
   }
 
@@ -199,7 +198,7 @@ class ConnectionPool extends BaseConnectionPool {
 
     // TODO: can we cache this?
     const connections = []
-    for (var i = 0; i < this.size; i++) {
+    for (let i = 0; i < this.size; i++) {
       const connection = this.connections[i]
       if (noAliveConnections || connection.status === Connection.statuses.ALIVE) {
         if (filter(connection) === true) {

package/lib/pool/index.d.ts

@@ -61,6 +61,10 @@ interface BasicAuth {
   password: string;
 }
 
+interface BearerAuth {
+  bearer: string
+}
+
 interface resurrectOptions {
   now?: number;
   requestId: string;
@@ -204,6 +208,7 @@ export {
   getConnectionOptions,
   ApiKeyAuth,
   BasicAuth,
+  BearerAuth,
   internals,
   resurrectOptions,
   ResurrectEvent,

package/package.json

@@ -11,7 +11,8 @@
     "./": "./"
   },
   "homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html",
-  "version": "7.11.0",
+  "version": "7.14.1",
+  "versionCanary": "7.14.0-canary.7",
   "keywords": [
     "elasticsearch",
     "elastic",
@@ -24,7 +25,6 @@
   ],
   "scripts": {
     "test": "npm run lint && tap test/{unit,acceptance}/{*,**/*}.test.js && npm run test:types",
-    "test:node8": "npm run lint && tap test/{unit,acceptance}/*.test.js",
     "test:unit": "tap test/unit/{*,**/*}.test.js",
     "test:acceptance": "tap test/acceptance/*.test.js",
     "test:integration": "node test/integration/index.js",
@@ -48,37 +48,38 @@
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "github:sinonjs/fake-timers#0bfffc1",
-    "@types/node": "^12.6.2",
-    "convert-hrtime": "^3.0.0",
+    "@types/node": "^15.3.1",
+    "convert-hrtime": "^5.0.0",
+    "cross-zip": "^4.0.0",
     "dedent": "^0.7.0",
-    "deepmerge": "^4.0.0",
+    "deepmerge": "^4.2.2",
     "dezalgo": "^1.0.3",
-    "fast-deep-equal": "^3.1.1",
-    "into-stream": "^5.1.1",
-    "js-yaml": "^3.13.1",
+    "fast-deep-equal": "^3.1.3",
+    "into-stream": "^6.0.0",
+    "js-yaml": "^4.1.0",
     "license-checker": "^25.0.1",
-    "minimist": "^1.2.0",
-    "ora": "^3.4.0",
+    "minimist": "^1.2.5",
+    "node-fetch": "^2.6.1",
+    "ora": "^5.4.0",
     "pretty-hrtime": "^1.0.3",
     "proxy": "^1.0.2",
-    "rimraf": "^2.6.3",
-    "semver": "^6.0.0",
-    "simple-git": "^1.110.0",
-    "simple-statistics": "^7.0.2",
-    "split2": "^3.1.1",
-    "standard": "^13.0.2",
+    "rimraf": "^3.0.2",
+    "semver": "^7.3.5",
+    "simple-git": "^2.39.0",
+    "simple-statistics": "^7.7.0",
+    "split2": "^3.2.2",
+    "standard": "^16.0.3",
     "stoppable": "^1.1.0",
-    "tap": "^14.4.1",
-    "tsd": "^0.13.1",
-    "workq": "^2.1.0",
-    "xmlbuilder2": "^2.1.2"
+    "tap": "^15.0.9",
+    "tsd": "^0.15.1",
+    "workq": "^3.0.0",
+    "xmlbuilder2": "^2.4.1"
   },
   "dependencies": {
-    "debug": "^4.1.1",
+    "debug": "^4.3.1",
     "hpagent": "^0.1.1",
-    "ms": "^2.1.1",
-    "pump": "^3.0.0",
-    "secure-json-parse": "^2.1.0"
+    "ms": "^2.1.3",
+    "secure-json-parse": "^2.4.0"
   },
   "license": "Apache-2.0",
   "repository": {
@@ -89,13 +90,12 @@
     "url": "https://github.com/elastic/elasticsearch-js/issues"
   },
   "engines": {
-    "node": ">=8"
+    "node": ">=12"
   },
   "tsd": {
     "directory": "test/types"
   },
   "tap": {
-    "esm": false,
     "ts": false,
     "jsx": false,
     "flow": false,