load balancer!

CONTRIBUTORS

@@ -179,6 +179,7 @@ Alexander Bocken <alexander@bocken.org>
 James Elmore <email@jameselmore.org>
 David Culley <6276049+davidculley@users.noreply.github.com>
 Rastislav Kish <rastislav.kish@protonmail.com>
+jake <jake@sharnoth.com>
 
 ********************
 

ftl/core/deck-config.ftl

@@ -451,6 +451,13 @@ deck-config-answer-good = Answer Good
 deck-config-days-to-simulate = Days to simulate
 deck-config-desired-retention-below-optimal = Your desired retention is below optimal. Increasing it is recommended.
 
+# Load Balancer
+deck-config-load-balancer-title = Load Balancer
+deck-config-load-balancer-only-count-self = Only count self
+deck-config-load-balancer-only-count-self-tooltip = Cards in this deck only count other cards in this deck when load balancing
+deck-config-load-balancer-hide-from-others = Hide from other decks
+deck-config-load-balancer-hide-from-others-tooltip = Cards in this deck do not count when load balancing other decks.
+
 ## NO NEED TO TRANSLATE. This text is no longer used by Anki, and will be removed in the future.
 
 deck-config-bury-siblings = Bury siblings

ftl/core/notetypes.ftl

@@ -35,6 +35,7 @@ notetypes-note-types = Note Types
 notetypes-options = Options
 notetypes-please-add-another-note-type-first = Please add another note type first.
 notetypes-type = Type
+notetypes-load-balancer-disperse-siblings = Prevent sibling overlap when using Load Balancer
 
 ## Image Occlusion
 

ftl/core/preferences.ftl

@@ -77,6 +77,8 @@ preferences-network-timeout = Network timeout
 preferences-reset-window-sizes = Reset Window Sizes
 preferences-reset-window-sizes-complete = Window sizes and locations have been reset.
 preferences-shortcut-placeholder = Enter an unused shortcut key, or leave empty to disable.
+preferences-load-balancer = Load Balancer
+preferences-load-balancer-enable = Enable Load Balancer
 
 ## NO NEED TO TRANSLATE. This text is no longer used by Anki, and will be removed in the future.
 

proto/anki/config.proto

