@elastic/elasticsearch 7.11.0 → 7.14.1

package/index.js

@@ -19,21 +19,23 @@
 
 'use strict'
 
-const nodeMajor = Number(process.versions.node.split('.')[0])
-
 const { EventEmitter } = require('events')
 const { URL } = require('url')
 const debug = require('debug')('elasticsearch')
 const Transport = require('./lib/Transport')
 const Connection = require('./lib/Connection')
 const { ConnectionPool, CloudConnectionPool } = require('./lib/pool')
-// Helpers works only in Node.js >= 10
-const Helpers = nodeMajor < 10 ? /* istanbul ignore next */ null : require('./lib/Helpers')
+const Helpers = require('./lib/Helpers')
 const Serializer = require('./lib/Serializer')
 const errors = require('./lib/errors')
 const { ConfigurationError } = errors
 const { prepareHeaders } = Connection.internals
-const clientVersion = require('./package.json').version
+let clientVersion = require('./package.json').version
+/* istanbul ignore next */
+if (clientVersion.includes('-')) {
+  // clean prerelease
+  clientVersion = clientVersion.slice(0, clientVersion.indexOf('-')) + 'p'
+}
 const nodeVersion = process.versions.node
 
 const kInitialOptions = Symbol('elasticsearchjs-initial-options')
@@ -43,24 +45,6 @@ const kEventEmitter = Symbol('elasticsearchjs-event-emitter')
 
 const ESAPI = require('./api')
 
