Skip to content

Add support for AbortSignal to enable request cancellation #33

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for AbortSignal to enable request cancellation #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/client-browser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import { Request } from './request'

export function sendXmlHttpRequest(path, method, headers, body, encoding, timeout, withCredentials) {
export function sendXmlHttpRequest(path, method, headers, body, encoding, timeout, withCredentials, abortSignal) {
return new Promise(function sendRequest(resolve, reject) {
let request = new Request.XMLHttpRequest()

request.signal = abortSignal
request.timeout = timeout

if (!encoding) {
Expand Down
9 changes: 5 additions & 4 deletions src/client-node.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
import { isFormData, isStream, normalizeTrailingSlashInPath } from './utils'

export function sendNodeAPIRequest(path, method, headers, body, encoding, timeout, withCredentials) {
export function sendNodeAPIRequest(path, method, headers, body, encoding, timeout, withCredentials, abortSignal) {
return new Promise((resolve, reject) => {
const u = require('url').parse(path)
const form = isFormData(body) && body

const https = u.protocol === 'https:'
const options = {
host: u.hostname,
port: u.port || (https ? 443 : 80),
path: normalizeTrailingSlashInPath(path, u) + (u.search || ''),
signal: abortSignal,
host : u.hostname,
port : u.port || (https ? 443 : 80),
path : normalizeTrailingSlashInPath(path, u) + (u.search || ''),
method,
headers,
timeout,
Expand Down
4 changes: 2 additions & 2 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Object.defineProperty(Request, 'FormData', {

Request.XMLHttpRequest = typeof XMLHttpRequest !== 'undefined' ? XMLHttpRequest : undefined

Request.send = (path, method, headers, body, encoding, timeout, withCredentials) => {
Request.send = (path, method, headers, body, encoding, timeout, withCredentials, abortSignal) => {
const sender = typeof Request.XMLHttpRequest !== 'undefined'
? sendXmlHttpRequest
: sendNodeAPIRequest

return sender(path, method, headers, body, encoding, timeout, withCredentials)
return sender(path, method, headers, body, encoding, timeout, withCredentials, abortSignal)
}

Request.verbose = false
Expand Down
15 changes: 14 additions & 1 deletion src/request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export class Request extends EventEmitter {
this.encoding = 'utf8'
this.timeout = 0
this.withCredentials = null
this.abortSignal = null
}

/**
Expand Down Expand Up @@ -185,6 +186,17 @@ export class Request extends EventEmitter {
return this
}

/**
* Sets abort signal
* @param abortSignal
* @returns {Request}
*/
setAbortSignal(abortSignal) {
this.abortSignal = abortSignal

return this
}

/**
* Sends the request
*
Expand Down Expand Up @@ -264,7 +276,8 @@ export class Request extends EventEmitter {
body,
this.encoding,
this.timeout,
withCredentials
withCredentials,
this.abortSignal,
)
.then(parseBody)
.then(checkStatus)
Expand Down
104 changes: 78 additions & 26 deletions tests/specs/node-client.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ describe('Node Client', () => {
'port' : '9898',
'timeout' : 0,
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -57,7 +58,8 @@ describe('Node Client', () => {
'path' : 'foo.bar/path/to/api',
'port' : 80,
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -75,7 +77,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : 80,
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -93,7 +96,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : 443,
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -113,7 +117,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -131,7 +136,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand Down Expand Up @@ -266,7 +272,8 @@ describe('Node Client', () => {
'path' : '/v1/documents/10psXGc-EW3vkeGXP0qG3v66Q-uo:batchUpdate',
'port' : 443,
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand Down Expand Up @@ -301,7 +308,8 @@ describe('Node Client', () => {
'path' : '/path/to/api?str=str&num1=0&num2=123&bool1=true&bool2=false',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -320,7 +328,8 @@ describe('Node Client', () => {
'path' : '/path/to/api?numArr=1&numArr=2&numArr=3&strArr=a&strArr=b&strArr=c',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -339,7 +348,8 @@ describe('Node Client', () => {
'path' : '/path/to/api?str=%D0%B0%D0%B1%D0%B2&space=%20&percent=%25&at=%40&strArr=%D0%B0%D0%B1%D0%B2&strArr=%20&strArr=%25&strArr=%40',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})
})
Expand All @@ -361,7 +371,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})
})
Expand All @@ -382,7 +393,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -403,7 +415,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})

expect(transaction2.requestBody).toEqual('[1,2,3]')
Expand All @@ -416,7 +429,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -436,7 +450,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})

})
Expand Down Expand Up @@ -488,7 +503,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -511,7 +527,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand Down Expand Up @@ -540,7 +557,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})
})
Expand All @@ -559,7 +577,33 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 1200,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})
})

describe('Request Abort Signal', () => {
it('runs a request with abort signal', async () => {
const transaction = registerNodeTransaction()

const abortController = new AbortController()

await Request.get('http://foo.bar:9898/path/to/api')
.setAbortSignal(abortController.signal)

const { signal, ...restOptions } = transaction.options

expect(signal).toBe(abortController.signal)

expect(restOptions).toEqual({
'headers' : {},
'host' : 'foo.bar',
'method' : 'GET',
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false,
})
})
})
Expand All @@ -577,7 +621,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -596,7 +641,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -615,7 +661,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})

Expand All @@ -634,7 +681,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})
})
})
Expand Down Expand Up @@ -758,7 +806,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})

})
Expand All @@ -781,7 +830,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})

})
Expand All @@ -805,7 +855,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})

})
Expand Down Expand Up @@ -838,7 +889,8 @@ describe('Node Client', () => {
'path' : '/path/to/api',
'port' : '9898',
'timeout' : 0,
'withCredentials': false
'withCredentials': false,
'signal' : null,
})

})
Expand Down