This repository has been archived by the owner on Apr 12, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat($templateRequest): introduce the $templateRequest service
This handy service is designed to download and cache template contents and to throw an error when a template request fails. BREAKING CHANGE Angular will now throw a $compile minErr each a template fails to download for ngView, directives and ngMessage template requests. This changes the former behavior of silently ignoring failed HTTP requests--or when the template itself is empty. Please ensure that all directive, ngView and ngMessage code now properly addresses this scenario. NgInclude is uneffected from this change.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| 'use strict'; | ||
|
|
||
| var $compileMinErr = minErr('$compile'); | ||
|
|
||
| /** | ||
| * @ngdoc service | ||
| * @name $templateRequest | ||
| * | ||
| * @description | ||
| * The `$templateRequest` service downloads the provided template using `$http` and, upon success, | ||
| * stores the contents inside of `$templateCache`. If the HTTP request fails or the response data | ||
| * of the HTTP request is empty then a `$compile` error will be thrown (the exception can be thwarted | ||
| * by setting the 2nd parameter of the function to true). | ||
| * | ||
| * @param {string} tpl The HTTP request template URL | ||
| * @param {boolean=} ignoreRequestError Whether or not to ignore the exception when the request fails or the template is empty | ||
| * | ||
| * @return {Promise} the HTTP Promise for the given. | ||
| * | ||
| * @property {number} totalPendingRequests total amount of pending template requests being downloaded. | ||
| */ | ||
| function $TemplateRequestProvider() { | ||
| this.$get = ['$templateCache', '$http', '$q', function($templateCache, $http, $q) { | ||
| function handleRequestFn(tpl, ignoreRequestError) { | ||
| var self = handleRequestFn; | ||
| self.totalPendingRequests++; | ||
|
|
||
| return $http.get(tpl, { cache : $templateCache }) | ||
| .then(function(response) { | ||
| var html = response.data; | ||
| if(!html || html.length === 0) { | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. |
||
| return handleError(); | ||
| } | ||
|
|
||
| self.totalPendingRequests--; | ||
| $templateCache.put(tpl, html); | ||
| return html; | ||
| }, handleError); | ||
|
|
||
| function handleError() { | ||
| self.totalPendingRequests--; | ||
| if (!ignoreRequestError) { | ||
| throw $compileMinErr('tpload', 'Failed to load template: {0}', tpl); | ||
| } | ||
| return $q.reject(); | ||
| } | ||
| } | ||
|
|
||
| handleRequestFn.totalPendingRequests = 0; | ||
|
|
||
| return handleRequestFn; | ||
| }]; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| 'use strict'; | ||
|
|
||
| describe('$templateRequest', function() { | ||
|
|
||
| it('should download the provided template file', | ||
| inject(function($rootScope, $templateRequest, $httpBackend) { | ||
|
|
||
| $httpBackend.expectGET('tpl.html').respond('<div>abc</div>'); | ||
|
|
||
| var content; | ||
| $templateRequest('tpl.html').then(function(html) { content = html; }); | ||
|
|
||
| $rootScope.$digest(); | ||
| $httpBackend.flush(); | ||
|
|
||
| expect(content).toBe('<div>abc</div>'); | ||
| })); | ||
|
|
||
| it('should cache the request using $templateCache to prevent extra downloads', | ||
| inject(function($rootScope, $templateRequest, $templateCache) { | ||
|
|
||
| $templateCache.put('tpl.html', 'matias'); | ||
|
|
||
| var content; | ||
| $templateRequest('tpl.html').then(function(html) { content = html; }); | ||
|
|
||
| $rootScope.$digest(); | ||
| expect(content).toBe('matias'); | ||
| })); | ||
|
|
||
| it('should throw an error when the template is not found', | ||
| inject(function($rootScope, $templateRequest, $httpBackend) { | ||
|
|
||
| $httpBackend.expectGET('tpl.html').respond(404); | ||
|
|
||
| $templateRequest('tpl.html'); | ||
|
|
||
| $rootScope.$digest(); | ||
|
|
||
| expect(function() { | ||
| $rootScope.$digest(); | ||
| $httpBackend.flush(); | ||
| }).toThrowMinErr('$compile', 'tpload', 'Failed to load template: tpl.html'); | ||
| })); | ||
|
|
||
| it('should throw an error when the template is empty', | ||
| inject(function($rootScope, $templateRequest, $httpBackend) { | ||
|
|
||
| $httpBackend.expectGET('tpl.html').respond(''); | ||
|
|
||
| $templateRequest('tpl.html'); | ||
|
|
||
| $rootScope.$digest(); | ||
|
|
||
| expect(function() { | ||
| $rootScope.$digest(); | ||
| $httpBackend.flush(); | ||
| }).toThrowMinErr('$compile', 'tpload', 'Failed to load template: tpl.html'); | ||
| })); | ||
|
|
||
| it('should keep track of how many requests are going on', | ||
| inject(function($rootScope, $templateRequest, $httpBackend) { | ||
|
|
||
| $httpBackend.expectGET('a.html').respond('a'); | ||
| $httpBackend.expectGET('b.html').respond('c'); | ||
| $templateRequest('a.html'); | ||
| $templateRequest('b.html'); | ||
|
|
||
| expect($templateRequest.totalPendingRequests).toBe(2); | ||
|
|
||
| $rootScope.$digest(); | ||
| $httpBackend.flush(); | ||
|
|
||
| expect($templateRequest.totalPendingRequests).toBe(0); | ||
|
|
||
| $httpBackend.expectGET('c.html').respond(404); | ||
| $templateRequest('c.html'); | ||
|
|
||
| expect($templateRequest.totalPendingRequests).toBe(1); | ||
| $rootScope.$digest(); | ||
|
|
||
| try { | ||
| $httpBackend.flush(); | ||
| } catch(e) {} | ||
|
|
||
| expect($templateRequest.totalPendingRequests).toBe(0); | ||
| })); | ||
|
|
||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
why do we care?