Merge pull request #1826 from 4Science/CST-6753_GA4

Update Google Analytics to version 4

Author: tdonohue

src/app/app.component.spec.ts

@@ -1,10 +1,9 @@
 import { Store, StoreModule } from '@ngrx/store';
 import { ComponentFixture, inject, TestBed, waitForAsync } from '@angular/core/testing';
 import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
-import { CommonModule, DOCUMENT } from '@angular/common';
+import { CommonModule } from '@angular/common';
 import { ActivatedRoute, Router } from '@angular/router';
 import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
-import { Angulartics2GoogleAnalytics } from 'angulartics2';
 
 // Load the implementations that should be tested
 import { AppComponent } from './app.component';
@@ -73,7 +72,6 @@ describe('App component', () => {
       providers: [
         { provide: NativeWindowService, useValue: new NativeWindowRef() },
         { provide: MetadataService, useValue: new MetadataServiceMock() },
-        { provide: Angulartics2GoogleAnalytics, useValue: new AngularticsProviderMock() },
         { provide: Angulartics2DSpace, useValue: new AngularticsProviderMock() },
         { provide: AuthService, useValue: new AuthServiceMock() },
         { provide: Router, useValue: new RouterMock() },

src/app/root/root.component.spec.ts

@@ -9,7 +9,6 @@ import { TranslateLoaderMock } from '../shared/mocks/translate-loader.mock';
 import { NativeWindowRef, NativeWindowService } from '../core/services/window.service';
 import { MetadataService } from '../core/metadata/metadata.service';
 import { MetadataServiceMock } from '../shared/mocks/metadata-service.mock';
-import { Angulartics2GoogleAnalytics } from 'angulartics2';
 import { AngularticsProviderMock } from '../shared/mocks/angulartics-provider.service.mock';
 import { Angulartics2DSpace } from '../statistics/angulartics/dspace-provider';
 import { AuthService } from '../core/auth/auth.service';
@@ -50,7 +49,6 @@ describe('RootComponent', () => {
       providers: [
         { provide: NativeWindowService, useValue: new NativeWindowRef() },
         { provide: MetadataService, useValue: new MetadataServiceMock() },
-        { provide: Angulartics2GoogleAnalytics, useValue: new AngularticsProviderMock() },
         { provide: Angulartics2DSpace, useValue: new AngularticsProviderMock() },
         { provide: AuthService, useValue: new AuthServiceMock() },
         { provide: Router, useValue: new RouterMock() },

src/app/root/root.component.ts

@@ -5,7 +5,6 @@ import { Router } from '@angular/router';
 import { combineLatest as combineLatestObservable, Observable, of } from 'rxjs';
 import { Store } from '@ngrx/store';
 import { TranslateService } from '@ngx-translate/core';
-import { Angulartics2GoogleAnalytics } from 'angulartics2';
 
 import { MetadataService } from '../core/metadata/metadata.service';
 import { HostWindowState } from '../shared/search/host-window.reducer';
@@ -51,7 +50,6 @@ export class RootComponent implements OnInit {
     private translate: TranslateService,
     private store: Store<HostWindowState>,
     private metadata: MetadataService,
-    private angulartics2GoogleAnalytics: Angulartics2GoogleAnalytics,
     private angulartics2DSpace: Angulartics2DSpace,
     private authService: AuthService,
     private router: Router,

src/app/shared/cookies/browser-klaro.service.spec.ts

@@ -10,10 +10,12 @@ import { AuthService } from '../../core/auth/auth.service';
 import { CookieService } from '../../core/services/cookie.service';
 import { getTestScheduler } from 'jasmine-marbles';
 import { MetadataValue } from '../../core/shared/metadata.models';
-import {clone, cloneDeep} from 'lodash';
+import { clone, cloneDeep } from 'lodash';
 import { ConfigurationDataService } from '../../core/data/configuration-data.service';
-import {createFailedRemoteDataObject$, createSuccessfulRemoteDataObject$} from '../remote-data.utils';
+import { createFailedRemoteDataObject$, createSuccessfulRemoteDataObject$ } from '../remote-data.utils';
 import { ConfigurationProperty } from '../../core/shared/configuration-property.model';
+import { ANONYMOUS_STORAGE_NAME_KLARO } from './klaro-configuration';
+import { TestScheduler } from 'rxjs/testing';
 
 describe('BrowserKlaroService', () => {
   const trackingIdProp = 'google.analytics.key';
@@ -29,7 +31,7 @@ describe('BrowserKlaroService', () => {
   let configurationDataService: ConfigurationDataService;
   const createConfigSuccessSpy = (...values: string[]) => jasmine.createSpyObj('configurationDataService', {
     findByPropertyName: createSuccessfulRemoteDataObject$({
-      ... new ConfigurationProperty(),
+      ...new ConfigurationProperty(),
       name: trackingIdProp,
       values: values,
     }),
@@ -42,7 +44,9 @@ describe('BrowserKlaroService', () => {
   let findByPropertyName;
 
   beforeEach(() => {
-    user = new EPerson();
+    user = Object.assign(new EPerson(), {
+      uuid: 'test-user'
+    });
 
     translateService = getMockTranslateService();
     ePersonService = jasmine.createSpyObj('ePersonService', {
@@ -104,7 +108,7 @@ describe('BrowserKlaroService', () => {
       services: [{
         name: appName,
         purposes: [purpose]
-      },{
+      }, {
         name: googleAnalytics,
         purposes: [purpose]
       }],
@@ -219,6 +223,40 @@ describe('BrowserKlaroService', () => {
     });
   });
 
+  describe('getSavedPreferences', () => {
+    let scheduler: TestScheduler;
+    beforeEach(() => {
+      scheduler = getTestScheduler();
+    });
+
+    describe('when no user is autheticated', () => {
+      beforeEach(() => {
+        spyOn(service as any, 'getUser$').and.returnValue(observableOf(undefined));
+      });
+
+      it('should return the cookie consents object', () => {
+        scheduler.schedule(() => service.getSavedPreferences().subscribe());
+        scheduler.flush();
+
+        expect(cookieService.get).toHaveBeenCalledWith(ANONYMOUS_STORAGE_NAME_KLARO);
+      });
+    });
+
+    describe('when user is autheticated', () => {
+      beforeEach(() => {
+        spyOn(service as any, 'getUser$').and.returnValue(observableOf(user));
+      });
+
+      it('should return the cookie consents object', () => {
+        scheduler.schedule(() => service.getSavedPreferences().subscribe());
+        scheduler.flush();
+
+        expect(cookieService.get).toHaveBeenCalledWith('klaro-' + user.uuid);
+      });
+    });
+  });
+
+
   describe('setSettingsForUser when there are changes', () => {
     const cookieConsent = { test: 'testt' };
     const cookieConsentString = '{test: \'testt\'}';
@@ -271,40 +309,40 @@ describe('BrowserKlaroService', () => {
     });
     it('should not filter googleAnalytics when servicesToHide are empty', () => {
       const filteredConfig = (service as any).filterConfigServices([]);
-      expect(filteredConfig).toContain(jasmine.objectContaining({name: googleAnalytics}));
+      expect(filteredConfig).toContain(jasmine.objectContaining({ name: googleAnalytics }));
     });
     it('should filter services using names passed as servicesToHide', () => {
       const filteredConfig = (service as any).filterConfigServices([googleAnalytics]);
-      expect(filteredConfig).not.toContain(jasmine.objectContaining({name: googleAnalytics}));
+      expect(filteredConfig).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));
     });
     it('should have been initialized with googleAnalytics', () => {
       service.initialize();
-      expect(service.klaroConfig.services).toContain(jasmine.objectContaining({name: googleAnalytics}));
+      expect(service.klaroConfig.services).toContain(jasmine.objectContaining({ name: googleAnalytics }));
     });
     it('should filter googleAnalytics when empty configuration is retrieved', () => {
       configurationDataService.findByPropertyName = jasmine.createSpy().withArgs(GOOGLE_ANALYTICS_KEY).and.returnValue(
         createSuccessfulRemoteDataObject$({
-          ... new ConfigurationProperty(),
+          ...new ConfigurationProperty(),
           name: googleAnalytics,
           values: [],
         }));
 
       service.initialize();
-      expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({name: googleAnalytics}));
+      expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));
     });
     it('should filter googleAnalytics when an error occurs', () => {
       configurationDataService.findByPropertyName = jasmine.createSpy().withArgs(GOOGLE_ANALYTICS_KEY).and.returnValue(
         createFailedRemoteDataObject$('Erro while loading GA')
       );
       service.initialize();
-      expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({name: googleAnalytics}));
+      expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));
     });
     it('should filter googleAnalytics when an invalid payload is retrieved', () => {
       configurationDataService.findByPropertyName = jasmine.createSpy().withArgs(GOOGLE_ANALYTICS_KEY).and.returnValue(
         createSuccessfulRemoteDataObject$(null)
       );
       service.initialize();
-      expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({name: googleAnalytics}));
+      expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));
     });
   });
 });

src/app/shared/cookies/browser-klaro.service.ts

@@ -13,7 +13,7 @@ import { EPersonDataService } from '../../core/eperson/eperson-data.service';
 import { cloneDeep, debounce } from 'lodash';
 import { ANONYMOUS_STORAGE_NAME_KLARO, klaroConfiguration } from './klaro-configuration';
 import { Operation } from 'fast-json-patch';
-import { getFirstCompletedRemoteData} from '../../core/shared/operators';
+import { getFirstCompletedRemoteData } from '../../core/shared/operators';
 import { ConfigurationDataService } from '../../core/data/configuration-data.service';
 
 /**
@@ -121,6 +121,23 @@ export class BrowserKlaroService extends KlaroService {
       });
   }
 
+  /**
+   * Return saved preferences stored in the klaro cookie
+   */
+  getSavedPreferences(): Observable<any> {
+    return this.getUser$().pipe(
+      map((user: EPerson) => {
+        let storageName;
+        if (isEmpty(user)) {
+          storageName = ANONYMOUS_STORAGE_NAME_KLARO;
+        } else {
+          storageName = this.getStorageName(user.uuid);
+        }
+        return this.cookieService.get(storageName);
+      })
+    );
+  }
+
   /**
    * Initialize configuration for the logged in user
    * @param user The authenticated user

src/app/shared/cookies/klaro-configuration.ts

@@ -12,6 +12,8 @@ export const HAS_AGREED_END_USER = 'dsHasAgreedEndUser';
  */
 export const ANONYMOUS_STORAGE_NAME_KLARO = 'klaro-anonymous';
 
+export const GOOGLE_ANALYTICS_KLARO_KEY = 'google-analytics';
+
 /**
  * Klaro configuration
  * For more information see https://kiprotect.com/docs/klaro/annotated-config
@@ -113,7 +115,7 @@ export const klaroConfiguration: any = {
       ]
     },
     {
-      name: 'google-analytics',
+      name: GOOGLE_ANALYTICS_KLARO_KEY,
       purposes: ['statistical'],
       required: false,
       cookies: [

src/app/shared/cookies/klaro.service.ts

@@ -1,5 +1,7 @@
 import { Injectable } from '@angular/core';
 
+import { Observable } from 'rxjs';
+
 /**
  * Abstract class representing a service for handling Klaro consent preferences and UI
  */
@@ -11,7 +13,12 @@ export abstract class KlaroService {
   abstract initialize();
 
   /**
-   * Shows a the dialog with the current consent preferences
+   * Shows a dialog with the current consent preferences
    */
   abstract showSettings();
+
+  /**
+   * Return saved preferences stored in the klaro cookie
+   */
+  abstract getSavedPreferences(): Observable<any>;
 }