Fix #78 - Implement server side pagination and sorting for queries #2566
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,23 @@ | ||
| import moment from 'moment'; | ||
| import { isString } from 'underscore'; | ||
|
There was a problem hiding this comment. If the React pull request gets merged before this one, we need to remember to replace this with |
||
| import startsWith from 'underscore.string/startsWith'; | ||
|
There was a problem hiding this comment. You can use There was a problem hiding this comment. Hm, I thought it's not supported by IE11? There was a problem hiding this comment. Thinking about IE11 is very benevolent of you :) But I would assume Babel takes care of this for us? |
||
|
|
||
| import { LivePaginator } from '@/lib/pagination'; | ||
| import template from './queries-list.html'; | ||
|
|
||
|
|
||
| class QueriesListCtrl { | ||
| constructor($location, $log, $route, Title, Query) { | ||
| const page = parseInt($location.search().page || 1, 10); | ||
| const orderSeparator = '-'; | ||
| const pageOrder = $location.search().order || 'created_at'; | ||
| const pageOrderReverse = startsWith(pageOrder, orderSeparator); | ||
| this.showEmptyState = false; | ||
| this.showDrafts = false; | ||
| this.pageSize = parseInt($location.search().page_size || 20, 10); | ||
| this.pageSizeOptions = [5, 10, 20, 50, 100]; | ||
| this.searchTerm = $location.search().search || ''; | ||
| this.oldSearchTerm = $location.search().q; | ||
| this.defaultOptions = {}; | ||
|
|
||
| const self = this; | ||
|
|
@@ -20,16 +31,42 @@ class QueriesListCtrl { | |
| Title.set('My Queries'); | ||
| this.resource = Query.myQueries; | ||
| break; | ||
| // Redirect to the real search view. | ||
| // TODO: check if that really always works. | ||
| case '/queries/search': | ||
| window.location.replace('/queries?q=' + this.oldSearchTerm); | ||
| break; | ||
| default: | ||
| break; | ||
| } | ||
|
|
||
| const setSearchOrClear = (name, value) => { | ||
| if (value) { | ||
| $location.search(name, value); | ||
| } else { | ||
| $location.search(name, undefined); | ||
| } | ||
| }; | ||
|
|
||
| function queriesFetcher(requestedPage, itemsPerPage, orderByField, orderByReverse, params, paginator) { | ||
| $location.search('page', requestedPage); | ||
| $location.search('page_size', itemsPerPage); | ||
| if (orderByReverse && !startsWith(orderByField, orderSeparator)) { | ||
| orderByField = orderSeparator + orderByField; | ||
| } | ||
| setSearchOrClear('order', orderByField); | ||
| setSearchOrClear('search', params.searchTerm); | ||
| setSearchOrClear('drafts', params.showDrafts); | ||
|
|
||
| const request = Object.assign( | ||
| {}, self.defaultOptions, | ||
| { | ||
| page: requestedPage, | ||
| page_size: itemsPerPage, | ||
| order: orderByField, | ||
| search: params.searchTerm, | ||
| drafts: params.showDrafts, | ||
| }, | ||
| ); | ||
|
|
||
| return self.resource(request).$promise.then((data) => { | ||
|
|
@@ -43,16 +80,49 @@ class QueriesListCtrl { | |
| }); | ||
| } | ||
|
|
||
| this.paginator = new LivePaginator( | ||
| queriesFetcher, | ||
| { | ||
| page, | ||
| itemsPerPage: this.pageSize, | ||
| orderByField: pageOrder, | ||
| orderByReverse: pageOrderReverse, | ||
| params: this.parameters, | ||
|
There was a problem hiding this comment. does There was a problem hiding this comment. It's a bit of a kerfuffle, I'll clean this up while porting this to #2573 |
||
| }, | ||
| ); | ||
|
|
||
| this.parameters = () => ({ | ||
| searchTerm: this.searchTerm, | ||
| showDrafts: this.showDrafts, | ||
| }); | ||
|
|
||
| this.tabs = [ | ||
| { path: 'queries', name: 'All Queries', isActive: path => path === '/queries' }, | ||
| { name: 'My Queries', path: 'queries/my' }, | ||
| ]; | ||
|
|
||
| this.searchUsed = () => this.searchTerm !== undefined || this.searchTerm !== ''; | ||
|
|
||
| this.hasResults = () => this.paginator.getPageRows() !== undefined && | ||
| this.paginator.getPageRows().length > 0; | ||
|
|
||
| this.showEmptyState = () => !this.hasResults() && !this.searchUsed(); | ||
|
|
||
| this.showDraftsCheckbox = () => $location.path() !== '/queries/my'; | ||
|
|
||
| this.clearSearch = () => { | ||
| this.searchTerm = ''; | ||
| this.update(); | ||
| }; | ||
|
|
||
| this.update = () => { | ||
| if (!isString(this.searchTerm) || this.searchTerm.trim() === '') { | ||
| this.searchTerm = ''; | ||
| } | ||
| this.paginator.itemsPerPage = this.pageSize; | ||
| this.paginator.params = this.parameters(); | ||
|
There was a problem hiding this comment. any reason not to just inline the |
||
| this.paginator.fetch(page); | ||
| }; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -71,5 +141,10 @@ export default function init(ngModule) { | |
| template: '<page-queries-list></page-queries-list>', | ||
| reloadOnSearch: false, | ||
| }, | ||
| // just for backward-compatible routes | ||
| '/queries/search': { | ||
| template: '<page-queries-list></page-queries-list>', | ||
| reloadOnSearch: false, | ||
| }, | ||
| }; | ||
| } | ||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be
...paramsinstead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, hm, maybe?