Merge pull request #110 from CodeGov-org/feat/review-vote

feat: add `vote` field to `ProposalReview`

Author: ilbertt

src/backend/api/backend.did

@@ -208,6 +208,12 @@ type ProposalReviewStatus = variant {
   published;
 };
 
+type ProposalVote = variant {
+  unspecified;
+  yes;
+  no;
+};
+
 type ProposalReview = record {
   proposal_id : text;
   user_id : text;
@@ -219,6 +225,7 @@ type ProposalReview = record {
   build_reproduced : opt bool;
   images_paths : vec text;
   proposal_review_commits : vec ProposalReviewCommitWithId;
+  vote : ProposalVote;
 };
 
 type ProposalReviewWithId = record {
@@ -231,6 +238,7 @@ type CreateProposalReviewRequest = record {
   summary : opt text;
   review_duration_mins : opt nat16;
   build_reproduced : opt bool;
+  vote : opt ProposalVote;
 };
 
 type CreateProposalReviewResponse = variant {
@@ -244,6 +252,7 @@ type UpdateProposalReviewRequest = record {
   summary : opt text;
   review_duration_mins : opt nat16;
   build_reproduced : opt bool;
+  vote : opt ProposalVote;
 };
 
 type UpdateProposalReviewResponse = variant {

src/backend/api/src/proposal_review.rs

@@ -10,6 +10,16 @@ pub enum ProposalReviewStatus {
     Published,
 }
 
+#[derive(Debug, CandidType, Deserialize, Clone, PartialEq, Eq)]
+pub enum ProposalVote {
+    #[serde(rename = "unspecified")]
+    Unspecified,
+    #[serde(rename = "yes")]
+    Yes,
+    #[serde(rename = "no")]
+    No,
+}
+
 #[derive(Debug, CandidType, Deserialize, Clone, PartialEq, Eq)]
 pub struct ProposalReview {
     pub proposal_id: String,
@@ -22,6 +32,7 @@ pub struct ProposalReview {
     pub build_reproduced: Option<bool>,
     pub images_paths: Vec<String>,
     pub proposal_review_commits: Vec<ProposalReviewCommitWithId>,
+    pub vote: ProposalVote,
 }
 
 #[derive(Debug, Clone, CandidType, Deserialize, PartialEq, Eq)]
@@ -36,6 +47,7 @@ pub struct CreateProposalReviewRequest {
     pub summary: Option<String>,
     pub review_duration_mins: Option<u16>,
     pub build_reproduced: Option<bool>,
+    pub vote: Option<ProposalVote>,
 }
 
 pub type CreateProposalReviewResponse = ProposalReviewWithId;
@@ -47,6 +59,7 @@ pub struct UpdateProposalReviewRequest {
     pub summary: Option<String>,
     pub review_duration_mins: Option<u16>,
     pub build_reproduced: Option<bool>,
+    pub vote: Option<ProposalVote>,
 }
 
 #[derive(Debug, Clone, CandidType, Deserialize, PartialEq, Eq)]

src/backend/impl/src/controllers/proposal_review_controller.rs

@@ -219,6 +219,7 @@ mod tests {
         fixtures,
         services::{MockAccessControlService, MockProposalReviewService},
     };
+    use backend_api::ProposalVote;
     use mockall::predicate::*;
     use rstest::*;
 
@@ -230,6 +231,7 @@ mod tests {
             summary: Some("summary".to_string()),
             review_duration_mins: Some(10),
             build_reproduced: Some(true),
+            vote: Some(ProposalVote::Yes),
         };
         let response = CreateProposalReviewResponse {
             id: "id".to_string(),
@@ -272,6 +274,7 @@ mod tests {
             summary: Some("summary".to_string()),
             review_duration_mins: Some(10),
             build_reproduced: Some(true),
+            vote: Some(ProposalVote::No),
         };
         let error = ApiError::permission_denied(&format!(
             "Principal {} must be a reviewer to call this endpoint",
@@ -312,6 +315,7 @@ mod tests {
             summary: Some("summary".to_string()),
             review_duration_mins: Some(10),
             build_reproduced: Some(true),
+            vote: Some(ProposalVote::Yes),
         };
 
         let mut access_control_service_mock = MockAccessControlService::new();
@@ -347,6 +351,7 @@ mod tests {
             summary: Some("summary".to_string()),
             review_duration_mins: Some(10),
             build_reproduced: Some(true),
+            vote: None,
         };
         let error = ApiError::permission_denied(&format!(
             "Principal {} must be a reviewer to call this endpoint",

src/backend/impl/src/fixtures/proposal_review.rs

@@ -1,6 +1,6 @@
 use rstest::*;
 
-use crate::repositories::{ProposalReview, ProposalReviewStatus};
+use crate::repositories::{ProposalReview, ProposalReviewStatus, ProposalVote};
 
 use super::{date_time_a, proposal_id, user_id, uuid};
 
@@ -16,6 +16,7 @@ pub fn proposal_review_draft() -> ProposalReview {
         review_duration_mins: Some(60),
         build_reproduced: Some(true),
         images_ids: vec![],
+        vote: ProposalVote::Unspecified,
     }
 }
 
@@ -31,6 +32,7 @@ pub fn proposal_review_published() -> ProposalReview {
         review_duration_mins: Some(60),
         build_reproduced: Some(true),
         images_ids: vec![uuid()],
+        vote: ProposalVote::Yes,
     }
 }
 

src/backend/impl/src/mappings/proposal_review.rs

@@ -1,6 +1,6 @@
 use crate::repositories::{
     ProposalReview, ProposalReviewCommit, ProposalReviewCommitId, ProposalReviewId,
-    ProposalReviewStatus,
+    ProposalReviewStatus, ProposalVote,
 };
 
 use super::map_proposal_review_commits;
@@ -23,6 +23,26 @@ impl From<backend_api::ProposalReviewStatus> for ProposalReviewStatus {
     }
 }
 
+impl From<backend_api::ProposalVote> for ProposalVote {
+    fn from(vote: backend_api::ProposalVote) -> Self {
+        match vote {
+            backend_api::ProposalVote::Unspecified => ProposalVote::Unspecified,
+            backend_api::ProposalVote::Yes => ProposalVote::Yes,
+            backend_api::ProposalVote::No => ProposalVote::No,
+        }
+    }
+}
+
+impl From<ProposalVote> for backend_api::ProposalVote {
+    fn from(vote: ProposalVote) -> Self {
+        match vote {
+            ProposalVote::Unspecified => backend_api::ProposalVote::Unspecified,
+            ProposalVote::Yes => backend_api::ProposalVote::Yes,
+            ProposalVote::No => backend_api::ProposalVote::No,
+        }
+    }
+}
+
 impl From<ProposalReview> for backend_api::ProposalReview {
     fn from(proposal_review: ProposalReview) -> Self {
         backend_api::ProposalReview {
@@ -36,6 +56,7 @@ impl From<ProposalReview> for backend_api::ProposalReview {
             build_reproduced: proposal_review.build_reproduced,
             images_paths: vec![],
             proposal_review_commits: vec![],
+            vote: proposal_review.vote.into(),
         }
     }
 }

src/backend/impl/src/repositories/types/proposal_review.rs

@@ -17,6 +17,15 @@ pub enum ProposalReviewStatus {
     Published,
 }
 
+/// Same as `ic_nns_governance::pb::v1::Vote`.
+#[derive(Debug, CandidType, Deserialize, Clone, PartialEq, Eq)]
+#[repr(i32)]
+pub enum ProposalVote {
+    Unspecified = 0,
+    Yes = 1,
+    No = 2,
+}
+
 #[derive(Debug, CandidType, Deserialize, Clone, PartialEq, Eq)]
 pub struct ProposalReview {
     pub proposal_id: ProposalId,
@@ -28,6 +37,7 @@ pub struct ProposalReview {
     pub review_duration_mins: Option<u16>,
     pub build_reproduced: Option<bool>,
     pub images_ids: Vec<ImageId>,
+    pub vote: ProposalVote,
 }
 
 impl ProposalReview {