Add a include_yanked parameter to /api/v1/crates

Add a URL parameter to the `/api/v1/crates` endpoint that specifies
whether or not the endpoint should return crates that have been fully
yanked - i.e., where every version has been yanked.

If not specified, this defaults to `true` because we have typically
always returned all matching crates, whether or not their versions have
been yanked.

This makes it possible to display only non-yanked crates at various
places in the UI, and is especially intended for the user and team pages
to display only non-yanked crates, as discussed in #958.

Author: bryanburgers

src/controllers/krate/search.rs

@@ -1,5 +1,6 @@
 //! Endpoint for searching and discovery functionality
 
+use diesel::dsl::*;
 use diesel_full_text_search::*;
 
 use crate::controllers::helpers::Paginate;
@@ -41,6 +42,10 @@ pub fn search(req: &mut dyn Request) -> CargoResult<Response> {
         .get("sort")
         .map(|s| &**s)
         .unwrap_or("recent-downloads");
+    let include_yanked = params
+        .get("include_yanked")
+        .map(|s| url_boolean(s))
+        .unwrap_or(true);
 
     let mut query = crates::table
         .left_join(recent_crate_downloads::table)
@@ -139,6 +144,14 @@ pub fn search(req: &mut dyn Request) -> CargoResult<Response> {
         );
     }
 
+    if !include_yanked {
+        query = query.filter(exists(
+            versions::table
+                .filter(versions::crate_id.eq(crates::id))
+                .filter(versions::yanked.eq(false)),
+        ));
+    }
+
     if sort == "downloads" {
         query = query.then_order_by(crates::downloads.desc())
     } else if sort == "recent-downloads" {
@@ -208,3 +221,11 @@ pub fn search(req: &mut dyn Request) -> CargoResult<Response> {
         meta: Meta { total },
     }))
 }
+
+/// Takes a string that might represent a boolean in a URL and converts it into a boolean.
+fn url_boolean(value: &str) -> bool {
+    match value.to_lowercase().as_ref() {
+        "y" | "yes" | "t" | "true" | "1" => true,
+        _ => false,
+    }
+}

src/tests/krate.rs

@@ -414,6 +414,49 @@ fn exact_match_on_queries_with_sort() {
     assert_eq!(json.crates[3].name, "other_sort");
 }
 
+#[test]
+fn index_include_yanked() {
+    let (app, anon, user) = TestApp::init().with_user();
+    let user = user.as_model();
+
+    app.db(|conn| {
+        CrateBuilder::new("unyanked", user.id)
+            .version(VersionBuilder::new("1.0.0"))
+            .version(VersionBuilder::new("2.0.0"))
+            .expect_build(conn);
+
+        CrateBuilder::new("newest_yanked", user.id)
+            .version(VersionBuilder::new("1.0.0"))
+            .version(VersionBuilder::new("2.0.0").yanked(true))
+            .expect_build(conn);
+
+        CrateBuilder::new("oldest_yanked", user.id)
+            .version(VersionBuilder::new("1.0.0").yanked(true))
+            .version(VersionBuilder::new("2.0.0"))
+            .expect_build(conn);
+
+        CrateBuilder::new("all_yanked", user.id)
+            .version(VersionBuilder::new("1.0.0").yanked(true))
+            .version(VersionBuilder::new("2.0.0").yanked(true))
+            .expect_build(conn);
+    });
+
+    // Include fully yanked (all versions were yanked) crates
+    let json = anon.search("include_yanked=y&sort=alphabetical");
+    assert_eq!(json.meta.total, 4);
+    assert_eq!(json.crates[0].name, "all_yanked");
+    assert_eq!(json.crates[1].name, "newest_yanked");
+    assert_eq!(json.crates[2].name, "oldest_yanked");
+    assert_eq!(json.crates[3].name, "unyanked");
+
+    // Do not include fully yanked (all versions were yanked) crates
+    let json = anon.search("include_yanked=n&sort=alphabetical");
+    assert_eq!(json.meta.total, 3);
+    assert_eq!(json.crates[0].name, "newest_yanked");
+    assert_eq!(json.crates[1].name, "oldest_yanked");
+    assert_eq!(json.crates[2].name, "unyanked");
+}
+
 #[test]
 fn show() {
     let (app, anon, user) = TestApp::init().with_user();