@elastic/elasticsearch 7.14.0 → 7.17.0

package/lib/Transport.js

@@ -36,13 +36,15 @@ const {
 
 const noop = () => {}
 
-const productCheckEmitter = new EventEmitter()
 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')
+const kMaxResponseSize = Symbol('max response size')
+const kMaxCompressedResponseSize = Symbol('max compressed response size')
 
 class Transport {
   constructor (opts) {
@@ -71,6 +73,9 @@ class Transport {
     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[kMaxResponseSize] = opts.maxResponseSize || MAX_STRING_LENGTH
+    this[kMaxCompressedResponseSize] = opts.maxCompressedResponseSize || MAX_BUFFER_LENGTH
 
     this.nodeFilter = opts.nodeFilter || defaultNodeFilter
     if (typeof opts.nodeSelector === 'function') {
@@ -161,13 +166,19 @@ class Transport {
       ? 0
       : (typeof options.maxRetries === 'number' ? options.maxRetries : this.maxRetries)
     const compression = options.compression !== undefined ? options.compression : this.compression
+    const maxResponseSize = options.maxResponseSize || this[kMaxResponseSize]
+    const maxCompressedResponseSize = options.maxCompressedResponseSize || this[kMaxCompressedResponseSize]
     let request = { abort: noop }
     const transportReturn = {
       then (onFulfilled, onRejected) {
-        return p.then(onFulfilled, onRejected)
+        if (p != null) {
+          return p.then(onFulfilled, onRejected)
+        }
       },
       catch (onRejected) {
-        return p.catch(onRejected)
+        if (p != null) {
+          return p.catch(onRejected)
+        }
       },
       abort () {
         meta.aborted = true
@@ -176,12 +187,15 @@ class Transport {
         return this
       },
       finally (onFinally) {
-        return p.finally(onFinally)
+        if (p != null) {
+          return p.finally(onFinally)
+        }
       }
     }
 
     const makeRequest = () => {
       if (meta.aborted === true) {
+        this.emit('request', new RequestAbortedError(), result)
         return process.nextTick(callback, new RequestAbortedError(), result)
       }
       meta.connection = this.getConnection({ requestId: meta.request.id })
@@ -237,26 +251,28 @@ class Transport {
 
       const contentEncoding = (result.headers['content-encoding'] || '').toLowerCase()
       const isCompressed = contentEncoding.indexOf('gzip') > -1 || contentEncoding.indexOf('deflate') > -1
+      const isVectorTile = (result.headers['content-type'] || '').indexOf('application/vnd.mapbox-vector-tile') > -1
 
       /* istanbul ignore else */
       if (result.headers['content-length'] !== undefined) {
         const contentLength = Number(result.headers['content-length'])
-        if (isCompressed && contentLength > MAX_BUFFER_LENGTH) {
+        if (isCompressed && contentLength > maxCompressedResponseSize) {
           response.destroy()
           return onConnectionError(
-            new RequestAbortedError(`The content length (${contentLength}) is bigger than the maximum allowed buffer (${MAX_BUFFER_LENGTH})`, result)
+            new RequestAbortedError(`The content length (${contentLength}) is bigger than the maximum allowed buffer (${maxCompressedResponseSize})`, result)
           )
-        } else if (contentLength > MAX_STRING_LENGTH) {
+        } else if (contentLength > maxResponseSize) {
           response.destroy()
           return onConnectionError(
-            new RequestAbortedError(`The content length (${contentLength}) is bigger than the maximum allowed string (${MAX_STRING_LENGTH})`, result)
+            new RequestAbortedError(`The content length (${contentLength}) is bigger than the maximum allowed string (${maxResponseSize})`, result)
           )
         }
       }
       // if the response is compressed, we must handle it
       // as buffer for allowing decompression later
-      let payload = isCompressed ? [] : ''
-      const onData = isCompressed
+      // while if it's a vector tile, we should return it as buffer
+      let payload = isCompressed || isVectorTile ? [] : ''
+      const onData = isCompressed || isVectorTile
         ? chunk => { payload.push(chunk) }
         : chunk => { payload += chunk }
       const onEnd = err => {
@@ -272,7 +288,7 @@ class Transport {
         if (isCompressed) {
           unzip(Buffer.concat(payload), onBody)
         } else {
-          onBody(null, payload)
+          onBody(null, isVectorTile ? Buffer.concat(payload) : payload)
         }
       }
 
@@ -281,7 +297,7 @@ class Transport {
         onEnd(new Error('Response aborted while reading the body'))
       }
 
-      if (!isCompressed) {
+      if (!isCompressed && !isVectorTile) {
         response.setEncoding('utf8')
       }
 
@@ -297,7 +313,9 @@ class Transport {
         this.emit('response', err, result)
         return callback(err, result)
       }
-      if (Buffer.isBuffer(payload)) {
+
+      const isVectorTile = (result.headers['content-type'] || '').indexOf('application/vnd.mapbox-vector-tile') > -1
+      if (Buffer.isBuffer(payload) && !isVectorTile) {
         payload = payload.toString()
       }
       const isHead = params.method === 'HEAD'
@@ -416,8 +434,6 @@ class Transport {
       // 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) {
@@ -448,6 +464,8 @@ class Transport {
       }
     }
 
+    meta.request.params = params
+    meta.request.options = options
     // still need to check the product or waiting for the check to finish
     if (this[kProductCheck] === 0 || this[kProductCheck] === 1) {
       // let pass info requests
@@ -455,7 +473,7 @@ class Transport {
         prepareRequest()
       } else {
         // wait for product check to finish
-        productCheckEmitter.once('product-check', (error, status) => {
+        this[kEventEmitter].once('product-check', (error, status) => {
           if (status === false) {
             const err = error || new ProductNotSupportedError(result)
             if (this[kProductCheck] === 4) {
@@ -555,49 +573,52 @@ class Transport {
         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.')
-          productCheckEmitter.emit('product-check', null, true)
+          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.',
+            'ProductNotSupportedSecurityError'
+          )
+          this[kEventEmitter].emit('product-check', null, true)
         } else {
           this[kProductCheck] = 0
-          productCheckEmitter.emit('product-check', err, false)
+          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 productCheckEmitter.emit('product-check', null, false)
+          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 productCheckEmitter.emit('product-check', null, false)
+          return this[kEventEmitter].emit('product-check', null, false)
         } else if (major >= 6 && major < 7) {
           if (tagline !== 'You Know, for Search') {
             debug('Bad tagline')
-            return productCheckEmitter.emit('product-check', null, false)
+            return this[kEventEmitter].emit('product-check', null, false)
           }
         } else if (major === 7 && minor < 14) {
           if (tagline !== 'You Know, for Search') {
             debug('Bad tagline')
-            return productCheckEmitter.emit('product-check', null, false)
+            return this[kEventEmitter].emit('product-check', null, false)
           }
 
           if (result.body.version.build_flavor !== 'default') {
             debug('Bad build_flavor')
             this[kProductCheck] = 4
-            return productCheckEmitter.emit('product-check', null, false)
+            return this[kEventEmitter].emit('product-check', null, false)
           }
         } else {
           if (result.headers['x-elastic-product'] !== 'Elasticsearch') {
             debug('x-elastic-product not recognized')
-            return productCheckEmitter.emit('product-check', null, false)
+            return this[kEventEmitter].emit('product-check', null, false)
           }
         }
         debug('Valid Elasticsearch distribution')
         this[kProductCheck] = 2
-        productCheckEmitter.emit('product-check', null, true)
+        this[kEventEmitter].emit('product-check', null, true)
       }
     })
   }

package/lib/errors.js

@@ -97,8 +97,10 @@ class ResponseError extends ElasticsearchClientError {
       } else {
         this.message = meta.body.error.type
       }
+    } else if (typeof meta.body === 'object' && meta.body != null) {
+      this.message = JSON.stringify(meta.body)
     } else {
-      this.message = 'Response Error'
+      this.message = meta.body || 'Response Error'
     }
     this.meta = meta
   }

package/lib/pool/BaseConnectionPool.js

@@ -36,6 +36,7 @@ class BaseConnectionPool {
     this._ssl = opts.ssl
     this._agent = opts.agent
     this._proxy = opts.proxy || null
+    this._caFingerprint = opts.caFingerprint || null
   }
 
   getConnection () {
@@ -72,6 +73,8 @@ class BaseConnectionPool {
     if (opts.agent == null) opts.agent = this._agent
     /* istanbul ignore else */
     if (opts.proxy == null) opts.proxy = this._proxy
+    /* istanbul ignore else */
+    if (opts.caFingerprint == null) opts.caFingerprint = this._caFingerprint
 
     const connection = new this.Connection(opts)
 

package/lib/pool/index.d.ts

@@ -31,6 +31,7 @@ interface BaseConnectionPoolOptions {
   auth?: BasicAuth | ApiKeyAuth;
   emit: (event: string | symbol, ...args: any[]) => boolean;
   Connection: typeof Connection;
+  caFingerprint?: string;
 }
 
 interface ConnectionPoolOptions extends BaseConnectionPoolOptions {

package/package.json

@@ -8,11 +8,11 @@
       "require": "./index.js",
       "import": "./index.mjs"
     },
-    "./": "./"
+    "./*": "./*.js"
   },
   "homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html",
-  "version": "7.14.0",
-  "versionCanary": "7.14.0-canary.7",
+  "version": "7.17.0",
+  "versionCanary": "7.16.0-canary.7",
   "keywords": [
     "elasticsearch",
     "elastic",
@@ -100,6 +100,7 @@
     "jsx": false,
     "flow": false,
     "coverage": false,
-    "jobs-auto": true
+    "jobs-auto": true,
+    "check-coverage": false
   }
 }

package/free-report-junit.xml

@@ -1,123 +0,0 @@
-<?xml version="1.0"?>
-<testsuites id="2021-04-02T14:09:24.358Z" name="Integration test for Free api" time="13" tests="35" failures="1" skipped="7">
-  <testsuite id="2021-04-02T14:09:24.431Z" name="free/bulk - /free/bulk/10_basic.yml" time="4" tests="7" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:24.431Z" name="Array of objects" time="1"/>
-    <testcase id="2021-04-02T14:09:25.235Z" name="Empty _id" time="0"/>
-    <testcase id="2021-04-02T14:09:25.622Z" name="Empty _id with op_type create" time="0"/>
-    <testcase id="2021-04-02T14:09:26.027Z" name="empty action" time="0"/>
-    <testcase id="2021-04-02T14:09:26.218Z" name="When setting require_alias flag per request" time="1"/>
-    <testcase id="2021-04-02T14:09:26.850Z" name="When setting require_alias flag" time="1"/>
-    <testcase id="2021-04-02T14:09:27.424Z" name="Return item-level error when no write index defined for an alias" time="1"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:27.976Z" name="free/bulk - /free/bulk/20_list_of_strings.yml" time="1" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:27.976Z" name="List of strings" time="1"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:28.725Z" name="free/bulk - /free/bulk/30_big_string.yml" time="0" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:28.725Z" name="One big string" time="0"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:29.217Z" name="free/bulk - /free/bulk/40_source.yml" time="1" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:29.217Z" name="Source filtering" time="1"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:30.150Z" name="free/bulk - /free/bulk/50_refresh.yml" time="2" tests="3" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:30.150Z" name="refresh=true immediately makes changes are visible in search" time="0"/>
-    <testcase id="2021-04-02T14:09:30.399Z" name="refresh=empty string immediately makes changes are visible in search" time="0"/>
-    <testcase id="2021-04-02T14:09:30.692Z" name="refresh=wait_for waits until changes are visible in search" time="1"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:31.890Z" name="free/bulk - /free/bulk/60_deprecated.yml" time="0" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:31.890Z" name="Deprecated parameters should fail in Bulk query" time="0"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:32.018Z" name="free/bulk - /free/bulk/80_cas.yml" time="0" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:32.018Z" name="Compare And Swap Sequence Numbers" time="0"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:32.344Z" name="free/bulk - /free/bulk/90_pipeline.yml" time="1" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:32.344Z" name="One request has pipeline and another not" time="1"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:32.958Z" name="free/cat.aliases - /free/cat.aliases/10_basic.yml" time="3" tests="15" failures="0" skipped="6">
-    <testcase id="2021-04-02T14:09:32.958Z" name="Help" time="0"/>
-    <testcase id="2021-04-02T14:09:33.172Z" name="Help (pre 7.4.0)" time="0">
-      <skipped>{
-  "version": "7.4.0 - ",
-  "features": "node_selector",
-  "reason": "is_write_index is shown in cat.aliases starting version 7.4.0"
-}</skipped>
-    </testcase>
-    <testcase id="2021-04-02T14:09:33.301Z" name="Empty cluster" time="0"/>
-    <testcase id="2021-04-02T14:09:33.434Z" name="Simple alias" time="0"/>
-    <testcase id="2021-04-02T14:09:33.710Z" name="Simple alias (pre 7.4.0)" time="0">
-      <skipped>{
-  "version": "7.4.0 - ",
-  "features": "node_selector",
-  "reason": "is_write_index is shown in cat.aliases starting version 7.4.0"
-}</skipped>
-    </testcase>
-    <testcase id="2021-04-02T14:09:33.848Z" name="Complex alias" time="0"/>
-    <testcase id="2021-04-02T14:09:34.172Z" name="Complex alias (pre 7.4.0)" time="0">
-      <skipped>{
-  "version": "7.4.0 - ",
-  "features": "node_selector",
-  "reason": "is_write_index is shown in cat.aliases starting version 7.4.0"
-}</skipped>
-    </testcase>
-    <testcase id="2021-04-02T14:09:34.303Z" name="Alias name" time="0"/>
-    <testcase id="2021-04-02T14:09:34.573Z" name="Multiple alias names" time="1"/>
-    <testcase id="2021-04-02T14:09:35.169Z" name="Column headers" time="0"/>
-    <testcase id="2021-04-02T14:09:35.450Z" name="Column headers (pre 7.4.0)" time="0">
-      <skipped>{
-  "version": "7.4.0 - ",
-  "features": "node_selector",
-  "reason": "is_write_index is shown in cat.aliases starting version 7.4.0"
-}</skipped>
-    </testcase>
-    <testcase id="2021-04-02T14:09:35.577Z" name="Select columns" time="0"/>
-    <testcase id="2021-04-02T14:09:35.814Z" name="Alias against closed index" time="0">
-      <skipped>{
-  "version": " - 7.3.99",
-  "reason": "is_write_index is shown in cat.aliases starting version 7.4.0",
-  "features": [
-    "allowed_warnings"
-  ]
-}</skipped>
-    </testcase>
-    <testcase id="2021-04-02T14:09:35.941Z" name="Alias against closed index (pre 7.4.0)" time="0">
-      <skipped>{
-  "version": "7.4.0 - ",
-  "features": [
-    "node_selector",
-    "allowed_warnings"
-  ],
-  "reason": "is_write_index is shown in cat.aliases starting version 7.4.0"
-}</skipped>
-    </testcase>
-    <testcase id="2021-04-02T14:09:36.058Z" name="Alias sorting" time="0"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:36.361Z" name="free/cat.aliases - /free/cat.aliases/20_headers.yml" time="0" tests="1" failures="0" skipped="1">
-    <testcase id="2021-04-02T14:09:36.361Z" name="Simple alias with yaml body through Accept header" time="0">
-      <skipped>{
-  "features": [
-    "headers",
-    "yaml"
-  ]
-}</skipped>
-    </testcase>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:36.487Z" name="free/cat.aliases - /free/cat.aliases/30_json.yml" time="0" tests="1" failures="0" skipped="0">
-    <testcase id="2021-04-02T14:09:36.487Z" name="Simple alias with json body through format argument" time="0"/>
-  </testsuite>
-  <testsuite id="2021-04-02T14:09:36.725Z" name="free/cat.aliases - /free/cat.aliases/40_hidden.yml" time="0" tests="2" failures="1" skipped="0">
-    <testcase id="2021-04-02T14:09:36.725Z" name="Test cat aliases output with a hidden index with a hidden alias" time="0"/>
-    <testcase id="2021-04-02T14:09:36.909Z" name="Test cat aliases output with a hidden index with a visible alias" time="0">
-      <failure message="ifError got unwanted exception: resource_already_exists_exception" type="ERR_ASSERTION">AssertionError [ERR_ASSERTION]: ifError got unwanted exception: resource_already_exists_exception
-    at doAction (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/test-runner.js:425:14)
-    at runMicrotasks (&lt;anonymous&gt;)
-    at processTicksAndRejections (internal/process/task_queues.js:93:5)
-    at async exec (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/test-runner.js:448:9)
-    at async Object.run (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/test-runner.js:220:5)
-    at async start (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/index.js:262:11)
-    at onBody (/Users/delvedor/Development/elastic/elasticsearch-js/lib/Transport.js:337:23)
-    at IncomingMessage.onEnd (/Users/delvedor/Development/elastic/elasticsearch-js/lib/Transport.js:264:11)
-    at IncomingMessage.emit (events.js:327:22)
-    at endReadableNT (_stream_readable.js:1327:12)
-    at processTicksAndRejections (internal/process/task_queues.js:80:21)</failure>
-    </testcase>
-  </testsuite>
-</testsuites>

package/platinum-report-junit.xml

@@ -1,18 +0,0 @@
-<?xml version="1.0"?>
-<testsuites id="2021-02-08T18:24:44.902Z" name="Integration test for Platinum api" time="7" tests="1" failures="1" skipped="0">
-  <testsuite id="2021-02-08T18:24:44.958Z" name="text_structure - /text_structure/find_structure.yml" time="7" tests="1" failures="1" skipped="0">
-    <testcase id="2021-02-08T18:24:44.959Z" name="Test NDJSON file structure analysis without overrides" time="7">
-      <failure message="ifError got unwanted exception: illegal_argument_exception" type="ERR_ASSERTION">AssertionError [ERR_ASSERTION]: ifError got unwanted exception: illegal_argument_exception
-    at doAction (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/test-runner.js:428:14)
-    at processTicksAndRejections (internal/process/task_queues.js:93:5)
-    at async exec (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/test-runner.js:451:9)
-    at async Object.run (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/test-runner.js:225:5)
-    at async start (/Users/delvedor/Development/elastic/elasticsearch-js/test/integration/index.js:252:11)
-    at onBody (/Users/delvedor/Development/elastic/elasticsearch-js/lib/Transport.js:333:23)
-    at IncomingMessage.onEnd (/Users/delvedor/Development/elastic/elasticsearch-js/lib/Transport.js:260:11)
-    at IncomingMessage.emit (events.js:327:22)
-    at endReadableNT (_stream_readable.js:1327:12)
-    at processTicksAndRejections (internal/process/task_queues.js:80:21)</failure>
-    </testcase>
-  </testsuite>
-</testsuites>