Fix SwSh eggs again. Throttle logging so program doesn't freeze is serial spams messages.

Author: Mysticial

ClientSource/Connection/MessageLogger.cpp

@@ -4,6 +4,7 @@
  *
  */
 
+#include "Common/Cpp/PrettyPrint.h"
 #include "Common/SerialPABotBase/SerialPABotBase_Protocol.h"
 #include "ClientSource/Libraries/MessageConverter.h"
 #include "BotBaseMessage.h"
@@ -83,17 +84,45 @@ void MessageLogger::on_recv(const BotBaseMessage& message){
 SerialLogger::SerialLogger(Logger& logger, bool log_everything)
     : MessageLogger(log_everything)
     , m_logger(logger)
+    , m_history(1000)
 {}
 void SerialLogger::log(const char* msg, Color color){
-    m_logger.log(msg, color);
+    if (ok_to_log()){
+        m_logger.log(msg, color);
+    }
 }
 void SerialLogger::log(const std::string& msg, Color color){
-    m_logger.log(msg, color);
+    if (ok_to_log()){
+        m_logger.log(msg, color);
+    }
 }
 void SerialLogger::log(std::string msg){
-    m_logger.log(msg, COLOR_DARKGREEN);
+    if (ok_to_log()){
+        m_logger.log(msg, COLOR_DARKGREEN);
+    }
 }
 
+bool SerialLogger::ok_to_log(){
+    WallClock now = current_time();
+    WriteSpinLock lg(m_lock);
+    while (!m_history.empty()){
+        if (now - m_history.front() < std::chrono::seconds(1)){
+            break;
+        }
+        m_history.pop_front();
+    }
+    if (!m_history.try_push_back(now)){
+        m_messages_dropped++;
+        return false;
+    }
+
+    if (m_messages_dropped != 0){
+        m_logger.log("Dropped " + tostr_u_commas(m_messages_dropped) + " message(s) due to logging rate limit.", COLOR_RED);
+        m_messages_dropped = 0;
+    }
+
+    return true;
+}
 
 
 

ClientSource/Connection/MessageLogger.h

@@ -9,6 +9,9 @@
 
 #include <atomic>
 #include "Common/Cpp/AbstractLogger.h"
+#include "Common/Cpp/Time.h"
+#include "Common/Cpp/Containers/CircularBuffer.h"
+#include "Common/Cpp/Concurrency/SpinLock.h"
 #include "MessageSniffer.h"
 
 namespace PokemonAutomation{
@@ -45,8 +48,14 @@ class SerialLogger : public Logger, public MessageLogger{
     virtual void log(const std::string& msg, Color color = Color()) override;
     virtual void log(std::string msg) override;
 
+private:
+    bool ok_to_log();
+
 private:
     Logger& m_logger;
+    SpinLock m_lock;
+    size_t m_messages_dropped = 0;
+    CircularBuffer<WallClock> m_history;
 };
 
 

Common/Cpp/Concurrency/AsyncDispatcher.cpp

@@ -7,6 +7,7 @@
 #include "Common/Cpp/PanicDump.h"
 #include "AsyncDispatcher.h"
 
+//#include <Windows.h>
 //#include <iostream>
 //using std::cout;
 //using std::endl;
@@ -62,6 +63,7 @@ AsyncDispatcher::~AsyncDispatcher(){
         m_cv.notify_all();
     }
     for (std::thread& thread : m_threads){
+//        cout << "AsyncDispatcher::~AsyncDispatcher() joining = " << thread.get_id() << endl;
         thread.join();
     }
     for (AsyncTask* task : m_queue){
@@ -144,6 +146,7 @@ void AsyncDispatcher::run_in_parallel(
 
 
 void AsyncDispatcher::thread_loop(){
+//    cout << "AsyncDispatcher::thread_loop() Start = " << GetCurrentThreadId() << ", threads = " << m_threads.size() << endl;
     if (m_new_thread_callback){
         m_new_thread_callback();
     }
@@ -158,6 +161,9 @@ void AsyncDispatcher::thread_loop(){
             }
 
             if (m_stopping){
+//                cout << "AsyncDispatcher::thread_loop() End (inside-start) = " << GetCurrentThreadId() << endl;
+//                Sleep(10000);
+//                cout << "AsyncDispatcher::thread_loop() End (inside-done) = " << GetCurrentThreadId() << endl;
                 return;
             }
             if (m_queue.empty()){
@@ -185,6 +191,7 @@ void AsyncDispatcher::thread_loop(){
         }
         task->signal();
     }
+//    cout << "AsyncDispatcher::thread_loop() End (outside) = " << GetCurrentThreadId() << endl;
 }
 
 

Common/Cpp/Containers/CircularBuffer.h

@@ -42,6 +42,8 @@ class CircularBuffer{
 
     template <class... Args>
     Object& push_back(Args&&... args);
+    template <class... Args>
+    Object* try_push_back(Args&&... args);
     void pop_front();
 
 private:
@@ -174,6 +176,20 @@ Object& CircularBuffer<Object>::push_back(Args&&... args){
     m_back++;
     return m_ptr[back];
 }
+template <typename Object>
+template <class... Args>
+Object* CircularBuffer<Object>::try_push_back(Args&&... args){
+    if (m_back - m_front >= m_capacity){
+        return nullptr;
+    }
+    size_t back = m_back;
+    if (back >= m_capacity){
+        back -= m_capacity;
+    }
+    new (m_ptr + back) Object(std::forward<Args>(args)...);
+    m_back++;
+    return &m_ptr[back];
+}
 
 template <typename Object>
 void CircularBuffer<Object>::pop_front(){

SerialPrograms/Source/CommonFramework/Globals.cpp

@@ -26,7 +26,7 @@ namespace PokemonAutomation{
 const bool IS_BETA_VERSION = true;
 const int PROGRAM_VERSION_MAJOR = 0;
 const int PROGRAM_VERSION_MINOR = 52;
-const int PROGRAM_VERSION_PATCH = 11;
+const int PROGRAM_VERSION_PATCH = 13;
 
 const std::string PROGRAM_VERSION_BASE =
     "v" + std::to_string(PROGRAM_VERSION_MAJOR) +

SerialPrograms/Source/PokemonSwSh/PokemonSwSh_Settings.cpp

@@ -213,7 +213,7 @@ GameSettings::GameSettings()
         0.3, 0
     )
     , LINE_SPARKLE_ALPHA(
-        "<b>Star Sparkle Alpha:</b>",
+        "<b>Line Sparkle Alpha:</b>",
         LockMode::LOCK_WHILE_RUNNING,
         0.3, 0
     )

SerialPrograms/Source/PokemonSwSh/Programs/EggPrograms/PokemonSwSh_EggAutonomous.cpp

@@ -869,7 +869,7 @@ void EggAutonomous::mash_B_until_y_comm_icon(
     int ret = run_until<ProControllerContext>(
         env.console, context,
         [](ProControllerContext& context){
-            pbf_mash_button(context, BUTTON_B, 1000ms);
+            pbf_mash_button(context, BUTTON_B, 10s);
         },
         {y_comm_detector}
     );