Merge pull request #177 from edx/juliasq/support_string_or_obj_for_loginfo

fix: Properly handle an error object sent into logInfo().

Author: Julia Eskew

src/logging/NewRelicLoggingService.js

@@ -109,23 +109,32 @@ export default class NewRelicLoggingService {
   /**
    *
    *
-   * @param {*} message
+   * @param {*} infoStringOrErrorObject
    * @param {*} [customAttributes={}]
    * @memberof NewRelicLoggingService
    */
-  logInfo(message, customAttributes = {}) {
-    sendPageAction(pageActionNameInfo, message, customAttributes);
+  logInfo(infoStringOrErrorObject, customAttributes = {}) {
+    let message = infoStringOrErrorObject;
+    let customAttrs = customAttributes;
+    if (typeof infoStringOrErrorObject === 'object' && 'message' in infoStringOrErrorObject) {
+      /* Caller has passed in an error object to be logged as a page action. */
+      /* Extract the attributes and the message. */
+      const infoCustomAttributes = infoStringOrErrorObject.customAttributes || {};
+      customAttrs = { ...infoCustomAttributes, ...customAttributes };
+      message = infoStringOrErrorObject.message;
+    }
+    sendPageAction(pageActionNameInfo, message, customAttrs);
   }
 
   /**
    *
    *
-   * @param {*} error
+   * @param {*} errorStringOrObject
    * @param {*} [customAttributes={}]
    * @memberof NewRelicLoggingService
    */
-  logError(error, customAttributes = {}) {
-    const errorCustomAttributes = error.customAttributes || {};
+  logError(errorStringOrObject, customAttributes = {}) {
+    const errorCustomAttributes = errorStringOrObject.customAttributes || {};
     let allCustomAttributes = { ...errorCustomAttributes, ...customAttributes };
     if (Object.keys(allCustomAttributes).length === 0) {
       // noticeError expects undefined if there are no custom attributes.
@@ -137,13 +146,13 @@ export default class NewRelicLoggingService {
         Ignored errors are logged via adding a page action.
         Other errors are logged via noticeError and count as "JS Errors" for the application.
     */
-    const errorMessage = typeof error === 'string' ? error : error.message;
+    const errorMessage = errorStringOrObject.message || (typeof errorStringOrObject === 'string' ? errorStringOrObject : '');
     if (this.ignoredErrorRegexes && errorMessage.match(this.ignoredErrorRegexes)) {
       /* ignored error */
       sendPageAction(pageActionNameIgnoredError, errorMessage, allCustomAttributes);
     } else {
       /*  error! */
-      sendError(error, allCustomAttributes);
+      sendError(errorStringOrObject, allCustomAttributes);
     }
   }
 }

src/logging/NewRelicLoggingService.test.js

@@ -46,12 +46,50 @@ describe('NewRelicLoggingService', () => {
       expect(global.newrelic.addPageAction).toHaveBeenCalledWith('INFO', { message });
     });
 
-    it('passes info parameters properly with custom attributes', () => {
+    it('handles plain string message properly with custom attributes', () => {
       const message = 'Test log';
-      const customAttrs = { a: 1, b: 'red', c: 3 };
-      service.logInfo(message, customAttrs);
+      const attrs = { a: 1, b: 'red', c: 3 };
+      service.logInfo(message, attrs);
       expect(global.newrelic.addPageAction).toHaveBeenCalledWith('INFO', {
-        message: 'Test log', a: 1, b: 'red', c: 3,
+        message, ...attrs,
+      });
+    });
+
+    it('handles plain string message properly with no custom attributes', () => {
+      const message = 'Test log';
+      service.logInfo(message);
+      expect(global.newrelic.addPageAction).toHaveBeenCalledWith('INFO', {
+        message,
+      });
+    });
+
+    it('handles error object properly with custom attributes', () => {
+      const message = 'Test log';
+      const attrs = { a: 1, b: 'red', c: 3 };
+      const err = { message, customAttributes: attrs };
+      service.logInfo(err);
+      expect(global.newrelic.addPageAction).toHaveBeenCalledWith('INFO', {
+        message, ...attrs,
+      });
+    });
+
+    it('handles error object properly with no custom attributes', () => {
+      const message = 'Test log';
+      const err = { message };
+      service.logInfo(err);
+      expect(global.newrelic.addPageAction).toHaveBeenCalledWith('INFO', {
+        message,
+      });
+    });
+
+    it('handles error object properly with custom attributes in object and param', () => {
+      const message = 'Test log';
+      const attrsObj = { a: 1, b: 'red', c: 3 };
+      const attrsParam = { x: 99, y: 'blue', z: 987 };
+      const err = { message, customAttributes: attrsObj };
+      service.logInfo(err, attrsParam);
+      expect(global.newrelic.addPageAction).toHaveBeenCalledWith('INFO', {
+        message, ...attrsObj, ...attrsParam,
       });
     });
   });