Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for passing iterable objects as headers #2708

Merged
merged 7 commits into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/core/request.js
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,18 @@ class Request {
processHeader(this, headers[i], headers[i + 1])
}
} else if (headers && typeof headers === 'object') {
const keys = Object.keys(headers)
for (let i = 0; i < keys.length; i++) {
const key = keys[i]
processHeader(this, key, headers[key])
if (headers[Symbol.iterator]) {
for (const header of headers) {
JaoodxD marked this conversation as resolved.
Show resolved Hide resolved
const key = header[0]
const value = header[1]
JaoodxD marked this conversation as resolved.
Show resolved Hide resolved
processHeader(this, key, value)
}
} else {
const keys = Object.keys(headers)
for (let i = 0; i < keys.length; i++) {
JaoodxD marked this conversation as resolved.
Show resolved Hide resolved
const key = keys[i]
processHeader(this, key, headers[key])
}
}
} else if (headers != null) {
throw new InvalidArgumentError('headers must be an object or an array')
Expand Down
100 changes: 100 additions & 0 deletions test/request.js
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,103 @@ test('DispatchOptions#reset', scope => {
})
})
})

test('Should include headers from iterable objects', scope => {
scope.plan(3)

scope.test('Should include headers built with Headers global object', async t => {
const server = createServer((req, res) => {
t.equal('GET', req.method)
t.equal(`localhost:${server.address().port}`, req.headers.host)
t.equal(req.headers.hello, 'world')
res.statusCode = 200
res.end('hello')
})

const headers = new Headers()
headers.set('hello', 'world')

t.plan(3)

t.teardown(server.close.bind(server))

await new Promise((resolve, reject) => {
server.listen(0, (err) => {
if (err != null) reject(err)
else resolve()
})
})

await request({
method: 'GET',
origin: `http://localhost:${server.address().port}`,
reset: true,
headers
})
})

scope.test('Should include headers built with Map', async t => {
const server = createServer((req, res) => {
t.equal('GET', req.method)
t.equal(`localhost:${server.address().port}`, req.headers.host)
t.equal(req.headers.hello, 'world')
res.statusCode = 200
res.end('hello')
})

const headers = new Map()
headers.set('hello', 'world')

t.plan(3)

t.teardown(server.close.bind(server))

await new Promise((resolve, reject) => {
server.listen(0, (err) => {
if (err != null) reject(err)
else resolve()
})
})

await request({
method: 'GET',
origin: `http://localhost:${server.address().port}`,
reset: true,
headers
})
})

scope.test('Should include headers built with custom iterable object', async t => {
const server = createServer((req, res) => {
t.equal('GET', req.method)
t.equal(`localhost:${server.address().port}`, req.headers.host)
t.equal(req.headers.hello, 'world')
res.statusCode = 200
res.end('hello')
})

const headers = {
* [Symbol.iterator] () {
yield ['hello', 'world']
}
}

t.plan(3)

t.teardown(server.close.bind(server))

await new Promise((resolve, reject) => {
server.listen(0, (err) => {
if (err != null) reject(err)
else resolve()
})
})

await request({
method: 'GET',
origin: `http://localhost:${server.address().port}`,
reset: true,
headers
})
})
})