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

fix($location/$browser): prevent infinite digests on empty hash changes #9923

Closed
Closed
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
9 changes: 8 additions & 1 deletion src/ng/browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ function Browser(window, document, $log, $sniffer) {
}
}

function getHash(url) {
var index = url.indexOf('#');
return index === -1 ? '' : url.substr(index + 1);
}

/**
* @private
* Note: this method is used only by scenario runner
Expand Down Expand Up @@ -191,8 +196,10 @@ function Browser(window, document, $log, $sniffer) {
}
if (replace) {
location.replace(url);
} else {
} else if (!sameBase) {
location.href = url;
} else {
location.hash = getHash(url);
}
}
return self;
Expand Down
9 changes: 7 additions & 2 deletions src/ng/location.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ function stripHash(url) {
return index == -1 ? url : url.substr(0, index);
}

function trimEmptyHash(url) {
return url.replace(/(#.+)|#$/, '$1');
}


function stripFile(url) {
return url.substr(0, stripHash(url).lastIndexOf('/') + 1);
Expand Down Expand Up @@ -847,10 +851,11 @@ function $LocationProvider() {

// update browser
$rootScope.$watch(function $locationWatch() {
var oldUrl = $browser.url();
var oldUrl = trimEmptyHash($browser.url());
var newUrl = trimEmptyHash($location.absUrl());
var oldState = $browser.state();
var currentReplace = $location.$$replace;
var urlOrStateChanged = oldUrl !== $location.absUrl() ||
var urlOrStateChanged = oldUrl !== newUrl ||
($location.$$html5 && $sniffer.history && oldState !== $location.$$state);

if (initializing || urlOrStateChanged) {
Expand Down
21 changes: 21 additions & 0 deletions test/ng/browserSpecs.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
'use strict';

/* global getHash:true, stripHash:true */

var historyEntriesLength;
var sniffer = {};

Expand Down Expand Up @@ -51,6 +53,12 @@ function MockWindow(options) {
mockWindow.history.state = null;
historyEntriesLength++;
},
get hash() {
return getHash(locationHref);
},
set hash(value) {
locationHref = stripHash(locationHref) + '#' + value;
},
replace: function(url) {
locationHref = url;
mockWindow.history.state = null;
Expand Down Expand Up @@ -550,6 +558,17 @@ describe('browser', function() {
expect(locationReplace).not.toHaveBeenCalled();
});

it("should retain the # character when the only change is clearing the hash fragment, to prevent page reload", function() {
sniffer.history = true;

browser.url('http://server/#123');
expect(fakeWindow.location.href).toEqual('http://server/#123');

browser.url('http://server/');
expect(fakeWindow.location.href).toEqual('http://server/#');

});

it('should use location.replace when history.replaceState not available', function() {
sniffer.history = false;
browser.url('http://new.org', true);
Expand All @@ -561,6 +580,7 @@ describe('browser', function() {
expect(fakeWindow.location.href).toEqual('http://server/');
});


it('should use location.replace and not use replaceState when the url only changed in the hash fragment to please IE10/11', function() {
sniffer.history = true;
browser.url('http://server/#123', true);
Expand All @@ -572,6 +592,7 @@ describe('browser', function() {
expect(fakeWindow.location.href).toEqual('http://server/');
});


it('should return $browser to allow chaining', function() {
expect(browser.url('http://any.com')).toBe(browser);
});
Expand Down
16 changes: 14 additions & 2 deletions test/ng/locationSpec.js
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,18 @@ describe('$location', function() {
};
}

describe('location watch', function() {
beforeEach(initService({supportHistory: true}));
beforeEach(inject(initBrowser({url:'http://new.com/a/b#'})));

it('should not update browser if only the empty hash fragment is cleared by updating the search', inject(function($rootScope, $browser, $location) {
$browser.url('http://new.com/a/b#');
var $browserUrl = spyOnlyCallsWithArgs($browser, 'url').andCallThrough();
$rootScope.$digest();
expect($browserUrl).not.toHaveBeenCalled();
}));
});

describe('wiring', function() {

beforeEach(initService({html5Mode:false,hashPrefix: '!',supportHistory: true}));
Expand Down Expand Up @@ -1224,7 +1236,7 @@ describe('$location', function() {
});


it('should not rewrite full url links do different domain', function() {
it('should not rewrite full url links to different domain', function() {
configureService({linkHref: 'http://www.dot.abc/a?b=c', html5Mode: true});
inject(
initBrowser(),
Expand Down Expand Up @@ -1290,7 +1302,7 @@ describe('$location', function() {


it ('should not rewrite links when rewriting links is disabled', function() {
configureService('/a?b=c', true, true, '', 'some content', false);
configureService({linkHref: 'link?a#b', html5Mode: {enabled: true, rewriteLinks:false}, supportHist: true});
inject(
initBrowser(),
initLocation(),
Expand Down