Skip to content

GraphQL: Allow a keyset_connection to support multiple ordering attributes

Brett Walker requested to merge bw-add-json-cursor-to-keyset-connection into master

What does this MR do?

Our current Gitlab::Graphql::Connections::KeysetConnection only supports ordering on one attribute. To properly support ordering on multiple attributes and ensuring that cursor based ordering will return proper results, we need to be able to order on multiple attributes, such as Issue.order(:udpated_at).order(:id)

We can now store the necessary attributes in the cursor (such as a node's updated_at and id value), in order to properly get back nodes in relation to the cursor. We do this by storing the attributes in a json structure and then encoding that into the cursor.

Related issue: #29713 (closed)

Screenshots

Does this MR meet the acceptance criteria?

Conformity

Performance and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • 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 Brett Walker

Merge request reports