Updated bootstrapper to resolve required legal entity context (#461)

* Updated bootstrapper to resolve required legal entity context

* Removed console log

Author: Blackbaud-PaulCrowder

package.json

@@ -42,7 +42,7 @@
     "@angular/platform-browser": "4.3.6",
     "@angular/platform-browser-dynamic": "4.3.6",
     "@angular/router": "4.3.6",
-    "@blackbaud/auth-client": "2.7.0",
+    "@blackbaud/auth-client": "2.8.0",
     "@blackbaud/skyux-lib-help": "1.3.0",
     "@blackbaud/skyux-logger": "1.0.2",
     "@ngtools/webpack": "1.3.1",

runtime/bootstrapper.spec.ts

@@ -15,7 +15,7 @@ describe('bootstrapper', () => {
   function validateContextProvided(testEnvId: string, testUrl: string, expectedUrl: string) {
     let contextPromiseResolve: any;
 
-    const contextPromise = new Promise((resolve, reject) => {
+    const contextPromise = new Promise((resolve) => {
       contextPromiseResolve = resolve;
     });
 
@@ -33,18 +33,23 @@ describe('bootstrapper', () => {
       };
 
       SkyAppBootstrapper.processBootstrapConfig().then(() => {
-        expect(historyReplaceStateSpy).toHaveBeenCalledWith(
-          {},
-          '',
-          expectedUrl
-        );
+        if (testUrl === expectedUrl) {
+          expect(historyReplaceStateSpy).not.toHaveBeenCalled();
+        } else {
+          expect(historyReplaceStateSpy).toHaveBeenCalledWith(
+            {},
+            '',
+            expectedUrl
+          );
+        }
 
         resolve();
       });
 
       contextPromiseResolve({
         envId: testEnvId,
-        svcId: 'abc'
+        svcId: 'abc',
+        url: 'https://example.com?envid=123'
       });
     });
   }
@@ -92,16 +97,15 @@ describe('bootstrapper', () => {
       'https://example.com',
       'https://example.com?envid=123'
     )
-      .then(() => validateContextProvided(
-        '12&3',
-        'https://example.com#test',
-        'https://example.com?envid=12%263#test'
-      ))
-      .then(() => validateContextProvided(
+      .then(done);
+  });
+
+  it('should not replace state when the resolved URL matches the current URL', (done) => {
+    validateContextProvided(
         '123',
-        'https://example.com?svcid=abc',
-        'https://example.com?svcid=abc&envid=123'
-      ))
+        'https://example.com?envid=123',
+        'https://example.com?envid=123'
+    )
       .then(done);
   });
 

runtime/bootstrapper.ts

@@ -1,20 +1,20 @@
+//#region imports
+
 import {
   BBAuth,
+  BBContextArgs,
   BBContextProvider
 } from '@blackbaud/auth-client';
 
-import { SkyuxConfig } from './config';
-
-import { SkyAppRuntimeConfigParams } from './params';
-
-function addQSParam(url: string, name: string, value: string): string {
-  const urlAndFragment = url.split('#');
+import {
+  SkyuxConfig
+} from './config';
 
-  urlAndFragment[0] += urlAndFragment[0].indexOf('?') >= 0 ? '&' : '?';
-  urlAndFragment[0] += `${name}=${encodeURIComponent(value)}`;
+import {
+  SkyAppRuntimeConfigParams
+} from './params';
 
-  return urlAndFragment.join('#');
-}
+//#endregion
 
 export class SkyAppBootstrapper {
 
@@ -23,35 +23,36 @@ export class SkyAppBootstrapper {
   public static processBootstrapConfig(): Promise<any> {
     if (SkyAppBootstrapper.config && SkyAppBootstrapper.config.auth) {
       return BBAuth.getToken()
-        .then((token) => {
-          const url = this.getUrl();
+        .then(() => {
+          const currentUrl = this.getUrl();
 
           const params = new SkyAppRuntimeConfigParams(
-            url,
+            currentUrl,
             this.config.params
           );
 
-          const currentEnvId = params.get('envid');
-
-          return BBContextProvider.ensureContext({
-            envId: currentEnvId,
+          const ensureContextArgs: BBContextArgs = {
+            envId: params.get('envid'),
             envIdRequired: params.isRequired('envid'),
+            leId: params.get('leid'),
+            leIdRequired: params.isRequired('leid'),
             svcId: params.get('svcid'),
             svcIdRequired: params.isRequired('svcid'),
-            url: url
-          }).then(({ envId }) => {
-            // The context provider was able to provide an environment ID when none
-            // was supplied to the app; add it to the URL's query string and continue
-            // loading the app.  Downstream constructors of SkyAppRuntimeConfigParams
-            // will then pick up the environment ID from the query string.
-            if (!currentEnvId && envId) {
-              history.replaceState(
-                {},
-                '',
-                addQSParam(url, 'envid', envId)
-              );
-            }
-          });
+            url: currentUrl
+          };
+
+          return BBContextProvider.ensureContext(ensureContextArgs)
+            .then((args) => {
+              // The URL will remain the same if the required context is already present, in which
+              // case there's no need to update the URL.
+              if (args.url !== currentUrl) {
+                history.replaceState(
+                  {},
+                  '',
+                  args.url
+                );
+              }
+            });
         });
     } else {
       return Promise.resolve();