[ENG-9037] feature(post metrics): post metrics endpoint to log user view of public project/registration (#534)

* feature(post metrics): post metrics endpoint to log user view of public project/registration * feature(post metrics): use project/preprint/registry datail page to call sendCountedUsage after resource is loaded and public * feature(post metrics): code updates * feature(post metrics): code updates * feature(post metrics): CR code updates

Author: mkovalua

src/app/features/preprints/pages/preprint-details/preprint-details.component.ts

@@ -13,6 +13,7 @@ import {
  Component,
  computed,
  DestroyRef,
+ effect,
  HostBinding,
  inject,
  OnDestroy,
@@ -50,6 +51,7 @@ import { CreateNewVersion, PreprintStepperSelectors } from '@osf/features/prepri
 import { IS_MEDIUM, pathJoin } from '@osf/shared/helpers';
 import { ReviewPermissions, UserPermissions } from '@shared/enums';
 import { CustomDialogService, MetaTagsService } from '@shared/services';
+import { AnalyticsService } from '@shared/services/analytics.service';
 import { DataciteService } from '@shared/services/datacite/datacite.service';
 import { ContributorsSelectors } from '@shared/stores';
 
@@ -152,8 +154,16 @@ export class PreprintDetailsComponent implements OnInit, OnDestroy {
  return actions[0];
  });
 
+ private readonly analyticsService = inject(AnalyticsService);
+
  constructor() {
  this.helpScoutService.setResourceType('preprint');
+ effect(() => {
+ const currentPreprint = this.preprint();
+ if (currentPreprint && currentPreprint.isPublic) {
+ this.analyticsService.sendCountedUsage(currentPreprint.id, 'preprint.detail').subscribe();
+ }
+ });
  }
 
  private currentUserIsAdmin = computed(() => {

src/app/features/project/overview/project-overview.component.ts

@@ -56,6 +56,7 @@ import {
  SubHeaderComponent,
  ViewOnlyLinkMessageComponent,
 } from '@shared/components';
+import { AnalyticsService } from '@shared/services/analytics.service';
 import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import {
@@ -253,6 +254,8 @@ export class ProjectOverviewComponent implements OnInit {
  };
  });
 
+ readonly analyticsService = inject(AnalyticsService);
+
  constructor() {
  this.setupCollectionsEffects();
  this.setupCleanup();
@@ -341,6 +344,12 @@ export class ProjectOverviewComponent implements OnInit {
  this.actions.getHomeWiki(ResourceType.Project, project.id);
  }
  });
+ effect(() => {
+ const currentProject = this.currentProject();
+ if (currentProject && currentProject.isPublic) {
+ this.analyticsService.sendCountedUsage(currentProject.id, 'project.detail').subscribe();
+ }
+ });
  }
 
  private setupRouteChangeListener(): void {

src/app/features/registry/registry.component.ts

@@ -10,7 +10,7 @@ import { ActivatedRoute, RouterOutlet } from '@angular/router';
 import { ENVIRONMENT } from '@core/provider/environment.provider';
 import { ClearCurrentProvider } from '@core/store/provider';
 import { pathJoin } from '@osf/shared/helpers';
-import { MetaTagsService } from '@osf/shared/services';
+import { AnalyticsService, MetaTagsService } from '@osf/shared/services';
 import { DataciteService } from '@shared/services/datacite/datacite.service';
 
 import { GetRegistryById, RegistryOverviewSelectors } from './store/registry-overview';
@@ -43,6 +43,7 @@ export class RegistryComponent implements OnDestroy {
  readonly registry = select(RegistryOverviewSelectors.getRegistry);
  readonly isRegistryLoading = select(RegistryOverviewSelectors.isRegistryLoading);
  readonly registry$ = toObservable(select(RegistryOverviewSelectors.getRegistry));
+ readonly analyticsService = inject(AnalyticsService);
 
  constructor() {
  effect(() => {
@@ -57,7 +58,15 @@ export class RegistryComponent implements OnDestroy {
  }
  });
 
+ effect(() => {
+ const currentRegistry = this.registry();
+ if (currentRegistry && currentRegistry.isPublic) {
+ this.analyticsService.sendCountedUsage(currentRegistry.id, 'registry.detail').subscribe();
+ }
+ });
+
  this.dataciteService.logIdentifiableView(this.registry$).pipe(takeUntilDestroyed(this.destroyRef)).subscribe();
+
  }
 
  ngOnDestroy(): void {

src/app/shared/services/analytics.service.ts

@@ -0,0 +1,36 @@
+import { Observable } from 'rxjs';
+
+import { inject, Injectable } from '@angular/core';
+
+import { ENVIRONMENT } from '@core/provider/environment.provider';
+import { JsonApiService } from '@osf/shared/services';
+
+@Injectable({ providedIn: 'root' })
+export class AnalyticsService {
+ private readonly jsonApiService = inject(JsonApiService);
+ private readonly environment = inject(ENVIRONMENT);
+
+ get apiDomainUrl() {
+ return `${this.environment.apiDomainUrl}/_/metrics/events/counted_usage/`;
+ }
+
+ sendCountedUsage(guid: string, routeName: string): Observable<void> {
+ const payload = {
+ data: {
+ type: 'counted-usage',
+ attributes: {
+ item_guid: guid,
+ action_labels: ['web', 'view'],
+ pageview_info: {
+ page_url: document.URL,
+ page_title: document.title,
+ referer_url: document.referrer,
+ route_name: `angular-osf-web.${routeName}`,
+ },
+ },
+ },
+ };
+
+ return this.jsonApiService.post<void>(this.apiDomainUrl, payload);
+ }
+}

src/app/shared/services/index.ts

@@ -1,5 +1,6 @@
 export * from './activity-logs';
 export * from './addons';
+export { AnalyticsService } from './analytics.service';
 export { BookmarksService } from './bookmarks.service';
 export { BrandService } from './brand.service';
 export { CollectionsService } from './collections.service';