Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Add request and requestError interception in ngResource #13273

Closed
krotscheck wants to merge 1 commit into from
Closed

Add request and requestError interception in ngResource #13273

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
Add request and requestError interception in ngResource 
This patch adds request and requestError interception for ngResource actions,
as per the documentation found for $http interceptors. It is important to
note that returning an error at this stage of the request - before the
call to $http - will completely bypass any global interceptors and/or recovery
handlers, as those are added to a separate context. This is intentional; intercepting
a request before it is passed to the HTTP stack indicates that the resource itself
has made a decision, and that it accepts the responsibility for recovery.

Closes #5146
  • Loading branch information
@krotscheck
Michael Krotscheck authored and krotscheck committed May 5, 2016
commit 1c6091242c18dec8a071c032e966f201cc71bcab
19 changes: 15 additions & 4 deletions src/ngResource/resource.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,9 @@ function shallowClearAndCopy(src, dst) {
* for more information.
* - **`responseType`** - `{string}` - see
* [requestType](https://developer.mozilla.org/en-US/docs/DOM/XMLHttpRequest#responseType).
* - **`interceptor`** - `{Object=}` - The interceptor object has two optional methods -
* `response` and `responseError`. Both `response` and `responseError` interceptors get called
* with `http response` object. See {@link ng.$http $http interceptors}.
* - **`interceptor`** - `{Object=}` - The interceptor object has four optional methods -
* `request`, `requestError`, `response`, and `responseError`. See
* {@link ng.$http $http interceptors} for details.
*
* @param {Object} options Hash with custom settings that should extend the
* default `$resourceProvider` behavior. The supported options are:
Expand Down Expand Up @@ -633,6 +633,10 @@ angular.module('ngResource', ['ng']).
var isInstanceCall = this instanceof Resource;
var value = isInstanceCall ? data : (action.isArray ? [] : new Resource(data));
var httpConfig = {};
var requestInterceptor = action.interceptor && action.interceptor.request ||
undefined;
var requestErrorInterceptor = action.interceptor && action.interceptor.requestError ||
undefined;
var responseInterceptor = action.interceptor && action.interceptor.response ||
defaultResponseInterceptor;
var responseErrorInterceptor = action.interceptor && action.interceptor.responseError ||
Expand Down Expand Up @@ -667,7 +671,14 @@ angular.module('ngResource', ['ng']).
extend({}, extractParams(data, action.params || {}), params),
action.url);

var promise = $http(httpConfig).then(function(response) {
// Start the promise chain
var promise = $q.
resolve(httpConfig).
then(requestInterceptor).
catch(requestErrorInterceptor).
then($http);

promise = promise.then(function(response) {
var data = response.data;

if (data) {
Expand Down
263 changes: 260 additions & 3 deletions test/ngResource/resourceSpec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
describe("resource", function() {

describe("basic usage", function() {
var $resource, CreditCard, callback, $httpBackend, resourceProvider;
var $resource, CreditCard, callback, $httpBackend, resourceProvider, $q;

beforeEach(module('ngResource'));

Expand All @@ -14,6 +14,7 @@ describe("basic usage", function() {
beforeEach(inject(function($injector) {
$httpBackend = $injector.get('$httpBackend');
$resource = $injector.get('$resource');
$q = $injector.get('$q');
CreditCard = $resource('/CreditCard/:id:verb', {id:'@id.key'}, {
charge:{
method:'post',
Expand Down Expand Up @@ -978,6 +979,188 @@ describe("basic usage", function() {
});
});


describe('requestInterceptor', function() {
var rejectReason = {'lol':'cat'};
var successSpy, failureSpy;

beforeEach(function() {
successSpy = jasmine.createSpy('successSpy');
failureSpy = jasmine.createSpy('failureSpy');
});

it('should allow per action request interceptor that gets full configuration', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function(httpConfig) {
callback(httpConfig);
Copy link
Contributor

@Narretz Narretz Jan 30, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the callback defined somewhere?

return httpConfig;
}
}
}
});

$httpBackend.expect('GET', '/CreditCard').respond([{id: 1}]);

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);

$httpBackend.flush();
expect(callback).toHaveBeenCalledOnce();
expect(successSpy).toHaveBeenCalledOnce();
expect(failureSpy).not.toHaveBeenCalled();

expect(callback).toHaveBeenCalledWith({
'method': 'get',
'url': '/CreditCard'
});
});

it('should call $http with the value returned from requestInterceptor', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function(httpConfig) {
httpConfig.url = '/DebitCard';
return httpConfig;
}
}
}
});

$httpBackend.expect('GET', '/DebitCard').respond([{id: 1}]);

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);

$httpBackend.flush();
expect(successSpy).toHaveBeenCalledOnce();
expect(failureSpy).not.toHaveBeenCalled();
});

it('should abort the operation if the requestInterceptor rejects the operation', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function() {
return $q.reject(rejectReason);
}
}
}
});

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);

// Make sure all promises resolve.
$rootScope.$apply();

// Ensure the resource promise was rejected
expect(resource.$resolved).toBeTruthy();
expect(successSpy).not.toHaveBeenCalled();
expect(failureSpy).toHaveBeenCalledOnce();
expect(failureSpy).toHaveBeenCalledWith(rejectReason);

// Ensure that no requests were made.
$httpBackend.verifyNoOutstandingRequest();
});

it('should call requestErrorInterceptor if requestInterceptor rejects the operation', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function() {
return $q.reject(rejectReason);
},
requestError: function(rejection) {
callback(rejection);
return $q.reject(rejection);
}
}
}
});

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);
$rootScope.$digest();

