[Eprod-974] Process Poll Timer

src/upgrader_canister/src/canister.rs

@@ -4,13 +4,15 @@ use candid::Principal;
 use ic_canister::{init, post_upgrade, query, update, Canister, MethodType, PreUpdate};
 use ic_exports::ic_kit::ic;
 use ic_stable_structures::stable_structures::Memory;
+use log::info;
 use upgrader_canister_did::error::Result;
 use upgrader_canister_did::{
     BuildData, Permission, PermissionList, Poll, PollCreateData, PollType, ProjectData,
     UpgraderCanisterInitData, UpgraderError,
 };
 
 use crate::build_data::canister_build_data;
+use crate::constant::POLL_TIMER_INTERVAL;
 use crate::state::permission::Permissions;
 use crate::state::UpgraderCanisterState;
 
@@ -30,7 +32,9 @@ impl PreUpdate for UpgraderCanister {
 
 impl UpgraderCanister {
     #[post_upgrade]
-    pub fn post_upgrade(&mut self) {}
+    pub fn post_upgrade(&mut self) {
+        self.set_timers();
+    }
 
     #[init]
     pub fn init(&mut self, data: UpgraderCanisterInitData) {
@@ -39,7 +43,29 @@ impl UpgraderCanister {
             permissions
                 .add_permissions(data.admin, vec![Permission::Admin])
                 .expect("failed to add admin permission");
-        })
+        });
+        self.set_timers();
+    }
+
+    /// Initializes the timers
+    pub fn set_timers(&mut self) {
+        // This block of code only need to be run in the wasm environment
+        if cfg!(target_family = "wasm") {
+            use ic_exports::ic_cdk_timers::set_timer_interval;
+
+            set_timer_interval(POLL_TIMER_INTERVAL, move || {
+                STATE.with(|state| {
+                    let mut permissions = state.permissions.borrow_mut();
+                    state
+                        .polls
+                        .borrow_mut()
+                        .finalize_polls(time_secs(), &mut permissions)
+                        .expect("Finalize polls error");
+                });
+            });
+        } else {
+            info!("Not setting timers as not in wasm environment");
+        }
     }
 
     /// Returns the build data of the canister
@@ -83,10 +109,10 @@ impl UpgraderCanister {
     ) -> Result<PermissionList> {
         STATE.with(|state| {
             state.permissions.borrow().check_admin(&ic::caller())?;
-            Ok(state
+            state
                 .permissions
                 .borrow_mut()
-                .remove_permissions(principal, &permissions))
+                .remove_permissions(principal, &permissions)
         })
     }
 
@@ -156,6 +182,18 @@ impl UpgraderCanister {
         STATE.with(|state| state.polls.borrow().get(&id))
     }
 
+    /// Returns a poll by id searching in the pending polls
+    #[query]
+    pub fn poll_get_pending(&self, id: u64) -> Option<Poll> {
+        STATE.with(|state| state.polls.borrow().get_pending(&id))
+    }
+
+    /// Returns a poll by id searching in the closed polls
+    #[query]
+    pub fn poll_get_closed(&self, id: u64) -> Option<Poll> {
+        STATE.with(|state| state.polls.borrow().get_closed(&id))
+    }
+
     /// Inspects permissions for the poll_create method
     pub fn poll_create_inspect<M: Memory>(
         permissions: &Permissions<M>,

src/upgrader_canister/src/constant.rs

@@ -1,5 +1,11 @@
+use std::time::Duration;
+
 pub(crate) const PERMISSIONS_MAP_MEMORY_ID: u8 = 1;
 pub(crate) const PROJECTS_MAP_MEMORY_ID: u8 = 2;
-pub(crate) const POLLS_MAP_MEMORY_ID: u8 = 3;
-pub(crate) const POLLS_ID_SEQUENCE_MEMORY_ID: u8 = 4;
-pub(crate) const SETTINGS_MAP_MEMORY_ID: u8 = 5;
+pub(crate) const POLLS_PENDING_MAP_MEMORY_ID: u8 = 3;
+pub(crate) const POLLS_CLOSED_MAP_MEMORY_ID: u8 = 4;
+pub(crate) const POLLS_ID_SEQUENCE_MEMORY_ID: u8 = 5;
+pub(crate) const SETTINGS_MAP_MEMORY_ID: u8 = 6;
+
+/// The interval at which the poll timer should run
+pub const POLL_TIMER_INTERVAL: Duration = Duration::from_secs(600);

src/upgrader_canister/src/state/permission.rs

@@ -100,7 +100,8 @@ impl<M: Memory> Permissions<M> {
         &mut self,
         principal: Principal,
         permissions: &[Permission],
-    ) -> PermissionList {
+    ) -> Result<PermissionList> {
+        self.check_anonymous_principal(&principal)?;
         let mut existing_permissions = self.permission_data.get(&principal).unwrap_or_default();
         existing_permissions
             .permissions
@@ -111,7 +112,7 @@ impl<M: Memory> Permissions<M> {
         } else {
             self.permission_data.remove(&principal);
         }
-        existing_permissions
+        Ok(existing_permissions)
     }
 
     /// Return the user permissions
@@ -232,14 +233,16 @@ mod tests {
 
         assert_eq!(
             PermissionList::default(),
-            permissions.remove_permissions(
-                principal,
-                &[
-                    Permission::VotePoll,
-                    Permission::CreatePoll,
-                    Permission::Admin
-                ]
-            )
+            permissions
+                .remove_permissions(
+                    principal,
+                    &[
+                        Permission::VotePoll,
+                        Permission::CreatePoll,
+                        Permission::Admin
+                    ]
+                )
+                .unwrap()
         );
         assert_eq!(
             PermissionList::default(),
@@ -250,6 +253,7 @@ mod tests {
             PermissionList::default(),
             permissions
                 .remove_permissions(principal, &[Permission::VotePoll, Permission::CreatePoll])
+                .unwrap()
         );
         assert_eq!(
             PermissionList::default(),
@@ -359,12 +363,21 @@ mod tests {
 
         // remove permissions
         {
-            permissions.remove_permissions(principal_1, &[Permission::CreatePoll]);
-            permissions.remove_permissions(principal_2, &[Permission::CreatePoll]);
-            permissions.remove_permissions(principal_3, &[Permission::CreatePoll]);
-            permissions.remove_permissions(principal_4, &[Permission::CreatePoll]);
             permissions
-                .remove_permissions(principal_5, &[Permission::CreatePoll, Permission::VotePoll]);
+                .remove_permissions(principal_1, &[Permission::CreatePoll])
+                .unwrap();
+            permissions
+                .remove_permissions(principal_2, &[Permission::CreatePoll])
+                .unwrap();
+            permissions
+                .remove_permissions(principal_3, &[Permission::CreatePoll])
+                .unwrap();
+            permissions
+                .remove_permissions(principal_4, &[Permission::CreatePoll])
+                .unwrap();
+            permissions
+                .remove_permissions(principal_5, &[Permission::CreatePoll, Permission::VotePoll])
+                .unwrap();
 
             // Assert
             assert!(!permissions.has_all_permissions(&principal_1, &[Permission::CreatePoll]));
@@ -501,7 +514,9 @@ mod tests {
             .unwrap();
         assert_eq!(Ok(()), permissions.check_admin(&principal_1));
 
-        permissions.remove_permissions(principal_1, &[Permission::Admin]);
+        permissions
+            .remove_permissions(principal_1, &[Permission::Admin])
+            .unwrap();
         assert_eq!(
             Err(UpgraderError::NotAuthorized),
             permissions.check_admin(&principal_1)