@@ -54,6 +54,7 @@ message ConfigKey {
     RANDOM_ORDER_REPOSITION = 23;
     SHIFT_POSITION_OF_EXISTING_CARDS = 24;
     RENDER_LATEX = 25;
+    LOAD_BALANCER_ENABLE = 26;
   }
   enum String {
     SET_DUE_BROWSER = 0;
@@ -115,6 +116,7 @@ message Preferences {
     bool show_remaining_due_counts = 3;
     bool show_intervals_on_buttons = 4;
     uint32 time_limit_secs = 5;
+    bool load_balancer_enable = 6;
   }
   message Editing {
     bool adding_defaults_to_current_deck = 1;

proto/anki/deck_config.proto

@@ -164,6 +164,9 @@ message DeckConfig {
     float historical_retention = 40;
     string weight_search = 45;
 
+    bool load_balancer_only_count_self = 47;
+    bool load_balancer_hide_from_others = 48;
+
     bytes other = 255;
   }
 

proto/anki/notetypes.proto

@@ -74,6 +74,8 @@ message Notetype {
     // the id in the source collection for imported notetypes (Anki 23.10)
     optional int64 original_id = 10;
 
+    bool load_balancer_disperse_siblings = 11;
+
     bytes other = 255;
   }
   message Field {

qt/aqt/forms/modelopts.ui

@@ -64,6 +64,39 @@
        </item>
       </layout>
      </widget>
+     <widget class="QWidget" name="tab_2">
+      <attribute name="title">
+       <string>preferences_load_balancer</string>
+      </attribute>
+      <layout class="QVBoxLayout" name="verticalLayout_3">
+       <item>
+        <widget class="QCheckBox" name="disperseSiblings">
+         <property name="sizePolicy">
+          <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+           <horstretch>0</horstretch>
+           <verstretch>0</verstretch>
+          </sizepolicy>
+         </property>
+         <property name="text">
+          <string>notetypes_load_balancer_disperse_siblings</string>
+         </property>
+        </widget>
+       </item>
+       <item>
+        <spacer name="verticalSpacer">
+         <property name="orientation">
+          <enum>Qt::Vertical</enum>
+         </property>
+         <property name="sizeHint" stdset="0">
+          <size>
+           <width>20</width>
+           <height>40</height>
+          </size>
+         </property>
+        </spacer>
+       </item>
+      </layout>
+     </widget>
     </widget>
    </item>
    <item>

qt/aqt/forms/preferences.ui

@@ -450,6 +450,22 @@
          </item>
         </layout>
        </item>
+       <item>
+        <widget class="QGroupBox" name="groupBox">
+         <property name="title">
+          <string>preferences_load_balancer</string>
+         </property>
+         <layout class="QVBoxLayout" name="verticalLayout_7">
+          <item>
+           <widget class="QCheckBox" name="load_balancer_enable">
+            <property name="text">
+             <string>preferences_load_balancer_enable</string>
+            </property>
+           </widget>
+          </item>
+         </layout>
+        </widget>
+       </item>
        <item>
         <spacer name="verticalSpacer_12">
          <property name="orientation">

qt/aqt/models.py

@@ -192,6 +192,7 @@ def onAdvanced(self) -> None:
         frm.latexsvg.setChecked(nt.get("latexsvg", False))
         frm.latexHeader.setText(nt["latexPre"])
         frm.latexFooter.setText(nt["latexPost"])
+        frm.disperseSiblings.setChecked(nt.get("loadBalancerDisperseSiblings", True))
         d.setWindowTitle(
             without_unicode_isolation(tr.actions_options_for(val=nt["name"]))
         )
@@ -203,6 +204,7 @@ def onAdvanced(self) -> None:
         nt["latexsvg"] = frm.latexsvg.isChecked()
         nt["latexPre"] = str(frm.latexHeader.toPlainText())
         nt["latexPost"] = str(frm.latexFooter.toPlainText())
+        nt["loadBalancerDisperseSiblings"] = frm.disperseSiblings.isChecked()
         update_notetype_legacy(parent=self, notetype=nt).success(
             self.refresh_list
         ).run_in_background()

qt/aqt/preferences.py

@@ -125,6 +125,7 @@ def setup_collection(self) -> None:
         form.showProgress.setChecked(reviewing.show_remaining_due_counts)
         form.showPlayButtons.setChecked(not reviewing.hide_audio_play_buttons)
         form.interrupt_audio.setChecked(reviewing.interrupt_audio_when_answering)
+        form.load_balancer_enable.setChecked(reviewing.load_balancer_enable)
 
         editing = self.prefs.editing
         form.useCurrent.setCurrentIndex(
@@ -157,6 +158,7 @@ def update_collection(self, on_done: Callable[[], None]) -> None:
         reviewing.time_limit_secs = form.timeLimit.value() * 60
         reviewing.hide_audio_play_buttons = not self.form.showPlayButtons.isChecked()
         reviewing.interrupt_audio_when_answering = self.form.interrupt_audio.isChecked()
+        reviewing.load_balancer_enable = self.form.load_balancer_enable.isChecked()
 
         editing = self.prefs.editing
         editing.adding_defaults_to_current_deck = not form.useCurrent.currentIndex()

rslib/src/backend/config.rs

@@ -37,6 +37,7 @@ impl From<BoolKeyProto> for BoolKey {
             BoolKeyProto::RandomOrderReposition => BoolKey::RandomOrderReposition,
             BoolKeyProto::ShiftPositionOfExistingCards => BoolKey::ShiftPositionOfExistingCards,
             BoolKeyProto::RenderLatex => BoolKey::RenderLatex,
+            BoolKeyProto::LoadBalancerEnable => BoolKey::LoadBalancerEnable,
         }
     }
 }

rslib/src/collection/mod.rs

@@ -25,6 +25,7 @@ use crate::notetype::Notetype;
 use crate::notetype::NotetypeId;
 use crate::progress::ProgressState;
 use crate::scheduler::queue::CardQueues;
+use crate::scheduler::states::load_balancer::LoadBalancer;
 use crate::scheduler::SchedulerInfo;
 use crate::storage::SchemaVersion;
 use crate::storage::SqliteStorage;
@@ -138,6 +139,7 @@ pub struct CollectionState {
     /// identical backups.
     pub(crate) last_backup_modified: Option<TimestampMillis>,
     pub(crate) progress: Arc<Mutex<ProgressState>>,
+    pub(crate) load_balancer: Option<LoadBalancer>,
 }
 
 pub struct Collection {

rslib/src/config/bool.rs

@@ -40,6 +40,7 @@ pub enum BoolKey {
     WithScheduling,
     WithDeckConfigs,
     Fsrs,
+    LoadBalancerEnable,
     #[strum(to_string = "normalize_note_text")]
     NormalizeNoteText,
     #[strum(to_string = "dayLearnFirst")]

rslib/src/deckconfig/mod.rs

@@ -80,6 +80,8 @@ const DEFAULT_DECK_CONFIG_INNER: DeckConfigInner = DeckConfigInner {
     historical_retention: 0.9,
     weight_search: String::new(),
     ignore_revlogs_before_date: String::new(),
+    load_balancer_only_count_self: false,
+    load_balancer_hide_from_others: false,
 };
 
 impl Default for DeckConfig {

rslib/src/deckconfig/schema11.rs

@@ -92,6 +92,10 @@ pub struct DeckConfSchema11 {
     sm2_retention: f32,
     #[serde(default)]
     weight_search: String,
+    #[serde(default)]
+    load_balancer_only_count_self: bool,
+    #[serde(default)]
+    load_balancer_hide_from_others: bool,
 
     #[serde(flatten)]
     other: HashMap<String, Value>,
@@ -309,6 +313,8 @@ impl Default for DeckConfSchema11 {
             sm2_retention: 0.9,
             weight_search: "".to_string(),
             ignore_revlogs_before_date: "".to_string(),
+            load_balancer_only_count_self: false,
+            load_balancer_hide_from_others: false,
         }
     }
 }
@@ -388,6 +394,8 @@ impl From<DeckConfSchema11> for DeckConfig {
                 desired_retention: c.desired_retention,
                 historical_retention: c.sm2_retention,
                 weight_search: c.weight_search,
+                load_balancer_only_count_self: c.load_balancer_only_count_self,
+                load_balancer_hide_from_others: c.load_balancer_hide_from_others,
                 other: other_bytes,
             },
         }
@@ -499,6 +507,8 @@ impl From<DeckConfig> for DeckConfSchema11 {
             sm2_retention: i.historical_retention,
             weight_search: i.weight_search,
             ignore_revlogs_before_date: i.ignore_revlogs_before_date,
+            load_balancer_only_count_self: i.load_balancer_only_count_self,
+            load_balancer_hide_from_others: i.load_balancer_hide_from_others,
         }
     }
 }
@@ -531,6 +541,8 @@ static RESERVED_DECKCONF_KEYS: Set<&'static str> = phf_set! {
     "sm2Retention",
     "weightSearch",
     "ignoreRevlogsBeforeDate",
+    "loadBalancerOnlyCountSelf",
+    "loadBalancerHideFromOthers",
 };
 
 static RESERVED_DECKCONF_NEW_KEYS: Set<&'static str> = phf_set! {

