Skip to content

WIP: add paginated versions API #5302

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

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 43 additions & 8 deletions src/controllers/krate/metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ use std::cmp::Reverse;
use std::str::FromStr;

use crate::controllers::frontend_prelude::*;
use crate::controllers::helpers::pagination::PaginationOptions;
use crate::controllers::helpers::pagination::{Paginated, PaginationOptions};
use crate::controllers::helpers::Paginate;

use crate::models::{
Category, Crate, CrateCategory, CrateKeyword, CrateVersions, Keyword, RecentCrateDownloads,
Expand Down Expand Up @@ -320,15 +321,38 @@ pub async fn readme(
/// Handles the `GET /crates/:crate_id/versions` route.
// FIXME: Not sure why this is necessary since /crates/:crate_id returns
// this information already, but ember is definitely requesting it
pub async fn versions(state: AppState, Path(crate_name): Path<String>) -> AppResult<Json<Value>> {
pub async fn versions(
state: AppState,
Path(crate_name): Path<String>,
req: Parts,
) -> AppResult<Json<Value>> {
conduit_compat(move || {
let conn = state.db_read()?;
let krate: Crate = Crate::by_name(&crate_name).first(&*conn)?;
let mut versions_and_publishers: Vec<(Version, Option<User>)> = krate
.all_versions()
.left_outer_join(users::table)
.select((versions::all_columns, users::all_columns.nullable()))
.load(&*conn)?;
// to keep retrocompatibility, we paginate only if per_page parameter is present
let (mut versions_and_publishers, meta) = if req.query().get("per_page").is_some() {
let pagination_options = PaginationOptions::builder().gather(&req)?;
let data: Paginated<(Version, Option<User>)> = krate
.all_versions()
.left_outer_join(users::table)
.select((versions::all_columns, users::all_columns.nullable()))
.order(versions::created_at.desc())
.pages_pagination(pagination_options)
.load(&conn)?;
let more = data.next_page_params().is_some();

(
data.into_iter().collect::<Vec<_>>(),
Some(json!({ "more": more })),
)
} else {
let data: Vec<(Version, Option<User>)> = krate
.all_versions()
.left_outer_join(users::table)
.select((versions::all_columns, users::all_columns.nullable()))
.load(&*conn)?;
(data, None)
};

versions_and_publishers
.sort_by_cached_key(|(version, _)| Reverse(semver::Version::parse(&version.num).ok()));
Expand All @@ -344,7 +368,18 @@ pub async fn versions(state: AppState, Path(crate_name): Path<String>) -> AppRes
.map(|((v, pb), aas)| EncodableVersion::from(v, &crate_name, pb, aas))
.collect::<Vec<_>>();

Ok(Json(json!({ "versions": versions })))
// probably here would be simplier with a concrete response type
let response = if let Some(meta) = meta {
json!({
"versions": versions,
"meta": meta,
})
} else {
json!({
"versions": versions,
})
};
Ok(Json(response))
})
.await
}
Expand Down