Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add competition ranking to leaderboard #439

Merged
merged 10 commits into from
Feb 12, 2025
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ doc = false


[dependencies]
momento-protos = { version = "0.120.0" }
momento-protos = { version = "0.122.1" }
log = "0.4"
hyper = { version = "0.14" }
h2 = { version = "0.3" }
Expand Down
11 changes: 11 additions & 0 deletions src/leaderboard/leaderboard_resource.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ use crate::leaderboard::messages::data::delete::{DeleteRequest, DeleteResponse};
use crate::leaderboard::messages::data::fetch::FetchResponse;
use crate::leaderboard::messages::data::fetch_by_rank::{FetchByRankRequest, RankRange};
use crate::leaderboard::messages::data::fetch_by_score::{FetchByScoreRequest, ScoreRange};
use crate::leaderboard::messages::data::get_competition_rank::{
GetCompetitionRankRequest, GetCompetitionRankResponse,
};
use crate::leaderboard::messages::data::get_rank::{GetRankRequest, GetRankResponse};
use crate::leaderboard::messages::data::length::{LengthRequest, LengthResponse};
use crate::leaderboard::messages::data::remove_elements::{
Expand Down Expand Up @@ -103,6 +106,14 @@ impl Leaderboard {
request.send(self).await
}

pub async fn get_competition_rank(
&self,
ids: impl IntoIterator<Item = u32>,
) -> MomentoResult<GetCompetitionRankResponse> {
let request = GetCompetitionRankRequest::new(ids);
request.send(self).await
}

/* helper fns */
pub(crate) fn new(
data_clients: Vec<
Expand Down
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/delete.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ impl LeaderboardRequest for DeleteRequest {
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::DeleteLeaderboardRequest {
cache_name: cache_name.to_string(),
malandis marked this conversation as resolved.
Show resolved Hide resolved
leaderboard: leaderboard.leaderboard_name().to_string(),
},
)?;
Expand Down
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/fetch_by_rank.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ impl LeaderboardRequest for FetchByRankRequest {
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::GetByRankRequest {
cache_name: cache_name.to_string(),
leaderboard: leaderboard.leaderboard_name().to_string(),
rank_range: Some(self.rank_range.into()),
order: self.order.into_proto() as i32,
Expand Down
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/fetch_by_score.rs
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ impl LeaderboardRequest for FetchByScoreRequest {
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::GetByScoreRequest {
cache_name: cache_name.to_string(),
leaderboard: leaderboard.leaderboard_name().to_string(),
score_range: Some(self.score_range.into()),
offset: self.offset.unwrap_or(0),
Expand Down
64 changes: 64 additions & 0 deletions src/leaderboard/messages/data/get_competition_rank.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
use super::{Order, RankedElement};
use crate::leaderboard::LeaderboardRequest;
use crate::utils::prep_leaderboard_request_with_timeout;
use crate::{Leaderboard, MomentoResult};

pub struct GetCompetitionRankRequest {
ids: Vec<u32>,
order: Order,
}

impl GetCompetitionRankRequest {
pub fn new(ids: impl IntoIterator<Item = u32>) -> Self {
Self {
ids: ids.into_iter().collect(),
order: Order::Descending,
}
}

pub fn order(mut self, order: Order) -> Self {
self.order = order;
self
}
}

impl LeaderboardRequest for GetCompetitionRankRequest {
type Response = GetCompetitionRankResponse;
malandis marked this conversation as resolved.
Show resolved Hide resolved

async fn send(self, leaderboard: &Leaderboard) -> MomentoResult<Self::Response> {
let cache_name = leaderboard.cache_name();
let request = prep_leaderboard_request_with_timeout(
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::GetCompetitionRankRequest {
leaderboard: leaderboard.leaderboard_name().to_string(),
ids: self.ids,
order: Some(self.order.into_proto() as i32),
},
)?;

let response = leaderboard
.next_data_client()
.get_competition_rank(request)
.await?
.into_inner();

Ok(Self::Response {
elements: response.elements.iter().map(|v| v.into()).collect(),
})
}
}

pub struct GetCompetitionRankResponse {
elements: Vec<RankedElement>,
}

impl GetCompetitionRankResponse {
pub fn elements(&self) -> &[RankedElement] {
&self.elements
}

pub fn into_elements(self) -> Vec<RankedElement> {
self.elements
}
}
malandis marked this conversation as resolved.
Show resolved Hide resolved
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/get_rank.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ impl LeaderboardRequest for GetRankRequest {
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::GetRankRequest {
cache_name: cache_name.to_string(),
leaderboard: leaderboard.leaderboard_name().to_string(),
ids: self.ids,
order: self.order.into_proto() as i32,
Expand Down
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/length.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ impl LeaderboardRequest for LengthRequest {
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::GetLeaderboardLengthRequest {
cache_name: cache_name.to_string(),
leaderboard: leaderboard.leaderboard_name().to_string(),
},
)?;
Expand Down
1 change: 1 addition & 0 deletions src/leaderboard/messages/data/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ pub mod fetch_by_rank;
/// Contains the request and response types for requesting elements from a
/// leaderboard by score.
pub mod fetch_by_score;
pub mod get_competition_rank;
/// Contains the request and response types for requesting elements from a
/// leaderboard using their element ids.
pub mod get_rank;
Expand Down
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/remove_elements.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ impl LeaderboardRequest for RemoveElementsRequest {
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::RemoveElementsRequest {
cache_name: cache_name.to_string(),
leaderboard: leaderboard.leaderboard_name().to_string(),
ids: self.ids,
},
Expand Down
1 change: 0 additions & 1 deletion src/leaderboard/messages/data/upsert.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ where
cache_name,
leaderboard.client_timeout(),
momento_protos::leaderboard::UpsertElementsRequest {
cache_name: cache_name.to_string(),
leaderboard: leaderboard.leaderboard_name().to_string(),
elements: self
.elements
Expand Down
Loading