Add removing censor API to Log

There are secrets that can be updated with time and it make sense
not to censor them anymore not to let performance suffer.

Relates-To: NLAM-140
Signed-off-by: Rustam Gamidov <[email protected]>

Author: rustam-gamidov-here

olp-cpp-sdk-core/include/olp/core/logging/Log.h

@@ -571,7 +571,17 @@ class CORE_API Log {
    *
    * @param message The line to be censored out from the log.
    */
-  static void censor(const std::string& message);
+  static void addCensor(const std::string& message);
+
+  /**
+   * @brief Removes a line from censoring out from the log.
+   *
+   * Censoring out is a replacement with a predefiend mask with length not
+   * correlated with the original line length.
+   *
+   * @param message The line to be excluded from censoring out from the log.
+   */
+  static void removeCensor(const std::string& message);
 };
 }  // namespace logging
 }  // namespace olp

olp-cpp-sdk-core/src/logging/Log.cpp

@@ -26,6 +26,7 @@
 #include <olp/core/porting/optional.h>
 #include <olp/core/thread/Atomic.h>
 
+#include <algorithm>
 #include <string>
 #include <unordered_map>
 
@@ -34,7 +35,8 @@ namespace logging {
 
 namespace {
 constexpr auto kSecretMask = "*****";
-}
+const auto kSecretMaskLength = std::strlen(kSecretMask);
+}  // namespace
 
 struct LogMessageExt : public LogMessage {
   olp::porting::optional<std::string> adjusted_message;
@@ -77,7 +79,8 @@ class LogImpl {
                   unsigned int line, const char* function,
                   const char* fullFunction);
 
-  void censor(std::string msg);
+  void addCensor(std::string msg);
+  void removeCensor(const std::string& msg);
 
  private:
   LogImpl();
@@ -219,15 +222,22 @@ void LogImpl::censorLogItem(LogItem& log_item, const std::string& original) {
       log_item.adjusted_message.value().replace(found_pos, secret.length(),
                                                 kSecretMask);
       found_pos = log_item.adjusted_message.value().find(
-          secret, found_pos + std::strlen(kSecretMask));
+          secret, found_pos + kSecretMaskLength);
     }
   }
 }
 
-void LogImpl::censor(std::string msg) {
+void LogImpl::addCensor(std::string msg) {
   m_toCensor.emplace_back(std::move(msg));
 }
 
+void LogImpl::removeCensor(const std::string& msg) {
+  auto it = std::find(m_toCensor.begin(), m_toCensor.end(), msg);
+  if (it != m_toCensor.end()) {
+    m_toCensor.erase(it);
+  }
+}
+
 // implementation of public static Log API
 //--------------------------------------------------------
 
@@ -348,11 +358,19 @@ void Log::logMessage(Level level, const std::string& tag,
   });
 }
 
-void Log::censor(const std::string& message) {
+void Log::addCensor(const std::string& message) {
+  if (!LogImpl::aliveStatus())
+    return;
+
+  LogImpl::getInstance().locked([&](LogImpl& log) { log.addCensor(message); });
+}
+
+void Log::removeCensor(const std::string& message) {
   if (!LogImpl::aliveStatus())
     return;
 
-  LogImpl::getInstance().locked([&](LogImpl& log) { log.censor(message); });
+  LogImpl::getInstance().locked(
+      [&](LogImpl& log) { log.removeCensor(message); });
 }
 
 }  // namespace logging

olp-cpp-sdk-core/tests/logging/LogTest.cpp

@@ -429,9 +429,9 @@ TEST(LogTest, LogCensor) {
   constexpr auto secret_02 = "to hide";
   constexpr auto secret_mask = "******";
 
-  olp::logging::Log::censor(secret_01);
-  olp::logging::Log::censor(secret_02);
-  olp::logging::Log::censor(secret_mask);
+  olp::logging::Log::addCensor(secret_01);
+  olp::logging::Log::addCensor(secret_02);
+  olp::logging::Log::addCensor(secret_mask);
 
   OLP_SDK_LOG_INFO_F("", "Nothing to censor");
   OLP_SDK_LOG_INFO_F("", "Inlined1st secretin message");
@@ -452,6 +452,16 @@ TEST(LogTest, LogCensor) {
   EXPECT_EQ("***** twice *****", appender->messages_[5].message_);
   EXPECT_EQ("no loop **********", appender->messages_[6].message_);
   EXPECT_EQ("Fatal *****", appender->messages_[7].message_);
+
+  olp::logging::Log::removeCensor("not exisiting secret");
+  OLP_SDK_LOG_TRACE_F("trace", "%s %s", "plain", secret_01);
+  olp::logging::Log::removeCensor(secret_01);
+  OLP_SDK_LOG_TRACE_F("trace", "%s %s", "plain", secret_01);
+
+  ASSERT_EQ(10U, appender->messages_.size());
+
+  EXPECT_EQ("plain *****", appender->messages_[8].message_);
+  EXPECT_EQ("plain 1st secret", appender->messages_[9].message_);
 }
 
 TEST(LogTest, LogLimits) {