From 210128169ad0c03898e2e1f16eb56ce0bb2c6f37 Mon Sep 17 00:00:00 2001
From: Ben Caimano <bcaimano@cloudflare.com>
Date: Fri, 7 Apr 2023 18:32:19 -0400
Subject: [PATCH] Cleanup: Simplify sentry logging macros

This commit does the following:
- Removes the `message` parameter from LOG_NOSENTRY, LOG_ERROR_ONCE, and LOG_ERROR_PERIODICALLY so that they can take a single string.
- Removes LOG_ERROR_ONCE_IF and LOG_ERROR_PERIODICALLY_IF since they were sugar for if statements.
- Removes the GCC CPP token paste operator from LOG_ERROR_ONCE and LOG_ERROR_PERIODICALLY. KJ_LOG already has it for us. (And if it didn't, we should be using `__VA_OPT__(...)`.)
---
 src/workerd/util/sentry.h | 28 +++++++---------------------
 1 file changed, 7 insertions(+), 21 deletions(-)

diff --git a/src/workerd/util/sentry.h b/src/workerd/util/sentry.h
index 40afc6e2ae5..dfb68c66b1c 100644
--- a/src/workerd/util/sentry.h
+++ b/src/workerd/util/sentry.h
@@ -38,36 +38,29 @@ inline kj::StringPtr maybeOmitColoFromSentry(uint32_t coloId) {
   return coloId == dogColoId ? "NOSENTRY"_kj : ""_kj;
 }
 
-#define LOG_NOSENTRY(severity, message, ...) \
-  KJ_LOG(severity,  "NOSENTRY " message, __VA_ARGS__);
+#define LOG_NOSENTRY(severity, ...) \
+  KJ_LOG(severity, "NOSENTRY " __VA_ARGS__);
 
 #define LOG_IF_INTERESTING(exception, severity, ...) \
   if (!::workerd::isInterestingException(exception)) { \
     LOG_NOSENTRY(severity, __VA_ARGS__); \
   } else { \
-    KJ_LOG(severity,  __VA_ARGS__); \
+    KJ_LOG(severity, __VA_ARGS__); \
   }
 
 // Log this to Sentry once ever per process. Typically will be better to use LOG_ERROR_PERIODICALLY.
-#define LOG_ERROR_ONCE(msg, ...)                                               \
+#define LOG_ERROR_ONCE(...)                                                    \
   do {                                                                         \
     static bool logOnce KJ_UNUSED = [&]() {                                    \
-      KJ_LOG(ERROR, msg, ##__VA_ARGS__);                                       \
+      KJ_LOG(ERROR, __VA_ARGS__);                                              \
       return true;                                                             \
     }();                                                                       \
   } while (0)
 
-#define LOG_ERROR_ONCE_IF(cond, msg, ...)                                      \
-  do {                                                                         \
-    if (cond) {                                                                \
-      LOG_ERROR_ONCE(msg, ##__VA_ARGS__);                                      \
-    }                                                                          \
-  } while (0)
-
 // Slightly more expensive than LOG_ERROR_ONCE. Avoid putting into a hot path (e.g. within a loop)
 // where an overhead of ~hundreds of nanoseconds per evaluation to retrieve the current time would
 // be prohibitive.
-#define LOG_ERROR_PERIODICALLY(msg, ...)                                       \
+#define LOG_ERROR_PERIODICALLY(...)                                            \
   do {                                                                         \
     static kj::TimePoint KJ_UNIQUE_NAME(lastLogged) =                          \
         kj::origin<kj::TimePoint>();                                           \
@@ -75,14 +68,7 @@ inline kj::StringPtr maybeOmitColoFromSentry(uint32_t coloId) {
     const auto elapsed = now - KJ_UNIQUE_NAME(lastLogged);                     \
     if (KJ_UNLIKELY(elapsed >= 1 * kj::HOURS)) {                               \
       KJ_UNIQUE_NAME(lastLogged) = now;                                        \
-      KJ_LOG(ERROR, msg, ##__VA_ARGS__);                                       \
-    }                                                                          \
-  } while (0)
-
-#define LOG_ERROR_PERIODICALLY_IF(cond, msg, ...)                              \
-  do {                                                                         \
-    if (cond) {                                                                \
-      LOG_ERROR_PERIODICALLY(msg, ##__VA_ARGS__);                              \
+      KJ_LOG(ERROR, __VA_ARGS__);                                              \
     }                                                                          \
   } while (0)