add pagination to GET /api/v1/find endpoint #1699
Conversation
Pull Request Test Coverage Report for Build 7512258238
💛 - Coveralls |
paskal
force-pushed
the
paskal/comments_pagination
branch
from
33b4f77
to
09ee26d
Compare
paskal
force-pushed
the
paskal/comments_pagination
branch
3 times, most recently
from
f7f18c8
to
d099924
Compare
paskal
force-pushed
the
paskal/comments_pagination
branch
from
d099924
to
4bbb980
Compare
`format=tree` pagination provides top-level comments with all replies and returns the last top-level comment as `last_comment` to be used as `offset` for the next page. If comments and replies overflow the limit, the one stepping out of the limit will not be returned. If the first comment and its replies after the given offset overflow the limit, it will be returned with all the replies. `format=plain` pagination works by providing all comments and returning the last comment as `last_comment` to be used as `offset` for the next page.
paskal
force-pushed
the
paskal/comments_pagination
branch
from
4bbb980
to
162a2da
Compare
| } | ||
| } | ||
|
|
||
| log.Printf("[DEBUG] get comments for %+v, sort %s, format %s, since %v, limit %d, offset %s", locator, sort, format, since, limit, offsetID) |
There was a problem hiding this comment.
I think %q for the offset will be less confusing in the log if it was input.
| @@ -70,7 +79,24 @@ func (s *public) findCommentsCtrl(w http.ResponseWriter, r *http.Request) { | |||
| since = time.Time{} // since doesn't make sense for tree | |||
| } | |||
|
|
|||
| log.Printf("[DEBUG] get comments for %+v, sort %s, format %s, since %v", locator, sort, format, since) | |||
| limitParam := r.URL.Query().Get("limit") | |||
| var limit int | |||
There was a problem hiding this comment.
nit: personally, I'd prefer limit:=0 instead, as it communicates the default value more clearly.
| if offsetID != "" { | ||
| for i, comment := range c { | ||
| if comment.ID == offsetID { | ||
| c = c[i+1:] |
There was a problem hiding this comment.
This is confusing and even scary a bit. Generally, the idea of changing the slice we are ranging over inside the loop feels wrong to me. Probably it is safe to do now, as we are breaking right away, but someday, as we add code to this function, it may not be the case. I'd rather add a new lcs variable for the result slice.
| // | ||
| // In case limit is less than the number of replies to first comment after given offset, that first comment is | ||
| // returned completely with all replies. | ||
| func (t *Tree) limit(limit int, offsetID string) { |
There was a problem hiding this comment.
I would suggest calling it setLimit or updateWithLimit, as this function modifies nodes and does not return anything.
| @@ -145,3 +159,81 @@ func (t *Tree) sortNodes(sortType string) { | |||
| } | |||
| }) | |||
| } | |||
|
|
|||
| // limit limits number of comments in tree and sets countLeft and lastLimitedComment, | |||
There was a problem hiding this comment.
I think there is no direct test for this non-trivial function, but rather only via MakeTree? It's up to you, but I will feel better if we have some.
format=treepagination provides top-level comments with all replies and returns the last top-level comment aslast_commentto be used asoffsetfor the next page. If comments and replies overflow the limit, the one stepping out of the limit will not be returned. If the first comment and its replies after the given offset overflow the limit, it will be returned with all the replies.format=plainpagination works by providing all comments and returning the last comment aslast_commentto be used asoffsetfor the next page.Requires #1685 to be merged first. Backend part for #782.