[PROD-45916] Add callback to logger before stringifying message

Workable · Aug 8, 2024 · bf796e4 · bf796e4
1 parent 2a89db2
commit bf796e4
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 8 deletions.
diff --git a/lib/appenders/console.js b/lib/appenders/console.js
@@ -3,6 +3,7 @@ const formatterResolver = require('../formatters/FormatterResolver');
 const getOut = (opts = {}) => {
   const color = !!opts.color;
   const styles = opts.styles;
+  const loggerCallback = opts.loggerCallback;
   const date = true;
 
   const out = (data, options) => {
@@ -15,7 +16,7 @@ const getOut = (opts = {}) => {
 
     if (log_tag) {
       for (const i in styles) {
-        const formatter = formatterResolver(styles[i], color, date, log_tag);
+        const formatter = formatterResolver(styles[i], color, date, log_tag, loggerCallback);
         const fmt = formatter.formatObject(data, options);
         process.stdout.write(`${fmt}\n`);
       }

diff --git a/lib/formatters/BaseFormatter.js b/lib/formatters/BaseFormatter.js
@@ -21,10 +21,11 @@ const colorStatusCodes = {
 };
 
 class BaseFormatter {
-  constructor(color = false, appendDate = false, requestType = '') {
+  constructor(color = false, appendDate = false, requestType = '', loggerCallback = null) {
     this.color = color;
     this.appendDate = appendDate;
     this.requestType = requestType;
+    this.loggerCallback = loggerCallback;
   }
 
   formatObject(obj) {

diff --git a/lib/formatters/FormatterResolver.js b/lib/formatters/FormatterResolver.js
@@ -9,6 +9,8 @@ const formatters = {
   json: JsonFormatter
 };
 
-module.exports = (type = '', color = false, appendDate = false, requestType = '') => {
-  return formatters[type] ? new formatters[type](color, appendDate, requestType) : new MissingFormatter(type);
+module.exports = (type = '', color = false, appendDate = false, requestType = '', loggerCallback = null) => {
+  return formatters[type]
+    ? new formatters[type](color, appendDate, requestType, loggerCallback)
+    : new MissingFormatter(type);
 };
diff --git a/lib/formatters/JsonFormatter.js b/lib/formatters/JsonFormatter.js
@@ -2,13 +2,15 @@ const merge = require('lodash/merge');
 const BaseFormatter = require('./BaseFormatter');
 
 class JsonFormatter extends BaseFormatter {
-  constructor(color = false, appendDate = false, requestType = '') {
-    super(false, appendDate, requestType);
+  constructor(color = false, appendDate = false, requestType = '', loggerCallback = null) {
+    super(false, appendDate, requestType, loggerCallback);
   }
 
   formatObject(obj) {
     let jsonObject = obj instanceof Error ? this.formatErrorObject(obj) : this.formatValidObject(obj);
-
+    if (this.loggerCallback && typeof this.loggerCallback === 'function') {
+      this.loggerCallback(jsonObject);
+    }
     return JSON.stringify(jsonObject);
   }
 

diff --git a/lib/options.js b/lib/options.js
@@ -6,7 +6,8 @@ const { isEmpty } = require('lodash');
 module.exports = (options = {}) => {
   const color = typeof options.color === 'boolean' ? options.color : true;
   const styles = !isEmpty(options.styles) ? options.styles : ['simple'];
-  const defaultLogger = out({ color, styles });
+  const loggerCallback = options.loggerCallback;
+  const defaultLogger = out({ color, styles, loggerCallback });
   return {
     color,
     styles,

diff --git a/test/lib/formatters/JsonFormatterTest.js b/test/lib/formatters/JsonFormatterTest.js
@@ -117,4 +117,24 @@ describe('Test Json Formatter', () => {
     json.message.should.equal('test-error');
     json.stack_trace.should.equal(obj.stack);
   });
+
+  it('should call lggerCallback', () => {
+    const stub = sandbox.stub();
+    const formatter = new JsonFormatter(false, false, '', stub);
+    const obj = {
+      method: 'GET',
+      requestId: 'testRequestId',
+      path: 'test-path',
+      log_tag: 'inbound_request',
+      duration: 50
+    };
+    formatter.formatObject(obj);
+    const event = stub.args[0][0];
+
+    event.severity.should.equal('info');
+    event['logging.googleapis.com/operation'].id.should.equal(obj.requestId);
+    event.requestId.should.equal(obj.requestId);
+    event.httpRequest.requestUrl.should.equal(obj.path);
+    event.httpRequest.latency.should.equal('0.050000s');
+  });
 });
diff --git a/types/riviere.d.ts b/types/riviere.d.ts
@@ -11,6 +11,7 @@ export function riviere(options?: {
     info: any,
     error: any
   },
+  loggerCallback?: (event: any) => void,
   inbound?: {
     enabled: boolean,
     request?: {