[Feature] - Addition of logging activity simulated command filter option

sjanel · Apr 22, 2024 · 1d084a1 · 1d084a1
1 parent f5407c5
commit 1d084a1
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 7 deletions.
diff --git a/CONFIG.md b/CONFIG.md
@@ -54,6 +54,7 @@ Configures the logging, tracking activity of relevant commands, and console outp
 | **fiatConversion.rate**                        | Duration string (ex: `8h`)               | Minimum duration between two consecutive requests of the same fiat conversion                                                                                                                                                                                                                                   |
 | **log.activityTracking.commandTypes**          | Array of strings (ex: `["Buy", "Sell"]`) | Array of command types whose output will be stored to activity history files.                                                                                                                                                                                                                                   |
 | **log.activityTracking.dateFileNameFormat**    | String (ex: `%Y-%m` for month split)     | Defines the date string format suffix used by activity history files. The string should be compatible with [std::strftime](https://en.cppreference.com/w/cpp/chrono/c/strftime). Old data will never be clean-up by `coincenter` (as it may contain important data). User should manage the clean-up / storage. |
+| **log.activityTracking.withSimulatedCommands** | Boolean                                  | When some commands are launched in simulated mode (trades, withdraw for instance), they will be logged if `true`.                                                                                                                                                                                               |
 | **log.consoleLevel**                           | String                                   | Defines the log level for standard output. Can be {'off', 'critical', 'error', 'warning', 'info', 'debug', 'trace'}                                                                                                                                                                                             |
 | **log.fileLevel**                              | String                                   | Defines the log level in files. Can be {'off', 'critical', 'error', 'warning', 'info', 'debug', 'trace'}                                                                                                                                                                                                        |
 | **log.maxFileSize**                            | String (ex: `5Mi` for 5 Megabytes)       | Defines in bytes the maximum logging file size. A string representation of an integral, possibly with one suffix ending such as k, M, G, T (1k multipliers) or Ki, Mi, Gi, Ti (1024 multipliers) are supported.                                                                                                 |

diff --git a/src/engine/include/queryresultprinter.hpp b/src/engine/include/queryresultprinter.hpp
@@ -112,7 +112,7 @@ class QueryResultPrinter {
 
   void printJson(const json &jsonData) const;
 
-  void logActivity(CoincenterCommandType commandType, const json &data) const;
+  void logActivity(CoincenterCommandType commandType, const json &data, bool isSimulationMode = false) const;
 
   const LoggingInfo &_loggingInfo;
   std::ostream *_pOs = nullptr;

diff --git a/src/engine/src/queryresultprinter.cpp b/src/engine/src/queryresultprinter.cpp
@@ -1008,7 +1008,7 @@ void QueryResultPrinter::printTrades(const TradeResultPerExchange &tradeResultPe
     case ApiOutputType::kNoPrint:
       break;
   }
-  logActivity(commandType, jsonData);
+  logActivity(commandType, jsonData, tradeOptions.isSimulation());
 }
 
 void QueryResultPrinter::printClosedOrders(const ClosedOrdersPerExchange &closedOrdersPerExchange,
@@ -1414,7 +1414,8 @@ void QueryResultPrinter::printWithdraw(const DeliveredWithdrawInfoWithExchanges
     case ApiOutputType::kNoPrint:
       break;
   }
-  logActivity(CoincenterCommandType::kWithdrawApply, jsonData);
+  logActivity(CoincenterCommandType::kWithdrawApply, jsonData,
+              withdrawOptions.mode() == WithdrawOptions::Mode::kSimulation);
 }
 
 void QueryResultPrinter::printDustSweeper(
@@ -1474,8 +1475,10 @@ void QueryResultPrinter::printJson(const json &jsonData) const {
   }
 }
 
-void QueryResultPrinter::logActivity(CoincenterCommandType commandType, const json &jsonData) const {
-  if (_loggingInfo.isCommandTypeTracked(commandType)) {
+void QueryResultPrinter::logActivity(CoincenterCommandType commandType, const json &jsonData,
+                                     bool isSimulationMode) const {
+  if (_loggingInfo.isCommandTypeTracked(commandType) &&
+      (!isSimulationMode || _loggingInfo.alsoLogActivityForSimulatedCommands())) {
     File activityFile = _loggingInfo.getActivityFile();
     activityFile.write(jsonData, Writer::Mode::Append);
   }

diff --git a/src/objects/include/generalconfigdefault.hpp b/src/objects/include/generalconfigdefault.hpp
@@ -23,7 +23,8 @@ struct GeneralConfigDefault {
         "Withdraw",
         "DustSweeper"
       ],
-      "dateFileNameFormat": "%Y-%m"
+      "dateFileNameFormat": "%Y-%m",
+      "withSimulatedCommands": false
     },
     "consoleLevel": "info",
     "fileLevel": "debug",

diff --git a/src/objects/include/logginginfo.hpp b/src/objects/include/logginginfo.hpp
@@ -51,6 +51,8 @@ class LoggingInfo {
 
   File getActivityFile() const;
 
+  bool alsoLogActivityForSimulatedCommands() const { return _alsoLogActivityForSimulatedCommands; }
+
  private:
   void createLoggers();
 
@@ -66,6 +68,7 @@ class LoggingInfo {
   int8_t _logLevelConsolePos = PosFromLevel(log::level::info);
   int8_t _logLevelFilePos = PosFromLevel(log::level::off);
   bool _destroyLoggers = false;
+  bool _alsoLogActivityForSimulatedCommands = false;
 };
 
 }  // namespace cct
diff --git a/src/objects/src/logginginfo.cpp b/src/objects/src/logginginfo.cpp
@@ -51,6 +51,7 @@ LoggingInfo::LoggingInfo(WithLoggersCreation withLoggersCreation, std::string_vi
       [](const json &elem) { return CoincenterCommandTypeFromString(elem.get<std::string_view>()); });
 
   _dateFormatStrActivityFiles = activityTrackingPart["dateFileNameFormat"];
+  _alsoLogActivityForSimulatedCommands = activityTrackingPart["withSimulatedCommands"].get<bool>();
 }
 
 LoggingInfo::LoggingInfo(LoggingInfo &&loggingInfo) noexcept
@@ -61,7 +62,8 @@ LoggingInfo::LoggingInfo(LoggingInfo &&loggingInfo) noexcept
       _maxNbLogFiles(loggingInfo._maxNbLogFiles),
       _logLevelConsolePos(loggingInfo._logLevelConsolePos),
       _logLevelFilePos(loggingInfo._logLevelFilePos),
-      _destroyLoggers(std::exchange(loggingInfo._destroyLoggers, false)) {}
+      _destroyLoggers(std::exchange(loggingInfo._destroyLoggers, false)),
+      _alsoLogActivityForSimulatedCommands(loggingInfo._alsoLogActivityForSimulatedCommands) {}
 
 LoggingInfo::~LoggingInfo() {
   if (_destroyLoggers) {