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

fix(ajax): Handle timeouts as errors #3653

Merged
merged 2 commits into from
May 21, 2018
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 49 additions & 26 deletions spec/observables/dom/ajax-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ import { expect } from 'chai';
import * as sinon from 'sinon';
import * as Rx from 'rxjs/Rx';
import { root } from 'rxjs/util/root';
import { TestScheduler } from 'rxjs/testing';

declare const global: any;
declare const rxTestScheduler: TestScheduler;

/** @test {ajax} */
describe('Observable.ajax', () => {
Expand Down Expand Up @@ -380,6 +382,39 @@ describe('Observable.ajax', () => {
});
});

it('should error on timeout of asynchronous request', () => {
const obj: Rx.AjaxRequest = {
url: '/flibbertyJibbet',
responseType: 'text',
timeout: 10
};

Rx.Observable.ajax(obj)
.subscribe((x: any) => {
throw 'should not have been called';
}, (e) => {
expect(e.status).to.equal(0);
expect(e.xhr.method).to.equal('GET');
expect(e.xhr.async).to.equal(true);
expect(e.xhr.timeout).to.equal(10);
expect(e.xhr.responseType).to.equal('text');
});

const request = MockXMLHttpRequest.mostRecent;

expect(request.url).to.equal('/flibbertyJibbet');

rxTestScheduler.schedule(() => {
request.respondWith({
'status': 200,
'contentType': 'text/plain',
'responseText': 'Wee! I am text!'
});
}, 1000);

rxTestScheduler.flush();
});

it('should create a synchronous request', () => {
const obj: Rx.AjaxRequest = {
url: '/flibbertyJibbet',
Expand Down Expand Up @@ -1028,8 +1063,20 @@ class MockXMLHttpRequest {
MockXMLHttpRequest.requests.push(this);
}

timeout: number;

send(data: any): void {
this.data = data;
if (this.timeout && this.timeout > 0) {
setTimeout(() => {
if (this.readyState != 4) {
this.readyState = 4;
this.status = 0;
this.triggerEvent('readystatechange');
this.triggerEvent('timeout');
}
}, this.timeout);
}
}

open(method: any, url: any, async: any, user: any, password: any): void {
Expand All @@ -1039,7 +1086,7 @@ class MockXMLHttpRequest {
this.user = user;
this.password = password;
this.readyState = 1;
this.triggerEvent('readyStateChange');
this.triggerEvent('readystatechange');
const originalProgressHandler = this.upload.onprogress;
Object.defineProperty(this.upload, 'progress', {
get() {
Expand All @@ -1052,24 +1099,6 @@ class MockXMLHttpRequest {
this.requestHeaders[key] = value;
}

addEventListener(name: string, handler: any): void {
this.eventHandlers.push({ name: name, handler: handler });
}

removeEventListener(name: string, handler: any): void {
for (let i = this.eventHandlers.length - 1; i--; ) {
let eh = this.eventHandlers[i];
if (eh.name === name && eh.handler === handler) {
this.eventHandlers.splice(i, 1);
}
}
}

throwError(err: any): void {
// TODO: something better with errors
this.triggerEvent('error');
}

protected jsonResponseValue(response: any) {
try {
this.response = JSON.parse(response.responseText);
Expand Down Expand Up @@ -1117,17 +1146,11 @@ class MockXMLHttpRequest {

triggerEvent(name: any, eventObj?: any): void {
// TODO: create a better default event
const e: any = eventObj || {};
const e: any = eventObj || { type: name };

if (this['on' + name]) {
this['on' + name](e);
}

this.eventHandlers.forEach(function (eh) {
if (eh.name === name) {
eh.handler.call(this, e);
}
});
}

triggerUploadEvent(name: any, eventObj?: any): void {
Expand Down
18 changes: 13 additions & 5 deletions src/internal/observable/dom/AjaxObservable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,15 @@ export class AjaxSubscriber<T> extends Subscriber<Event> {
}

function xhrReadyStateChange(this: XMLHttpRequest, e: Event) {
const { subscriber, progressSubscriber, request } = (<any>xhrReadyStateChange);
return;
}
xhr.onreadystatechange = xhrReadyStateChange;
(<any>xhrReadyStateChange).subscriber = this;
(<any>xhrReadyStateChange).progressSubscriber = progressSubscriber;
(<any>xhrReadyStateChange).request = request;

function xhrLoad(this: XMLHttpRequest, e: Event) {
const { subscriber, progressSubscriber, request } = (<any>xhrLoad);
if (this.readyState === 4) {
// normalize IE9 bug (http://bugs.jquery.com/ticket/1450)
let status: number = this.status === 1223 ? 204 : this.status;
Expand Down Expand Up @@ -382,10 +390,10 @@ export class AjaxSubscriber<T> extends Subscriber<Event> {
}
}
}
xhr.onreadystatechange = xhrReadyStateChange;
(<any>xhrReadyStateChange).subscriber = this;
(<any>xhrReadyStateChange).progressSubscriber = progressSubscriber;
(<any>xhrReadyStateChange).request = request;
xhr.onload = xhrLoad;
(<any>xhrLoad).subscriber = this;
(<any>xhrLoad).progressSubscriber = progressSubscriber;
(<any>xhrLoad).request = request;
}

unsubscribe() {
Expand Down