Reimplement tree pagination for Rugged
What does this MR do?
Contributes to #334140 (closed)
!66657 (merged) added support for tree pagination options for Gitaly. However, rugged implementation for it is missing but some users can still rely on it.
Problem
After we update frontend to use a PaginatedTree
GraphQL query, users without Gitaly support will receive a non-paginated response.
Solution
Reimplement pagination from Go version in Ruby.
Screenshots or Screencasts (strongly suggested)
How to setup and validate locally (strongly suggested)
Setup
-
A repository with more than 100 elements in tree (or reduce max_page_size here to test in the smaller repository).
-
Adjust GraphQL query for your repository
query {
project(fullPath:"root/my-awesome-project") {
name
repository {
paginatedTree {
pageInfo {
endCursor
startCursor
}
nodes {
trees {
nodes {
path
}
}
blobs {
edges {
node {
path
}
}
}
submodules {
nodes {
path
}
}
}
}
}
}
}
- Stop
rails-web
(gdk stop rails-web
) and usegdk thin
to enable rugged-mode.
Testing
- Open GraphQL explorer (
<GDK_host>/-/graphql-explorer
) and execute the graphQL query - User
endCursor
value in modified GraphQL query to fetch the next page
query {
project(fullPath:"root/my-awesome-project") {
name
repository {
paginatedTree(after: "<endCursor value from previous response>" {
...
- Confirm that you received the next page
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Edited by Vasilii Iakliushin