diff --git a/src/build_queue.rs b/src/build_queue.rs index 8a0187c98..43e04ab3d 100644 --- a/src/build_queue.rs +++ b/src/build_queue.rs @@ -15,6 +15,10 @@ use std::sync::Arc; use tokio::runtime::Runtime; use tracing::{debug, error, info}; +// Threshold priority to decide whether a crate will in the rebuild-queue-list. +// If crate is in the rebuild-queue-list it won't in the build-queue-list. +pub(crate) const REBUILD_PRIORITY: i32 = 20; + #[derive(Debug, Clone, Eq, PartialEq, serde::Serialize)] pub(crate) struct QueuedCrate { #[serde(skip)] diff --git a/src/web/releases.rs b/src/web/releases.rs index c06e5e633..58c4c33fa 100644 --- a/src/web/releases.rs +++ b/src/web/releases.rs @@ -1,7 +1,7 @@ //! Releases web handlers use crate::{ - build_queue::QueuedCrate, + build_queue::{QueuedCrate, REBUILD_PRIORITY}, cdn, impl_axum_webpage, utils::{report_error, retry_async}, web::{ @@ -22,6 +22,7 @@ use axum::{ use base64::{engine::general_purpose::STANDARD as b64, Engine}; use chrono::{DateTime, Utc}; use futures_util::stream::TryStreamExt; +use itertools::Itertools; use once_cell::sync::Lazy; use rinja::Template; use serde::{Deserialize, Serialize}; @@ -782,16 +783,24 @@ pub(crate) async fn activity_handler(mut conn: DbConnection) -> AxumResult, + rebuild_queue: Vec, active_cdn_deployments: Vec, in_progress_builds: Vec<(String, String)>, csp_nonce: String, + expand_rebuild_queue: bool, } impl_axum_webpage! { BuildQueuePage } +#[derive(Deserialize)] +pub(crate) struct BuildQueueParams { + expand: Option, +} + pub(crate) async fn build_queue_handler( Extension(build_queue): Extension>, mut conn: DbConnection, + Query(params): Query, ) -> AxumResult { let mut active_cdn_deployments: Vec<_> = cdn::queued_or_active_crate_invalidations(&mut conn) .await? @@ -823,7 +832,8 @@ pub(crate) async fn build_queue_handler( .map(|rec| (rec.name, rec.version)) .collect(); - let queue: Vec = build_queue + let mut rebuild_queue = Vec::new(); + let mut queue = build_queue .queued_crates() .await? .into_iter() @@ -833,22 +843,29 @@ pub(crate) async fn build_queue_handler( *name == krate.name && *version == krate.version }) }) - .map(|mut krate| { + .collect_vec(); + + queue.retain_mut(|krate| { + if krate.priority >= REBUILD_PRIORITY { + rebuild_queue.push(krate.clone()); + false + } else { // The priority here is inverted: in the database if a crate has a higher priority it // will be built after everything else, which is counter-intuitive for people not // familiar with docs.rs's inner workings. krate.priority = -krate.priority; - - krate - }) - .collect(); + true + } + }); Ok(BuildQueuePage { description: "crate documentation scheduled to build & deploy", queue, + rebuild_queue, active_cdn_deployments, in_progress_builds, csp_nonce: String::new(), + expand_rebuild_queue: params.expand.is_some(), }) } @@ -1061,7 +1078,7 @@ mod tests { } #[test] - fn search_result_can_retrive_sort_by_from_pagination() { + fn search_result_can_retrieve_sort_by_from_pagination() { wrapper(|env| { let mut crates_io = mockito::Server::new(); env.override_config(|config| { @@ -1838,6 +1855,81 @@ mod tests { }); } + #[test] + fn test_releases_rebuild_queue_empty() { + wrapper(|env| { + let web = env.frontend(); + + let empty = kuchikiki::parse_html().one(web.get("/releases/queue").send()?.text()?); + + assert!(empty + .select(".about > p") + .expect("missing heading") + .any(|el| el.text_contents().contains("We continuously rebuild"))); + + assert!(empty + .select(".about > p") + .expect("missing heading") + .any(|el| el.text_contents().contains("crates in the rebuild queue"))); + + Ok(()) + }); + } + + #[test] + fn test_releases_rebuild_queue_with_crates() { + wrapper(|env| { + let web = env.frontend(); + let queue = env.build_queue(); + queue.add_crate("foo", "1.0.0", REBUILD_PRIORITY, None)?; + queue.add_crate("bar", "0.1.0", REBUILD_PRIORITY + 1, None)?; + queue.add_crate("baz", "0.0.1", REBUILD_PRIORITY - 1, None)?; + + let full = kuchikiki::parse_html().one(web.get("/releases/queue").send()?.text()?); + let items = full + .select(".rebuild-queue-list > li") + .expect("missing list items") + .collect::>(); + + // empty because expand_rebuild_queue is not set + assert_eq!(items.len(), 0); + assert!(full + .select(".about > p") + .expect("missing heading") + .any(|el| el + .text_contents() + .contains("There are currently 2 crates in the rebuild queue"))); + + let full = + kuchikiki::parse_html().one(web.get("/releases/queue?expand=1").send()?.text()?); + let build_queue_list = full + .select(".queue-list > li") + .expect("missing list items") + .collect::>(); + let rebuild_queue_list = full + .select(".rebuild-queue-list > li") + .expect("missing list items") + .collect::>(); + + assert_eq!(build_queue_list.len(), 1); + assert_eq!(rebuild_queue_list.len(), 2); + assert!(rebuild_queue_list + .iter() + .any(|li| li.text_contents().contains("foo"))); + assert!(rebuild_queue_list + .iter() + .any(|li| li.text_contents().contains("bar"))); + assert!(build_queue_list + .iter() + .any(|li| li.text_contents().contains("baz"))); + assert!(!rebuild_queue_list + .iter() + .any(|li| li.text_contents().contains("baz"))); + + Ok(()) + }); + } + #[test] fn home_page_links() { wrapper(|env| { diff --git a/templates/releases/build_queue.html b/templates/releases/build_queue.html index 000eaf41c..9418affd4 100644 --- a/templates/releases/build_queue.html +++ b/templates/releases/build_queue.html @@ -84,9 +84,41 @@ {%- endfor %} {%- else %} - There is nothing in the queue + There is nothing in the build queue {%- endif %} + +
+ Rebuild Queue +
+ +
+

