Merge pull request #2705 from input-output-hk/explorer-paginate-votes…

…tatuses

Explorer paginate votestatuses

jormungandr/src/explorer/graphql/connections.rs

@@ -1,6 +1,8 @@
 use super::error::ErrorKind;
-use super::scalars::{BlockCount, IndexCursor, PoolCount, TransactionCount, VotePlanCount};
-use super::{Block, Context, Pool, Transaction, VotePlanStatus};
+use super::scalars::{
+    BlockCount, IndexCursor, PoolCount, TransactionCount, VotePlanCount, VoteStatusCount,
+};
+use super::{Block, Context, Pool, Transaction, VotePlanStatus, VoteStatus};
 use crate::blockcfg::HeaderHash;
 use crate::explorer::indexing::ExplorerTransaction;
 use juniper::FieldResult;
@@ -82,6 +84,19 @@ impl VotePlanEdge {
     }
 }
 
+#[juniper::object(
+    Context = Context
+)]
+impl VoteStatusEdge {
+    pub fn node(&self) -> &VoteStatus {
+        &self.node
+    }
+
+    pub fn cursor(&self) -> &IndexCursor {
+        &self.cursor
+    }
+}
+
 #[juniper::object(
     Context = Context,
     name = "BlockConnection"
@@ -158,6 +173,25 @@ impl VotePlanConnection {
     }
 }
 
