opendev/gerrit
Code Issues Proposed changes

Document upgradeUrl functionality

Browse Source 
Bug: Issue 6708
Change-Id: I061a410246771948277b752b47eb8b821fd5e02d
This commit is contained in:
Kasper Nilsson
2017-07-24 15:39:21 -07:00
parent 49e3d1f47f
commit 8eab05da93
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
polygerrit-ui/app/elements/core/gr-navigation/gr-navigation.html
View File

@@ -72,7 +72,12 @@ limitations under the License.
/** @type {Function} */ /** @type {Function} */
_generateUrl: uninitialized, _generateUrl: uninitialized,
/** @type {Function} */ /**
* Handler for when a legacy URL can be upgraded. Router implementations
* may implement as a no-op if route upgrades are not needed.
*
* @type {Function}
*/
_upgradeUrl: uninitialized, _upgradeUrl: uninitialized,
_checkPatchRange(patchNum, basePatchNum) { _checkPatchRange(patchNum, basePatchNum) {

7
polygerrit-ui/app/elements/core/gr-router/gr-router.js
View File

@@ -46,6 +46,13 @@
page.base(base); page.base(base);
} }
/**
* While resolving Issue 6708, the need for some way to upgrade obsolete
* URLs in-place without page reloads became evident.
*
* This function aims to update the app params and the URL when the URL is
* found to be obsolete.
*/
const upgradeUrl = params => { const upgradeUrl = params => {
const url = generateUrl(params); const url = generateUrl(params);
if (url !== window.location.pathname) { if (url !== window.location.pathname) {