More work on stream history. Add support for video in error reports.

Author: Mysticial

Common/Cpp/Exceptions.cpp

@@ -11,6 +11,9 @@ namespace PokemonAutomation{
 
 
 
+void Exception::log(Logger& logger) const{
+    logger.log(std::string(name()) + ": " + message(), COLOR_RED);
+}
 std::string Exception::message() const{
     return "";
 }

Common/Cpp/Exceptions.h

@@ -7,12 +7,21 @@
 #ifndef PokemonAutomation_Exceptions_H
 #define PokemonAutomation_Exceptions_H
 
+#include <utility>
 #include "Common/Compiler.h"
 #include "AbstractLogger.h"
 
 namespace PokemonAutomation{
 
 
+template <typename ExceptionType, class... Args>
+[[noreturn]] void throw_and_log(Logger& logger, Args&&... args){
+    ExceptionType exception(std::forward<Args>(args)...);
+    exception.log(logger);
+    throw exception;
+}
+
+
 //  Definitions:
 //      Catch:   To catch the exception using a try-catch.
 //      Consume: To catch the exception and not rethrow it.
@@ -22,6 +31,8 @@ namespace PokemonAutomation{
 class Exception{
 public:
     virtual ~Exception() = default;
+
+    virtual void log(Logger& logger) const;
     virtual const char* name() const = 0;
     virtual std::string message() const;
     virtual std::string to_str() const;

SerialPrograms/Source/CommonFramework/AudioPipeline/Backends/AudioPassthroughPairQt.cpp

@@ -57,13 +57,12 @@ class AudioPassthroughPairQt::SampleListener final : public AudioFloatStreamList
         if (parent.m_writer){
             parent.m_writer->operator AudioFloatStreamListener&().on_samples(data, frames);
         }
-        for (AudioFloatStreamListener* listener : m_parent.m_stream_listeners){
-            listener->on_samples(data, frames);
-        }
         if (parent.m_fft_runner){
             parent.m_fft_runner->on_samples(data, frames);
         }
-
+        for (AudioFloatStreamListener* listener : m_parent.m_stream_listeners){
+            listener->on_samples(data, frames);
+        }
     }
 
 private:

SerialPrograms/Source/CommonFramework/ErrorReports/ErrorReports.cpp

@@ -15,6 +15,7 @@
 #include "CommonFramework/Logging/Logger.h"
 #include "CommonFramework/Notifications/ProgramNotifications.h"
 #include "CommonFramework/Options/Environment/ThemeSelectorOption.h"
+#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "ProgramDumper.h"
 #include "ErrorReports.h"
 
@@ -55,6 +56,11 @@ ErrorReportOption::ErrorReportOption()
         LockMode::UNLOCK_WHILE_RUNNING,
         true
     )
+    , VIDEO(
+        "<b>Include Video:</b><br>Include a video leading up to the error. (if possible)",
+        LockMode::UNLOCK_WHILE_RUNNING,
+        true
+    )
     , LOGS(
         "<b>Include Logs:</b><br>Include the recent log leading up to the error.",
         LockMode::UNLOCK_WHILE_RUNNING,
@@ -65,20 +71,23 @@ ErrorReportOption::ErrorReportOption()
         LockMode::UNLOCK_WHILE_RUNNING,
         true
     )
-#if 0
     , FILES(
         "<b>Include Other Files:</b><br>Include other files that may be helpful for the developers.",
         LockMode::UNLOCK_WHILE_RUNNING,
         true
     )
-#endif
 {
     PA_ADD_STATIC(DESCRIPTION);
     PA_ADD_OPTION(SEND_MODE);
     PA_ADD_OPTION(SCREENSHOT);
+    if (PreloadSettings::instance().DEVELOPER_MODE){
+        PA_ADD_OPTION(VIDEO);
+    }
     PA_ADD_OPTION(LOGS);
     PA_ADD_OPTION(DUMPS);
-//    PA_ADD_OPTION(FILES);
+    if (PreloadSettings::instance().DEVELOPER_MODE){
+        PA_ADD_OPTION(FILES);
+    }
 }
 
 
@@ -97,7 +106,8 @@ SendableErrorReport::SendableErrorReport(
     const ProgramInfo& info,
     std::string title,
     std::vector<std::pair<std::string, std::string>> messages,
-    const ImageViewRGB32& image
+    const ImageViewRGB32& image,
+    ConsoleHandle* console
 )
     : SendableErrorReport()
 {
@@ -126,10 +136,15 @@ SendableErrorReport::SendableErrorReport(
         }
         file.write(log.c_str());
         file.flush();
-        m_files.emplace_back(ERROR_LOGS_NAME);
+        m_logs_name = ERROR_LOGS_NAME;
+    }
+    if (console){
+        if (console->save_stream_history(m_directory + "Video.mp4")){
+            m_video_name = "Video.mp4";
+        }
     }
     if (program_dump(logger, m_directory + ERROR_DUMP_NAME)){
-        m_files.emplace_back(ERROR_DUMP_NAME);
+        m_dump_name = ERROR_DUMP_NAME;
     }
 }
 
@@ -140,11 +155,6 @@ SendableErrorReport::SendableErrorReport(std::string directory)
         m_directory += '/';
     }
 