-/* istanbul ignore next */
-if (nodeMajor < 10) {
-  process.emitWarning('You are using a version of Node.js that is currently in EOL. ' +
-                      'The support for this version will be dropped in 7.12. ' +
-                      'Please refer to https://ela.st/nodejs-support for additional information.',
-  'DeprecationWarning'
-  )
-}
-
-/* istanbul ignore next */
-if (nodeMajor >= 10 && nodeMajor < 12) {
-  process.emitWarning('You are using a version of Node.js that will reach EOL in April 2021. ' +
-                      'The support for this version will be dropped in 7.13. ' +
-                      'Please refer to https://ela.st/nodejs-support for additional information.',
-  'DeprecationWarning'
-  )
-}
-
 class Client extends ESAPI {
   constructor (opts = {}) {
     super({ ConfigurationError })
@@ -128,9 +112,14 @@ class Client extends ESAPI {
         opaqueIdPrefix: null,
         context: null,
         proxy: null,
-        enableMetaHeader: true
+        enableMetaHeader: true,
+        disablePrototypePoisoningProtection: false
       }, opts)
 
+    if (process.env.ELASTIC_CLIENT_APIVERSIONING === 'true') {
+      options.headers = Object.assign({ accept: 'application/vnd.elasticsearch+json; compatible-with=7' }, options.headers)
+    }
+
     this[kInitialOptions] = options
     this[kExtensions] = []
     this.name = options.name
@@ -145,7 +134,9 @@ class Client extends ESAPI {
       this[kEventEmitter] = options[kChild].eventEmitter
     } else {
       this[kEventEmitter] = new EventEmitter()
-      this.serializer = new options.Serializer()
+      this.serializer = new options.Serializer({
+        disablePrototypePoisoningProtection: options.disablePrototypePoisoningProtection
+      })
       this.connectionPool = new options.ConnectionPool({
         pingTimeout: options.pingTimeout,
         resurrectStrategy: options.resurrectStrategy,
@@ -184,16 +175,13 @@ class Client extends ESAPI {
       context: options.context
     })
 
-    /* istanbul ignore else */
-    if (Helpers !== null) {
-      this.helpers = new Helpers({
-        client: this,
-        maxRetries: options.maxRetries,
-        metaHeader: options.enableMetaHeader
-          ? `es=${clientVersion},js=${nodeVersion},t=${clientVersion},hc=${nodeVersion}`
-          : null
-      })
-    }
+    this.helpers = new Helpers({
+      client: this,
+      maxRetries: options.maxRetries,
+      metaHeader: options.enableMetaHeader
+        ? `es=${clientVersion},js=${nodeVersion},t=${clientVersion},hc=${nodeVersion}`
+        : null
+    })
   }
 
   get emit () {
@@ -218,7 +206,7 @@ class Client extends ESAPI {
       opts = {}
     }
 
-    var [namespace, method] = name.split('.')
+    let [namespace, method] = name.split('.')
     if (method == null) {
       method = namespace
       namespace = null
@@ -267,6 +255,10 @@ class Client extends ESAPI {
     }
 
     const client = new Client(options)
+    // sync product check
+    const tSymbol = Object.getOwnPropertySymbols(this.transport)
+      .filter(symbol => symbol.description === 'product check')[0]
+    client.transport[tSymbol] = this.transport[tSymbol]
     // Add parent extensions
     if (this[kExtensions].length > 0) {
       this[kExtensions].forEach(({ name, opts, fn }) => {

package/lib/Connection.js

@@ -25,7 +25,7 @@ const hpagent = require('hpagent')
 const http = require('http')
 const https = require('https')
 const debug = require('debug')('elasticsearch')
-const pump = require('pump')
+const { pipeline } = require('stream')
 const INVALID_PATH_REGEX = /[^\u0021-\u00ff]/
 const {
   ConnectionError,
@@ -133,7 +133,7 @@ class Connection {
 
     // starts the request
     if (isStream(params.body) === true) {
-      pump(params.body, request, err => {
+      pipeline(params.body, request, err => {
         /* istanbul ignore if  */
         if (err != null && cleanedListeners === false) {
           cleanListeners()
@@ -213,8 +213,8 @@ class Connection {
     }
 
     const paramsKeys = Object.keys(params)
-    for (var i = 0, len = paramsKeys.length; i < len; i++) {
-      var key = paramsKeys[i]
+    for (let i = 0, len = paramsKeys.length; i < len; i++) {
+      const key = paramsKeys[i]
       if (key === 'path') {
         request.pathname = resolve(request.pathname, params[key])
       } else if (key === 'querystring' && !!params[key] === true) {
@@ -331,6 +331,8 @@ function prepareHeaders (headers = {}, auth) {
       } else {
         headers.authorization = `ApiKey ${auth.apiKey}`
       }
+    } else if (auth.bearer) {
+      headers.authorization = `Bearer ${auth.bearer}`
     } else if (auth.username && auth.password) {
       headers.authorization = 'Basic ' + Buffer.from(`${auth.username}:${auth.password}`).toString('base64')
     }

package/lib/Helpers.d.ts

@@ -25,8 +25,8 @@ export default class Helpers {
   search<TDocument = unknown, TRequestBody extends RequestBody = Record<string, any>>(params: Search<TRequestBody>, options?: TransportRequestOptions): Promise<TDocument[]>
   scrollSearch<TDocument = unknown, TResponse = Record<string, any>, TRequestBody extends  RequestBody = Record<string, any>, TContext = Context>(params: Search<TRequestBody>, options?: TransportRequestOptions): AsyncIterable<ScrollSearchResponse<TDocument, TResponse, TContext>>
   scrollDocuments<TDocument = unknown, TRequestBody extends RequestBody = Record<string, any>>(params: Search<TRequestBody>, options?: TransportRequestOptions): AsyncIterable<TDocument>
-  msearch(options?: MsearchHelperOptions): MsearchHelper
-  bulk<TDocument = unknown>(options: BulkHelperOptions<TDocument>): BulkHelper<BulkStats>
+  msearch(options?: MsearchHelperOptions, reqOptions?: TransportRequestOptions): MsearchHelper
+  bulk<TDocument = unknown>(options: BulkHelperOptions<TDocument>, reqOptions?: TransportRequestOptions): BulkHelper<BulkStats>
 }
 
 export interface ScrollSearchResponse<TDocument = unknown, TResponse = Record<string, any>, TContext = Context> extends ApiResponse<TResponse, TContext> {
@@ -36,6 +36,7 @@ export interface ScrollSearchResponse<TDocument = unknown, TResponse = Record<st
 
 export interface BulkHelper<T> extends Promise<T> {
   abort: () => BulkHelper<T>
+  readonly stats: BulkStats
 }
 
 export interface BulkStats {
@@ -43,6 +44,7 @@ export interface BulkStats {
   failed: number
   retry: number
   successful: number
+  noop: number
   time: number
   bytes: number
   aborted: boolean

package/lib/Helpers.js

@@ -158,7 +158,7 @@ class Helpers {
    */
   async * scrollDocuments (params, options) {
     appendFilterPath('hits.hits._source', params, true)
-    for await (const { documents } of this.scrollSearch(params)) {
+    for await (const { documents } of this.scrollSearch(params, options)) {
       for (const document of documents) {
         yield document
       }
@@ -169,9 +169,10 @@ class Helpers {
    * Creates a msearch helper instance. Once you configure it, you can use the provided
    * `search` method to add new searches in the queue.
    * @param {object} options - The configuration of the msearch operations.
+   * @param {object} reqOptions - The client optional configuration for this request.
    * @return {object} The possible operations to run.
    */
-  msearch (options = {}) {
+  msearch (options = {}, reqOptions = {}) {
     const client = this[kClient]
     const {
       operations = 5,
@@ -378,7 +379,7 @@ class Helpers {
       // This function never returns an error, if the msearch operation fails,
       // the error is dispatched to all search executors.
       function tryMsearch (msearchBody, callbacks, done) {
-        client.msearch(Object.assign({}, msearchOptions, { body: msearchBody }), (err, results) => {
+        client.msearch(Object.assign({}, msearchOptions, { body: msearchBody }), reqOptions, (err, results) => {
           const retryBody = []
           const retryCallbacks = []
           if (err) {
@@ -415,12 +416,16 @@ class Helpers {
    * Creates a bulk helper instance. Once you configure it, you can pick which operation
    * to execute with the given dataset, index, create, update, and delete.
    * @param {object} options - The configuration of the bulk operation.
+   * @param {object} reqOptions - The client optional configuration for this request.
    * @return {object} The possible operations to run with the datasource.
    */
-  bulk (options) {
+  bulk (options, reqOptions = {}) {
     const client = this[kClient]
-    const { serialize, deserialize } = client.serializer
-    const reqOptions = this[kMetaHeader] !== null ? { headers: { 'x-elastic-client-meta': this[kMetaHeader] + ',h=bp' } } : {}
+    const { serializer } = client
+    if (this[kMetaHeader] !== null) {
+      reqOptions.headers = reqOptions.headers || {}
+      reqOptions.headers['x-elastic-client-meta'] = this[kMetaHeader] + ',h=bp'
+    }
     const {
       datasource,
       onDocument,
@@ -451,6 +456,7 @@ class Helpers {
       failed: 0,
       retry: 0,
       successful: 0,
+      noop: 0,
       time: 0,
       bytes: 0,
       aborted: false
@@ -458,6 +464,9 @@ class Helpers {
 
     const p = iterate()
     const helper = {
+      get stats () {
+        return stats
+      },
       then (onFulfilled, onRejected) {
         return p.then(onFulfilled, onRejected)
       },
@@ -500,19 +509,19 @@ class Helpers {
           ? Object.keys(action[0])[0]
           : Object.keys(action)[0]
         if (operation === 'index' || operation === 'create') {
-          actionBody = serialize(action)
-          payloadBody = typeof chunk === 'string' ? chunk : serialize(chunk)
+          actionBody = serializer.serialize(action)
+          payloadBody = typeof chunk === 'string' ? chunk : serializer.serialize(chunk)
           chunkBytes += Buffer.byteLength(actionBody) + Buffer.byteLength(payloadBody)
           bulkBody.push(actionBody, payloadBody)
         } else if (operation === 'update') {
-          actionBody = serialize(action[0])
+          actionBody = serializer.serialize(action[0])
           payloadBody = typeof chunk === 'string'
             ? `{"doc":${chunk}}`
-            : serialize({ doc: chunk, ...action[1] })
+            : serializer.serialize({ doc: chunk, ...action[1] })
           chunkBytes += Buffer.byteLength(actionBody) + Buffer.byteLength(payloadBody)
           bulkBody.push(actionBody, payloadBody)
         } else if (operation === 'delete') {
-          actionBody = serialize(action)
+          actionBody = serializer.serialize(action)
           chunkBytes += Buffer.byteLength(actionBody)
           bulkBody.push(actionBody)
         } else {
@@ -545,7 +554,7 @@ class Helpers {
           index: typeof refreshOnCompletion === 'string'
             ? refreshOnCompletion
             : '_all'
-        })
+        }, reqOptions)
       }
 
       stats.time = Date.now() - startTime
@@ -664,13 +673,13 @@ class Helpers {
             return
           }
           for (let i = 0, len = bulkBody.length; i < len; i = i + 2) {
-            const operation = Object.keys(deserialize(bulkBody[i]))[0]
+            const operation = Object.keys(serializer.deserialize(bulkBody[i]))[0]
             onDrop({
               status: 429,
               error: null,
-              operation: deserialize(bulkBody[i]),
+              operation: serializer.deserialize(bulkBody[i]),
               document: operation !== 'delete'
-                ? deserialize(bulkBody[i + 1])
+                ? serializer.deserialize(bulkBody[i + 1])
                 /* istanbul ignore next */
                 : null,
               retried: isRetrying
@@ -687,6 +696,11 @@ class Helpers {
           if (err) return callback(err, null)
           if (body.errors === false) {
             stats.successful += body.items.length
+            for (const item of body.items) {
+              if (item.update && item.update.result === 'noop') {
+                stats.noop++
+              }
+            }
             return callback(null, [])
           }
           const retry = []
@@ -711,9 +725,9 @@ class Helpers {
                 onDrop({
                   status: status,
                   error: action[operation].error,
-                  operation: deserialize(bulkBody[indexSlice]),
+                  operation: serializer.deserialize(bulkBody[indexSlice]),
                   document: operation !== 'delete'
-                    ? deserialize(bulkBody[indexSlice + 1])
+                    ? serializer.deserialize(bulkBody[indexSlice + 1])
                     : null,
                   retried: isRetrying
                 })

package/lib/Serializer.d.ts

@@ -17,7 +17,12 @@
  * under the License.
  */
 
+export interface SerializerOptions {
+  disablePrototypePoisoningProtection: boolean | 'proto' | 'constructor'
+}
+
 export default class Serializer {
+  constructor (opts?: SerializerOptions)
   serialize(object: any): string;
   deserialize(json: string): any;
   ndserialize(array: any[]): string;

package/lib/Serializer.js

@@ -23,12 +23,22 @@ const { stringify } = require('querystring')
 const debug = require('debug')('elasticsearch')
 const sjson = require('secure-json-parse')
 const { SerializationError, DeserializationError } = require('./errors')
+const kJsonOptions = Symbol('secure json parse options')
 
 class Serializer {
+  constructor (opts = {}) {
+    const disable = opts.disablePrototypePoisoningProtection
+    this[kJsonOptions] = {
+      protoAction: disable === true || disable === 'proto' ? 'ignore' : 'error',
+      constructorAction: disable === true || disable === 'constructor' ? 'ignore' : 'error'
+    }
+  }
+
   serialize (object) {
     debug('Serializing', object)
+    let json
     try {
-      var json = JSON.stringify(object)
+      json = JSON.stringify(object)
     } catch (err) {
       throw new SerializationError(err.message, object)
     }
@@ -37,8 +47,9 @@ class Serializer {
 
   deserialize (json) {
     debug('Deserializing', json)
+    let object
     try {
-      var object = sjson.parse(json)
+      object = sjson.parse(json, this[kJsonOptions])
     } catch (err) {
       throw new DeserializationError(err.message, json)
     }
@@ -50,8 +61,8 @@ class Serializer {
     if (Array.isArray(array) === false) {
       throw new SerializationError('The argument provided is not an array')
     }
-    var ndjson = ''
-    for (var i = 0, len = array.length; i < len; i++) {
+    let ndjson = ''
+    for (let i = 0, len = array.length; i < len; i++) {
       if (typeof array[i] === 'string') {
         ndjson += array[i] + '\n'
       } else {
@@ -67,8 +78,8 @@ class Serializer {
     if (typeof object === 'string') return object
     // arrays should be serialized as comma separated list
     const keys = Object.keys(object)
-    for (var i = 0, len = keys.length; i < len; i++) {
-      var key = keys[i]
+    for (let i = 0, len = keys.length; i < len; i++) {
+      const key = keys[i]
       // elasticsearch will complain for keys without a value
       if (object[key] === undefined) {
         delete object[key]

package/lib/Transport.d.ts

@@ -26,9 +26,10 @@ import * as errors from './errors';
 export type ApiError = errors.ConfigurationError | errors.ConnectionError |
                        errors.DeserializationError | errors.SerializationError |
                        errors.NoLivingConnectionsError | errors.ResponseError |
-                       errors.TimeoutError | errors.RequestAbortedError
+                       errors.TimeoutError | errors.RequestAbortedError |
+                       errors.ProductNotSupportedError
 
-export type Context = Record<string, unknown> | null
+export type Context = unknown
 
 export interface nodeSelectorFn {
   (connections: Connection[]): Connection;
@@ -120,6 +121,7 @@ export interface TransportRequestCallback {
 
 export interface TransportRequestPromise<T> extends Promise<T> {
   abort: () => void;
+  finally(onFinally?: (() => void) | undefined | null): Promise<T>;
 }
 
 export interface TransportGetConnectionOptions {