Add Verions Owner Actions to the API

Contributes to Issue #1548

Author: markcatley

src/controllers/krate/metadata.rs

@@ -7,7 +7,7 @@
 use crate::controllers::prelude::*;
 use crate::models::{
     Category, Crate, CrateCategory, CrateKeyword, CrateVersions, Keyword, RecentCrateDownloads,
-    User, Version,
+    User, Version, VersionOwnerAction,
 };
 use crate::schema::*;
 use crate::views::{
@@ -105,13 +105,31 @@ pub fn show(req: &mut dyn Request) -> AppResult<Response> {
     let conn = req.db_conn()?;
     let krate = Crate::by_name(name).first::<Crate>(&*conn)?;
 
-    let mut versions_and_publishers: Vec<(Version, Option<User>)> = krate
+    let mut versions_and_publishers = krate
         .all_versions()
         .left_outer_join(users::table)
         .select((versions::all_columns, users::all_columns.nullable()))
-        .load(&*conn)?;
+        .load::<(Version, Option<User>)>(&*conn)?;
     versions_and_publishers.sort_by(|a, b| b.0.num.cmp(&a.0.num));
-    let ids = versions_and_publishers.iter().map(|v| v.0.id).collect();
+    let versions = versions_and_publishers
+        .iter()
+        .map(|(v, _)| v)
+        .cloned()
+        .collect::<Vec<_>>();
+    let audit_actions = VersionOwnerAction::belonging_to(&versions)
+        .inner_join(users::table)
+        .order(version_owner_actions::dsl::id)
+        .load::<(VersionOwnerAction, User)>(&*conn)?
+        .grouped_by(&versions);
+    let versions_publishers_and_audit_actions = versions_and_publishers
+        .into_iter()
+        .zip(audit_actions.into_iter())
+        .map(|((v, pb), aas)| (v, pb, aas))
+        .collect::<Vec<_>>();
+    let ids = versions_publishers_and_audit_actions
+        .iter()
+        .map(|v| v.0.id)
+        .collect();
 
     let kws = CrateKeyword::belonging_to(&krate)
         .inner_join(keywords::table)
@@ -149,9 +167,9 @@ pub fn show(req: &mut dyn Request) -> AppResult<Response> {
             false,
             recent_downloads,
         ),
-        versions: versions_and_publishers
+        versions: versions_publishers_and_audit_actions
             .into_iter()
-            .map(|(v, pb)| v.encodable(&krate.name, pb))
+            .map(|(v, pb, aas)| v.encodable(&krate.name, pb, aas))
             .collect(),
         keywords: kws.into_iter().map(Keyword::encodable).collect(),
         categories: cats.into_iter().map(Category::encodable).collect(),
@@ -193,9 +211,20 @@ pub fn versions(req: &mut dyn Request) -> AppResult<Response> {
         .select((versions::all_columns, users::all_columns.nullable()))
         .load(&*conn)?;
     versions_and_publishers.sort_by(|a, b| b.0.num.cmp(&a.0.num));
+    let versions = versions_and_publishers
+        .iter()
+        .map(|(v, _)| v)
+        .cloned()
+        .collect::<Vec<_>>();
+    let audit_actions = VersionOwnerAction::belonging_to(&versions)
+        .inner_join(users::table)
+        .order(version_owner_actions::dsl::id)
+        .load::<(VersionOwnerAction, User)>(&*conn)?
+        .grouped_by(&versions);
     let versions = versions_and_publishers
         .into_iter()
-        .map(|(v, pb)| v.encodable(crate_name, pb))
+        .zip(audit_actions.into_iter())
+        .map(|((v, pb), aas)| v.encodable(crate_name, pb, aas))
         .collect();
 
     #[derive(Serialize)]
@@ -220,7 +249,7 @@ pub fn reverse_dependencies(req: &mut dyn Request) -> AppResult<Response> {
 
     let version_ids: Vec<i32> = rev_deps.iter().map(|dep| dep.version_id).collect();
 
-    let versions = versions::table
+    let versions_and_publishers = versions::table
         .filter(versions::id.eq(any(version_ids)))
         .inner_join(crates::table)
         .left_outer_join(users::table)
@@ -229,9 +258,23 @@ pub fn reverse_dependencies(req: &mut dyn Request) -> AppResult<Response> {
             crates::name,
             users::all_columns.nullable(),
         ))
-        .load::<(Version, String, Option<User>)>(&*conn)?
+        .load::<(Version, String, Option<User>)>(&*conn)?;
+    let versions = versions_and_publishers
+        .iter()
+        .map(|(v, _, _)| v)
+        .cloned()
+        .collect::<Vec<_>>();
+    let audit_actions = VersionOwnerAction::belonging_to(&versions)
+        .inner_join(users::table)
+        .order(version_owner_actions::dsl::id)
+        .load::<(VersionOwnerAction, User)>(&*conn)?
+        .grouped_by(&versions);
+    let versions = versions_and_publishers
         .into_iter()
-        .map(|(version, krate_name, user)| version.encodable(&krate_name, user))
+        .zip(audit_actions.into_iter())
+        .map(|((version, krate_name, published_by), actions)| {
+            version.encodable(&krate_name, published_by, actions)
+        })
         .collect();
 
     #[derive(Serialize)]

src/controllers/user/me.rs

@@ -7,8 +7,12 @@ use crate::email;
 use crate::util::bad_request;
 use crate::util::errors::AppError;
 
-use crate::models::{CrateOwner, Email, Follow, NewEmail, OwnerKind, User, Version};
-use crate::schema::{crate_owners, crates, emails, follows, users, versions};
+use crate::models::{
+    CrateOwner, Email, Follow, NewEmail, OwnerKind, User, Version, VersionOwnerAction,
+};
+use crate::schema::{
+    crate_owners, crates, emails, follows, users, version_owner_actions, versions,
+};
 use crate::views::{EncodableMe, EncodableVersion, OwnedCrate};
 
 /// Handles the `GET /me` route.
@@ -80,12 +84,24 @@ pub fn updates(req: &mut dyn Request) -> AppResult<Response> {
         ))
         .paginate(&req.query())?
         .load::<(Version, String, Option<User>)>(&*conn)?;
-
     let more = data.next_page_params().is_some();
+    let versions = data.iter().map(|(v, _, _)| v).cloned().collect::<Vec<_>>();
+    let audit_actions = VersionOwnerAction::belonging_to(&versions)
+        .inner_join(users::table)
+        .order(version_owner_actions::dsl::id)
+        .load::<(VersionOwnerAction, User)>(&*conn)?
+        .grouped_by(&versions);
+    let data = data
+        .into_iter()
+        .zip(audit_actions.into_iter())
+        .map(|((v, cn, pb), voas)| (v, cn, pb, voas))
+        .collect::<Vec<_>>();
 
     let versions = data
         .into_iter()
-        .map(|(version, crate_name, published_by)| version.encodable(&crate_name, published_by))
+        .map(|(version, crate_name, published_by, actions)| {
+            version.encodable(&crate_name, published_by, actions)
+        })
         .collect();
 
     #[derive(Serialize)]
@@ -234,7 +250,7 @@ pub fn update_email_notifications(req: &mut dyn Request) -> AppResult<Response>
     let user = req.user()?;
     let conn = req.db_conn()?;
 
-    // Build inserts from existing crates beloning to the current user
+    // Build inserts from existing crates belonging to the current user
     let to_insert = CrateOwner::by_owner_kind(OwnerKind::User)
         .filter(owner_id.eq(user.id))
         .select((crate_id, owner_id, owner_kind, email_notifications))

src/controllers/version/deprecated.rs

@@ -7,7 +7,7 @@
 
 use crate::controllers::prelude::*;
 
-use crate::models::{Crate, User, Version};
+use crate::models::{Crate, User, Version, VersionOwnerAction};
 use crate::schema::*;
 use crate::views::EncodableVersion;
 
@@ -22,7 +22,7 @@ pub fn index(req: &mut dyn Request) -> AppResult<Response> {
         .filter_map(|(ref a, ref b)| if *a == "ids[]" { b.parse().ok() } else { None })
         .collect::<Vec<i32>>();
 
-    let versions = versions::table
+    let versions_and_publishers = versions::table
         .inner_join(crates::table)
         .left_outer_join(users::table)
         .select((
@@ -31,9 +31,23 @@ pub fn index(req: &mut dyn Request) -> AppResult<Response> {
             users::all_columns.nullable(),
         ))
         .filter(versions::id.eq(any(ids)))
-        .load::<(Version, String, Option<User>)>(&*conn)?
+        .load::<(Version, String, Option<User>)>(&*conn)?;
+    let versions = versions_and_publishers
+        .iter()
+        .map(|(v, _, _)| v)
+        .cloned()
+        .collect::<Vec<_>>();
+    let audit_actions = VersionOwnerAction::belonging_to(&versions)
+        .inner_join(users::table)
+        .order(version_owner_actions::dsl::id)
+        .load::<(VersionOwnerAction, User)>(&*conn)?
+        .grouped_by(&versions);
+    let versions = versions_and_publishers
         .into_iter()
-        .map(|(version, crate_name, published_by)| version.encodable(&crate_name, published_by))
+        .zip(audit_actions.into_iter())
+        .map(|((version, crate_name, published_by), actions)| {
+            version.encodable(&crate_name, published_by, actions)
+        })
         .collect();
 
     #[derive(Serialize)]
@@ -60,12 +74,13 @@ pub fn show_by_id(req: &mut dyn Request) -> AppResult<Response> {
             users::all_columns.nullable(),
         ))
         .first(&*conn)?;
+    let audit_actions = VersionOwnerAction::by_version_id(&conn, id)?;
 
     #[derive(Serialize)]
     struct R {
         version: EncodableVersion,
     }
     Ok(req.json(&R {
-        version: version.encodable(&krate.name, published_by),
+        version: version.encodable(&krate.name, published_by, audit_actions),
     }))
 }

src/controllers/version/metadata.rs

@@ -6,6 +6,7 @@
 
 use crate::controllers::prelude::*;
 
+use crate::models::{User, VersionOwnerAction};
 use crate::schema::*;
 use crate::views::{EncodableDependency, EncodablePublicUser, EncodableVersion};
 
@@ -70,12 +71,16 @@ pub fn show(req: &mut dyn Request) -> AppResult<Response> {
     let (version, krate) = version_and_crate(req)?;
     let conn = req.db_conn()?;
     let published_by = version.published_by(&conn);
+    let actions = VersionOwnerAction::belonging_to(&version)
+        .inner_join(users::table)
+        .order(version_owner_actions::dsl::id)
+        .load::<(VersionOwnerAction, User)>(&*conn)?;
 
     #[derive(Serialize)]
     struct R {
         version: EncodableVersion,
     }
     Ok(req.json(&R {
-        version: version.encodable(&krate.name, published_by),
+        version: version.encodable(&krate.name, published_by, actions),
     }))
 }

src/models/action.rs

@@ -20,6 +20,24 @@ pub enum VersionAction {
     Unyank = 2,
 }
 
+impl Into<&'static str> for VersionAction {
+    fn into(self) -> &'static str {
+        match self {
+            VersionAction::Publish => "publish",
+            VersionAction::Yank => "yank",
+            VersionAction::Unyank => "unyank",
+        }
+    }
+}
+
+impl Into<String> for VersionAction {
+    fn into(self) -> String {
+        let string: &'static str = self.into();
+
+        string.into()
+    }
+}
+
 impl FromSql<Integer, Pg> for VersionAction {
     fn from_sql(bytes: Option<&[u8]>) -> deserialize::Result<Self> {
         match <i32 as FromSql<Integer, Pg>>::from_sql(bytes)? {
@@ -56,16 +74,16 @@ impl VersionOwnerAction {
         version_owner_actions::table.load(conn)
     }
 
-    pub fn by_version_id_and_action(
+    pub fn by_version_id(
         conn: &PgConnection,
         version_id_: i32,
-        action_: VersionAction,
-    ) -> QueryResult<Vec<VersionOwnerAction>> {
-        use version_owner_actions::dsl::{action, version_id};
+    ) -> QueryResult<Vec<(VersionOwnerAction, User)>> {
+        use version_owner_actions::dsl::version_id;
 
         version_owner_actions::table
             .filter(version_id.eq(version_id_))
-            .filter(action.eq(action_))
+            .inner_join(users::table)
+            .order(version_owner_actions::dsl::id)
             .load(conn)
     }
 }

src/models/version.rs

@@ -5,9 +5,9 @@ use diesel::prelude::*;
 
 use crate::util::{cargo_err, AppResult};
 
-use crate::models::{Crate, Dependency, User};
+use crate::models::{Crate, Dependency, User, VersionOwnerAction};
 use crate::schema::*;
-use crate::views::{EncodableVersion, EncodableVersionLinks};
+use crate::views::{EncodableAuditAction, EncodableVersion, EncodableVersionLinks};
 
 // Queryable has a custom implementation below
 #[derive(Clone, Identifiable, Associations, Debug, Queryable, Deserialize, Serialize)]
@@ -38,7 +38,12 @@ pub struct NewVersion {
 }
 
 impl Version {
-    pub fn encodable(self, crate_name: &str, published_by: Option<User>) -> EncodableVersion {
+    pub fn encodable(
+        self,
+        crate_name: &str,
+        published_by: Option<User>,
+        audit_actions: Vec<(VersionOwnerAction, User)>,
+    ) -> EncodableVersion {
         let Version {
             id,
             num,
@@ -71,6 +76,14 @@ impl Version {
             },
             crate_size,
             published_by: published_by.map(User::encodable_public),
+            audit_actions: audit_actions
+                .into_iter()
+                .map(|(audit_action, user)| EncodableAuditAction {
+                    action: audit_action.action.into(),
+                    user: User::encodable_public(user),
+                    time: audit_action.time,
+                })
+                .collect(),
         }
     }