@elastic/elasticsearch 7.7.0-rc.2 → 7.8.0

package/index.js

@@ -4,13 +4,16 @@
 
 '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')
-const Helpers = require('./lib/Helpers')
+// Helpers works only in Node.js >= 10
+const Helpers = nodeMajor < 10 ? /* istanbul ignore next */ null : require('./lib/Helpers')
 const Serializer = require('./lib/Serializer')
 const errors = require('./lib/errors')
 const { ConfigurationError } = errors
@@ -127,7 +130,10 @@ class Client extends EventEmitter {
       opaqueIdPrefix: options.opaqueIdPrefix
     })
 
-    this.helpers = new Helpers({ client: this, maxRetries: options.maxRetries })
+    /* istanbul ignore else */
+    if (Helpers !== null) {
+      this.helpers = new Helpers({ client: this, maxRetries: options.maxRetries })
+    }
 
     const apis = buildApi({
       makeRequest: this.transport.request.bind(this.transport),
@@ -232,6 +238,7 @@ function getAuth (node) {
   return null
 
   function getUsernameAndPassword (node) {
+    /* istanbul ignore else */
     if (typeof node === 'string') {
       const { username, password } = new URL(node)
       return {

package/lib/Connection.js

@@ -20,7 +20,7 @@ const {
 } = require('./errors')
 
 class Connection {
-  constructor (opts = {}) {
+  constructor (opts) {
     this.url = opts.url
     this.ssl = opts.ssl || null
     this.id = opts.id || stripAuth(opts.url.href)
@@ -64,6 +64,7 @@ class Connection {
     // https://github.com/nodejs/node/commit/b961d9fd83
     if (INVALID_PATH_REGEX.test(requestParams.path) === true) {
       callback(new TypeError(`ERR_UNESCAPED_CHARACTERS: ${requestParams.path}`), null)
+      /* istanbul ignore next */
       return { abort: () => {} }
     }
 
@@ -73,6 +74,7 @@ class Connection {
     // listen for the response event
     // TODO: handle redirects?
     request.on('response', response => {
+      /* istanbul ignore else */
       if (ended === false) {
         ended = true
         this._openRequests--
@@ -87,6 +89,7 @@ class Connection {
 
     // handles request timeout
     request.on('timeout', () => {
+      /* istanbul ignore else */
       if (ended === false) {
         ended = true
         this._openRequests--
@@ -97,6 +100,7 @@ class Connection {
 
     // handles request error
     request.on('error', err => {
+      /* istanbul ignore else */
       if (ended === false) {
         ended = true
         this._openRequests--
@@ -107,6 +111,7 @@ class Connection {
     // updates the ended state
     request.on('abort', () => {
       debug('Request aborted', params)
+      /* istanbul ignore else */
       if (ended === false) {
         ended = true
         this._openRequests--
@@ -121,7 +126,7 @@ class Connection {
     if (isStream(params.body) === true) {
       pump(params.body, request, err => {
         /* istanbul ignore if  */
-        if (err != null && ended === false) {
+        if (err != null && /* istanbul ignore next */ ended === false) {
           ended = true
           this._openRequests--
           callback(err, null)
@@ -300,6 +305,7 @@ function resolve (host, path) {
 
 function prepareHeaders (headers = {}, auth) {
   if (auth != null && headers.authorization == null) {
+    /* istanbul ignore else */
     if (auth.apiKey) {
       if (typeof auth.apiKey === 'object') {
         headers.authorization = 'ApiKey ' + Buffer.from(`${auth.apiKey.id}:${auth.apiKey.api_key}`).toString('base64')

package/lib/Helpers.d.ts

@@ -3,13 +3,14 @@
 // See the LICENSE file in the project root for more information
 
 import { Readable as ReadableStream } from 'stream'
-import { TransportRequestOptions, ApiResponse, RequestBody } from './Transport'
-import { Search, Bulk } from '../api/requestParams'
+import { TransportRequestOptions, ApiError, ApiResponse, RequestBody } from './Transport'
+import { Search, Msearch, Bulk } from '../api/requestParams'
 
 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 = unknown>(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>
 }
 
@@ -68,10 +69,11 @@ export interface BulkHelperOptions<TDocument = unknown> extends Omit<Bulk, 'body
   datasource: TDocument[] | Buffer | ReadableStream | AsyncIterator<TDocument>
   onDocument: (doc: TDocument) => Action
   flushBytes?: number
+  flushInterval?: number
   concurrency?: number
   retries?: number
-  wait?: number,
-  onDrop?: (doc: OnDropDocument<TDocument>) => void,
+  wait?: number
+  onDrop?: (doc: OnDropDocument<TDocument>) => void
   refreshOnCompletion?: boolean | string
 }
 
@@ -87,4 +89,19 @@ export interface OnDropDocument<TDocument = unknown> {
   }
   document: TDocument
   retried: boolean
-}
+}
+
+export interface MsearchHelperOptions extends Omit<Msearch, 'body'> {
+  operations?: number
+  flushInterval?: number
+  concurrency?: number
+  retries?: number
+  wait?: number
+}
+
+declare type callbackFn<Response, Context> = (err: ApiError, result: ApiResponse<Response, Context>) => void;
+export interface MsearchHelper extends Promise<void> {
+  stop(error?: Error): void
+  search<TResponse = Record<string, any>, TRequestBody extends  RequestBody = Record<string, any>, TContext = unknown>(header: Omit<Search, 'body'>, body: TRequestBody): Promise<ApiResponse<TResponse, TContext>>
+  search<TResponse = Record<string, any>, TRequestBody extends  RequestBody = Record<string, any>, TContext = unknown>(header: Omit<Search, 'body'>, body: TRequestBody, callback: callbackFn<TResponse, TContext>): void
+}