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: onConnect w/ controller #3028

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion lib/api/abort-signal.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,17 @@ const kSignal = Symbol('kSignal')
function abort (self) {
if (self.abort) {
self.abort(self[kSignal]?.reason)
} else if (self.controller?.abort) {
self.controller.abort(self[kSignal]?.reason)
} else {
self.onError(self[kSignal]?.reason ?? new RequestAbortedError())
self.reason = self[kSignal]?.reason ?? new RequestAbortedError()
}
removeSignal(self)
}

function addSignal (self, signal) {
self.reason = null

self[kSignal] = null
self[kListener] = null

Expand Down
10 changes: 7 additions & 3 deletions lib/api/api-connect.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
'use strict'

const assert = require('node:assert')
const { AsyncResource } = require('node:async_hooks')
const { InvalidArgumentError, RequestAbortedError, SocketError } = require('../core/errors')
const { InvalidArgumentError, SocketError } = require('../core/errors')
const util = require('../core/util')
const { addSignal, removeSignal } = require('./abort-signal')

Expand Down Expand Up @@ -32,10 +33,13 @@ class ConnectHandler extends AsyncResource {
}

onConnect (abort, context) {
if (!this.callback) {
throw new RequestAbortedError()
if (this.reason) {
abort(this.reason)
return
}

assert(this.callback)

this.abort = abort
this.context = context
}
Expand Down
10 changes: 6 additions & 4 deletions lib/api/api-pipeline.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,14 @@ class PipelineHandler extends AsyncResource {
onConnect (abort, context) {
const { ret, res } = this

assert(!res, 'pipeline cannot be retried')

if (ret.destroyed) {
throw new RequestAbortedError()
if (this.reason) {
abort(this.reason)
return
}

assert(!res, 'pipeline cannot be retried')
assert(!ret.destroyed)

this.abort = abort
this.context = context
}
Expand Down
23 changes: 15 additions & 8 deletions lib/api/api-request.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
'use strict'

const assert = require('node:assert')
const { Readable } = require('./readable')
const {
InvalidArgumentError,
RequestAbortedError
} = require('../core/errors')
const { InvalidArgumentError } = require('../core/errors')
const util = require('../core/util')
const { getResolveErrorBodyCallback } = require('./util')
const { AsyncResource } = require('node:async_hooks')
Expand Down Expand Up @@ -69,16 +67,19 @@ class RequestHandler extends AsyncResource {
}

onConnect (abort, context) {
if (!this.callback) {
throw new RequestAbortedError()
if (this.reason) {
abort(this.reason)
return
}

assert(this.callback)

this.abort = abort
this.context = context
}

onHeaders (statusCode, rawHeaders, resume, statusMessage) {
const { callback, opaque, abort, context, responseHeaders, highWaterMark } = this
const { callback, opaque, context, responseHeaders, highWaterMark } = this

const headers = responseHeaders === 'raw' ? util.parseRawHeaders(rawHeaders) : util.parseHeaders(rawHeaders)

Expand All @@ -92,7 +93,13 @@ class RequestHandler extends AsyncResource {
const parsedHeaders = responseHeaders === 'raw' ? util.parseHeaders(rawHeaders) : headers
const contentType = parsedHeaders['content-type']
const contentLength = parsedHeaders['content-length']
const body = new Readable({ resume, abort, contentType, contentLength, highWaterMark })
const body = new Readable({
resume,
abort: this.abort,
contentType,
contentLength,
highWaterMark
})

this.callback = null
this.res = body
Expand Down
11 changes: 7 additions & 4 deletions lib/api/api-stream.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
'use strict'

const assert = require('node:assert')
const { finished, PassThrough } = require('node:stream')
const {
InvalidArgumentError,
InvalidReturnValueError,
RequestAbortedError
InvalidReturnValueError
} = require('../core/errors')
const util = require('../core/util')
const { getResolveErrorBodyCallback } = require('./util')
Expand Down Expand Up @@ -70,10 +70,13 @@ class StreamHandler extends AsyncResource {
}

onConnect (abort, context) {
if (!this.callback) {
throw new RequestAbortedError()
if (this.reason) {
abort(this.reason)
return
}

assert(this.callback)

this.abort = abort
this.context = context
}
Expand Down
9 changes: 6 additions & 3 deletions lib/api/api-upgrade.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict'

const { InvalidArgumentError, RequestAbortedError, SocketError } = require('../core/errors')
const { InvalidArgumentError, SocketError } = require('../core/errors')
const { AsyncResource } = require('node:async_hooks')
const util = require('../core/util')
const { addSignal, removeSignal } = require('./abort-signal')
Expand Down Expand Up @@ -34,10 +34,13 @@ class UpgradeHandler extends AsyncResource {
}

onConnect (abort, context) {
if (!this.callback) {
throw new RequestAbortedError()
if (this.reason) {
abort(this.reason)
return
}

assert(this.callback)

this.abort = abort
this.context = null
}
Expand Down
80 changes: 61 additions & 19 deletions lib/core/request.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class Request {

this.method = method

this.abort = null
this.controller = null

if (body == null) {
this.body = null
Expand All @@ -105,8 +105,8 @@ class Request {
}

this.errorHandler = err => {
if (this.abort) {
this.abort(err)
if (this.controller) {
this.controller.abort(err)
} else {
this.error = err
}
Expand Down Expand Up @@ -196,7 +196,7 @@ class Request {
try {
return this[kHandler].onBodySent(chunk)
} catch (err) {
this.abort(err)
this.controller.abort(err)
}
}
}
Expand All @@ -210,59 +210,102 @@ class Request {
try {
return this[kHandler].onRequestSent()
} catch (err) {
this.abort(err)
this.controller.abort(err)
}
}
}

onConnect (abort) {
assert(abort)
assert(!this.aborted)
assert(!this.completed)

// TODO(fix): Hack for compatibility with the old API.
// Remove and use proper class with encapsulation in
// semver major.
this.controller = abort.controller = {
paused: false,
aborted: false,
_internal: null,
_abort: abort,
abort (err) {
this.aborted = true
this._abort(err)
},
pause () {
this.paused = true
this._internal?.pause?.()
},
resume () {
this.paused = false
this._internal?.resume?.()
}
}

// TODO (fix): This should be enabled. Needs some thinking
// in regards to pipeline retries.
// if (this.controller) {
// this.controller.abort()
// this.controller = null
// }

if (this.error) {
abort(this.error)
} else {
this.abort = abort
return this[kHandler].onConnect(abort)
this[kHandler].onConnect(abort)
}
}

onResponseStarted () {
return this[kHandler].onResponseStarted?.()
onStart () {
assert(!this.aborted)
assert(!this.completed)
assert(this.controller)

try {
this[kHandler].onResponseStarted?.()
} catch (err) {
this.controller.abort(err)
}
}

onHeaders (statusCode, headers, resume, statusText) {
onHeaders (statusCode, statusText, headers) {
assert(!this.aborted)
assert(!this.completed)
assert(this.controller)

if (channels.headers.hasSubscribers) {
channels.headers.publish({ request: this, response: { statusCode, headers, statusText } })
}

try {
return this[kHandler].onHeaders(statusCode, headers, resume, statusText)
if (this[kHandler].onHeaders?.(statusCode, headers, () => this.controller.resume(), statusText) === false) {
this.controller.pause()
}
} catch (err) {
this.abort(err)
this.controller.abort(err)
}
}

onData (chunk) {
assert(!this.aborted)
assert(!this.completed)
assert(this.controller)

try {
return this[kHandler].onData(chunk)
if (this[kHandler].onData?.(chunk) === false) {
this.controller.pause()
}
} catch (err) {
this.abort(err)
return false
this.controller.abort(err)
}
}

onUpgrade (statusCode, headers, socket) {
assert(!this.aborted)
assert(!this.completed)
assert(this.controller)

return this[kHandler].onUpgrade(statusCode, headers, socket)
this[kHandler].onUpgrade(statusCode, headers, socket)
}

onComplete (trailers) {
Expand All @@ -276,9 +319,8 @@ class Request {
}

try {
return this[kHandler].onComplete(trailers)
this[kHandler].onComplete(trailers)
} catch (err) {
// TODO (fix): This might be a bad idea?
this.onError(err)
}
}
Expand All @@ -295,7 +337,7 @@ class Request {
}
this.aborted = true

return this[kHandler].onError(error)
this[kHandler].onError(error)
}

onFinally () {
Expand Down
17 changes: 11 additions & 6 deletions lib/dispatcher/client-h1.js
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,12 @@ class Parser {
if (!request) {
return -1
}
request.onResponseStarted()

request.controller._internal = this

request.onStart()

return request.controller.paused ? constants.ERROR.PAUSED : 0
}

onHeaderField (buf) {
Expand Down Expand Up @@ -504,7 +509,7 @@ class Parser {
socket[kReset] = true
}

const pause = request.onHeaders(statusCode, headers, this.resume, statusText) === false
request.onHeaders(statusCode, statusText, headers)

if (request.aborted) {
return -1
Expand All @@ -523,7 +528,7 @@ class Parser {
client[kResume]()
}

return pause ? constants.ERROR.PAUSED : 0
return request.controller.paused ? constants.ERROR.PAUSED : 0
}

onBody (buf) {
Expand Down Expand Up @@ -553,9 +558,9 @@ class Parser {

this.bytesRead += buf.length

if (request.onData(buf) === false) {
return constants.ERROR.PAUSED
}
request.onData(buf)

return request.controller.paused ? constants.ERROR.PAUSED : 0
}

onMessageComplete () {
Expand Down
Loading
Loading