Skip to content

Support for AbortController #380

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 2 commits into
base: master
Choose a base branch
from
+42 −34
Open

Support for AbortController #380

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c664fc9
Added support for AbortSignal for HttpClient
oliver-s-lee Nov 20, 2024
c83dbbb
Added support for abort signal for RestClient
oliver-s-lee Nov 20, 2024
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
41 changes: 21 additions & 20 deletions lib/HttpClient.ts
View file
Original file line number Diff line number Diff line change
@@ -202,50 +202,50 @@ export class HttpClient implements ifm.IHttpClient {
}
}

public options(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('OPTIONS', requestUrl, null, additionalHeaders || {});
public options(requestUrl: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('OPTIONS', requestUrl, null, additionalHeaders || {}, signal);
}

public get(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('GET', requestUrl, null, additionalHeaders || {});
public get(requestUrl: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('GET', requestUrl, null, additionalHeaders || {}, signal);
}

public del(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('DELETE', requestUrl, null, additionalHeaders || {});
public del(requestUrl: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('DELETE', requestUrl, null, additionalHeaders || {}, signal);
}

public post(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('POST', requestUrl, data, additionalHeaders || {});
public post(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('POST', requestUrl, data, additionalHeaders || {}, signal);
}

public patch(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('PATCH', requestUrl, data, additionalHeaders || {});
public patch(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('PATCH', requestUrl, data, additionalHeaders || {}, signal);
}

public put(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('PUT', requestUrl, data, additionalHeaders || {});
public put(requestUrl: string, data: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('PUT', requestUrl, data, additionalHeaders || {}, signal);
}

public head(requestUrl: string, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request('HEAD', requestUrl, null, additionalHeaders || {});
public head(requestUrl: string, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request('HEAD', requestUrl, null, additionalHeaders || {}, signal);
}

public sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
return this.request(verb, requestUrl, stream, additionalHeaders);
public sendStream(verb: string, requestUrl: string, stream: NodeJS.ReadableStream, additionalHeaders?: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
return this.request(verb, requestUrl, stream, additionalHeaders, signal);
}

/**
* Makes a raw http request.
* All other methods such as get, post, patch, and request ultimately call this.
* Prefer get, del, post and patch
*/
public async request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: ifm.IHeaders): Promise<ifm.IHttpClientResponse> {
public async request(verb: string, requestUrl: string, data: string | NodeJS.ReadableStream, headers: ifm.IHeaders, signal?: AbortSignal): Promise<ifm.IHttpClientResponse> {
if (this._disposed) {
throw new Error("Client has already been disposed.");
}

let parsedUrl = url.parse(requestUrl);
let info: RequestInfo = this._prepareRequest(verb, parsedUrl, headers);
let info: RequestInfo = this._prepareRequest(verb, parsedUrl, headers, signal);

// Only perform retries on reads since writes may not be idempotent.
let maxTries: number = (this._allowRetries && RetryableHttpVerbs.indexOf(verb) != -1) ? this._maxRetries + 1 : 1;
@@ -305,7 +305,7 @@ export class HttpClient implements ifm.IHttpClient {
await response.readBody();

// let's make the request with the new redirectUrl
info = this._prepareRequest(verb, parsedRedirectUrl, headers);
info = this._prepareRequest(verb, parsedRedirectUrl, headers, signal);
response = await this.requestRaw(info, data);
redirectsRemaining--;
}
@@ -416,7 +416,7 @@ export class HttpClient implements ifm.IHttpClient {
}
}

private _prepareRequest(method: string, requestUrl: url.Url, headers: ifm.IHeaders): ifm.IRequestInfo {
private _prepareRequest(method: string, requestUrl: url.Url, headers: ifm.IHeaders, signal?: AbortSignal): ifm.IRequestInfo {
const info: ifm.IRequestInfo = <ifm.IRequestInfo>{};

info.parsedUrl = requestUrl;
@@ -438,6 +438,7 @@ export class HttpClient implements ifm.IHttpClient {
}

info.options.agent = this._getAgent(info.parsedUrl);
info.options.signal = signal;

// gives handlers an opportunity to participate
if (this.handlers && !this._isPresigned(url.format(requestUrl))) {
35 changes: 21 additions & 14 deletions lib/RestClient.ts
View file
Original file line number Diff line number Diff line change
@@ -55,11 +55,12 @@ export class RestClient {
* @param {IRequestOptions} requestOptions - (optional) requestOptions object
*/
public async options<T>(requestUrl: string,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(requestUrl, this._baseUrl);
let res: httpm.HttpClientResponse = await this.client.options(url,
this._headersFromOptions(options));
this._headersFromOptions(options), signal);
return this.processResponse<T>(res, options);
}

@@ -70,11 +71,12 @@ export class RestClient {
* @param {IRequestOptions} requestOptions - (optional) requestOptions object
*/
public async get<T>(resource: string,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl, (options || {}).queryParameters);
let res: httpm.HttpClientResponse = await this.client.get(url,
this._headersFromOptions(options));
this._headersFromOptions(options), signal);
return this.processResponse<T>(res, options);
}

@@ -85,11 +87,12 @@ export class RestClient {
* @param {IRequestOptions} requestOptions - (optional) requestOptions object
*/
public async del<T>(resource: string,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl, (options || {}).queryParameters);
let res: httpm.HttpClientResponse = await this.client.del(url,
this._headersFromOptions(options));
this._headersFromOptions(options), signal);
return this.processResponse<T>(res, options);
}

@@ -102,13 +105,14 @@ export class RestClient {
*/
public async create<T>(resource: string,
resources: any,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let data: string = JSON.stringify(resources, null, 2);
let res: httpm.HttpClientResponse = await this.client.post(url, data, headers);
let res: httpm.HttpClientResponse = await this.client.post(url, data, headers, signal);
return this.processResponse<T>(res, options);
}

@@ -121,13 +125,14 @@ export class RestClient {
*/
public async update<T>(resource: string,
resources: any,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let data: string = JSON.stringify(resources, null, 2);
let res: httpm.HttpClientResponse = await this.client.patch(url, data, headers);
let res: httpm.HttpClientResponse = await this.client.patch(url, data, headers, signal);
return this.processResponse<T>(res, options);
}

@@ -140,25 +145,27 @@ export class RestClient {
*/
public async replace<T>(resource: string,
resources: any,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let data: string = JSON.stringify(resources, null, 2);
let res: httpm.HttpClientResponse = await this.client.put(url, data, headers);
let res: httpm.HttpClientResponse = await this.client.put(url, data, headers, signal);
return this.processResponse<T>(res, options);
}

public async uploadStream<T>(verb: string,
requestUrl: string,
stream: NodeJS.ReadableStream,
options?: IRequestOptions): Promise<IRestResponse<T>> {
options?: IRequestOptions,
signal?: AbortSignal): Promise<IRestResponse<T>> {

let url: string = util.getUrl(requestUrl, this._baseUrl);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let res: httpm.HttpClientResponse = await this.client.sendStream(verb, url, stream, headers);
let res: httpm.HttpClientResponse = await this.client.sendStream(verb, url, stream, headers, signal);
return this.processResponse<T>(res, options);
}