habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Drop support for body param in helpers and tests (#2521)

Browse Source 
* Update tests and bulk helper to stop using body param

* Update compatible-with content-type header for 9.0
This commit is contained in:
Josh Mock
2024-12-05 13:03:19 -06:00
committed by GitHub
parent e9c2f8b0af
commit 6447fc10bf
4 changed files with 31 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/client.ts
View File

@ -383,9 +383,9 @@ export default class Client extends API {
maxResponseSize: options.maxResponseSize, maxResponseSize: options.maxResponseSize,
maxCompressedResponseSize: options.maxCompressedResponseSize, maxCompressedResponseSize: options.maxCompressedResponseSize,
vendoredHeaders: { vendoredHeaders: {
jsonContentType: 'application/vnd.elasticsearch+json; compatible-with=8', jsonContentType: 'application/vnd.elasticsearch+json; compatible-with=9',
ndjsonContentType: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', ndjsonContentType: 'application/vnd.elasticsearch+x-ndjson; compatible-with=9',
accept: 'application/vnd.elasticsearch+json; compatible-with=8,text/plain' accept: 'application/vnd.elasticsearch+json; compatible-with=9,text/plain'
}, },
redaction: options.redaction redaction: options.redaction
}) })

2
src/helpers.ts
View File

@ -910,7 +910,7 @@ export default class Helpers {
function tryBulk (bulkBody: string[], callback: (err: Error | null, bulkBody: string[]) => void): void { function tryBulk (bulkBody: string[], callback: (err: Error | null, bulkBody: string[]) => void): void {
if (shouldAbort) return callback(null, []) if (shouldAbort) return callback(null, [])
client.bulk(Object.assign({}, bulkOptions, { body: bulkBody }), reqOptions as TransportRequestOptionsWithMeta) client.bulk(Object.assign({}, bulkOptions, { operations: bulkBody }), reqOptions as TransportRequestOptionsWithMeta)
.then(response => { .then(response => {
const result = response.body const result = response.body
const results = zipBulkResults(result.items, bulkBody) const results = zipBulkResults(result.items, bulkBody)

123
test/unit/api.test.ts
View File

@ -22,7 +22,7 @@ import { connection } from '../utils'
import { Client } from '../..' import { Client } from '../..'
import * as T from '../../lib/api/types' import * as T from '../../lib/api/types'
test('Api without body key and top level body', async t => { test('Api with top level body', async t => {
t.plan(2) t.plan(2)
const Connection = connection.buildMockConnection({ const Connection = connection.buildMockConnection({
@ -50,37 +50,7 @@ test('Api without body key and top level body', async t => {
t.equal(response.took, 42) t.equal(response.took, 42)
}) })
test('Api with body key and top level body', async t => { test('Api with keyed body', async t => {
t.plan(2)
const Connection = connection.buildMockConnection({
onRequest (opts) {
// @ts-expect-error
t.same(JSON.parse(opts.body), { query: { match_all: {} } })
return {
statusCode: 200,
body: { took: 42 }
}
}
})
const client = new Client({
node: 'http://localhost:9200',
Connection
})
const response = await client.search({
index: 'test',
allow_no_indices: true,
body: {
query: { match_all: {} }
}
})
t.equal(response.took, 42)
})
test('Api without body key and keyed body', async t => {
t.plan(2) t.plan(2)
const Connection = connection.buildMockConnection({ const Connection = connection.buildMockConnection({
@ -108,95 +78,6 @@ test('Api without body key and keyed body', async t => {
t.equal(response.result, 'created') t.equal(response.result, 'created')
}) })
test('Api with body key and keyed body', async t => {
t.plan(2)
const Connection = connection.buildMockConnection({
onRequest (opts) {
// @ts-expect-error
t.same(JSON.parse(opts.body), { foo: 'bar' })
return {
statusCode: 200,
body: { result: 'created' }
}
}
})
const client = new Client({
node: 'http://localhost:9200',
Connection
})
const response = await client.create({
index: 'test',
id: '1',
body: { foo: 'bar' }
})
t.equal(response.result, 'created')
})
test('Using the body key should not mutate the body', async t => {
t.plan(2)
const Connection = connection.buildMockConnection({
onRequest (opts) {
// @ts-expect-error
t.same(JSON.parse(opts.body), { query: { match_all: {} }, sort: 'foo' })
return {
statusCode: 200,
body: { took: 42 }
}
}
})
const client = new Client({
node: 'http://localhost:9200',
Connection
})
const body = { query: { match_all: {} } }
await client.search({
index: 'test',
sort: 'foo',
body
})
t.same(body, { query: { match_all: {} } })
})
test('Using the body key with a string value', async t => {
t.plan(2)
const Connection = connection.buildMockConnection({
onRequest (opts) {
// @ts-expect-error
t.same(JSON.parse(opts.body), { query: { match_all: {} } })
return {
statusCode: 200,
body: { took: 42 }
}
}
})
const client = new Client({
node: 'http://localhost:9200',
Connection
})
try {
const body = { query: { match_all: {} } }
await client.search({
index: 'test',
// @ts-expect-error
body: JSON.stringify(body)
})
t.pass('ok!')
} catch (err: any) {
t.fail(err)
}
})
test('With generic document', async t => { test('With generic document', async t => {
t.plan(1) t.plan(1)

50
test/unit/helpers/bulk.test.ts
View File

@ -58,7 +58,7 @@ test('bulk index', t => {
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { t.match(params.headers, {
'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9',
'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp` 'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp`
}) })
// @ts-expect-error // @ts-expect-error
@ -104,7 +104,7 @@ test('bulk index', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
t.notMatch(params.headers, { t.notMatch(params.headers, {
'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp` 'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp`
}) })
@ -150,7 +150,7 @@ test('bulk index', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
t.equal(params.body.split('\n').filter(Boolean).length, 6) t.equal(params.body.split('\n').filter(Boolean).length, 6)
return { body: { errors: false, items: new Array(3).fill({}) } } return { body: { errors: false, items: new Array(3).fill({}) } }
@ -195,7 +195,7 @@ test('bulk index', t => {
return { body: { acknowledged: true } } return { body: { acknowledged: true } }
} else { } else {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test' } }) t.same(JSON.parse(action), { index: { _index: 'test' } })
@ -241,7 +241,7 @@ test('bulk index', t => {
return { body: { acknowledged: true } } return { body: { acknowledged: true } }
} else { } else {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test' } }) t.same(JSON.parse(action), { index: { _index: 'test' } })
@ -283,7 +283,7 @@ test('bulk index', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { index: { _index: 'test', _id: count } })
@ -328,7 +328,7 @@ test('bulk index', t => {
t.test('Should perform a bulk request (retry)', async t => { t.test('Should perform a bulk request (retry)', async t => {
async function handler (req: http.IncomingMessage, res: http.ServerResponse) { async function handler (req: http.IncomingMessage, res: http.ServerResponse) {
t.equal(req.url, '/_bulk') t.equal(req.url, '/_bulk')
t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
let body = '' let body = ''
req.setEncoding('utf8') req.setEncoding('utf8')
@ -446,7 +446,7 @@ test('bulk index', t => {
t.test('Should perform a bulk request (failure)', async t => { t.test('Should perform a bulk request (failure)', async t => {
async function handler (req: http.IncomingMessage, res: http.ServerResponse) { async function handler (req: http.IncomingMessage, res: http.ServerResponse) {
t.equal(req.url, '/_bulk') t.equal(req.url, '/_bulk')
t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
let body = '' let body = ''
req.setEncoding('utf8') req.setEncoding('utf8')
@ -587,7 +587,7 @@ test('bulk index', t => {
t.test('Should abort a bulk request', async t => { t.test('Should abort a bulk request', async t => {
async function handler (req: http.IncomingMessage, res: http.ServerResponse) { async function handler (req: http.IncomingMessage, res: http.ServerResponse) {
t.equal(req.url, '/_bulk') t.equal(req.url, '/_bulk')
t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
let body = '' let body = ''
req.setEncoding('utf8') req.setEncoding('utf8')
@ -724,7 +724,7 @@ test('bulk index', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { index: { _index: 'test', _id: count } })
@ -815,7 +815,7 @@ test('bulk index', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test' } }) t.same(JSON.parse(action), { index: { _index: 'test' } })
@ -914,7 +914,7 @@ test('bulk index', t => {
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { t.match(params.headers, {
'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9',
'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp` 'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp`
}) })
// @ts-expect-error // @ts-expect-error
@ -969,7 +969,7 @@ test('bulk create', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { create: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { create: { _index: 'test', _id: count } })
@ -1017,7 +1017,7 @@ test('bulk create', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { create: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { create: { _index: 'test', _id: count } })
@ -1073,7 +1073,7 @@ test('bulk update', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { update: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { update: { _index: 'test', _id: count } })
@ -1122,7 +1122,7 @@ test('bulk update', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { update: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { update: { _index: 'test', _id: count } })
@ -1169,7 +1169,7 @@ test('bulk update', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { update: { _index: 'test', _id: count } }) t.same(JSON.parse(action), { update: { _index: 'test', _id: count } })
@ -1223,7 +1223,7 @@ test('bulk delete', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
t.same(JSON.parse(params.body), { delete: { _index: 'test', _id: count++ } }) t.same(JSON.parse(params.body), { delete: { _index: 'test', _id: count++ } })
return { body: { errors: false, items: [{}] } } return { body: { errors: false, items: [{}] } }
@ -1266,7 +1266,7 @@ test('bulk delete', t => {
t.test('Should perform a bulk request (failure)', async t => { t.test('Should perform a bulk request (failure)', async t => {
async function handler (req: http.IncomingMessage, res: http.ServerResponse) { async function handler (req: http.IncomingMessage, res: http.ServerResponse) {
t.equal(req.url, '/_bulk') t.equal(req.url, '/_bulk')
t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(req.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
let body = '' let body = ''
req.setEncoding('utf8') req.setEncoding('utf8')
@ -1469,7 +1469,7 @@ test('transport options', t => {
if (params.path === '/_bulk') { if (params.path === '/_bulk') {
t.match(params.headers, { t.match(params.headers, {
'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9',
foo: 'bar' foo: 'bar'
}) })
return { body: { errors: false, items: [{}] } } return { body: { errors: false, items: [{}] } }
@ -1618,7 +1618,7 @@ test('Flush interval', t => {
const MockConnection = connection.buildMockConnection({ const MockConnection = connection.buildMockConnection({
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test' } }) t.same(JSON.parse(action), { index: { _index: 'test' } })
@ -1671,7 +1671,7 @@ test('Flush interval', t => {
onRequest (params) { onRequest (params) {
t.ok(count < 2) t.ok(count < 2)
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' }) t.match(params.headers, { 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' })
// @ts-expect-error // @ts-expect-error
const [action, payload] = params.body.split('\n') const [action, payload] = params.body.split('\n')
t.same(JSON.parse(action), { index: { _index: 'test' } }) t.same(JSON.parse(action), { index: { _index: 'test' } })
@ -1730,7 +1730,7 @@ test('Flush interval', t => {
onRequest (params) { onRequest (params) {
t.equal(params.path, '/_bulk') t.equal(params.path, '/_bulk')
t.match(params.headers, { t.match(params.headers, {
'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', 'content-type': 'application/vnd.elasticsearch+x-ndjson; compatible-with=9',
'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp` 'x-elastic-client-meta': `es=${clientVersion},js=${nodeVersion},t=${transportVersion},hc=${nodeVersion},h=bp`
}) })
// @ts-expect-error // @ts-expect-error
@ -1749,12 +1749,12 @@ test('Flush interval', t => {
datasource: dataset.slice(), datasource: dataset.slice(),
flushBytes: 1, flushBytes: 1,
concurrency: 1, concurrency: 1,
onDocument (doc) { onDocument (_doc) {
return { return {
index: { _index: 'test' } index: { _index: 'test' }
} }
}, },
onDrop (doc) { onDrop (_doc) {
t.fail('This should never be called') t.fail('This should never be called')
} }
}) })