From 0ccd6636346896a7b001edc8aae2daadefaeb91a Mon Sep 17 00:00:00 2001
From: Hamish Peebles <hamishpeebles@gmail.com>
Date: Mon, 26 Feb 2024 11:21:38 +0000
Subject: [PATCH] Switch over to reading events from stable memory

---
 rs/canister/api/can.did                     |  1 -
 rs/canister/api/src/queries/events.rs       |  1 -
 rs/canister/impl/src/lifecycle/heartbeat.rs |  7 ---
 rs/canister/impl/src/lifecycle/mod.rs       |  1 -
 rs/canister/impl/src/model/events.rs        | 66 ++++-----------------
 rs/canister/impl/src/queries/events.rs      |  1 -
 6 files changed, 13 insertions(+), 64 deletions(-)
 delete mode 100644 rs/canister/impl/src/lifecycle/heartbeat.rs

diff --git a/rs/canister/api/can.did b/rs/canister/api/can.did
index 690578c..d41ab2e 100644
--- a/rs/canister/api/can.did
+++ b/rs/canister/api/can.did
@@ -1,6 +1,5 @@
 type EventsArgs = record { start : nat64; length : nat64 };
 type EventsResponse = record {
-  latest_event_index_in_stable_memory : opt nat64;
   events : vec IndexedEvent;
   latest_event_index : opt nat64;
 };
diff --git a/rs/canister/api/src/queries/events.rs b/rs/canister/api/src/queries/events.rs
index aecb5b7..58ceb0f 100644
--- a/rs/canister/api/src/queries/events.rs
+++ b/rs/canister/api/src/queries/events.rs
@@ -12,5 +12,4 @@ pub struct EventsArgs {
 pub struct EventsResponse {
     pub events: Vec<IndexedEvent>,
     pub latest_event_index: Option<u64>,
-    pub latest_event_index_in_stable_memory: Option<u64>,
 }
diff --git a/rs/canister/impl/src/lifecycle/heartbeat.rs b/rs/canister/impl/src/lifecycle/heartbeat.rs
deleted file mode 100644
index a6fa91b..0000000
--- a/rs/canister/impl/src/lifecycle/heartbeat.rs
+++ /dev/null
@@ -1,7 +0,0 @@
-use crate::state;
-use ic_cdk::heartbeat;
-
-#[heartbeat]
-fn heartbeat() {
-    state::mutate(|s| s.events.migrate(1000));
-}
diff --git a/rs/canister/impl/src/lifecycle/mod.rs b/rs/canister/impl/src/lifecycle/mod.rs
index c5f1281..dc39ebd 100644
--- a/rs/canister/impl/src/lifecycle/mod.rs
+++ b/rs/canister/impl/src/lifecycle/mod.rs
@@ -1,4 +1,3 @@
-mod heartbeat;
 mod init;
 mod post_upgrade;
 mod pre_upgrade;
diff --git a/rs/canister/impl/src/model/events.rs b/rs/canister/impl/src/model/events.rs
index 04e5ea2..ea23afa 100644
--- a/rs/canister/impl/src/model/events.rs
+++ b/rs/canister/impl/src/model/events.rs
@@ -5,69 +5,32 @@ use ic_stable_structures::storable::Bound;
 use ic_stable_structures::{StableLog, Storable};
 use serde::Serialize;
 use std::borrow::Cow;
-use std::collections::VecDeque;
 
 #[derive(Serialize, Deserialize)]
 pub struct Events {
-    events: VecDeque<IndexedEvent>,
-    #[serde(skip, default = "init_events")]
-    events_v2: StableLog<StorableEvent, Memory, Memory>,
-    latest_event_index: Option<u64>,
+    #[serde(alias = "events_v2", skip, default = "init_events")]
+    events: StableLog<StorableEvent, Memory, Memory>,
 }
 
 impl Events {
     pub fn get(&self, start: u64, length: u64) -> Vec<IndexedEvent> {
-        let start_index = start as usize;
-        if start_index < self.events.len() {
-            self.events
-                .range(start_index..)
-                .take(length as usize)
-                .cloned()
-                .collect()
-        } else {
-            Vec::new()
-        }
-    }
-
-    pub fn migrate(&mut self, count: u64) {
-        for event in self.get(self.events_v2.len(), count) {
-            self.events_v2
-                .append(&StorableEvent {
-                    index: event.index,
-                    name: event.name,
-                    timestamp: event.timestamp,
-                    user: event.user,
-                    source: event.source,
-                    payload: event.payload,
-                })
-                .unwrap();
-        }
+        self.events
+            .iter()
+            .skip(start as usize)
+            .take(length as usize)
+            .map(|e| e.into())
+            .collect()
     }
 
     pub fn push(&mut self, event: IdempotentEvent) {
-        let index = self.latest_event_index.map_or(0, |i| i + 1);
-
-        if self.events_v2.len() == index {
-            self.events_v2
-                .append(&StorableEvent::new(event.clone(), index))
-                .unwrap();
-        }
-
-        self.events.push_back(IndexedEvent {
-            index,
-            name: event.name,
-            timestamp: event.timestamp,
-            user: event.user,
-            source: event.source,
-            payload: event.payload,
-        });
-        self.latest_event_index = Some(index);
+        self.events
+            .append(&StorableEvent::new(event.clone(), self.events.len()))
+            .unwrap();
     }
 
     pub fn stats(&self) -> EventsStats {
         EventsStats {
-            latest_event_index: self.latest_event_index,
-            latest_event_index_in_stable_memory: self.events_v2.iter().last().map(|e| e.index),
+            latest_event_index: self.events.iter().last().map(|e| e.index),
         }
     }
 }
@@ -75,9 +38,7 @@ impl Events {
 impl Default for Events {
     fn default() -> Self {
         Events {
-            events: VecDeque::new(),
-            events_v2: init_events(),
-            latest_event_index: None,
+            events: init_events(),
         }
     }
 }
@@ -88,7 +49,6 @@ fn init_events() -> StableLog<StorableEvent, Memory, Memory> {
 
 pub struct EventsStats {
     pub latest_event_index: Option<u64>,
-    pub latest_event_index_in_stable_memory: Option<u64>,
 }
 
 #[derive(Serialize, Deserialize)]
diff --git a/rs/canister/impl/src/queries/events.rs b/rs/canister/impl/src/queries/events.rs
index 93af9bd..724859a 100644
--- a/rs/canister/impl/src/queries/events.rs
+++ b/rs/canister/impl/src/queries/events.rs
@@ -12,7 +12,6 @@ fn events(args: EventsArgs) -> EventsResponse {
         EventsResponse {
             events,
             latest_event_index: stats.latest_event_index,
-            latest_event_index_in_stable_memory: stats.latest_event_index_in_stable_memory,
         }
     })
 }