@elastic/elasticsearch 7.9.0 → 7.9.1

package/api/utils.js

@@ -0,0 +1,58 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+'use strict'
+
+const result = { body: null, statusCode: null, headers: null, warnings: null }
+const kConfigurationError = Symbol('configuration error')
+
+function handleError (err, callback) {
+  if (callback) {
+    process.nextTick(callback, err, result)
+    return { then: noop, catch: noop, abort: noop }
+  }
+  return Promise.reject(err)
+}
+
+function snakeCaseKeys (acceptedQuerystring, snakeCase, querystring) {
+  var target = {}
+  var keys = Object.keys(querystring)
+  for (var i = 0, len = keys.length; i < len; i++) {
+    var key = keys[i]
+    target[snakeCase[key] || key] = querystring[key]
+  }
+  return target
+}
+
+function normalizeArguments (params, options, callback) {
+  if (typeof options === 'function') {
+    callback = options
+    options = {}
+  }
+  if (typeof params === 'function' || params == null) {
+    callback = params
+    params = {}
+    options = {}
+  }
+  return [params, options, callback]
+}
+
+function noop () {}
+
+module.exports = { handleError, snakeCaseKeys, normalizeArguments, noop, kConfigurationError }

package/index.js

@@ -17,17 +17,19 @@ const Helpers = nodeMajor < 10 ? /* istanbul ignore next */ null : require('./li
 const Serializer = require('./lib/Serializer')
 const errors = require('./lib/errors')
 const { ConfigurationError } = errors
+const { prepareHeaders } = Connection.internals
 
 const kInitialOptions = Symbol('elasticsearchjs-initial-options')
 const kChild = Symbol('elasticsearchjs-child')
 const kExtensions = Symbol('elasticsearchjs-extensions')
 const kEventEmitter = Symbol('elasticsearchjs-event-emitter')
 
-const buildApi = require('./api')
+const ESAPI = require('./api')
 
-class Client {
+class Client extends ESAPI {
   constructor (opts = {}) {
-    if (opts.cloud) {
+    super({ ConfigurationError })
+    if (opts.cloud && opts[kChild] === undefined) {
       const { id, username, password } = opts.cloud
       // the cloud id is `cluster-name:base64encodedurl`
       // the url is a string divided by two '$', the first is the cloud url
@@ -56,37 +58,41 @@ class Client {
       throw new ConfigurationError('Missing node(s) option')
     }
 
-    const checkAuth = getAuth(opts.node || opts.nodes)
-    if (checkAuth && checkAuth.username && checkAuth.password) {
-      opts.auth = Object.assign({}, opts.auth, { username: checkAuth.username, password: checkAuth.password })
+    if (opts[kChild] === undefined) {
+      const checkAuth = getAuth(opts.node || opts.nodes)
+      if (checkAuth && checkAuth.username && checkAuth.password) {
+        opts.auth = Object.assign({}, opts.auth, { username: checkAuth.username, password: checkAuth.password })
+      }
     }
 
-    const options = Object.assign({}, {
-      Connection,
-      Transport,
-      Serializer,
-      ConnectionPool: opts.cloud ? CloudConnectionPool : ConnectionPool,
-      maxRetries: 3,
-      requestTimeout: 30000,
-      pingTimeout: 3000,
-      sniffInterval: false,
-      sniffOnStart: false,
-      sniffEndpoint: '_nodes/_all/http',
-      sniffOnConnectionFault: false,
-      resurrectStrategy: 'ping',
-      suggestCompression: false,
-      compression: false,
-      ssl: null,
-      agent: null,
-      headers: {},
-      nodeFilter: null,
-      nodeSelector: 'round-robin',
-      generateRequestId: null,
-      name: 'elasticsearch-js',
-      auth: null,
-      opaqueIdPrefix: null,
-      context: null
-    }, opts)
+    const options = opts[kChild] !== undefined
+      ? opts[kChild].initialOptions
+      : Object.assign({}, {
+        Connection,
+        Transport,
+        Serializer,
+        ConnectionPool: opts.cloud ? CloudConnectionPool : ConnectionPool,
+        maxRetries: 3,
+        requestTimeout: 30000,
+        pingTimeout: 3000,
+        sniffInterval: false,
+        sniffOnStart: false,
+        sniffEndpoint: '_nodes/_all/http',
+        sniffOnConnectionFault: false,
+        resurrectStrategy: 'ping',
+        suggestCompression: false,
+        compression: false,
+        ssl: null,
+        agent: null,
+        headers: {},
+        nodeFilter: null,
+        nodeSelector: 'round-robin',
+        generateRequestId: null,
+        name: 'elasticsearch-js',
+        auth: null,
+        opaqueIdPrefix: null,
+        context: null
+      }, opts)
 
     this[kInitialOptions] = options
     this[kExtensions] = []
@@ -140,17 +146,6 @@ class Client {
     if (Helpers !== null) {
       this.helpers = new Helpers({ client: this, maxRetries: options.maxRetries })
     }
-
-    const apis = buildApi({
-      makeRequest: this.transport.request.bind(this.transport),
-      result: { body: null, statusCode: null, headers: null, warnings: null },
-      ConfigurationError
-    })
-
-    const apiNames = Object.keys(apis)
-    for (var i = 0, len = apiNames.length; i < len; i++) {
-      this[apiNames[i]] = apis[apiNames[i]]
-    }
   }
 
   get emit () {
@@ -186,7 +181,7 @@ class Client {
         throw new Error(`The method "${method}" already exists on namespace "${namespace}"`)
       }
 
-      this[namespace] = this[namespace] || {}
+      if (this[namespace] == null) this[namespace] = {}
       this[namespace][method] = fn({
         makeRequest: this.transport.request.bind(this.transport),
         result: { body: null, statusCode: null, headers: null, warnings: null },
@@ -209,15 +204,21 @@ class Client {
 
   child (opts) {
     // Merge the new options with the initial ones
-    const initialOptions = Object.assign({}, this[kInitialOptions], opts)
+    const options = Object.assign({}, this[kInitialOptions], opts)
     // Pass to the child client the parent instances that cannot be overriden
-    initialOptions[kChild] = {
+    options[kChild] = {
       connectionPool: this.connectionPool,
       serializer: this.serializer,
-      eventEmitter: this[kEventEmitter]
+      eventEmitter: this[kEventEmitter],
+      initialOptions: options
+    }
+
+    /* istanbul ignore else */
+    if (options.auth !== undefined) {
+      options.headers = prepareHeaders(options.headers, options.auth)
     }
 
-    const client = new Client(initialOptions)
+    const client = new Client(options)
     // Add parent extensions
     if (this[kExtensions].length > 0) {
       this[kExtensions].forEach(({ name, opts, fn }) => {

package/lib/Connection.d.ts

@@ -33,7 +33,7 @@ interface ConnectionRoles {
 
 interface RequestOptions extends http.ClientRequestArgs {
   asStream?: boolean;
-  body?: string | Buffer | ReadableStream;
+  body?: string | Buffer | ReadableStream | null;
   querystring?: string;
 }
 

package/lib/Connection.js

@@ -324,3 +324,4 @@ function prepareHeaders (headers = {}, auth) {
 }
 
 module.exports = Connection
+module.exports.internals = { prepareHeaders }

package/lib/Helpers.js

@@ -69,7 +69,7 @@ class Helpers {
     const { method, body, index, ...querystring } = params
 
     let response = null
-    for (let i = 0; i < maxRetries; i++) {
+    for (let i = 0; i <= maxRetries; i++) {
       response = await this[kClient].search(params, options)
       if (response.statusCode !== 429) break
       await sleep(wait)
@@ -99,9 +99,10 @@ class Helpers {
         break
       }
 
-      for (let i = 0; i < maxRetries; i++) {
+      for (let i = 0; i <= maxRetries; i++) {
         response = await this[kClient].scroll({
-          ...querystring,
+          scroll: querystring.scroll,
+          rest_total_hits_as_int: querystring.rest_total_hits_as_int || querystring.restTotalHitsAsInt,
           body: { scroll_id }
         }, options)
         if (response.statusCode !== 429) break

package/lib/Transport.js

@@ -112,25 +112,47 @@ class Transport {
       body: null,
       statusCode: null,
       headers: null,
-      warnings: options.warnings || null,
       meta
     }
 
+    Object.defineProperty(result, 'warnings', {
+      get () {
+        return this.headers && this.headers.warning
+          ? this.headers.warning.split(/(?!\B"[^"]*),(?![^"]*"\B)/)
+          : null
+      }
+    })
+
     // We should not retry if we are sending a stream body, because we should store in memory
     // a copy of the stream to be able to send it again, but since we don't know in advance
     // 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) ? 0 : options.maxRetries || this.maxRetries
+    const maxRetries = isStream(params.body) || isStream(params.bulkBody)
+      ? 0 : (typeof options.maxRetries === 'number' ? options.maxRetries : this.maxRetries)
     const compression = options.compression !== undefined ? options.compression : this.compression
     var request = { abort: noop }
+    const transportReturn = {
+      then (onFulfilled, onRejected) {
+        return p.then(onFulfilled, onRejected)
+      },
+      catch (onRejected) {
+        return p.catch(onRejected)
+      },
+      abort () {
+        meta.aborted = true
+        request.abort()
+        debug('Aborting request', params)
+        return this
+      }
+    }
 
     const makeRequest = () => {
       if (meta.aborted === true) {
-        return callback(new RequestAbortedError(), result)
+        return process.nextTick(callback, new RequestAbortedError(), result)
       }
       meta.connection = this.getConnection({ requestId: meta.request.id })
       if (meta.connection == null) {
-        return callback(new NoLivingConnectionsError(), result)
+        return process.nextTick(callback, new NoLivingConnectionsError(), result)
       }
       this.emit('request', null, result)
       // perform the actual http request
@@ -168,11 +190,6 @@ class Transport {
       const { statusCode, headers } = response
       result.statusCode = statusCode
       result.headers = headers
-      if (headers['warning'] !== undefined) {
-        result.warnings = result.warnings || []
-        // split the string over the commas not inside quotes
-        result.warnings.push.apply(result.warnings, headers['warning'].split(/(?!\B"[^"]*),(?![^"]*"\B)/))
-      }
 
       if (options.asStream === true) {
         result.body = response
@@ -265,7 +282,8 @@ class Transport {
         try {
           params.body = this.serializer.serialize(params.body)
         } catch (err) {
-          return callback(err, result)
+          process.nextTick(callback, err, result)
+          return transportReturn
         }
       }
 
@@ -279,7 +297,8 @@ class Transport {
         try {
           params.body = this.serializer.ndserialize(params.bulkBody)
         } catch (err) {
-          return callback(err, result)
+          process.nextTick(callback, err, result)
+          return transportReturn
         }
       } else {
         params.body = params.bulkBody
@@ -332,20 +351,7 @@ class Transport {
       makeRequest()
     }
 
-    return {
-      then (onFulfilled, onRejected) {
-        return p.then(onFulfilled, onRejected)
-      },
-      catch (onRejected) {
-        return p.catch(onRejected)
-      },
-      abort () {
-        meta.aborted = true
-        request.abort()
-        debug('Aborting request', params)
-        return this
-      }
-    }
+    return transportReturn
   }
 
   getConnection (opts) {

package/package.json

@@ -11,7 +11,7 @@
     "./": "./"
   },
   "homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html",
-  "version": "7.9.0",
+  "version": "7.9.1",
   "keywords": [
     "elasticsearch",
     "elastic",

package/api/api/async_search.delete.js

@@ -1,78 +0,0 @@
-// Licensed to Elasticsearch B.V under one or more agreements.
-// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-// See the LICENSE file in the project root for more information
-
-'use strict'
-
-/* eslint camelcase: 0 */
-/* eslint no-unused-vars: 0 */
-
-function buildAsyncSearchDelete (opts) {
-  // eslint-disable-next-line no-unused-vars
-  const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
-
-  const acceptedQuerystring = [
-
-  ]
-
-  const snakeCase = {
-
-  }
-
-  /**
-   * Perform a async_search.delete request
-   * Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.
-   * https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
-   */
-  return function asyncSearchDelete (params, options, callback) {
-    options = options || {}
-    if (typeof options === 'function') {
-      callback = options
-      options = {}
-    }
-    if (typeof params === 'function' || params == null) {
-      callback = params
-      params = {}
-      options = {}
-    }
-
-    // check required parameters
-    if (params['id'] == null) {
-      const err = new ConfigurationError('Missing required parameter: id')
-      return handleError(err, callback)
-    }
-
-    // validate headers object
-    if (options.headers != null && typeof options.headers !== 'object') {
-      const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
-      return handleError(err, callback)
-    }
-
-    var warnings = []
-    var { method, body, id, ...querystring } = params
-    querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
-
-    var ignore = options.ignore
-    if (typeof ignore === 'number') {
-      options.ignore = [ignore]
-    }
-
-    var path = ''
-
-    if (method == null) method = 'DELETE'
-    path = '/' + '_async_search' + '/' + encodeURIComponent(id)
-
-    // build request object
-    const request = {
-      method,
-      path,
-      body: body || '',
-      querystring
-    }
-
-    options.warnings = warnings.length === 0 ? null : warnings
-    return makeRequest(request, options, callback)
-  }
-}
-
-module.exports = buildAsyncSearchDelete

package/api/api/async_search.get.js

@@ -1,82 +0,0 @@
-// Licensed to Elasticsearch B.V under one or more agreements.
-// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-// See the LICENSE file in the project root for more information
-
-'use strict'
-
-/* eslint camelcase: 0 */
-/* eslint no-unused-vars: 0 */
-
-function buildAsyncSearchGet (opts) {
-  // eslint-disable-next-line no-unused-vars
-  const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
-
-  const acceptedQuerystring = [
-    'wait_for_completion_timeout',
-    'keep_alive',
-    'typed_keys'
-  ]
-
-  const snakeCase = {
-    waitForCompletionTimeout: 'wait_for_completion_timeout',
-    keepAlive: 'keep_alive',
-    typedKeys: 'typed_keys'
-  }
-
-  /**
-   * Perform a async_search.get request
-   * Retrieves the results of a previously submitted async search request given its ID.
-   * https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
-   */
-  return function asyncSearchGet (params, options, callback) {
-    options = options || {}
-    if (typeof options === 'function') {
-      callback = options
-      options = {}
-    }
-    if (typeof params === 'function' || params == null) {
-      callback = params
-      params = {}
-      options = {}
-    }
-
-    // check required parameters
-    if (params['id'] == null) {
-      const err = new ConfigurationError('Missing required parameter: id')
-      return handleError(err, callback)
-    }
-
-    // validate headers object
-    if (options.headers != null && typeof options.headers !== 'object') {
-      const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
-      return handleError(err, callback)
-    }
-
-    var warnings = []
-    var { method, body, id, ...querystring } = params
-    querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
-
-    var ignore = options.ignore
-    if (typeof ignore === 'number') {
-      options.ignore = [ignore]
-    }
-
-    var path = ''
-
-    if (method == null) method = 'GET'
-    path = '/' + '_async_search' + '/' + encodeURIComponent(id)
-
-    // build request object
-    const request = {
-      method,
-      path,
-      body: null,
-      querystring
-    }
-
-    options.warnings = warnings.length === 0 ? null : warnings
-    return makeRequest(request, options, callback)
-  }
-}
-
-module.exports = buildAsyncSearchGet

package/api/api/async_search.submit.js

@@ -1,147 +0,0 @@
-// Licensed to Elasticsearch B.V under one or more agreements.
-// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-// See the LICENSE file in the project root for more information
-
-'use strict'
-
-/* eslint camelcase: 0 */
-/* eslint no-unused-vars: 0 */
-
-function buildAsyncSearchSubmit (opts) {
-  // eslint-disable-next-line no-unused-vars
-  const { makeRequest, ConfigurationError, handleError, snakeCaseKeys } = opts
-
-  const acceptedQuerystring = [
-    'wait_for_completion_timeout',
-    'keep_on_completion',
-    'keep_alive',
-    'batched_reduce_size',
-    'request_cache',
-    'analyzer',
-    'analyze_wildcard',
-    'default_operator',
-    'df',
-    'explain',
-    'stored_fields',
-    'docvalue_fields',
-    'from',
-    'ignore_unavailable',
-    'ignore_throttled',
-    'allow_no_indices',
-    'expand_wildcards',
-    'lenient',
-    'preference',
-    'q',
-    'routing',
-    'search_type',
-    'size',
-    'sort',
-    '_source',
-    '_source_excludes',
-    '_source_exclude',
-    '_source_includes',
-    '_source_include',
-    'terminate_after',
-    'stats',
-    'suggest_field',
-    'suggest_mode',
-    'suggest_size',
-    'suggest_text',
-    'timeout',
-    'track_scores',
-    'track_total_hits',
-    'allow_partial_search_results',
-    'typed_keys',
-    'version',
-    'seq_no_primary_term',
-    'max_concurrent_shard_requests'
-  ]
-
-  const snakeCase = {
-    waitForCompletionTimeout: 'wait_for_completion_timeout',
-    keepOnCompletion: 'keep_on_completion',
-    keepAlive: 'keep_alive',
-    batchedReduceSize: 'batched_reduce_size',
-    requestCache: 'request_cache',
-    analyzeWildcard: 'analyze_wildcard',
-    defaultOperator: 'default_operator',
-    storedFields: 'stored_fields',
-    docvalueFields: 'docvalue_fields',
-    ignoreUnavailable: 'ignore_unavailable',
-    ignoreThrottled: 'ignore_throttled',
-    allowNoIndices: 'allow_no_indices',
-    expandWildcards: 'expand_wildcards',
-    searchType: 'search_type',
-    _sourceExcludes: '_source_excludes',
-    _sourceExclude: '_source_exclude',
-    _sourceIncludes: '_source_includes',
-    _sourceInclude: '_source_include',
-    terminateAfter: 'terminate_after',
-    suggestField: 'suggest_field',
-    suggestMode: 'suggest_mode',
-    suggestSize: 'suggest_size',
-    suggestText: 'suggest_text',
-    trackScores: 'track_scores',
-    trackTotalHits: 'track_total_hits',
-    allowPartialSearchResults: 'allow_partial_search_results',
-    typedKeys: 'typed_keys',
-    seqNoPrimaryTerm: 'seq_no_primary_term',
-    maxConcurrentShardRequests: 'max_concurrent_shard_requests'
-  }
-
-  /**
-   * Perform a async_search.submit request
-   * Executes a search request asynchronously.
-   * https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
-   */
-  return function asyncSearchSubmit (params, options, callback) {
-    options = options || {}
-    if (typeof options === 'function') {
-      callback = options
-      options = {}
-    }
-    if (typeof params === 'function' || params == null) {
-      callback = params
-      params = {}
-      options = {}
-    }
-
-    // validate headers object
-    if (options.headers != null && typeof options.headers !== 'object') {
-      const err = new ConfigurationError(`Headers should be an object, instead got: ${typeof options.headers}`)
-      return handleError(err, callback)
-    }
-
-    var warnings = []
-    var { method, body, index, ...querystring } = params
-    querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring, warnings)
-
-    var ignore = options.ignore
-    if (typeof ignore === 'number') {
-      options.ignore = [ignore]
-    }
-
-    var path = ''
-
-    if ((index) != null) {
-      if (method == null) method = 'POST'
-      path = '/' + encodeURIComponent(index) + '/' + '_async_search'
-    } else {
-      if (method == null) method = 'POST'
-      path = '/' + '_async_search'
-    }
-
-    // build request object
-    const request = {
-      method,
-      path,
-      body: body || '',
-      querystring
-    }
-
-    options.warnings = warnings.length === 0 ? null : warnings
-    return makeRequest(request, options, callback)
-  }
-}
-
-module.exports = buildAsyncSearchSubmit