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

feat(Headers): spec-compliant fill & constructor #1502

Merged
merged 1 commit into from Jun 20, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
70 changes: 30 additions & 40 deletions lib/fetch/headers.js
Expand Up @@ -30,45 +30,30 @@ function headerValueNormalize (potentialValue) {
}

function fill (headers, object) {
// TODO: use idl converters once implemented
// To fill a Headers object headers with a given object object, run these steps:

if (object[Symbol.iterator]) {
// 1. If object is a sequence, then for each header in object:
// TODO: How to check if sequence?
for (let header of object) {
// 1. If object is a sequence, then for each header in object:
// Note: webidl conversion to array has already been done.
if (Array.isArray(object)) {
for (const header of object) {
// 1. If header does not contain exactly two items, then throw a TypeError.
if (!header[Symbol.iterator]) {
// TODO: Spec doesn't define what to do here?
throw new TypeError()
}

if (typeof header === 'string') {
// TODO: Spec doesn't define what to do here?
throw new TypeError()
}

if (!Array.isArray(header)) {
header = [...header]
}

if (header.length !== 2) {
throw new TypeError()
}

// 2. Append header’s first item/header’s second item to headers.
// 2. Append (header’s first item, header’s second item) to headers.
headers.append(header[0], header[1])
}
} else if (object && typeof object === 'object') {
// Otherwise, object is a record, then for each key → value in object,
// append key/value to headers.
// TODO: How to check if record?
for (const header of Object.entries(object)) {
headers.append(header[0], header[1])
} else if (typeof object === 'object' && object !== null) {
// Note: null should throw

// 2. Otherwise, object is a record, then for each key → value in object,
// append (key, value) to headers
for (const [key, value] of Object.entries(object)) {
headers.append(key, value)
}
} else {
// TODO: Spec doesn't define what to do here?
throw TypeError()
throw new TypeError()
}
}

Expand Down Expand Up @@ -173,17 +158,7 @@ class HeadersList {

// https://fetch.spec.whatwg.org/#headers-class
class Headers {
constructor (...args) {
if (
args[0] !== undefined &&
!(typeof args[0] === 'object' && args[0] != null) &&
!Array.isArray(args[0])
) {
throw new TypeError(
"Failed to construct 'Headers': The provided value is not of type '(record<ByteString, ByteString> or sequence<sequence<ByteString>>"
)
}
const init = args.length >= 1 ? args[0] ?? {} : {}
constructor (init = undefined) {
this[kHeadersList] = new HeadersList()

// The new Headers(init) constructor steps are:
Expand All @@ -192,7 +167,10 @@ class Headers {
this[kGuard] = 'none'

// 2. If init is given, then fill this with init.
fill(this, init)
if (init !== undefined) {
init = webidl.converters.HeadersInit(init)
fill(this, init)
}
}

get [Symbol.toStringTag] () {
Expand Down Expand Up @@ -461,6 +439,18 @@ Object.defineProperties(Headers.prototype, {
forEach: kEnumerableProperty
})

webidl.converters.HeadersInit = function (V) {
if (webidl.util.Type(V) === 'Object') {
if (V[Symbol.iterator]) {
return webidl.converters['sequence<sequence<ByteString>>'](V)
}

return webidl.converters['record<ByteString, ByteString>'](V)
}

throw new TypeError()
}

module.exports = {
fill,
Headers,
Expand Down
103 changes: 68 additions & 35 deletions lib/fetch/webidl.js
Expand Up @@ -154,9 +154,63 @@ webidl.util.IntegerPart = function (n) {
return r
}

// https://webidl.spec.whatwg.org/#es-sequence
webidl.sequenceConverter = function (converter) {
return (V) => {
return webidl.converters.sequence(V, converter)
// 1. If Type(V) is not Object, throw a TypeError.
if (webidl.util.Type(V) !== 'Object') {
throw new TypeError()
}

// 2. Let method be ? GetMethod(V, @@iterator).
/** @type {Generator} */
const method = V?.[Symbol.iterator]?.()
const seq = []

// 3. If method is undefined, throw a TypeError.
if (
method === undefined ||
typeof method.next !== 'function'
) {
throw new TypeError()
}

// https://webidl.spec.whatwg.org/#create-sequence-from-iterable
while (true) {
const { done, value } = method.next()

if (done) {
break
}

seq.push(converter(value))
}

return seq
}
}

webidl.recordConverter = function (keyConverter, valueConverter) {
return (V) => {
const record = {}
const type = webidl.util.Type(V)

if (type === 'Undefined' || type === 'Null') {
return record
}

if (type !== 'Object') {
throw new TypeError()
}

for (let [key, value] of Object.entries(V)) {
key = keyConverter(key)
value = valueConverter(value)

record[key] = value
}

return record
}
}

Expand Down Expand Up @@ -270,40 +324,6 @@ webidl.converters['long long'] = function (V, opts) {
return x
}

// https://webidl.spec.whatwg.org/#es-sequence
webidl.converters.sequence = function (V, converter) {
// 1. If Type(V) is not Object, throw a TypeError.
if (webidl.util.Type(V) !== 'Object') {
throw new TypeError()
}

// 2. Let method be ? GetMethod(V, @@iterator).
/** @type {Generator} */
const method = V[Symbol.iterator]?.()
const seq = []

// 3. If method is undefined, throw a TypeError.
if (
method === undefined ||
typeof method.next !== 'function'
) {
throw new TypeError()
}

// https://webidl.spec.whatwg.org/#create-sequence-from-iterable
while (true) {
const { done, value } = method.next()

if (done) {
break
}

seq.push(converter(value))
}

return seq
}

// https://webidl.spec.whatwg.org/#idl-ArrayBuffer
webidl.converters.ArrayBuffer = function (V, opts = {}) {
// 1. If Type(V) is not Object, or V does not have an
Expand Down Expand Up @@ -413,6 +433,19 @@ webidl.converters.BufferSource = function (V, opts = {}) {
throw new TypeError(`Could not convert ${V} to a BufferSource.`)
}

webidl.converters['sequence<ByteString>'] = webidl.sequenceConverter(
webidl.converters.ByteString
)

webidl.converters['sequence<sequence<ByteString>>'] = webidl.sequenceConverter(
webidl.converters['sequence<ByteString>']
)

webidl.converters['record<ByteString, ByteString>'] = webidl.recordConverter(
webidl.converters.ByteString,
webidl.converters.ByteString
)

module.exports = {
webidl
}
22 changes: 16 additions & 6 deletions test/fetch/headers.js
Expand Up @@ -5,7 +5,7 @@ const { Headers, fill } = require('../../lib/fetch/headers')
const { kGuard } = require('../../lib/fetch/symbols')

tap.test('Headers initialization', t => {
t.plan(7)
t.plan(8)

t.test('allows undefined', t => {
t.plan(1)
Expand Down Expand Up @@ -54,15 +54,25 @@ tap.test('Headers initialization', t => {
/* eslint-enable no-new-wrappers */
})

t.test('fails if function or primitive is passed', t => {
t.plan(4)
const expectedTypeError = TypeError("Failed to construct 'Headers': The provided value is not of type '(record<ByteString, ByteString> or sequence<sequence<ByteString>>")
t.throws(() => new Headers(Function), expectedTypeError)
t.throws(() => new Headers(function () {}), expectedTypeError)
t.test('fails if primitive is passed', t => {
t.plan(2)
const expectedTypeError = TypeError
t.throws(() => new Headers(1), expectedTypeError)
t.throws(() => new Headers('1'), expectedTypeError)
})

t.test('allows some weird stuff (because of webidl)', t => {
t.doesNotThrow(() => {
new Headers(function () {}) // eslint-disable-line no-new
})

t.doesNotThrow(() => {
new Headers(Function) // eslint-disable-line no-new
})

t.end()
})

t.test('allows a myriad of header values to be passed', t => {
t.plan(4)

Expand Down
34 changes: 21 additions & 13 deletions test/webidl/converters.js
Expand Up @@ -4,35 +4,43 @@ const { test } = require('tap')
const { webidl } = require('../../lib/fetch/webidl')

test('sequence', (t) => {
const converter = webidl.sequenceConverter(
webidl.converters.DOMString
)

t.same(converter([1, 2, 3]), ['1', '2', '3'])

t.throws(() => {
converter(3)
}, TypeError, 'disallows non-objects')

t.throws(() => {
webidl.converters.sequence(true)
converter(null)
}, TypeError)

t.throws(() => {
webidl.converters.sequence({})
converter(undefined)
}, TypeError)

t.throws(() => {
webidl.converters.sequence({
converter({})
}, TypeError, 'no Symbol.iterator')

t.throws(() => {
converter({
[Symbol.iterator]: 42
})
}, TypeError)
}, TypeError, 'invalid Symbol.iterator')

t.throws(() => {
webidl.converters.sequence({
converter(webidl.converters.sequence({
[Symbol.iterator] () {
return {
next: 'never!'
}
}
})
}, TypeError)

const converter = webidl.sequenceConverter(
webidl.converters.DOMString
)

t.same(converter([1, 2, 3]), ['1', '2', '3'])
}))
}, TypeError, 'invalid generator')

t.end()
})
Expand Down