Consider cards already reviewed today when calculating new/review ratio

CONTRIBUTORS

@@ -118,7 +118,7 @@ yellowjello <github.com/yellowjello>
 Ingemar Berg <github.com/ingemarberg>
 Ben Kerman <ben@kermanic.org>
 Euan Kemp <euank@euank.com>
-Kieran Black <kieranlblack@gmail.com> 
+Kieran Black <kieranlblack@gmail.com>
 XeR <github.com/XeR>
 mgrottenthaler <github.com/mgrottenthaler>
 Austin Siew <github.com/Aquafina-water-bottle>
@@ -138,7 +138,7 @@ Monty Evans <montyevans@gmail.com>
 Nil Admirari <https://github.com/nihil-admirari>
 Michael Winkworth <github.com/SteelColossus>
 Mateusz Wojewoda <kawa1.11@o2.pl>
-Jarrett Ye <jarrett.ye@outlook.com> 
+Jarrett Ye <jarrett.ye@outlook.com>
 Sam Waechter <github.com/swektr>
 Michael Eliachevitch <m.eliachevitch@posteo.de>
 Carlo Quick <https://github.com/CarloQuick>
@@ -187,10 +187,11 @@ Christian Donat <https://github.com/cdonat2>
 Asuka Minato <https://asukaminato.eu.org>
 Dillon Baldwin <https://github.com/DillBal>
 Voczi <https://github.com/voczi>
-Ben Nguyen <105088397+bpnguyen107@users.noreply.github.com>   
+Ben Nguyen <105088397+bpnguyen107@users.noreply.github.com>
 Themis Demetriades <themis100@outlook.com>
 Gregory Abrasaldo <degeemon@gmail.com>
 Taylor Obyen <https://github.com/taylorobyen>
+Kris Cherven <krischerven@gmail.com>
 
 ********************
 

rslib/src/import_export/package/colpkg/export.rs

@@ -62,7 +62,7 @@ impl Collection {
         self.close(Some(if legacy {
             SchemaVersion::V11
         } else {
-            SchemaVersion::V18
+            SchemaVersion::V19
         }))?;
 
         export_collection_file(

rslib/src/import_export/package/meta.rs

@@ -36,7 +36,7 @@ impl VersionExt for Version {
         match self {
             Version::Unknown => unreachable!(),
             Version::Legacy1 | Version::Legacy2 => SchemaVersion::V11,
-            Version::Latest => SchemaVersion::V18,
+            Version::Latest => SchemaVersion::V19,
         }
     }
 }

rslib/src/scheduler/queue/builder/intersperser.rs

@@ -12,6 +12,7 @@ where
     two_idx: usize,
     one_len: usize,
     two_len: usize,
+    one_add: i32,
     ratio: f32,
 }
 
