WIP deprecate logInfoWithCorrelationIds & logErrorWithCorrelationIds

api/src/shared/infrastructure/utils/logger.js

@@ -49,32 +49,14 @@ function extractUserIdFromRequest(request) {
 }
 
 function parseDataForLogger(data) {
-  return typeof data === 'string' || data instanceof String
-    ? {
-        message: data,
-      }
-    : data;
+  return typeof data === 'string' || data instanceof String ? { message: data } : data;
 }
 
-function _logErrorWithCorrelationIds(logger) {
+function _logWithCorrelationIds(loggingFunction) {
   return function (data) {
     const parsedData = parseDataForLogger(data);
     const context = getCorrelationContext();
-    logger.error(
-      {
-        ...context,
-        ...omit(parsedData, 'message'),
-      },
-      get(parsedData, 'message', '-'),
-    );
-  };
-}
-
-function _logInfoWithCorrelationIds(logger) {
-  return function (data) {
-    const parsedData = parseDataForLogger(data);
-    const context = getCorrelationContext();
-    logger.info(
+    loggingFunction(
       {
         ...context,
         ...omit(parsedData, 'message'),
@@ -100,14 +82,39 @@ function _logInfoWithCorrelationIds(logger) {
  * };
  * logErrorWithCorrelationIds(data);
  *
- * @param {object} data
+ * @param {object|string} data
+ * @deprecated use logger#error instead
  */
-const logErrorWithCorrelationIds = _logErrorWithCorrelationIds(internalLogger);
-const logInfoWithCorrelationIds = _logInfoWithCorrelationIds(internalLogger);
+const logErrorWithCorrelationIds = _logWithCorrelationIds(internalLogger.error.bind(internalLogger));
 
+/** @param {object|string} data
+ * Usage : show logErrorWithCorrelationIds
+ * @deprecated use logger#info instead
+ */
+const logInfoWithCorrelationIds = _logWithCorrelationIds(internalLogger.info.bind(internalLogger));
+
+/**
+ * In order to be displayed properly in Datadog,
+ * the parameter "data" should contain
+ * - a required property message as string
+ * - all other properties you need to pass to Datadog
+ *
+ * @example
+ * const data = {
+ *   message: 'Error message',
+ *   context: 'My Context',
+ *   data: { more: 'data', if: 'needed' },
+ *   event: 'Event which trigger this error',
+ *   team: 'My Team',
+ * };
+ * logErrorWithCorrelationIds(data);
+ *
+ * @param {object|string} data
+ * @deprecated use logger#error instead
+ */
 const logger = {
-  error: logErrorWithCorrelationIds,
-  info: logInfoWithCorrelationIds,
+  error: _logWithCorrelationIds(internalLogger.error.bind(internalLogger)),
+  info: _logWithCorrelationIds(internalLogger.info.bind(internalLogger)),
   warn: internalLogger.warn.bind(internalLogger),
   trace: internalLogger.trace.bind(internalLogger),
   fatal: internalLogger.fatal.bind(internalLogger),