+#[juniper::object(
+    Context = Context,
+    name = "VoteStatusConnection"
+)]
+impl VoteStatusConnection {
+    pub fn page_info(&self) -> &PageInfo {
+        &self.page_info
+    }
+
+    pub fn edges(&self) -> &Vec<VoteStatusEdge> {
+        &self.edges
+    }
+
+    /// A count of the total number of objects in this connection, ignoring pagination.
+    pub fn total_count(&self) -> &VoteStatusCount {
+        &self.total_count
+    }
+}
+
 pub struct PageInfo {
     pub has_next_page: bool,
     pub has_previous_page: bool,
@@ -191,6 +225,11 @@ pub struct VotePlanEdge {
     pub cursor: IndexCursor,
 }
 
+pub struct VoteStatusEdge {
+    node: VoteStatus,
+    pub cursor: IndexCursor,
+}
+
 pub trait Edge {
     type Node;
     fn new(node: Self::Node, cursor: IndexCursor) -> Self;
@@ -295,6 +334,7 @@ pub type BlockConnection = Connection<BlockEdge, BlockCount>;
 pub type TransactionConnection = Connection<TransactionEdge, TransactionCount>;
 pub type PoolConnection = Connection<PoolEdge, PoolCount>;
 pub type VotePlanConnection = Connection<VotePlanEdge, VotePlanCount>;
+pub type VoteStatusConnection = Connection<VoteStatusEdge, VoteStatusCount>;
 
 #[allow(clippy::large_enum_variant)]
 #[derive(Clone)]
@@ -356,6 +396,18 @@ impl Edge for VotePlanEdge {
     }
 }
 
+impl Edge for VoteStatusEdge {
+    type Node = VoteStatus;
+
+    fn new(node: Self::Node, cursor: IndexCursor) -> Self {
+        VoteStatusEdge { node, cursor }
+    }
+
+    fn cursor(&self) -> &IndexCursor {
+        &self.cursor
+    }
+}
+
 fn compute_range_boundaries(
     total_elements: InclusivePaginationInterval<u64>,
     pagination_arguments: ValidatedPaginationArguments<u64>,

jormungandr/src/explorer/graphql/mod.rs

@@ -6,6 +6,7 @@ mod scalars;
 use self::connections::{
     BlockConnection, InclusivePaginationInterval, PaginationArguments, PaginationInterval,
     PoolConnection, TransactionConnection, TransactionNodeFetchInfo, VotePlanConnection,
+    VoteStatusConnection,
 };
 use self::error::ErrorKind;
 use super::indexing::{
@@ -1165,8 +1166,48 @@ impl VoteProposalStatus {
         self.tally.as_ref()
     }
 
-    pub fn votes(&self) -> &[VoteStatus] {
-        &self.votes
+    pub fn votes(
+        &self,
+        first: Option<i32>,
+        last: Option<i32>,
+        before: Option<IndexCursor>,
+        after: Option<IndexCursor>,
+        context: &Context,
+    ) -> FieldResult<VoteStatusConnection> {
+        let boundaries = if !self.votes.is_empty() {
+            PaginationInterval::Inclusive(InclusivePaginationInterval {
+                lower_bound: 0u32,
+                upper_bound: self
+                    .votes
+                    .len()
+                    .checked_sub(1)
+                    .unwrap()
+                    .try_into()
+                    .expect("tried to paginate more than 2^32 elements"),
+            })
+        } else {
+            PaginationInterval::Empty
+        };
+
+        let pagination_arguments = PaginationArguments {
+            first,
+            last,
+            before: before.map(u32::try_from).transpose()?,
+            after: after.map(u32::try_from).transpose()?,
+        }
+        .validate()?;
+
+        VoteStatusConnection::new(boundaries, pagination_arguments, |range| match range {
+            PaginationInterval::Empty => vec![],
+            PaginationInterval::Inclusive(range) => {
+                let from = range.lower_bound;
+                let to = range.upper_bound;
+
+                (from..=to)
+                    .map(|i: u32| (self.votes[i as usize].clone(), i))
+                    .collect::<Vec<(VoteStatus, u32)>>()
+            }
+        })
     }
 }
 

jormungandr/src/explorer/graphql/scalars.rs

@@ -58,6 +58,9 @@ pub struct Weight(pub String);
 #[derive(juniper::GraphQLScalarValue)]
 pub struct VotePlanCount(pub String);
 
+#[derive(juniper::GraphQLScalarValue)]
+pub struct VoteStatusCount(pub String);
+
 /// Vote option range
 ///
 /// provide a range of available choices for a given proposal. Usual value would
@@ -266,3 +269,9 @@ impl From<u32> for VotePlanCount {
         VotePlanCount(format!("{}", number))
     }
 }
+
+impl From<u64> for VoteStatusCount {
+    fn from(number: u64) -> VoteStatusCount {
+        VoteStatusCount(format!("{}", number))
+    }
+}

testing/jormungandr-integration-tests/src/jormungandr/vit/mod.rs

@@ -454,4 +454,21 @@ pub fn jcli_e2e_flow() {
             .votes_cast,
         3
     );
+
+    assert_eq!(
+        jormungandr
+            .explorer()
+            .vote_plans(1)
+            .unwrap()
+            .data
+            .unwrap()
+            .all_vote_plans
+            .edges[0]
+            .node
+            .proposals[0]
+            .votes
+            .edges
+            .len(),
+        3
+    );
 }

testing/jormungandr-testing-utils/resources/explorer/graphql/schema.graphql

@@ -104,6 +104,7 @@ type PageInfo {
 
 enum PayloadType {
   PUBLIC
+  PRIVATE
 }
 
 type Pool {
@@ -371,14 +372,31 @@ type VoteProposalStatus {
   proposalId: ExternalProposalId!
   options: VoteOptionRange!
   tally: TallyStatus
-  votes: [VoteStatus!]!
+  votes(first: Int, last: Int, before: IndexCursor, after: IndexCursor): VoteStatusConnection!
 }
 
 type VoteStatus {
   address: Address!
   payload: VotePayloadStatus!
 }
 
+type VoteStatusConnection {
+  pageInfo: PageInfo!
+  edges: [VoteStatusEdge!]!
+
+  """
+  A count of the total number of objects in this connection, ignoring pagination.
+  """
+  totalCount: VoteStatusCount!
+}
+
+scalar VoteStatusCount
+
+type VoteStatusEdge {
+  node: VoteStatus!
+  cursor: IndexCursor!
+}
+
 type VoteTally {
   votePlan: VotePlanId!
 }

testing/jormungandr-testing-utils/resources/explorer/graphql/voteplans.graphql

@@ -1,29 +1,51 @@
-query AllVotePlans($first: Int!){ 
-    allVotePlans(first: $first) {
-        edges{
-            node {
-                    id,
-                    voteStart{
-                        epoch{
-                            id
-                        }
-                        slot
-                    }
-                    voteEnd{
-                        epoch{
-                            id
-                        }
-                        slot
-                    }
-                    committeeEnd {
-                        epoch{
-                            id
-                        }
-                        slot
-                    }
-                    payloadType,
+query AllVotePlans($first: Int!) {
+  allVotePlans(first: $first) {
+    edges {
+      node {
+        id
+        voteStart {
+          epoch {
+            id
+          }
+          slot
+        }
+        voteEnd {
+          epoch {
+            id
+          }
+          slot
+        }
+        committeeEnd {
+          epoch {
+            id
+          }
+          slot
+        }
+        payloadType
+        proposals {
+          # proposalId
+          options {
+            start
+            end
+          }
+          votes {
+            edges {
+              node {
+                address {
+                  id
+                }
+                payload {
+                   __typename
+                  ... on VotePayloadPublicStatus {
+                    choice
+                  }
                 }
+              }
+            }
+          }
         }
-        totalCount
+      }
     }
-}
+    totalCount
+  }
+}