Merge pull request #4018 from 4Science/task/main/CST-18964

Add support for Matomo

Author: tdonohue

package-lock.json

@@ -150,6 +150,7 @@
     "ng2-file-upload": "7.0.1",
     "ng2-nouislider": "^2.0.0",
     "ngx-infinite-scroll": "^18.0.0",
+    "ngx-matomo-client": "^6.4.1",
     "ngx-pagination": "6.0.3",
     "ngx-skeleton-loader": "^9.0.0",
     "ngx-ui-switch": "^15.0.0",

package.json

@@ -1,4 +1,7 @@
-import { CommonModule } from '@angular/common';
+import {
+  CommonModule,
+  Location,
+} from '@angular/common';
 import { PLATFORM_ID } from '@angular/core';
 import {
   ComponentFixture,
@@ -14,13 +17,15 @@ import { of as observableOf } from 'rxjs';
 
 import { getForbiddenRoute } from '../../app-routing-paths';
 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', () => {
@@ -33,10 +38,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',
@@ -54,6 +62,7 @@ describe('BitstreamDownloadPageComponent', () => {
     authService = jasmine.createSpyObj('authService', {
       isAuthenticated: observableOf(true),
       setRedirectUrl: {},
+      getShortlivedToken: observableOf('token'),
     });
     authorizationService = jasmine.createSpyObj('authorizationSerivice', {
       isAuthorized: observableOf(true),
@@ -63,9 +72,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: {
@@ -94,6 +112,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() {
@@ -108,7 +128,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();
@@ -142,9 +165,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();
       });
@@ -159,9 +184,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(() => {
@@ -174,9 +201,11 @@ describe('BitstreamDownloadPageComponent', () => {
         component = fixture.componentInstance;
         fixture.detectChanges();
       });
-      it('should navigate to the forbidden route', () => {
-        expect(router.navigateByUrl).toHaveBeenCalledWith(getForbiddenRoute(), { skipLocationChange: true });
-      });
+      it('should navigate to the forbidden route', waitForAsync(() => {
+        fixture.whenStable().then(() => {
+          expect(router.navigateByUrl).toHaveBeenCalledWith(getForbiddenRoute(), { skipLocationChange: true });
+        });
+      }));
     });
     describe('when the user is not authorized and not logged in', () => {
       beforeEach(waitForAsync(() => {
@@ -190,10 +219,12 @@ describe('BitstreamDownloadPageComponent', () => {
         component = fixture.componentInstance;
         fixture.detectChanges();
       });
-      it('should navigate to the login page', () => {
-        expect(authService.setRedirectUrl).toHaveBeenCalled();
-        expect(router.navigateByUrl).toHaveBeenCalledWith('login');
-      });
+      it('should navigate to the login page', waitForAsync(() => {
+        fixture.whenStable().then(() => {
+          expect(authService.setRedirectUrl).toHaveBeenCalled();
+          expect(router.navigateByUrl).toHaveBeenCalledWith('login');
+        });
+      }));
     });
   });
 });

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

@@ -45,6 +45,7 @@ import {
   hasValue,
   isNotEmpty,
 } from '../../shared/empty.util';
+import { MatomoService } from '../../statistics/matomo.service';
 
 @Component({
   selector: 'ds-bitstream-download-page',
@@ -74,6 +75,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();
@@ -116,14 +118,20 @@ export class BitstreamDownloadPageComponent implements OnInit {
         } else if (hasValue(accessToken)) {
           return [[isAuthorized, !isLoggedIn, bitstream, '', accessToken]];
         } else {
-          return [[isAuthorized, isLoggedIn, bitstream, '']];
+          return [[isAuthorized, isLoggedIn, bitstream, bitstream._links.content.href]];
         }
       }),
+      switchMap(([isAuthorized, isLoggedIn, bitstream, fileLink, accessToken]: [boolean, boolean, Bitstream, string, string]) =>
+        this.matomoService.appendVisitorId(fileLink)
+          .pipe(
+            map((fileLinkWithVisitorId) => [isAuthorized, isLoggedIn, bitstream, fileLinkWithVisitorId, accessToken]),
+          ),
+      ),
     ).subscribe(([isAuthorized, isLoggedIn, bitstream, fileLink, accessToken]: [boolean, boolean, Bitstream, string, string]) => {
       if (isAuthorized && isLoggedIn && isNotEmpty(fileLink)) {
         this.hardRedirectService.redirect(fileLink);
       } else if (isAuthorized && !isLoggedIn && !hasValue(accessToken)) {
-        this.hardRedirectService.redirect(bitstream._links.content.href);
+        this.hardRedirectService.redirect(fileLink);
       } else if (!isAuthorized) {
         // Either we have an access token, or we are logged in, or we are not logged in.
         // For now, the access token does not care if we are logged in or not.

src/app/bitstream-page/bitstream-download-page/bitstream-download-page.component.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.spec.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/core/shared/search/search.service.ts

@@ -28,6 +28,7 @@ import { ANONYMOUS_STORAGE_NAME_OREJIME } from './orejime-configuration';
 describe('BrowserOrejimeService', () => {
   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';
@@ -310,9 +311,11 @@ describe('BrowserOrejimeService', () => {
   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');
@@ -361,6 +364,15 @@ describe('BrowserOrejimeService', () => {
               name: trackingIdTestValue,
               values: ['false'],
             }),
+          )
+          .withArgs(MATOMO_ENABLED)
+          .and
+          .returnValue(
+            createSuccessfulRemoteDataObject$({
+              ... new ConfigurationProperty(),
+              name: matomoTrackingId,
+              values: ['false'],
+            }),
           );
 
       service.initialize();
@@ -380,6 +392,15 @@ describe('BrowserOrejimeService', () => {
               name: trackingIdTestValue,
               values: ['false'],
             }),
+          )
+          .withArgs(MATOMO_ENABLED)
+          .and
+          .returnValue(
+            createSuccessfulRemoteDataObject$({
+              ... new ConfigurationProperty(),
+              name: matomoTrackingId,
+              values: ['false'],
+            }),
           );
       service.initialize();
       expect(service.orejimeConfig.apps).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));
@@ -398,6 +419,15 @@ describe('BrowserOrejimeService', () => {
               name: trackingIdTestValue,
               values: ['false'],
             }),
+          )
+          .withArgs(MATOMO_ENABLED)
+          .and
+          .returnValue(
+            createSuccessfulRemoteDataObject$({
+              ... new ConfigurationProperty(),
+              name: matomoTrackingId,
+              values: ['false'],
+            }),
           );
       service.initialize();
       expect(service.orejimeConfig.apps).not.toContain(jasmine.objectContaining({ name: googleAnalytics }));

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

@@ -39,6 +39,7 @@ import { OrejimeService } from './orejime.service';
 import {
   ANONYMOUS_STORAGE_NAME_OREJIME,
   getOrejimeConfiguration,
+  MATOMO_OREJIME_KEY,
 } from './orejime-configuration';
 
 /**
@@ -89,6 +90,7 @@ export class BrowserOrejimeService extends OrejimeService {
 
   private readonly GOOGLE_ANALYTICS_SERVICE_NAME = 'google-analytics';
 
+  private readonly MATOMO_ENABLED = 'matomo.enabled';
 
   /**
    * Initial Orejime configuration
@@ -133,15 +135,26 @@ export class BrowserOrejimeService extends OrejimeService {
       ),
     );
 
-    const appsToHide$: 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 appsToHide$: Observable<string[]> = observableCombineLatest([hideGoogleAnalytics$, hideRegistrationVerification$, hideMatomo$]).pipe(
+      map(([hideGoogleAnalytics, hideRegistrationVerification, hideMatomo]) => {
         const appsToHideArray: string[] = [];
         if (hideGoogleAnalytics) {
           appsToHideArray.push(this.GOOGLE_ANALYTICS_SERVICE_NAME);
         }
         if (hideRegistrationVerification) {
           appsToHideArray.push(CAPTCHA_NAME);
         }
+        if (hideMatomo) {
+          appsToHideArray.push(MATOMO_OREJIME_KEY);
+        }
         return appsToHideArray;
       }),
     );

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

@@ -19,6 +19,10 @@ export const ANONYMOUS_STORAGE_NAME_OREJIME = 'orejime-anonymous';
 
 export const GOOGLE_ANALYTICS_OREJIME_KEY = 'google-analytics';
 
+export const MATOMO_OREJIME_KEY = 'matomo';
+
+export const MATOMO_COOKIE = 'dsMatomo';
+
 /**
  * Orejime configuration
  * For more information see https://github.com/empreinte-digitale/orejime
@@ -134,6 +138,17 @@ export function getOrejimeConfiguration(_window: NativeWindowRef): any {
           HAS_AGREED_END_USER,
         ],
       },
+      {
+        name: MATOMO_OREJIME_KEY,
+        purposes: ['statistical'],
+        required: false,
+        cookies: [
+          MATOMO_COOKIE,
+        ],
+        callback: (consent: boolean) => {
+          _window?.nativeWindow.changeMatomoConsent(consent);
+        },
+      },
       {
         name: GOOGLE_ANALYTICS_OREJIME_KEY,
         purposes: ['statistical'],