Merge pull request #4233 from atmire/4099-duplicate-view-events_contibute-7.x

tdonohue · web-flow · commit 7b25b1d63cb4 · 2025-04-23T17:01:35.000-05:00
[Port to dspace-7_x] Fix for double view events when using dynamic themes
diff --git a/src/app/app-routing.module.ts b/src/app/app-routing.module.ts
@@ -40,6 +40,8 @@ import {
 import { ServerCheckGuard } from './core/server-check/server-check.guard';
 import { MenuResolver } from './menu.resolver';
 import { ThemedPageErrorComponent } from './page-error/themed-page-error.component';
+import { HomePageResolver } from './home-page/home-page.resolver';
+import { ViewTrackerResolverService } from './statistics/angulartics/dspace/view-tracker-resolver.service';
 
 @NgModule({
   imports: [
@@ -63,7 +65,15 @@ import { ThemedPageErrorComponent } from './page-error/themed-page-error.compone
             path: 'home',
             loadChildren: () => import('./home-page/home-page.module')
               .then((m) => m.HomePageModule),
-            data: { showBreadcrumbs: false },
+            data: {
+              showBreadcrumbs: false,
+              dsoPath: 'site'
+            },
+            resolve: {
+              site: HomePageResolver,
+              tracking: ViewTrackerResolverService,
+            },
+
             canActivate: [EndUserAgreementCurrentUserGuard]
           },
           {
@@ -251,6 +261,7 @@ import { ThemedPageErrorComponent } from './page-error/themed-page-error.compone
 })
   ],
   exports: [RouterModule],
+  providers: [HomePageResolver, ViewTrackerResolverService],
 })
 export class AppRoutingModule {
 
diff --git a/src/app/collection-page/collection-page-routing.module.ts b/src/app/collection-page/collection-page-routing.module.ts
@@ -23,6 +23,7 @@ import { ThemedCollectionPageComponent } from './themed-collection-page.componen
 import { MenuItemType } from '../shared/menu/menu-item-type.model';
 import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver';
 import { CommunityBreadcrumbResolver } from '../core/breadcrumbs/community-breadcrumb.resolver';
+import { ViewTrackerResolverService } from '../statistics/angulartics/dspace/view-tracker-resolver.service';
 
 @NgModule({
   imports: [
@@ -86,6 +87,7 @@ import { CommunityBreadcrumbResolver } from '../core/breadcrumbs/community-bread
             pathMatch: 'full',
             resolve: {
               menu: DSOEditMenuResolver,
+              tracking: ViewTrackerResolverService,
             },
           }
         ],
@@ -116,6 +118,7 @@ import { CommunityBreadcrumbResolver } from '../core/breadcrumbs/community-bread
     CreateCollectionPageGuard,
     CollectionPageAdministratorGuard,
     CommunityBreadcrumbResolver,
+    ViewTrackerResolverService,
   ]
 })
 export class CollectionPageRoutingModule {
diff --git a/src/app/collection-page/collection-page.component.html b/src/app/collection-page/collection-page.component.html
@@ -3,7 +3,6 @@
          *ngVar="(collectionRD$ | async) as collectionRD">
               <div *ngIf="collectionRD?.hasSucceeded" @fadeInOut>
                       <div *ngIf="collectionRD?.payload as collection">
-              <ds-view-tracker [object]="collection"></ds-view-tracker>
               <div class="d-flex flex-row border-bottom mb-4 pb-4">
                 <header class="comcol-header mr-auto">
                   <!-- Collection Name -->
diff --git a/src/app/community-page/community-page-routing.module.ts b/src/app/community-page/community-page-routing.module.ts
@@ -16,6 +16,7 @@ import { ThemedCommunityPageComponent } from './themed-community-page.component'
 import { MenuItemType } from '../shared/menu/menu-item-type.model';
 import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver';
 import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.resolver';
+import { ViewTrackerResolverService } from '../statistics/angulartics/dspace/view-tracker-resolver.service';
 
 @NgModule({
   imports: [
@@ -69,6 +70,7 @@ import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.reso
             pathMatch: 'full',
             resolve: {
               menu: DSOEditMenuResolver,
+              tracking: ViewTrackerResolverService,
             },
           }
         ],
@@ -97,6 +99,7 @@ import { I18nBreadcrumbResolver } from '../core/breadcrumbs/i18n-breadcrumb.reso
     LinkService,
     CreateCommunityPageGuard,
     CommunityPageAdministratorGuard,
+    ViewTrackerResolverService,
   ]
 })
 export class CommunityPageRoutingModule {
diff --git a/src/app/community-page/community-page.component.html b/src/app/community-page/community-page.component.html
@@ -1,7 +1,6 @@
 <div class="container" *ngVar="(communityRD$ | async) as communityRD">
   <div class="community-page" *ngIf="communityRD?.hasSucceeded" @fadeInOut>
     <div *ngIf="communityRD?.payload; let communityPayload">
-      <ds-view-tracker [object]="communityPayload"></ds-view-tracker>
       <div class="d-flex flex-row border-bottom mb-4 pb-4">
         <header class="comcol-header mr-auto">
           <!-- Community name -->
diff --git a/src/app/home-page/home-page-routing.module.ts b/src/app/home-page/home-page-routing.module.ts
@@ -1,7 +1,6 @@
 import { NgModule } from '@angular/core';
 import { RouterModule } from '@angular/router';
 
-import { HomePageResolver } from './home-page.resolver';
 import { LinkMenuItemModel } from '../shared/menu/menu-item/models/link.model';
 import { ThemedHomePageComponent } from './themed-home-page.component';
 import { MenuItemType } from '../shared/menu/menu-item-type.model';
@@ -28,15 +27,9 @@ import { MenuItemType } from '../shared/menu/menu-item-type.model';
               } as LinkMenuItemModel,
             }],
           },