rslib/src/notetype/mod.rs

@@ -111,6 +111,7 @@ impl Notetype {
             css: DEFAULT_CSS.into(),
             latex_pre: DEFAULT_LATEX_HEADER.into(),
             latex_post: DEFAULT_LATEX_FOOTER.into(),
+            load_balancer_disperse_siblings: true,
             ..Default::default()
         }
     }

rslib/src/notetype/schema11.rs

@@ -23,6 +23,7 @@ use crate::notetype::NoteFieldConfig;
 use crate::notetype::Notetype;
 use crate::notetype::NotetypeConfig;
 use crate::serde::default_on_invalid;
+use crate::serde::default_true;
 use crate::serde::deserialize_bool_from_anything;
 use crate::serde::deserialize_number_from_string;
 use crate::serde::is_default;
@@ -66,6 +67,8 @@ pub struct NotetypeSchema11 {
     pub(crate) original_stock_kind: i32,
     #[serde(default, skip_serializing_if = "is_default")]
     pub(crate) original_id: Option<i64>,
+    #[serde(default = "default_true", skip_serializing_if = "is_default")]
+    pub(crate) load_balancer_disperse_siblings: bool,
     #[serde(flatten)]
     pub(crate) other: HashMap<String, Value>,
 }
@@ -112,6 +115,7 @@ impl From<NotetypeSchema11> for Notetype {
                 reqs: nt.req.0.into_iter().map(Into::into).collect(),
                 original_stock_kind: nt.original_stock_kind,
                 original_id: nt.original_id,
+                load_balancer_disperse_siblings: nt.load_balancer_disperse_siblings,
                 other: other_to_bytes(&nt.other),
             },
             fields: nt.flds.into_iter().map(Into::into).collect(),
@@ -176,6 +180,7 @@ impl From<Notetype> for NotetypeSchema11 {
             req: CardRequirementsSchema11(c.reqs.into_iter().map(Into::into).collect()),
             original_stock_kind: c.original_stock_kind,
             original_id: c.original_id,
+            load_balancer_disperse_siblings: c.load_balancer_disperse_siblings,
             other: parse_other_fields(&c.other, &RESERVED_NOTETYPE_KEYS),
         }
     }
@@ -197,7 +202,8 @@ static RESERVED_NOTETYPE_KEYS: Set<&'static str> = phf_set! {
     "tmpls",
     "type",
     "sortf",
-    "latexsvg"
+    "latexsvg",
+    "loadBalancerDisperseSiblings",
 };
 
 impl From<CardRequirementSchema11> for CardRequirement {

rslib/src/preferences.rs

@@ -98,6 +98,7 @@ impl Collection {
             show_intervals_on_buttons: self
                 .get_config_bool(BoolKey::ShowIntervalsAboveAnswerButtons),
             time_limit_secs: self.get_answer_time_limit_secs(),
+            load_balancer_enable: self.get_config_bool(BoolKey::LoadBalancerEnable),
         })
     }
 
@@ -117,6 +118,12 @@ impl Collection {
             s.show_intervals_on_buttons,
         )?;
         self.set_answer_time_limit_secs(s.time_limit_secs)?;
+
+        self.set_config_bool_inner(BoolKey::LoadBalancerEnable, s.load_balancer_enable)?;
+        if !s.load_balancer_enable {
+            self.state.load_balancer = None;
+        }
+
         Ok(())
     }