920060 - Bug.search API doesn't return total results

Status: RESOLVED FIXED

(bugzilla.mozilla.org :: API, defect)

Description

[Erik Bryn]

In order to paginate a list of search results, a client needs to know if there are more results to display. I propose that a total results count should be returned.

Comment 1

[Byron Jones ‹:glob› 🎈]

as our methods don't support pagination, you're always getting the full number of bugs returned as search results (up to a maximum upper limit of 10,000).

to determine the total number of results, can't you count the bugs returned by the query?

Comment 2

[Byron Jones ‹:glob› 🎈]

TIL our webservices do support offset as well as limit (we don't use it in our UI however).

my concern with this is we'll have to execute each query twice to determine the total, which i'd like to avoid if possible.  i'll discuss this with dkl and see what we can do here.

Comment 3

[Dave Miller [:justdave] ([e-mail])]

From what I understood, because of the volume of data we request in our queries, a lot of time spent is actually transmitting the data back to the webhead, and not the query itself. So wouldn't a query that just asks for a result count not take as long?

Comment 4

[Byron Jones ‹:glob› 🎈]

Attachment: 920060_1.patch

adds ember/search method which takes the same parameters as GET /bug?, and returns a total:

{ bugs: [ ... ],
  total: 12 }

this total is always set.  for searches without pagination (both offset+limit params) this is always equal to the count of bugs returned.  for paginated searches, the total is equal to the number of bugs matched.

Comment 5

[David Lawrence [:dkl]]

Comment on attachment 809305 [details] [diff] [review]
920060_1.patch

Review of attachment 809305 [details] [diff] [review]:
-----------------------------------------------------------------

r=dkl

Comment 6

[Byron Jones ‹:glob› 🎈]

Committing to: bzr+ssh://[e-mail]/bmo/4.2/
modified Bugzilla/Search.pm
modified Bugzilla/WebService/Bug.pm
modified extensions/Ember/lib/WebService.pm
Committed revision 9037.

Committing to: bzr+ssh://[e-mail]/bmo/4.2-dev/
modified Bugzilla/Search.pm
modified Bugzilla/WebService/Bug.pm
modified extensions/Ember/lib/WebService.pm
Committed revision 8562.