-    try{
-        m_image_owner = ImageRGB32(m_directory + "Image.png");
-        m_image = m_image_owner;
-    }catch (FileException&){}
-
     JsonValue json = load_json_file(m_directory + "Report.json");
     const JsonObject& obj = json.to_object_throw();
     m_timestamp = obj.get_string_throw("Timestamp");
@@ -165,6 +175,33 @@ SendableErrorReport::SendableErrorReport(std::string directory)
             );
         }
     }
+    {
+        const std::string* image_name = obj.get_string("Screenshot");
+        if (image_name){
+            try{
+                m_image_owner = ImageRGB32(*image_name);
+                m_image = m_image_owner;
+            }catch (FileException&){}
+        }
+    }
+    {
+        const std::string* video_name = obj.get_string("Video");
+        if (video_name){
+            m_video_name = *video_name;
+        }
+    }
+    {
+        const std::string* dump_name = obj.get_string("Dump");
+        if (dump_name){
+            m_dump_name = *dump_name;
+        }
+    }
+    {
+        const std::string* logs_name = obj.get_string("Logs");
+        if (logs_name){
+            m_logs_name = *logs_name;
+        }
+    }
     {
         const JsonArray& files = obj.get_array_throw("Files");
         for (const JsonValue& file : files){
@@ -200,8 +237,21 @@ void SendableErrorReport::save(Logger* logger) const{
         }
         report["Messages"] = std::move(messages);
     }
-
-    m_image.save(m_directory + "Image.png");
+    if (m_image){
+        std::string image_name = m_directory + "Screenshot.png";
+        if (m_image.save(image_name)){
+            report["Screenshot"] = std::move(image_name);
+        }
+    }
+    if (!m_video_name.empty()){
+        report["Video"] = m_video_name;
+    }
+    if (!m_dump_name.empty()){
+        report["Dump"] = m_dump_name;
+    }
+    if (!m_logs_name.empty()){
+        report["Logs"] = m_logs_name;
+    }
 
     JsonArray array;
     for (const std::string& file : m_files){
@@ -314,6 +364,7 @@ void report_error(
     std::string title,
     std::vector<std::pair<std::string, std::string>> messages,
     const ImageViewRGB32& image,
+    ConsoleHandle* console,
     const std::vector<std::string>& files
 ){
     if (logger == nullptr){
@@ -326,7 +377,8 @@ void report_error(
             info,
             std::move(title),
             std::move(messages),
-            image
+            image,
+            console
         );
 
         std::vector<std::string> full_file_paths;

SerialPrograms/Source/CommonFramework/ErrorReports/ErrorReports.h

@@ -19,12 +19,16 @@
 namespace PokemonAutomation{
 
 
+class ConsoleHandle;
+
+
 extern const std::string& ERROR_LOGS_NAME;
 extern const std::string& ERROR_DUMP_NAME;
 extern const std::string& ERROR_PATH_UNSENT;
 extern const std::string& ERROR_PATH_SENT;
 
 
+
 enum class ErrorReportSendMode{
     SEND_AUTOMATICALLY,
     PROMPT_WHEN_CONVENIENT,
@@ -40,9 +44,10 @@ class ErrorReportOption : public GroupOption{
     EnumDropdownOption<ErrorReportSendMode> SEND_MODE;
 
     BooleanCheckBoxOption SCREENSHOT;
+    BooleanCheckBoxOption VIDEO;
     BooleanCheckBoxOption LOGS;
     BooleanCheckBoxOption DUMPS;
-//    BooleanCheckBoxOption FILES;
+    BooleanCheckBoxOption FILES;
 };
 
 
@@ -57,7 +62,8 @@ class SendableErrorReport{
         const ProgramInfo& info = ProgramInfo(),
         std::string title = "",
         std::vector<std::pair<std::string, std::string>> messages = {},
-        const ImageViewRGB32& image = ImageViewRGB32()
+        const ImageViewRGB32& image = ImageViewRGB32(),
+        ConsoleHandle* console = nullptr
     );
 
     //  Deserialize from existing report.
@@ -85,6 +91,9 @@ class SendableErrorReport{
     std::vector<std::pair<std::string, std::string>> m_messages;
     ImageRGB32 m_image_owner;
     ImageViewRGB32 m_image;
+    std::string m_logs_name;
+    std::string m_video_name;
+    std::string m_dump_name;
     std::vector<std::string> m_files;
 };
 
@@ -99,6 +108,7 @@ void report_error(
     std::string title = "",
     std::vector<std::pair<std::string, std::string>> messages = {},
     const ImageViewRGB32& image = ImageViewRGB32(),
+    ConsoleHandle* console = nullptr,
     const std::vector<std::string>& files = {}
 );
 

SerialPrograms/Source/CommonFramework/Exceptions/FatalProgramException.cpp

@@ -4,71 +4,20 @@
  *
  */
 
-#include "CommonFramework/ImageTypes/ImageRGB32.h"
-#include "CommonFramework/Notifications/ProgramNotifications.h"
-#include "CommonFramework/ErrorReports/ErrorReports.h"
-//#include "CommonFramework/Tools/ErrorDumper.h"
-#include "CommonFramework/Tools/ProgramEnvironment.h"
-#include "CommonFramework/Tools/ConsoleHandle.h"
 #include "FatalProgramException.h"
 
 namespace PokemonAutomation{
 
 
 FatalProgramException::FatalProgramException(ScreenshotException&& e)
-    : ScreenshotException(e.m_send_error_report, std::move(e.m_message), std::move(e.m_screenshot))
+    : ScreenshotException(
+        e.m_send_error_report,
+        std::move(e.m_message),
+        std::move(e.m_screenshot)
+    )
 {}
-FatalProgramException::FatalProgramException(ErrorReport error_report, Logger& logger, std::string message)
-    : ScreenshotException(error_report, std::move(message))
-{
-    logger.log(std::string(FatalProgramException::name()) + ": " + m_message, COLOR_RED);
-}
-FatalProgramException::FatalProgramException(ErrorReport error_report, Logger& logger, std::string message, std::shared_ptr<const ImageRGB32> screenshot)
-    : ScreenshotException(error_report, std::move(message), std::move(screenshot))
-{
-    logger.log(std::string(FatalProgramException::name()) + ": " + m_message, COLOR_RED);
-}
-FatalProgramException::FatalProgramException(ErrorReport error_report, ConsoleHandle& console, std::string message, bool take_screenshot)
-    : ScreenshotException(error_report, console, std::move(message), take_screenshot)
-{
-    console.log(std::string(FatalProgramException::name()) + ": " + m_message, COLOR_RED);
-}
 
 
-void FatalProgramException::send_notification(ProgramEnvironment& env, EventNotificationOption& notification) const{
-    std::vector<std::pair<std::string, std::string>> embeds;
-    if (!m_message.empty()){
-        embeds.emplace_back(std::pair<std::string, std::string>("Message:", m_message));
-    }
-    if (m_send_error_report == ErrorReport::SEND_ERROR_REPORT){
-        report_error(
-            &env.logger(),
-            env.program_info(),
-            name(),
-            embeds,
-            screenshot()
-        );
-#if 0
-        std::string label = name();
-        std::string filename = dump_image_alone(env.logger(), env.program_info(), label, *m_screenshot);
-        send_program_telemetry(
-            env.logger(), true, COLOR_RED,
-            env.program_info(),
-            label,
-            embeds,
-            filename
-        );
-#endif
-    }
-    send_program_notification(
-        env, notification,
-        COLOR_RED,
-        "Program Error",
-        std::move(embeds), "",
-        screenshot()
-    );
-}
-
 
 
 

SerialPrograms/Source/CommonFramework/Exceptions/FatalProgramException.h

@@ -7,7 +7,6 @@
 #ifndef PokemonAutomation_FatalProgramException_H
 #define PokemonAutomation_FatalProgramException_H
 
-#include <memory>
 #include "ScreenshotException.h"
 
 namespace PokemonAutomation{
@@ -16,15 +15,10 @@ namespace PokemonAutomation{
 //  A generic exception that should not be caught outside of infra.
 class FatalProgramException : public ScreenshotException{
 public:
+    using ScreenshotException::ScreenshotException;
     FatalProgramException(ScreenshotException&& e);
-    explicit FatalProgramException(ErrorReport error_report, Logger& logger, std::string message);
-    explicit FatalProgramException(ErrorReport error_report, Logger& logger, std::string message, std::shared_ptr<const ImageRGB32> screenshot);
-    explicit FatalProgramException(ErrorReport error_report, ConsoleHandle& console, std::string message, bool take_screenshot);
 
     virtual const char* name() const override{ return "FatalProgramException"; }
-    virtual std::string message() const override{ return m_message; }
-
-    virtual void send_notification(ProgramEnvironment& env, EventNotificationOption& notification) const override;
 };