Files
gerrit/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view.js
Logan Hanks 29693ac125 Fix pagination when limit:N is given in query
Ordinarily the limit defaults to user preference, but it can be
overridden by the query string itself. This is common in dashboard
queries. Users who follow the linked section headers in the dashboard
get confused by the pagination because each page skips many results.

To fix this, we use a regex to look for limit:N in the query. If
present, the value given in the query overrides the user preference when
computing the navigation links.

Bug: Issue 6716
Change-Id: I1c20913634e3cf8fbe98b24d5c166b66287043be
2017-07-13 18:47:58 +00:00

187 lines
4.7 KiB
JavaScript

// Copyright (C) 2016 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
(function() {
'use strict';
const LookupQueryPatterns = {
CHANGE_ID: /^\s*i?[0-9a-f]{8,40}\s*$/i,
CHANGE_NUM: /^\s*[1-9][0-9]*\s*$/g,
};
const LIMIT_OPERATOR_PATTERN = /\blimit:(\d+)/i;
Polymer({
is: 'gr-change-list-view',
/**
* Fired when the title of the page should change.
*
* @event title-change
*/
behaviors: [
Gerrit.BaseUrlBehavior,
Gerrit.URLEncodingBehavior,
],
properties: {
/**
* URL params passed from the router.
*/
params: {
type: Object,
observer: '_paramsChanged',
},
/**
* True when user is logged in.
*/
loggedIn: {
type: Boolean,
value: false,
},
/**
* State persisted across restamps of the element.
*/
viewState: {
type: Object,
notify: true,
value() { return {}; },
},
_changesPerPage: Number,
/**
* Currently active query.
*/
_query: {
type: String,
value: '',
},
/**
* Offset of currently visible query results.
*/
_offset: Number,
/**
* Change objects loaded from the server.
*/
_changes: Array,
/**
* For showing a "loading..." string during ajax requests.
*/
_loading: {
type: Boolean,
value: true,
},
},
listeners: {
'next-page': '_handleNextPage',
'previous-page': '_handlePreviousPage',
},
attached() {
this.fire('title-change', {title: this._query});
},
_paramsChanged(value) {
if (value.view != this.tagName.toLowerCase()) { return; }
this._loading = true;
this._query = value.query;
this._offset = value.offset || 0;
if (this.viewState.query != this._query ||
this.viewState.offset != this._offset) {
this.set('viewState.selectedChangeIndex', 0);
this.set('viewState.query', this._query);
this.set('viewState.offset', this._offset);
}
this.fire('title-change', {title: this._query});
this._getPreferences().then(prefs => {
this._changesPerPage = prefs.changes_per_page;
return this._getChanges();
}).then(changes => {
if (this._query && changes.length === 1) {
for (const query in LookupQueryPatterns) {
if (LookupQueryPatterns.hasOwnProperty(query) &&
this._query.match(LookupQueryPatterns[query])) {
page.show('/c/' + changes[0]._number);
return;
}
}
}
this._changes = changes;
this._loading = false;
});
},
_getChanges() {
return this.$.restAPI.getChanges(this._changesPerPage, this._query,
this._offset);
},
_getPreferences() {
return this.$.restAPI.getPreferences();
},
_limitFor(query, defaultLimit) {
const match = query.match(LIMIT_OPERATOR_PATTERN);
if (!match) {
return defaultLimit;
}
return parseInt(match[1], 10);
},
_computeNavLink(query, offset, direction, changesPerPage) {
// Offset could be a string when passed from the router.
offset = +(offset || 0);
const limit = this._limitFor(query, changesPerPage);
const newOffset = Math.max(0, offset + (limit * direction));
// Double encode URI component.
let href = this.getBaseUrl() + '/q/' + this.encodeURL(query, false);
if (newOffset > 0) {
href += ',' + newOffset;
}
return href;
},
_hidePrevArrow(offset) {
return offset === 0;
},
_hideNextArrow(loading) {
return loading || !this._changes || !this._changes.length ||
!this._changes[this._changes.length - 1]._more_changes;
},
_handleNextPage() {
if (this.$.nextArrow.hidden) { return; }
page.show(this._computeNavLink(
this._query, this._offset, 1, this._changesPerPage));
},
_handlePreviousPage() {
if (this.$.prevArrow.hidden) { return; }
page.show(this._computeNavLink(
this._query, this._offset, -1, this._changesPerPage));
},
});
})();