Merge pull request #90 from dsteelma-umd/feature/LIBDRUM-954

LIBDRUM-954. Incorporated 4Science Matomo patch into DRUM

https://umd-dit.atlassian.net/browse/LIBDRUM-954

Author: dsteelma-umd

package.json

@@ -113,6 +113,7 @@
     "ng2-file-upload": "5.0.0",
     "ng2-nouislider": "^2.0.0",
     "ngx-infinite-scroll": "^16.0.0",
+    "ngx-matomo-client": "^6.4.1",
     "ngx-pagination": "6.0.3",
     "ngx-skeleton-loader": "^9.0.0",
     "ngx-ui-switch": "^14.1.0",

src/app/bitstream-page/bitstream-download-page/bitstream-download-page.component.spec.ts

@@ -2,7 +2,10 @@
 /* eslint-disable import-newlines/enforce */
 /* eslint-disable simple-import-sort/imports */
 // End Customization
-import { CommonModule } from '@angular/common';
+import {
+  CommonModule,
+  Location,
+} from '@angular/common';
 import { PLATFORM_ID } from '@angular/core';
 import {
   ComponentFixture,
@@ -20,13 +23,15 @@ import { of as observableOf } from 'rxjs';
 import { RESTRICTED_ACCESS_MODULE_PATH } from '../../app-routing-paths';
 // End UMD Customization
 import { AuthService } from '../../core/auth/auth.service';
+import { DSONameService } from '../../core/breadcrumbs/dso-name.service';
 import { AuthorizationDataService } from '../../core/data/feature-authorization/authorization-data.service';
 import { SignpostingDataService } from '../../core/data/signposting-data.service';
 import { HardRedirectService } from '../../core/services/hard-redirect.service';
 import { ServerResponseService } from '../../core/services/server-response.service';
 import { Bitstream } from '../../core/shared/bitstream.model';
 import { FileService } from '../../core/shared/file.service';
 import { createSuccessfulRemoteDataObject } from '../../shared/remote-data.utils';
+import { MatomoService } from '../../statistics/matomo.service';
 import { BitstreamDownloadPageComponent } from './bitstream-download-page.component';
 
 describe('BitstreamDownloadPageComponent', () => {
@@ -39,10 +44,13 @@ describe('BitstreamDownloadPageComponent', () => {
   let hardRedirectService: HardRedirectService;
   let activatedRoute;
   let router;
+  let location: Location;
+  let dsoNameService: DSONameService;
 
   let bitstream: Bitstream;
   let serverResponseService: jasmine.SpyObj<ServerResponseService>;
   let signpostingDataService: jasmine.SpyObj<SignpostingDataService>;
+  let matomoService: jasmine.SpyObj<MatomoService>;
 
   const mocklink = {
     href: 'http://test.org',
@@ -60,6 +68,7 @@ describe('BitstreamDownloadPageComponent', () => {
     authService = jasmine.createSpyObj('authService', {
       isAuthenticated: observableOf(true),
       setRedirectUrl: {},
+      getShortlivedToken: observableOf('token'),
     });
     authorizationService = jasmine.createSpyObj('authorizationSerivice', {
       isAuthorized: observableOf(true),
@@ -69,9 +78,18 @@ describe('BitstreamDownloadPageComponent', () => {
       retrieveFileDownloadLink: observableOf('content-url-with-headers'),
     });
 
-    hardRedirectService = jasmine.createSpyObj('fileService', {
+    hardRedirectService = jasmine.createSpyObj('hardRedirectService', {
       redirect: {},
     });
+
+    location = jasmine.createSpyObj('location', {
+      back: {},
+    });
+
+    dsoNameService = jasmine.createSpyObj('dsoNameService', {
+      getName: 'Test Bitstream',
+    });
+
     bitstream = Object.assign(new Bitstream(), {
       uuid: 'bitstreamUuid',
       _links: {
@@ -100,6 +118,8 @@ describe('BitstreamDownloadPageComponent', () => {
     signpostingDataService = jasmine.createSpyObj('SignpostingDataService', {
       getLinks: observableOf([mocklink, mocklink2]),
     });
+    matomoService = jasmine.createSpyObj('MatomoService', ['appendVisitorId']);
+    matomoService.appendVisitorId.and.callFake((link) => observableOf(link));
   }
 
   function initTestbed() {
@@ -114,7 +134,10 @@ describe('BitstreamDownloadPageComponent', () => {
         { provide: HardRedirectService, useValue: hardRedirectService },
         { provide: ServerResponseService, useValue: serverResponseService },
         { provide: SignpostingDataService, useValue: signpostingDataService },
+        { provide: MatomoService, useValue: matomoService },
         { provide: PLATFORM_ID, useValue: 'server' },
+        { provide: Location, useValue: location },
+        { provide: DSONameService, useValue: dsoNameService },
       ],
     })
       .compileComponents();
@@ -148,9 +171,11 @@ describe('BitstreamDownloadPageComponent', () => {
         component = fixture.componentInstance;
         fixture.detectChanges();
       });
-      it('should redirect to the content link', () => {
-        expect(hardRedirectService.redirect).toHaveBeenCalledWith('bitstream-content-link');
-      });
+      it('should redirect to the content link', waitForAsync(() => {
+        fixture.whenStable().then(() => {
+          expect(hardRedirectService.redirect).toHaveBeenCalledWith('bitstream-content-link');
+        });
+      }));
       it('should add the signposting links', () => {
         expect(serverResponseService.setHeader).toHaveBeenCalled();
       });
@@ -165,9 +190,11 @@ describe('BitstreamDownloadPageComponent', () => {
         component = fixture.componentInstance;
         fixture.detectChanges();
       });
-      it('should redirect to an updated content link', () => {
-        expect(hardRedirectService.redirect).toHaveBeenCalledWith('content-url-with-headers');
-      });
+      it('should redirect to an updated content link', waitForAsync(() => {
+        fixture.whenStable().then(() => {
+          expect(hardRedirectService.redirect).toHaveBeenCalledWith('content-url-with-headers');
+        });
+      }));
     });
     describe('when the user is not authorized and logged in', () => {
       beforeEach(waitForAsync(() => {
@@ -181,11 +208,13 @@ describe('BitstreamDownloadPageComponent', () => {
         fixture.detectChanges();
       });
       // UMD Customization
-      it('should navigate to the restricted access route', () => {
-        expect(router.navigateByUrl).toHaveBeenCalledWith(
-          `${RESTRICTED_ACCESS_MODULE_PATH}/bitstreamUuid`, { replaceUrl: true },
-        );
-      });
+      it('should navigate to the restricted access route', waitForAsync(() => {
+        fixture.whenStable().then(() => {
+          expect(router.navigateByUrl).toHaveBeenCalledWith(
+            `${RESTRICTED_ACCESS_MODULE_PATH}/bitstreamUuid`, { replaceUrl: true },
+          );
+        });
+      }));
       // End UMD Customization
     });
     describe('when the user is not authorized and not logged in', () => {
@@ -201,11 +230,13 @@ describe('BitstreamDownloadPageComponent', () => {
         fixture.detectChanges();
       });
       // UMD Customization
-      it('should navigate to the restricted access route', () => {
-        expect(router.navigateByUrl).toHaveBeenCalledWith(
-          `${RESTRICTED_ACCESS_MODULE_PATH}/bitstreamUuid`, { replaceUrl: true },
-        );
-      });
+      it('should navigate to the restricted access route', waitForAsync(() => {
+        fixture.whenStable().then(() => {
+          expect(router.navigateByUrl).toHaveBeenCalledWith(
+            `${RESTRICTED_ACCESS_MODULE_PATH}/bitstreamUuid`, { replaceUrl: true },
+          );
+        });
+      }));
       // End UMD Customization
     });
   });

src/app/bitstream-page/bitstream-download-page/bitstream-download-page.component.ts

@@ -50,6 +50,7 @@ import {
   hasValue,
   isNotEmpty,
 } from '../../shared/empty.util';
+import { MatomoService } from '../../statistics/matomo.service';
 
 @Component({
   selector: 'ds-bitstream-download-page',
@@ -79,6 +80,7 @@ export class BitstreamDownloadPageComponent implements OnInit {
     public dsoNameService: DSONameService,
     private signpostingDataService: SignpostingDataService,
     private responseService: ServerResponseService,
+    private matomoService: MatomoService,
     @Inject(PLATFORM_ID) protected platformId: string,
   ) {
     this.initPageLinks();
@@ -115,14 +117,20 @@ export class BitstreamDownloadPageComponent implements OnInit {
               return [isAuthorized, isLoggedIn, bitstream, fileLink];
             }));
         } else {
-          return [[isAuthorized, isLoggedIn, bitstream, '']];
+          return [[isAuthorized, isLoggedIn, bitstream, bitstream._links.content.href]];
         }
       }),
+      switchMap(([isAuthorized, isLoggedIn, bitstream, fileLink]: [boolean, boolean, Bitstream, string]) =>
+        this.matomoService.appendVisitorId(fileLink)
+          .pipe(
+            map((fileLinkWithVisitorId) => [isAuthorized, isLoggedIn, bitstream, fileLinkWithVisitorId]),
+          ),
+      ),
     ).subscribe(([isAuthorized, isLoggedIn, bitstream, fileLink]: [boolean, boolean, Bitstream, string]) => {
       if (isAuthorized && isLoggedIn && isNotEmpty(fileLink)) {
         this.hardRedirectService.redirect(fileLink);
       } else if (isAuthorized && !isLoggedIn) {
-        this.hardRedirectService.redirect(bitstream._links.content.href);
+        this.hardRedirectService.redirect(fileLink);
       // UMD Customization
       } else if (!isAuthorized && isLoggedIn) {
         // This can happen due to a "Campus" group IP restrictions

src/app/core/shared/search/search.service.spec.ts

@@ -37,6 +37,7 @@ import { SearchService } from './search.service';
 import { SearchConfigurationService } from './search-configuration.service';
 import anything = jasmine.anything;
 
+
 @Component({
   template: '',
   standalone: true,

src/app/core/shared/search/search.service.ts

@@ -367,7 +367,7 @@ export class SearchService {
       const appliedFilter = appliedFilters[i];
       filters.push(appliedFilter);
     }
-    this.angulartics2.eventTrack.next({
+    const searchTrackObject = {
       action: 'search',
       properties: {
         searchOptions: config,
@@ -384,7 +384,9 @@ export class SearchService {
         filters: filters,
         clickedObject,
       },
-    });
+    };
+
+    this.angulartics2.eventTrack.next(searchTrackObject);
   }
 
   /**

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

@@ -28,6 +28,7 @@ import { ANONYMOUS_STORAGE_NAME_KLARO } from './klaro-configuration';
 describe('BrowserKlaroService', () => {
   const trackingIdProp = 'google.analytics.key';
   const trackingIdTestValue = 'mock-tracking-id';
+  const matomoTrackingId = 'matomo-tracking-id';
   const googleAnalytics = 'google-analytics';
   const recaptchaProp = 'registration.verification.enabled';
   const recaptchaValue = 'true';
@@ -309,9 +310,11 @@ describe('BrowserKlaroService', () => {
   describe('initialize google analytics configuration', () => {
     let GOOGLE_ANALYTICS_KEY;
     let REGISTRATION_VERIFICATION_ENABLED_KEY;
+    let MATOMO_ENABLED;
     beforeEach(() => {
       GOOGLE_ANALYTICS_KEY = clone((service as any).GOOGLE_ANALYTICS_KEY);
       REGISTRATION_VERIFICATION_ENABLED_KEY = clone((service as any).REGISTRATION_VERIFICATION_ENABLED_KEY);
+      MATOMO_ENABLED = clone((service as any).MATOMO_ENABLED);
       spyOn((service as any), 'getUser$').and.returnValue(observableOf(user));
       translateService.get.and.returnValue(observableOf('loading...'));
       spyOn(service, 'addAppMessages');
@@ -360,6 +363,15 @@ describe('BrowserKlaroService', () => {
               name: trackingIdTestValue,
               values: ['false'],
             }),
+          )
+          .withArgs(MATOMO_ENABLED)
+          .and
+          .returnValue(
+            createSuccessfulRemoteDataObject$({
+              ... new ConfigurationProperty(),
+              name: matomoTrackingId,
+              values: ['false'],
+            }),
           );
 
       service.initialize();
@@ -379,6 +391,15 @@ describe('BrowserKlaroService', () => {
               name: trackingIdTestValue,
               values: ['false'],
             }),
+          )
+          .withArgs(MATOMO_ENABLED)
+          .and
+          .returnValue(
+            createSuccessfulRemoteDataObject$({
+              ... new ConfigurationProperty(),
+              name: matomoTrackingId,
+              values: ['false'],
+            }),
           );
       service.initialize();
       expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));
@@ -397,6 +418,15 @@ describe('BrowserKlaroService', () => {
               name: trackingIdTestValue,
               values: ['false'],
             }),
+          )
+          .withArgs(MATOMO_ENABLED)
+          .and
+          .returnValue(
+            createSuccessfulRemoteDataObject$({
+              ... new ConfigurationProperty(),
+              name: matomoTrackingId,
+              values: ['false'],
+            }),
           );
       service.initialize();
       expect(service.klaroConfig.services).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));

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

@@ -35,6 +35,7 @@ import { KlaroService } from './klaro.service';
 import {
   ANONYMOUS_STORAGE_NAME_KLARO,
   klaroConfiguration,
+  MATOMO_KLARO_KEY,
 } from './klaro-configuration';
 
 /**
@@ -85,6 +86,8 @@ export class BrowserKlaroService extends KlaroService {
 
   private readonly GOOGLE_ANALYTICS_SERVICE_NAME = 'google-analytics';
 
+  private readonly MATOMO_ENABLED = 'matomo.enabled';
+
   /**
    * Initial Klaro configuration
    */
@@ -126,15 +129,26 @@ export class BrowserKlaroService extends KlaroService {
       ),
     );
 
-    const servicesToHide$: Observable<string[]> = observableCombineLatest([hideGoogleAnalytics$, hideRegistrationVerification$]).pipe(
-      map(([hideGoogleAnalytics, hideRegistrationVerification]) => {
+    const hideMatomo$ =
+      this.configService.findByPropertyName(this.MATOMO_ENABLED).pipe(
+        getFirstCompletedRemoteData(),
+        map((remoteData) =>
+          !remoteData.hasSucceeded || !remoteData.payload || isEmpty(remoteData.payload.values) || remoteData.payload.values[0].toLowerCase() !== 'true',
+        ),
+      );
+
+    const servicesToHide$: Observable<string[]> = observableCombineLatest([hideGoogleAnalytics$, hideRegistrationVerification$, hideMatomo$]).pipe(
+      map(([hideGoogleAnalytics, hideRegistrationVerification, hideMatomo]) => {
         const servicesToHideArray: string[] = [];
         if (hideGoogleAnalytics) {
           servicesToHideArray.push(this.GOOGLE_ANALYTICS_SERVICE_NAME);
         }
         if (hideRegistrationVerification) {
           servicesToHideArray.push(CAPTCHA_NAME);
         }
+        if (hideMatomo) {
+          servicesToHideArray.push(MATOMO_KLARO_KEY);
+        }
         return servicesToHideArray;
       }),
     );

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

@@ -21,6 +21,10 @@ export const ANONYMOUS_STORAGE_NAME_KLARO = 'klaro-anonymous';
 
 export const GOOGLE_ANALYTICS_KLARO_KEY = 'google-analytics';
 
+export const MATOMO_KLARO_KEY = 'matomo';
+
+export const MATOMO_COOKIE = 'dsMatomo';
+
 /**
  * Klaro configuration
  * For more information see https://klaro.org/docs/integration/annotated-configuration
@@ -150,6 +154,16 @@ export const klaroConfiguration: any = {
         HAS_AGREED_END_USER,
       ],
     },
+    {
+      name: MATOMO_KLARO_KEY,
+      purposes: ['statistical'],
+      required: false,
+      cookies: [
+        MATOMO_COOKIE,
+      ],
+      onAccept: `window?.changeMatomoConsent(true)`,
+      onDecline: `window?.changeMatomoConsent(false)`,
+    },
     {
       name: GOOGLE_ANALYTICS_KLARO_KEY,
       purposes: ['statistical'],