fix: bumping version of frontend-build to latest (#122)

davidjoy · web-flow · commit 05e4acbea0cd · 2020-10-22T15:35:38.000-04:00
* fix: bumping version of frontend-build to latest

Also opportunistically removing a strange script tag loading ‘index.js’ in the example app, which doesn’t work.

* fix: linting because of @edx/eslint-config

The linting needs to happen because @edx/frontend-build was updated to use the new @edx/eslint-config.

* fix: updating tests because of new jest version

Updating to the latest @edx/frontend-build has brought with it some updated versions of jest, which caused some of our tests to break.  This fixes them.

* fix: pegging version of frontend-build.

* fix: further linting errors after rebase
diff --git a/example/index.jsx b/example/index.jsx
@@ -2,7 +2,12 @@ import 'babel-polyfill'; // eslint-disable-line import/no-extraneous-dependencie
 
 import React from 'react';
 import ReactDOM from 'react-dom';
-import { AppProvider, AuthenticatedPageRoute, ErrorPage, PageRoute } from '@edx/frontend-platform/react';
+import {
+  AppProvider,
+  AuthenticatedPageRoute,
+  ErrorPage,
+  PageRoute,
+} from '@edx/frontend-platform/react';
 import { APP_INIT_ERROR, APP_READY, initialize } from '@edx/frontend-platform';
 import { subscribe } from '@edx/frontend-platform/pubSub';
 
@@ -17,9 +22,7 @@ subscribe(APP_READY, () => {
       <PageRoute
         exact
         path="/error_example"
-        component={() =>
-          <ErrorPage message="Test error message" />
-        }
+        component={() => <ErrorPage message="Test error message" />}
       />
       <AuthenticatedPageRoute exact path="/authenticated" component={AuthenticatedPage} />
     </AppProvider>,
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
   "devDependencies": {
     "@commitlint/cli": "8.2.0",
     "@commitlint/config-angular": "8.2.0",
-    "@edx/frontend-build": "2.0.6",
+    "@edx/frontend-build": "5.3.2",
     "@edx/paragon": "7.1.5",
     "axios-mock-adapter": "1.17.0",
     "babel-polyfill": "6.26.0",
diff --git a/public/index.html b/public/index.html
@@ -7,6 +7,5 @@
   </head>
   <body>
     <div id="root"></div>
-    <script src="./index.js"></script>
   </body>
 </html>
diff --git a/src/analytics/SegmentAnalyticsService.js b/src/analytics/SegmentAnalyticsService.js
@@ -25,7 +25,9 @@ class SegmentAnalyticsService {
     const { analytics } = global;
 
     // If the real analytics.js is already on the page return.
-    if (analytics.initialize) return;
+    if (analytics.initialize) {
+      return;
+    }
 
     // If the snippet was invoked do nothing.
     if (analytics.invoked) {
diff --git a/src/auth/AxiosJwtAuthService.js b/src/auth/AxiosJwtAuthService.js
@@ -197,8 +197,8 @@ class AxiosJwtAuthService {
     await this.fetchAuthenticatedUser();
 
     if (this.getAuthenticatedUser() === null) {
-      const isRedirectFromLoginPage = global.document.referrer &&
-        global.document.referrer.startsWith(this.config.LOGIN_URL);
+      const isRedirectFromLoginPage = global.document.referrer
+        && global.document.referrer.startsWith(this.config.LOGIN_URL);
 
       if (isRedirectFromLoginPage) {
         const redirectLoopError = new Error('Redirect from login page. Rejecting to avoid infinite redirect loop.');
diff --git a/src/auth/AxiosJwtAuthService.test.jsx b/src/auth/AxiosJwtAuthService.test.jsx
@@ -78,7 +78,8 @@ Object.keys(jwtTokens).forEach((jwtTokenName) => {
 const mockCsrfToken = 'thetokenvalue';
 const mockApiEndpointPath = `${process.env.BASE_URL}/api/v1/test`;
 
-window.location.assign = jest.fn();
+global.location = { ...global.location, assign: jest.fn() };
+
 const mockCookies = new Cookies();
 
 let service = null;
@@ -106,16 +107,15 @@ const setJwtTokenRefreshResponseTo = (status, jwtCookieValue) => {
   });
 };
 
-
 function expectLogout(redirectUrl = process.env.BASE_URL) {
   const encodedRedirectUrl = encodeURIComponent(redirectUrl);
-  expect(window.location.assign)
+  expect(global.location.assign)
     .toHaveBeenCalledWith(`${process.env.LOGOUT_URL}?redirect_url=${encodedRedirectUrl}`);
 }
 
 function expectLogin(redirectUrl = process.env.BASE_URL) {
   const encodedRedirectUrl = encodeURIComponent(redirectUrl);
-  expect(window.location.assign)
+  expect(global.location.assign)
     .toHaveBeenCalledWith(`${process.env.LOGIN_URL}?next=${encodedRedirectUrl}`);
 }
 
@@ -158,6 +158,8 @@ const expectRequestToHaveCsrfToken = (request) => {
   expect(request.headers['X-CSRFToken']).toEqual(mockCsrfToken);
 };
 
+const { location } = global;
+
 beforeEach(() => {
   service = new AxiosJwtAuthService(authOptions);
   accessTokenAxios = service.getJwtTokenService().getHttpClient();
@@ -174,7 +176,11 @@ beforeEach(() => {
   accessTokenAxiosMock.reset();
   csrfTokensAxiosMock.reset();
   mockCookies.get.mockReset();
-  window.location.assign.mockReset();
+  delete global.location;
+  global.location = {
+    assign: jest.fn(),
+    origin: 'http://localhost',
+  };
   mockLoggingService.logInfo.mockReset();
   mockLoggingService.logError.mockReset();
   service.getCsrfTokenService().clearCsrfTokenCache();
@@ -189,6 +195,10 @@ beforeEach(() => {
   accessTokenAxios.defaults.maxRetries = 0;
 });
 
+afterEach(() => {
+  global.location = location;
+});
+
 describe('getAuthenticatedHttpClient', () => {
   beforeEach(() => {
     console.error = jest.fn();
@@ -512,7 +522,7 @@ describe('authenticatedHttpClient usage', () => {
       it(`${method.toUpperCase()}: does not redirect to login`, () => {
         return client[method](mockApiEndpointPath).then(() => {
           expectSingleCallToJwtTokenRefresh();
-          expect(window.location.assign).not.toHaveBeenCalled();
+          expect(global.location.assign).not.toHaveBeenCalled();
         });
       });
     });
@@ -732,7 +742,7 @@ describe('ensureAuthenticatedUser', () => {
       expect.hasAssertions();
       return service.ensureAuthenticatedUser().catch(() => {
         expectSingleCallToJwtTokenRefresh();
-        expect(window.location.assign).not.toHaveBeenCalled();
+        expect(global.location.assign).not.toHaveBeenCalled();
         expectLogFunctionToHaveBeenCalledWithMessage(
           mockLoggingService.logError.mock.calls[0],
           '[frontend-auth] Redirect from login page. Rejecting to avoid infinite redirect loop.',
diff --git a/src/auth/MockAuthService.js b/src/auth/MockAuthService.js
@@ -138,8 +138,9 @@ class MockAuthService {
 
     // Mock user
     this.authenticatedUser = this.config.authenticatedUser ? this.config.authenticatedUser : null;
-    this.hydratedAuthenticatedUser = this.config.hydratedAuthenticatedUser ?
-      this.config.hydratedAuthenticatedUser : {};
+    this.hydratedAuthenticatedUser = this.config.hydratedAuthenticatedUser
+      ? this.config.hydratedAuthenticatedUser
+      : {};
 
     this.authenticatedHttpClient = axios.create();
     this.httpClient = axios.create();
diff --git a/src/auth/interface.js b/src/auth/interface.js
@@ -245,7 +245,6 @@ export async function hydrateAuthenticatedUser() {
   publish(AUTHENTICATED_USER_CHANGED);
 }
 
-
 /**
  * @name AuthService
  * @interface
diff --git a/src/config.js b/src/config.js
@@ -25,6 +25,7 @@
  */
 
 import { APP_CONFIG_INITIALIZED, CONFIG_CHANGED } from './constants';
+
 import { publish, subscribe } from './pubSub';
 import { ensureDefinedConfig } from './utils';
 
diff --git a/src/constants.js b/src/constants.js
@@ -1,4 +1,3 @@
-
 /** @constant */
 export const APP_TOPIC = 'APP';
 
@@ -65,4 +64,3 @@ export const APP_INIT_ERROR = `${APP_TOPIC}.INIT_ERROR`;
 export const CONFIG_TOPIC = 'CONFIG';
 
 export const CONFIG_CHANGED = `${CONFIG_TOPIC}.CHANGED`;
-
diff --git a/src/i18n/injectIntlWithShim.jsx b/src/i18n/injectIntlWithShim.jsx
@@ -10,10 +10,6 @@ import { getLoggingService } from './lib';
  */
 const injectIntlWithShim = (WrappedComponent) => {
   class ShimmedIntlComponent extends React.Component {
-    static propTypes = {
-      intl: intlShape.isRequired,
-    };
-
     constructor(props) {
       super(props);
       this.shimmedIntl = Object.create(this.props.intl, {
@@ -39,8 +35,11 @@ const injectIntlWithShim = (WrappedComponent) => {
     }
   }
 
+  ShimmedIntlComponent.propTypes = {
+    intl: intlShape.isRequired,
+  };
+
   return injectIntl(ShimmedIntlComponent);
 };
 
-
 export default injectIntlWithShim;
diff --git a/src/i18n/lib.test.js b/src/i18n/lib.test.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 import {
   configure,
   getPrimaryLanguageSubtag,
@@ -13,10 +14,15 @@ jest.mock('universal-cookie');
 
 describe('lib', () => {
   describe('configure', () => {
-    let warnSpy = null;
+    let originalWarn = null;
 
     beforeEach(() => {
-      warnSpy = spyOn(console, 'warn');
+      originalWarn = console.warn;
+      console.warn = jest.fn();
+    });
+
+    afterEach(() => {
+      console.warn = originalWarn;
     });
 
     it('should not call console.warn in production', () => {
@@ -33,7 +39,7 @@ describe('lib', () => {
         },
       });
 
-      expect(warnSpy).not.toHaveBeenCalled();
+      expect(console.warn).not.toHaveBeenCalled();
     });
 
     it('should warn about unexpected locales', () => {
@@ -61,7 +67,7 @@ describe('lib', () => {
         },
       });
 
-      expect(warnSpy).toHaveBeenCalledWith('Unexpected locale: uhoh');
+      expect(console.warn).toHaveBeenCalledWith('Unexpected locale: uhoh');
     });
 
     it('should warn about missing locales', () => {
@@ -74,20 +80,20 @@ describe('lib', () => {
         messages: {},
       });
 
-      expect(warnSpy).toHaveBeenCalledTimes(13);
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: ar');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: es-419');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: fr');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: zh-cn');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: ca');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: he');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: id');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: ko-kr');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: pl');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: pt-br');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: ru');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: th');
-      expect(warnSpy).toHaveBeenCalledWith('Missing locale: uk');
+      expect(console.warn).toHaveBeenCalledTimes(13);
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: ar');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: es-419');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: fr');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: zh-cn');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: ca');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: he');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: id');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: ko-kr');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: pl');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: pt-br');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: ru');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: th');
+      expect(console.warn).toHaveBeenCalledWith('Missing locale: uk');
     });
   });
 
diff --git a/src/initialize.js b/src/initialize.js
@@ -49,14 +49,33 @@ import { createBrowserHistory, createMemoryHistory } from 'history';
 import {
   publish,
 } from './pubSub';
+// eslint-disable-next-line import/no-cycle
+import { getConfig } from './config';
 import {
-  getConfig,
-} from './config';
-import { configure as configureLogging, getLoggingService, NewRelicLoggingService, logError } from './logging';
-import { configure as configureAnalytics, SegmentAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser } from './analytics';
-import { getAuthenticatedHttpClient, configure as configureAuth, ensureAuthenticatedUser, fetchAuthenticatedUser, hydrateAuthenticatedUser, getAuthenticatedUser, AxiosJwtAuthService } from './auth';
+  configure as configureLogging, getLoggingService, NewRelicLoggingService, logError,
+} from './logging';
+import {
+  configure as configureAnalytics, SegmentAnalyticsService, identifyAnonymousUser, identifyAuthenticatedUser,
+} from './analytics';
+import {
+  getAuthenticatedHttpClient,
+  configure as configureAuth,
+  ensureAuthenticatedUser,
+  fetchAuthenticatedUser,
+  hydrateAuthenticatedUser,
+  getAuthenticatedUser,
+  AxiosJwtAuthService,
+} from './auth';
 import { configure as configureI18n } from './i18n';
-import { APP_PUBSUB_INITIALIZED, APP_CONFIG_INITIALIZED, APP_AUTH_INITIALIZED, APP_I18N_INITIALIZED, APP_LOGGING_INITIALIZED, APP_ANALYTICS_INITIALIZED, APP_READY, APP_INIT_ERROR } from './constants';
+import {
+  APP_PUBSUB_INITIALIZED,
+  APP_CONFIG_INITIALIZED,
+  APP_AUTH_INITIALIZED,
+  APP_I18N_INITIALIZED,
+  APP_LOGGING_INITIALIZED,
+  APP_ANALYTICS_INITIALIZED,
+  APP_READY, APP_INIT_ERROR,
+} from './constants';
 
 /**
  * A browser history or memory history object created by the [history](https://github.com/ReactTraining/history)
@@ -109,7 +128,6 @@ export async function auth(requireUser, hydrateUser) {
   }
 }
 
-
 /**
  * The default handler for the initialization lifecycle's `analytics` phase.
  *
diff --git a/src/initialize.test.js b/src/initialize.test.js
@@ -12,8 +12,21 @@ import {
 import { initialize } from './initialize';
 import { subscribe } from './pubSub';
 
-import { configure as configureLogging, NewRelicLoggingService, getLoggingService, logError } from './logging';
-import { configure as configureAuth, getAuthenticatedHttpClient, ensureAuthenticatedUser, fetchAuthenticatedUser, hydrateAuthenticatedUser, getAuthenticatedUser, AxiosJwtAuthService } from './auth';
+import {
+  configure as configureLogging,
+  NewRelicLoggingService,
+  getLoggingService,
+  logError,
+} from './logging';
+import {
+  configure as configureAuth,
+  getAuthenticatedHttpClient,
+  ensureAuthenticatedUser,
+  fetchAuthenticatedUser,
+  hydrateAuthenticatedUser,
+  getAuthenticatedUser,
+  AxiosJwtAuthService,
+} from './auth';
 import { configure as configureAnalytics, SegmentAnalyticsService } from './analytics';
 import { configure as configureI18n } from './i18n';
 import { getConfig } from './config';
diff --git a/src/logging/NewRelicLoggingService.js b/src/logging/NewRelicLoggingService.js
@@ -10,7 +10,8 @@ function fixErrorLength(error) {
     const processedError = Object.create(error);
     processedError.message = processedError.message.substring(0, MAX_ERROR_LENGTH);
     return processedError;
-  } else if (typeof error === 'string' && error.length > MAX_ERROR_LENGTH) {
+  }
+  if (typeof error === 'string' && error.length > MAX_ERROR_LENGTH) {
     return error.substring(0, MAX_ERROR_LENGTH);
   }
   return error;
@@ -58,7 +59,7 @@ export default class NewRelicLoggingService {
     }
     /* istanbul ignore else */
     if (window && typeof window.newrelic !== 'undefined') {
-      window.newrelic.addPageAction('INFO', Object.assign({}, { message }, customAttributes));
+      window.newrelic.addPageAction('INFO', { message, ...customAttributes });
     }
   }
 
diff --git a/src/logging/index.js b/src/logging/index.js
@@ -1,2 +1,8 @@
-export { getLoggingService, resetLoggingService, configure, logInfo, logError } from './interface';
+export {
+  getLoggingService,
+  resetLoggingService,
+  configure,
+  logInfo,
+  logError,
+} from './interface';
 export { default as NewRelicLoggingService } from './NewRelicLoggingService';
diff --git a/src/pubSub.js b/src/pubSub.js
@@ -19,7 +19,6 @@
 
 import PubSub from 'pubsub-js';
 
-
 /**
  *
  * @param {string} type
diff --git a/src/react/AppProvider.jsx b/src/react/AppProvider.jsx
diff --git a/src/react/AuthenticatedPageRoute.test.jsx b/src/react/AuthenticatedPageRoute.test.jsx
diff --git a/src/react/ErrorBoundary.jsx b/src/react/ErrorBoundary.jsx
diff --git a/src/react/ErrorPage.jsx b/src/react/ErrorPage.jsx
diff --git a/src/react/OptionalReduxProvider.jsx b/src/react/OptionalReduxProvider.jsx
diff --git a/src/utils.js b/src/utils.js
diff --git a/src/utils.test.js b/src/utils.test.js

Original file line number	Diff line number	Diff line change
`@@ -245,7 +245,6 @@ export async function hydrateAuthenticatedUser() {`
`245`	`245`	`publish(AUTHENTICATED_USER_CHANGED);`
`246`	`246`	`}`
`247`	`247`
`248`		`-`
`249`	`248`	`/**`
`250`	`249`	`* @name AuthService`
`251`	`250`	`* @interface`