-        },
-        resolve: {
-          site: HomePageResolver
         }
       }
     ])
-  ],
-  providers: [
-    HomePageResolver
   ]
 })
 export class HomePageRoutingModule {
diff --git a/src/app/home-page/home-page.component.html b/src/app/home-page/home-page.component.html
@@ -1,8 +1,5 @@
 <ds-themed-home-news></ds-themed-home-news>
 <div class="container">
-  <ng-container *ngIf="(site$ | async) as site">
-    <ds-view-tracker [object]="site"></ds-view-tracker>
-  </ng-container>
   <ds-themed-search-form [inPlaceSearch]="false" [searchPlaceholder]="'home.search-form.placeholder' | translate"></ds-themed-search-form>
   <ds-themed-top-level-community-list></ds-themed-top-level-community-list>
   <ds-recent-item-list *ngIf="recentSubmissionspageSize>0"></ds-recent-item-list>
diff --git a/src/app/item-page/full/full-item-page.component.html b/src/app/item-page/full/full-item-page.component.html
@@ -3,7 +3,6 @@
     <div *ngIf="itemRD?.payload as item">
       <ds-themed-item-alerts [item]="item"></ds-themed-item-alerts>
       <ds-item-versions-notice [item]="item"></ds-item-versions-notice>
-      <ds-view-tracker [object]="item"></ds-view-tracker>
       <div *ngIf="!item.isWithdrawn || (isAdmin$|async)" class="full-item-info">
         <div class="d-flex flex-row">
           <ds-themed-item-page-title-field class="mr-auto" [item]="item"></ds-themed-item-page-title-field>
diff --git a/src/app/item-page/item-page-routing.module.ts b/src/app/item-page/item-page-routing.module.ts
@@ -19,6 +19,7 @@ import { REQUEST_COPY_MODULE_PATH } from '../app-routing-paths';
 import { OrcidPageComponent } from './orcid-page/orcid-page.component';
 import { OrcidPageGuard } from './orcid-page/orcid-page.guard';
 import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver';
+import { ViewTrackerResolverService } from '../statistics/angulartics/dspace/view-tracker-resolver.service';
 
 @NgModule({
   imports: [
@@ -37,13 +38,15 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver';
             pathMatch: 'full',
             resolve: {
               menu: DSOEditMenuResolver,
+              tracking: ViewTrackerResolverService,
             },
           },
           {
             path: 'full',
             component: ThemedFullItemPageComponent,
             resolve: {
               menu: DSOEditMenuResolver,
+              tracking: ViewTrackerResolverService,
             },
           },
           {
@@ -103,7 +106,8 @@ import { DSOEditMenuResolver } from '../shared/dso-page/dso-edit-menu.resolver';
     LinkService,
     ItemPageAdministratorGuard,
     VersionResolver,
-    OrcidPageGuard
+    OrcidPageGuard,
+    ViewTrackerResolverService,
   ]
 
 })
diff --git a/src/app/item-page/simple/item-page.component.html b/src/app/item-page/simple/item-page.component.html
@@ -3,7 +3,6 @@
     <div *ngIf="itemRD?.payload as item">
       <ds-themed-item-alerts [item]="item"></ds-themed-item-alerts>
       <ds-item-versions-notice [item]="item"></ds-item-versions-notice>
-      <ds-view-tracker [object]="item"></ds-view-tracker>
       <ds-listable-object-component-loader *ngIf="!item.isWithdrawn || (isAdmin$|async)" [object]="item" [viewMode]="viewMode"></ds-listable-object-component-loader>
       <ds-item-versions class="mt-2" [item]="item" [displayActions]="false"></ds-item-versions>
     </div>
diff --git a/src/app/statistics/angulartics/dspace/view-tracker-resolver.service.ts b/src/app/statistics/angulartics/dspace/view-tracker-resolver.service.ts
@@ -0,0 +1,56 @@
+import { Injectable, } from '@angular/core';
+import { Angulartics2 } from 'angulartics2';
+import { switchMap } from 'rxjs';
+import { filter, take } from 'rxjs/operators';
+
+import { ReferrerService } from '../../../core/services/referrer.service';
+import { ActivatedRouteSnapshot, ResolveEnd, Router, RouterStateSnapshot } from '@angular/router';
+
+/**
+ * This component triggers a page view statistic
+ */
+@Injectable({
+  providedIn: 'root'
+})
+export class ViewTrackerResolverService {
+
+  constructor(
+    public angulartics2: Angulartics2,
+    public referrerService: ReferrerService,
+    public router: Router,
+  ) {
+  }
+
+  resolve(routeSnapshot: ActivatedRouteSnapshot, state: RouterStateSnapshot): boolean {
+    const dsoPath = routeSnapshot.data.dsoPath || 'dso.payload'; // Fetch the resolvers passed via the route data
+    this.router.events.pipe(
+      filter(event => event instanceof ResolveEnd),
+      take(1),
+      switchMap(() =>
+        this.referrerService.getReferrer().pipe(take(1))))
+      .subscribe((referrer: string) => {
+        this.angulartics2.eventTrack.next({
+          action: 'page_view',
+          properties: {
+            object: this.getNestedProperty(routeSnapshot.data, dsoPath),
+            referrer,
+          },
+        });
+      });
+    return true;
+  }
+
+  private getNestedProperty(obj: any, path: string) {
+    const keys = path.split('.');
+    let result = obj;
+
+    for (const key of keys) {
+      if (result && result.hasOwnProperty(key)) {
+        result = result[key];
+      } else {
+        return undefined;
+      }
+    }
+    return result;
+  }
+}
diff --git a/src/app/statistics/angulartics/dspace/view-tracker.component.html b/src/app/statistics/angulartics/dspace/view-tracker.component.html
diff --git a/src/app/statistics/angulartics/dspace/view-tracker.component.scss b/src/app/statistics/angulartics/dspace/view-tracker.component.scss
diff --git a/src/app/statistics/angulartics/dspace/view-tracker.component.ts b/src/app/statistics/angulartics/dspace/view-tracker.component.ts
diff --git a/src/app/statistics/statistics.module.ts b/src/app/statistics/statistics.module.ts
@@ -2,7 +2,6 @@ import { ModuleWithProviders, NgModule } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { CoreModule } from '../core/core.module';
 import { SharedModule } from '../shared/shared.module';
-import { ViewTrackerComponent } from './angulartics/dspace/view-tracker.component';
 import { StatisticsEndpoint } from './statistics-endpoint.model';
 
 /**
@@ -19,10 +18,8 @@ export const models = [
     SharedModule,
   ],
   declarations: [
-    ViewTrackerComponent,
   ],
   exports: [
-    ViewTrackerComponent,
   ]
 })
 /**
