Merge pull request #491 from openedx/davidjoy/feat_new_relic_setcustomattribute

feat: set userId custom attribute for logging service

Author: davidjoy

src/auth/AxiosJwtAuthService.js

@@ -234,8 +234,13 @@ class AxiosJwtAuthService {
         administrator: decodedAccessToken.administrator,
         name: decodedAccessToken.name,
       });
+      // Sets userId as a custom attribute that will be included with all subsequent log messages.
+      // Very helpful for debugging.
+      this.loggingService.setCustomAttribute('userId', decodedAccessToken.user_id);
     } else {
       this.setAuthenticatedUser(null);
+      // Intentionally not setting `userId` in the logging service here because it would be useful
+      // to know the previously logged in user for debugging refresh issues.
     }
 
     return this.getAuthenticatedUser();

src/auth/AxiosJwtAuthService.test.jsx

@@ -7,6 +7,7 @@ import AxiosJwtAuthService from './AxiosJwtAuthService';
 const mockLoggingService = {
   logInfo: jest.fn(),
   logError: jest.fn(),
+  setCustomAttribute: jest.fn(),
 };
 
 const authOptions = {
@@ -204,6 +205,7 @@ beforeEach(() => {
   };
   mockLoggingService.logInfo.mockReset();
   mockLoggingService.logError.mockReset();
+  mockLoggingService.setCustomAttribute.mockReset();
   service.getCsrfTokenService().clearCsrfTokenCache();
   axiosMock.onGet('/unauthorized').reply(401);
   axiosMock.onGet('/forbidden').reply(403);
@@ -861,6 +863,7 @@ describe('fetchAuthenticatedUser', () => {
     setJwtTokenRefreshResponseTo(200, jwtTokens.valid.encoded);
     return service.fetchAuthenticatedUser().then((authenticatedUserAccessToken) => {
       expect(authenticatedUserAccessToken).toEqual(jwtTokens.valid.formatted);
+      expect(mockLoggingService.setCustomAttribute).toHaveBeenCalledWith('userId', jwtTokens.valid.formatted.userId);
       expectSingleCallToJwtTokenRefresh();
     });
   });
@@ -878,6 +881,7 @@ describe('fetchAuthenticatedUser', () => {
     setJwtTokenRefreshResponseTo(401, null);
     return service.fetchAuthenticatedUser({ forceRefresh: true }).then((authenticatedUserAccessToken) => {
       expect(authenticatedUserAccessToken).toEqual(null);
+      expect(mockLoggingService.setCustomAttribute).not.toHaveBeenCalled();
       expectSingleCallToJwtTokenRefresh();
     });
   });

src/logging/MockLoggingService.js

@@ -19,6 +19,13 @@ class MockLoggingService {
    * @memberof MockLoggingService
    */
   logError = jest.fn();
+
+  /**
+   * Implemented as a jest.fn()
+   *
+   * @memberof MockLoggingService
+   */
+  setCustomAttribute = jest.fn();
 }
 
 export default MockLoggingService;

src/logging/NewRelicLoggingService.js

@@ -23,9 +23,10 @@ const pageActionNameIgnoredError = 'IGNORED_ERROR';
 
 function sendPageAction(actionName, message, customAttributes) {
   if (process.env.NODE_ENV === 'development') {
-    console.log(message, customAttributes); // eslint-disable-line
+    console.log(actionName, message, customAttributes); // eslint-disable-line
   }
   if (window && typeof window.newrelic !== 'undefined') {
+    // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/addpageaction/
     window.newrelic.addPageAction(actionName, { message, ...customAttributes });
   }
 }
@@ -35,10 +36,21 @@ function sendError(error, customAttributes) {
     console.error(error, customAttributes); // eslint-disable-line
   }
   if (window && typeof window.newrelic !== 'undefined') {
+    // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/noticeerror/
     window.newrelic.noticeError(fixErrorLength(error), customAttributes);
   }
 }
 
+function setCustomAttribute(name, value) {
+  if (process.env.NODE_ENV === 'development') {
+    console.log(name, value); // eslint-disable-line
+  }
+  if (window && typeof window.newrelic !== 'undefined') {
+    // https://docs.newrelic.com/docs/browser/new-relic-browser/browser-apis/setcustomattribute/
+    window.newrelic.setCustomAttribute(name, value);
+  }
+}
+
 /**
  * The NewRelicLoggingService is a concrete implementation of the logging service interface that
  * sends messages to NewRelic that can be seen in NewRelic Browser and NewRelic Insights. When in
@@ -65,7 +77,8 @@ function sendError(error, customAttributes) {
  * ```
  *
  * You can also add your own custom metrics as an additional argument, or see the code to find
- * other standard custom attributes.
+ * other standard custom attributes. By default, userId is added (via setCustomAttribute) for logged
+ * in users via the auth service (AuthAxiosJwtService).
  *
  * Requires the NewRelic Browser JavaScript snippet.
  *
@@ -155,4 +168,14 @@ export default class NewRelicLoggingService {
       sendError(errorStringOrObject, allCustomAttributes);
     }
   }
+
+  /**
+   * Sets a custom attribute that will be included with all subsequent log messages.
+   *
+   * @param {string} name
+   * @param {string|number|null} value
+   */
+  setCustomAttribute(name, value) {
+    setCustomAttribute(name, value);
+  }
 }

src/logging/NewRelicLoggingService.test.js

@@ -3,6 +3,7 @@ import NewRelicLoggingService, { MAX_ERROR_LENGTH } from './NewRelicLoggingServi
 global.newrelic = {
   addPageAction: jest.fn(),
   noticeError: jest.fn(),
+  setCustomAttribute: jest.fn(),
 };
 
 let service = null;
@@ -140,6 +141,17 @@ describe('NewRelicLoggingService', () => {
     });
   });
 
+  describe('setCustomAttribute', () => {
+    beforeEach(() => {
+      global.newrelic.setCustomAttribute.mockReset();
+    });
+
+    it('calls New Relic client with name and value', () => {
+      service.setCustomAttribute('foo', 'bar');
+      expect(global.newrelic.setCustomAttribute).toHaveBeenCalledWith('foo', 'bar');
+    });
+  });
+
   describe('ignoredErrors', () => {
     beforeEach(() => {
       global.newrelic.addPageAction.mockReset();

src/logging/interface.js

@@ -71,6 +71,16 @@ export function logError(errorStringOrObject, customAttributes) {
   return service.logError(errorStringOrObject, customAttributes);
 }
 
+/**
+ * Sets a custom attribute that will be included with all subsequent log messages.
+ *
+ * @param {string} name
+ * @param {string|number|null} value
+ */
+export function setCustomAttribute(name, value) {
+  return service.setCustomAttribute(name, value);
+}
+
 /**
  *
  * @throws {Error} Thrown if the logging service has not yet been configured via {@link configure}.