expect(callback).toHaveBeenCalledOnce();
expect(callback).toHaveBeenCalledWith(rejectReason);
expect(successSpy).not.toHaveBeenCalled();
expect(failureSpy).toHaveBeenCalledOnce();
expect(failureSpy).toHaveBeenCalledWith(rejectReason);

// Ensure that no requests were made.
$httpBackend.verifyNoOutstandingRequest();
});

it('should abort the operation if a requestErrorInterceptor rejects the operation', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function() {
return $q.reject(rejectReason);
},
requestError: function(rejection) {
return $q.reject(rejection);
}
}
}
});

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);
$rootScope.$apply();

expect(resource.$resolved).toBeTruthy();
expect(successSpy).not.toHaveBeenCalled();
expect(failureSpy).toHaveBeenCalledOnce();
expect(failureSpy).toHaveBeenCalledWith(rejectReason);

// Ensure that no requests were made.
$httpBackend.verifyNoOutstandingRequest();
});

it('should continue the operation if a requestErrorInterceptor rescues it', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function(httpConfig) {
return $q.reject(httpConfig);
},
requestError: function(httpConfig) {
return $q.resolve(httpConfig);
}
}
}
});

$httpBackend.expect('GET', '/CreditCard').respond([{id: 1}]);

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);
$httpBackend.flush();

expect(resource.$resolved).toBeTruthy();
expect(successSpy).toHaveBeenCalledOnce();
expect(failureSpy).not.toHaveBeenCalled();
$httpBackend.verifyNoOutstandingRequest();
});
Copy link
Member

@gkalpak gkalpak Feb 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should verify that $resolved is true etc.

});

it('should allow per action response interceptor that gets full response', function() {
CreditCard = $resource('/CreditCard', {}, {
query: {
Expand Down Expand Up @@ -1318,7 +1501,7 @@ describe("basic usage", function() {
});

describe('errors', function() {
var $httpBackend, $resource, $q;
var $httpBackend, $resource, $q, $rootScope;

beforeEach(module(function($exceptionHandlerProvider) {
$exceptionHandlerProvider.mode('log');
Expand All @@ -1330,6 +1513,7 @@ describe('errors', function() {
$httpBackend = $injector.get('$httpBackend');
$resource = $injector.get('$resource');
$q = $injector.get('$q');
$rootScope = $injector.get('$rootScope');
}));


Expand Down Expand Up @@ -1366,6 +1550,78 @@ describe('errors', function() {
/^\[\$resource:badcfg\] Error in resource configuration for action `get`\. Expected response to contain an object but got an array \(Request: GET \/Customer\/123\)/
);
});

describe('requestInterceptor', function() {
var rejectReason = {'lol':'cat'};
var successSpy, failureSpy, callback;

beforeEach(function() {
successSpy = jasmine.createSpy('successSpy');
failureSpy = jasmine.createSpy('failureSpy');
callback = jasmine.createSpy();
});

it('should call requestErrorInterceptor if requestInterceptor throws an error', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function() {
throw rejectReason;
},
requestError: function(rejection) {
callback(rejection);
return $q.reject(rejection);
}
}
}
});

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);
$rootScope.$apply();

expect(callback).toHaveBeenCalledOnce();
expect(callback).toHaveBeenCalledWith(rejectReason);
expect(successSpy).not.toHaveBeenCalled();
expect(failureSpy).toHaveBeenCalledOnce();
expect(failureSpy).toHaveBeenCalledWith(rejectReason);

// Ensure that no requests were made.
$httpBackend.verifyNoOutstandingRequest();
});

it('should abort the operation if a requestErrorInterceptor throws an exception', function() {
var CreditCard = $resource('/CreditCard', {}, {
query: {
method: 'get',
isArray: true,
interceptor: {
request: function() {
return $q.reject();
},
requestError: function() {
throw rejectReason;
}
}
}
});

var resource = CreditCard.query();
resource.$promise.then(successSpy, failureSpy);
$rootScope.$apply();

expect(resource.$resolved).toBeTruthy();
expect(successSpy).not.toHaveBeenCalled();
expect(failureSpy).toHaveBeenCalledOnce();
expect(failureSpy).toHaveBeenCalledWith(rejectReason);

// Ensure that no requests were made.
$httpBackend.verifyNoOutstandingRequest();
});
});

});

describe('cancelling requests', function() {
Expand Down Expand Up @@ -1430,7 +1686,7 @@ describe('cancelling requests', function() {
);

it('should use `cancellable` value if passed a non-numeric `timeout` in an action',
inject(function($log, $q) {
inject(function($log, $q, $rootScope) {
spyOn($log, 'debug');
$httpBackend.whenGET('/CreditCard').respond({});

Expand All @@ -1443,6 +1699,7 @@ describe('cancelling requests', function() {
});

var creditCard = CreditCard.get();
$rootScope.$apply();
Copy link
Member

@gkalpak gkalpak Feb 22, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really needed ? That might indicate a BC 😞

Copy link
Author

@krotscheck krotscheck Feb 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I believe it's because we're putting a promise between the GET request and the invocation to $http, which has to resolve first. We can wrap creating the requestInterceptor promise into a conditional though, which would remove the need for this line.

Copy link
Member

@gkalpak gkalpak Feb 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come this is the only test that needs this ? 😕

Copy link
Author

@krotscheck krotscheck Feb 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...perhaps a sign that ngResource needs more coverage ;)

expect(creditCard.$cancelRequest).toBeDefined();
expect(httpSpy.calls.argsFor(0)[0].timeout).toEqual(jasmine.any($q));
expect(httpSpy.calls.argsFor(0)[0].timeout.then).toBeDefined();
Expand Down