Scaling tweaks (#9653)

* refactor: update throttling factor calculation and add unit tests for scaling behavior * refactor: adjust throttling factor calculation for improved accuracy in different configurations * Update src/mesh/Default.h Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update src/mesh/Default.h Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * refactor: enhance throttling factor calculation and introduce pow_of_2 utility function * refactor: improve expected ms calculation in unit tests for Default::getConfiguredOrDefaultMsScaled * refactor: improve scaling logic for routers and sensors in computeExpectedMs function --------- Co-authored-by: Ben Meadors <benmmeadors@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-28 12:03:22 -04:00 · 2026-03-04 11:59:42 +00:00
parent 153ab81a9f
commit b7bf251798
4 changed files with 134 additions and 20 deletions
--- a/test/test_default/test_main.cpp
+++ b/test/test_default/test_main.cpp
@@ -0,0 +1,109 @@
+// Unit tests for Default::getConfiguredOrDefaultMsScaled
+#include "Default.h"
+#include "MeshRadio.h"
+#include "TestUtil.h"
+#include "meshUtils.h"
+#include <unity.h>
+
+// Helper to compute expected ms using same logic as Default::congestionScalingCoefficient
+static uint32_t computeExpectedMs(uint32_t defaultSeconds, uint32_t numOnlineNodes)
+{
+    uint32_t baseMs = Default::getConfiguredOrDefaultMs(0, defaultSeconds);
+
+    // Routers don't scale
+    if (config.device.role == meshtastic_Config_DeviceConfig_Role_ROUTER) {
+        return baseMs;
+    }
+
+    // Sensors and trackers don't scale
+    if ((config.device.role == meshtastic_Config_DeviceConfig_Role_SENSOR) ||
+        (config.device.role == meshtastic_Config_DeviceConfig_Role_TRACKER)) {
+        return baseMs;
+    }
+
+    if (numOnlineNodes <= 40) {
+        return baseMs;
+    }
+
+    float bwKHz =
+        config.lora.use_preset ? modemPresetToBwKHz(config.lora.modem_preset, false) : bwCodeToKHz(config.lora.bandwidth);
+
+    uint8_t sf = config.lora.spread_factor;
+    if (sf < 7)
+        sf = 7;
+    else if (sf > 12)
+        sf = 12;
+
+    float throttlingFactor = static_cast<float>(pow_of_2(sf)) / (bwKHz * 100.0f);
+#if USERPREFS_EVENT_MODE
+    throttlingFactor = static_cast<float>(pow_of_2(sf)) / (bwKHz * 25.0f);
+#endif
+
+    int nodesOverForty = (numOnlineNodes - 40);
+    float coeff = 1.0f + (nodesOverForty * throttlingFactor);
+    return static_cast<uint32_t>(baseMs * coeff + 0.5f);
+}
+
+void test_router_no_scaling()
+{
+    config.device.role = meshtastic_Config_DeviceConfig_Role_ROUTER;
+    // set some sane lora config so bootstrap paths are deterministic
+    config.lora.use_preset = false;
+    config.lora.spread_factor = 9;
+    config.lora.bandwidth = 250;
+
+    uint32_t res = Default::getConfiguredOrDefaultMsScaled(0, 60, 100);
+    uint32_t expected = computeExpectedMs(60, 100);
+    TEST_ASSERT_EQUAL_UINT32(expected, res);
+}
+
+void test_client_below_threshold()
+{
+    config.device.role = meshtastic_Config_DeviceConfig_Role_CLIENT;
+    config.lora.use_preset = false;
+    config.lora.spread_factor = 9;
+    config.lora.bandwidth = 250;
+
+    uint32_t res = Default::getConfiguredOrDefaultMsScaled(0, 60, 40);
+    uint32_t expected = computeExpectedMs(60, 40);
+    TEST_ASSERT_EQUAL_UINT32(expected, res);
+}
+
+void test_client_default_preset_scaling()
+{
+    config.device.role = meshtastic_Config_DeviceConfig_Role_CLIENT;
+    config.lora.use_preset = false;
+    config.lora.spread_factor = 9; // SF9
+    config.lora.bandwidth = 250;   // 250 kHz
+
+    uint32_t res = Default::getConfiguredOrDefaultMsScaled(0, 60, 50);
+    uint32_t expected = computeExpectedMs(60, 50); // nodesOverForty = 10
+    TEST_ASSERT_EQUAL_UINT32(expected, res);
+}
+
+void test_client_medium_fast_preset_scaling()
+{
+    config.device.role = meshtastic_Config_DeviceConfig_Role_CLIENT;
+    config.lora.use_preset = true;
+    config.lora.modem_preset = meshtastic_Config_LoRaConfig_ModemPreset_MEDIUM_FAST;
+    // nodesOverForty = 30 -> test with nodes=70
+    uint32_t res = Default::getConfiguredOrDefaultMsScaled(0, 60, 70);
+    uint32_t expected = computeExpectedMs(60, 70);
+    // Allow ±1 ms tolerance for floating-point rounding
+    TEST_ASSERT_INT_WITHIN(1, expected, res);
+}
+
+void setup()
+{
+    // Small delay to match other test mains
+    delay(10);
+    initializeTestEnvironment();
+    UNITY_BEGIN();
+    RUN_TEST(test_router_no_scaling);
+    RUN_TEST(test_client_below_threshold);
+    RUN_TEST(test_client_default_preset_scaling);
+    RUN_TEST(test_client_medium_fast_preset_scaling);
+    exit(UNITY_END());
+}
+
+void loop() {}