@@ -20,7 +21,7 @@ where
     I: ExactSizeIterator,
     I2: ExactSizeIterator<Item = I::Item>,
 {
-    pub fn new(one: I, two: I2) -> Self {
+    pub fn new(one: I, two: I2, one_add: i32) -> Self {
         let one_len = one.len();
         let two_len = two.len();
         let ratio = (one_len + 1) as f32 / (two_len + 1) as f32;
@@ -31,6 +32,7 @@ where
             two_idx: 0,
             one_len,
             two_len,
+            one_add,
             ratio,
         }
     }
@@ -73,7 +75,7 @@ where
         match (self.one_idx(), self.two_idx()) {
             (Some(idx1), Some(idx2)) => {
                 let relative_idx2 = (idx2 + 1) as f32 * self.ratio;
-                if relative_idx2 < (idx1 + 1) as f32 {
+                if relative_idx2 < (idx1 + 1 + (self.one_add as usize)) as f32 {
                     self.next_two()
                 } else {
                     self.next_one()
@@ -103,7 +105,7 @@ mod test {
     use super::Intersperser;
 
     fn intersperse(a: &[u32], b: &[u32]) -> Vec<u32> {
-        Intersperser::new(a.iter().cloned(), b.iter().cloned()).collect()
+        Intersperser::new(a.iter().cloned(), b.iter().cloned(), 0).collect()
     }
 
     #[test]

rslib/src/scheduler/queue/builder/mod.rs

@@ -109,6 +109,7 @@ pub(super) struct QueueBuilder {
     limits: LimitTreeMap,
     load_balancer: LoadBalancer,
     context: Context,
+    excess_reviews: i32,
 }
 
 /// Data container and helper for building queues.
@@ -168,6 +169,7 @@ impl QueueBuilder {
                 deck_map,
                 fsrs: col.get_config_bool(BoolKey::Fsrs),
             },
+            excess_reviews: col.storage.get_excess_reviews_for_deck(deck_id),
         })
     }
 
@@ -192,11 +194,13 @@ impl QueueBuilder {
             self.review,
             self.day_learning,
             self.context.sort_options.day_learn_mix,
+            self.excess_reviews,
         );
         let main_iter = merge_new(
             with_interday_learn,
             self.new,
             self.context.sort_options.new_review_mix,
+            self.excess_reviews,
         );
 
         CardQueues {
@@ -239,28 +243,36 @@ fn merge_day_learning(
     reviews: Vec<DueCard>,
     day_learning: Vec<DueCard>,
     mode: ReviewMix,
+    excess_reviews: i32,
 ) -> Box<dyn ExactSizeIterator<Item = MainQueueEntry>> {
     let day_learning_iter = day_learning.into_iter().map(Into::into);
     let reviews_iter = reviews.into_iter().map(Into::into);
 
     match mode {
         ReviewMix::AfterReviews => Box::new(SizedChain::new(reviews_iter, day_learning_iter)),
         ReviewMix::BeforeReviews => Box::new(SizedChain::new(day_learning_iter, reviews_iter)),
-        ReviewMix::MixWithReviews => Box::new(Intersperser::new(reviews_iter, day_learning_iter)),
+        ReviewMix::MixWithReviews => Box::new(Intersperser::new(
+            reviews_iter,
+            day_learning_iter,
+            excess_reviews,
+        )),
     }
 }
 
 fn merge_new(
     review_iter: impl ExactSizeIterator<Item = MainQueueEntry> + 'static,
     new: Vec<NewCard>,
     mode: ReviewMix,
+    excess_reviews: i32,
 ) -> Box<dyn ExactSizeIterator<Item = MainQueueEntry>> {
     let new_iter = new.into_iter().map(Into::into);
 
     match mode {
         ReviewMix::BeforeReviews => Box::new(SizedChain::new(new_iter, review_iter)),
         ReviewMix::AfterReviews => Box::new(SizedChain::new(review_iter, new_iter)),
-        ReviewMix::MixWithReviews => Box::new(Intersperser::new(review_iter, new_iter)),
+        ReviewMix::MixWithReviews => {
+            Box::new(Intersperser::new(review_iter, new_iter, excess_reviews))
+        }
     }
 }
 

rslib/src/storage/mod.rs

@@ -24,7 +24,7 @@ pub(crate) use sqlite::SqliteStorage;
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum SchemaVersion {
     V11,
-    V18,
+    V19,
 }
 
 impl SchemaVersion {

rslib/src/storage/revlog/mod.rs

@@ -21,6 +21,11 @@ pub(crate) struct StudiedToday {
     pub seconds: f64,
 }
 
+#[derive(Debug)]
+pub(crate) struct ExcessReviews {
+    pub reviews: u32,
+}
+
 impl FromSql for RevlogReviewKind {
     fn column_result(value: ValueRef<'_>) -> std::result::Result<Self, FromSqlError> {
         if let ValueRef::Integer(i) = value {
@@ -83,6 +88,35 @@ impl SqliteStorage {
                 entry.taken_millis,
                 entry.review_kind as u8
             ])?;
+
+        let cid = entry.cid;
+        let card = self.get_card(cid);
+
+        if let Ok(Some(card)) = card {
+            let deck_id = card.deck_id;
+            if entry.review_kind == RevlogReviewKind::Review {
+                self.db
+                  .execute_batch(&format!(
+                      concat!(
+                          "insert or ignore into excess_reviews (deck_id, reviews) values ({}, {});",
+                          "update excess_reviews set reviews=reviews+1 where deck_id={}"
+                      ),
+                      deck_id, 0, deck_id
+                  ))
+                  .unwrap();
+            } else {
+                self.db
+                  .execute_batch(&format!(
+                      concat!(
+                          "insert or ignore into excess_reviews (deck_id, reviews) values ({}, {});",
+                          "update excess_reviews set reviews=0 where deck_id={}"
+                      ),
+                      deck_id, 0, deck_id
+                  ))
+                  .unwrap();
+            }
+        }
+
         Ok((added > 0).then(|| RevlogId(self.db.last_insert_rowid())))
     }
 
@@ -183,6 +217,27 @@ impl SqliteStorage {
             .map_err(Into::into)
     }
 
+    pub(crate) fn get_excess_reviews_for_deck_1(&self, deck_id: DeckId) -> Result<ExcessReviews> {
+        self.db
+            .prepare_cached("select reviews from excess_reviews where deck_id == ? limit 1")?
+            .query_map([deck_id], |row| {
+                Ok(ExcessReviews {
+                    reviews: row.get(0)?,
+                })
+            })?
+            .next()
+            .unwrap_or(Ok(ExcessReviews { reviews: 0 }))
+            .map_err(Into::into)
+    }
+
+    pub(crate) fn get_excess_reviews_for_deck(&self, deck_id: DeckId) -> i32 {
+        self.get_excess_reviews_for_deck_1(deck_id)
+            .unwrap_or(ExcessReviews { reviews: 0 })
+            .reviews
+            .try_into()
+            .unwrap()
+    }
+
     pub(crate) fn upgrade_revlog_to_v2(&self) -> Result<()> {
         self.db
             .execute_batch(include_str!("v2_upgrade.sql"))

rslib/src/storage/upgrades/mod.rs

@@ -6,7 +6,7 @@ pub(super) const SCHEMA_MIN_VERSION: u8 = 11;
 /// The version new files are initially created with.
 pub(super) const SCHEMA_STARTING_VERSION: u8 = 11;
 /// The maximum schema version we can open.
-pub(super) const SCHEMA_MAX_VERSION: u8 = 18;
+pub(super) const SCHEMA_MAX_VERSION: u8 = 19;
 
 use super::SchemaVersion;
 use super::SqliteStorage;
@@ -40,6 +40,10 @@ impl SqliteStorage {
             self.db
                 .execute_batch(include_str!("schema18_upgrade.sql"))?;
         }
+        if ver < 19 {
+            self.db
+                .execute_batch(include_str!("schema19_upgrade.sql"))?;
+        }
 
         // in some future schema upgrade, we may want to change
         // _collapsed to _expanded in DeckCommon and invert existing values, so
@@ -52,13 +56,15 @@ impl SqliteStorage {
     pub(super) fn downgrade_to(&self, ver: SchemaVersion) -> Result<()> {
         match ver {
             SchemaVersion::V11 => self.downgrade_to_schema_11(),
-            SchemaVersion::V18 => Ok(()),
+            SchemaVersion::V19 => Ok(()),
         }
     }
 
     fn downgrade_to_schema_11(&self) -> Result<()> {
         self.begin_trx()?;
 
+        self.db
+            .execute_batch(include_str!("schema19_downgrade.sql"))?;
         self.db
             .execute_batch(include_str!("schema18_downgrade.sql"))?;
         self.downgrade_deck_conf_from_schema16()?;
@@ -85,10 +91,10 @@ mod test {
 
     #[test]
     #[allow(clippy::assertions_on_constants)]
-    fn assert_18_is_latest_schema_version() {
+    fn assert_19_is_latest_schema_version() {
         assert_eq!(
-            18, SCHEMA_MAX_VERSION,
-            "must implement SqliteStorage::downgrade_to(SchemaVersion::V18)"
+            19, SCHEMA_MAX_VERSION,
+            "must implement SqliteStorage::downgrade_to(SchemaVersion::V19)"
         );
     }
 

rslib/src/storage/upgrades/schema19_downgrade.sql

@@ -0,0 +1,3 @@
+DROP TABLE excess_reviews;
+UPDATE col
+SET ver = 18;

rslib/src/storage/upgrades/schema19_upgrade.sql

@@ -0,0 +1,6 @@
+CREATE TABLE excess_reviews (
+  deck_id integer PRIMARY KEY,
+  reviews integer NOT NULL
+);
+UPDATE col
+SET ver = 19;

rslib/src/sync/collection/upload.rs

@@ -43,7 +43,7 @@ impl Collection {
         self.before_upload()?;
         let col_path = self.col_path.clone();
         let progress = self.new_progress_handler();
-        self.close(Some(SchemaVersion::V18))?;
+        self.close(Some(SchemaVersion::V19))?;
         let col_data = fs::read(&col_path)?;
 
         let total_bytes = col_data.len();

rslib/src/sync/version.rs

@@ -74,7 +74,7 @@ impl SyncVersion {
         if self.is_multipart() {
             SchemaVersion::V11
         } else {
-            SchemaVersion::V18
+            SchemaVersion::V19
         }
     }
 }