+ We continuously rebuild the latest versions for all crates so they can + benefit from new features in rustdoc. +

+ {%- if !expand_rebuild_queue -%} + {% let rebuild_queue_len = rebuild_queue.len() %} +

There are currently {{ rebuild_queue_len }} crate{{ rebuild_queue_len|pluralize }} in the rebuild queue.

+

Show

+ {%- endif -%} +
+ + {%- if expand_rebuild_queue -%} +
    + {%- if !rebuild_queue.is_empty() -%} + {% for crate_item in rebuild_queue -%} +
  1. + + {{- crate_item.name }} {{ crate_item.version -}} + +
    2. + {%- endfor %} + {%- else %} + There is nothing in the rebuild queue + {%- endif %} +
+ {%- endif -%} {%- endblock body -%} diff --git a/templates/style/style.scss b/templates/style/style.scss index 4a01e6bd7..21832fff8 100644 --- a/templates/style/style.scss +++ b/templates/style/style.scss @@ -262,7 +262,7 @@ div.recent-releases-container { padding: 0; } - ol.queue-list li { + ol.queue-list li, ol.rebuild-queue-list li { list-style-type: decimal; margin-left: 20px; @@ -270,6 +270,10 @@ div.recent-releases-container { color: var(--color-url); } } + + .about p { + margin-left: 20px; + } strong { font-weight: 500;