controllers/summary: Expose the yanked field

Author: eth3lbert

src/controllers/summary.rs

@@ -34,7 +34,7 @@ pub async fn summary(state: AppState) -> AppResult<Json<Value>> {
 
         fn encode_crates(
             conn: &mut impl Conn,
-            data: Vec<(Crate, i64, Option<i64>, Option<String>)>,
+            data: Vec<Record>,
         ) -> AppResult<Vec<EncodableCrate>> {
             let krates = data.iter().map(|(c, ..)| c).collect::<Vec<_>>();
             let versions: Vec<Version> = krates.versions().load(conn)?;
@@ -43,17 +43,19 @@ pub async fn summary(state: AppState) -> AppResult<Json<Value>> {
                 .into_iter()
                 .map(TopVersions::from_versions)
                 .zip(data)
-                .map(|(top_versions, (krate, total, recent, default_version))| {
-                    Ok(EncodableCrate::from_minimal(
-                        krate,
-                        default_version.as_deref(),
-                        None,
-                        Some(&top_versions),
-                        false,
-                        total,
-                        recent,
-                    ))
-                })
+                .map(
+                    |(top_versions, (krate, total, recent, default_version, yanked))| {
+                        Ok(EncodableCrate::from_minimal(
+                            krate,
+                            default_version.as_deref(),
+                            yanked,
+                            Some(&top_versions),
+                            false,
+                            total,
+                            recent,
+                        ))
+                    },
+                )
                 .collect()
         }
 
@@ -62,6 +64,7 @@ pub async fn summary(state: AppState) -> AppResult<Json<Value>> {
             crate_downloads::downloads,
             recent_crate_downloads::downloads.nullable(),
             versions::num.nullable(),
+            versions::yanked.nullable(),
         );
 
         let new_crates = crates::table
@@ -137,3 +140,5 @@ pub async fn summary(state: AppState) -> AppResult<Json<Value>> {
     })
     .await
 }
+
+type Record = (Crate, i64, Option<i64>, Option<String>, Option<bool>);

src/tests/routes/summary.rs

@@ -100,6 +100,7 @@ async fn summary_new_crates() {
         json.most_downloaded[0].default_version,
         Some("0.2.0".into())
     );
+    assert_eq!(json.most_downloaded[0].yanked, Some(false));
     assert_eq!(json.most_downloaded[0].downloads, 5000);
     assert_eq!(json.most_downloaded[0].recent_downloads, Some(50));
     assert_eq!(
@@ -110,23 +111,27 @@ async fn summary_new_crates() {
         json.most_recently_downloaded[0].default_version,
         Some("0.2.0".into())
     );
+    assert_eq!(json.most_recently_downloaded[0].yanked, Some(false));
     assert_eq!(json.most_recently_downloaded[0].recent_downloads, Some(50));
     assert_eq!(json.popular_keywords[0].keyword, "popular");
     assert_eq!(json.popular_categories[0].category, "Category 1");
     assert_eq!(json.just_updated.len(), 2);
 
     assert_eq!(json.just_updated[0].name, "just_updated_patch");
     assert_eq!(json.just_updated[0].default_version, Some("0.2.0".into()));
+    assert_eq!(json.just_updated[0].yanked, Some(false));
     assert_eq!(json.just_updated[0].max_version, "0.2.0");
     assert_eq!(json.just_updated[0].newest_version, "0.1.1");
 
     assert_eq!(json.just_updated[1].name, "just_updated");
     assert_eq!(json.just_updated[1].default_version, Some("0.1.2".into()));
+    assert_eq!(json.just_updated[1].yanked, Some(false));
     assert_eq!(json.just_updated[1].max_version, "0.1.2");
     assert_eq!(json.just_updated[1].newest_version, "0.1.2");
 
     assert_eq!(json.new_crates[0].name, "with_downloads");
     assert_eq!(json.new_crates[0].default_version, Some("0.3.0".into()));
+    assert_eq!(json.new_crates[0].yanked, Some(false));
     assert_eq!(json.new_crates.len(), 5);
 }
 
@@ -172,6 +177,7 @@ async fn excluded_crate_id() {
         json.most_downloaded[0].default_version,
         Some("0.1.0".into())
     );
+    assert_eq!(json.most_downloaded[0].yanked, Some(false));
     assert_eq!(json.most_downloaded[0].downloads, 20);
 
     assert_eq!(json.most_recently_downloaded.len(), 1);
@@ -180,5 +186,61 @@ async fn excluded_crate_id() {
         json.most_recently_downloaded[0].default_version,
         Some("0.1.0".into())
     );
+    assert_eq!(json.most_recently_downloaded[0].yanked, Some(false));
+    assert_eq!(json.most_recently_downloaded[0].recent_downloads, Some(10));
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn all_yanked() {
+    let (app, anon, user) = TestApp::init()
+        .with_config(|config| {
+            config.excluded_crate_names = vec![
+                "most_recent_downloads".into(),
+                // make sure no error occurs with a crate name that doesn't exist and that the name
+                // matches are exact, not substrings
+                "downloads".into(),
+            ];
+        })
+        .with_user();
+
+    let mut conn = app.db_conn();
+    let user = user.as_model();
+
+    CrateBuilder::new("some_downloads", user.id)
+        .version(VersionBuilder::new("0.1.0").yanked(true))
+        .version(VersionBuilder::new("0.2.0").yanked(true))
+        .description("description")
+        .keyword("popular")
+        .category("cat1")
+        .downloads(20)
+        .recent_downloads(10)
+        .expect_build(&mut conn);
+
+    CrateBuilder::new("most_recent_downloads", user.id)
+        .version(VersionBuilder::new("0.2.0"))
+        .keyword("popular")
+        .category("cat1")
+        .downloads(5000)
+        .recent_downloads(50)
+        .expect_build(&mut conn);
+
+    let json: SummaryResponse = anon.get("/api/v1/summary").await.good();
+
+    assert_eq!(json.most_downloaded.len(), 1);
+    assert_eq!(json.most_downloaded[0].name, "some_downloads");
+    assert_eq!(
+        json.most_downloaded[0].default_version,
+        Some("0.2.0".into())
+    );
+    assert_eq!(json.most_downloaded[0].yanked, Some(true));
+    assert_eq!(json.most_downloaded[0].downloads, 20);
+
+    assert_eq!(json.most_recently_downloaded.len(), 1);
+    assert_eq!(json.most_recently_downloaded[0].name, "some_downloads");
+    assert_eq!(
+        json.most_recently_downloaded[0].default_version,
+        Some("0.2.0".into())
+    );
+    assert_eq!(json.most_recently_downloaded[0].yanked, Some(true));
     assert_eq!(json.most_recently_downloaded[0].recent_downloads, Some(10));
 }