[ENG-4002] log pageviews to osf:metrics (#1640)

-   Ticket: [ENG-4002]

## Purpose
start saving our own pageview/usage data (under `osf:api/_/metrics/`), without disrupting our current metrics setup but with intent to eventually delete our current metrics setup.
(depends on CenterForOpenScience/osf.io#9954)

## Summary of Changes
- update `trackPage()` on the `analytics` service to:
  - gather metadata from each active route via [`RouterService.currentRoute`](https://api.emberjs.com/ember/3.26/classes/RouterService/properties/currentRoute?anchor=currentRoute) (including route-specific metadata via [`RouteInfo.metadata`](https://api.emberjs.com/ember/3.26/classes/RouteInfo/properties/metadata?anchor=metadata))
  - send a usage event to `osf:api/_/metrics/events/counted_usage/`
- implement [`buildRouteInfoMetadata()`](https://api.emberjs.com/ember/3.26/classes/Route/methods/buildRouteInfoMetadata?anchor=buildRouteInfoMetadata) on routes that have their own pageview metadata (e.g. a guid or provider)
- add `trackPage()` calls to each `application` route's `didTransition` hook, in the host app and each engine 
- remove `trackPage()` calls from all non-`application` routes that had them
- add mirage endpoint and model for `counted_usage`, and a simple `analytics.trackPage()` test that uses them
- update the [analytics page in the handbook](https://github.com/CenterForOpenScience/ember-osf-web/pull/1640/files#diff-27cfe9fecf6f24b61e3b7b6bdd13c46ad4b0c7e5e3a9b9b0d88013d015804095) accordingly

Author: aaxelb

app/application/route.ts

@@ -1,8 +1,10 @@
 import Route from '@ember/routing/route';
+import { action } from '@ember/object';
 import { inject as service } from '@ember/service';
 import Intl from 'ember-intl/services/intl';
 
 import checkAuth from 'ember-osf-web/decorators/check-auth';
+import Analytics from 'ember-osf-web/services/analytics';
 import CurrentUser from 'ember-osf-web/services/current-user';
 
 @checkAuth
@@ -18,6 +20,7 @@ export default class ApplicationRoute extends Route.extend(
 ) {
     @service intl!: Intl;
     @service currentUser!: CurrentUser;
+    @service analytics!: Analytics;
 
     queryParams = {
         viewOnlyToken: {
@@ -28,4 +31,9 @@ export default class ApplicationRoute extends Route.extend(
     beforeModel() {
         return this.intl.setLocale('en-us');
     }
+
+    @action
+    didTransition() {
+        this.analytics.trackPage();
+    }
 }

app/dashboard/route.ts

@@ -1,18 +1,15 @@
-import { action } from '@ember/object';
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
 import { taskFor } from 'ember-concurrency-ts';
 import Session from 'ember-simple-auth/services/session';
 
 import DashboardController from 'ember-osf-web/dashboard/controller';
 import requireAuth from 'ember-osf-web/decorators/require-auth';
-import Analytics from 'ember-osf-web/services/analytics';
 import CurrentUser from 'ember-osf-web/services/current-user';
 import Ready from 'ember-osf-web/services/ready';
 
 @requireAuth('home')
 export default class Dashboard extends Route {
-    @service analytics!: Analytics;
     @service currentUser!: CurrentUser;
     @service ready!: Ready;
     @service session!: Session;
@@ -27,9 +24,4 @@ export default class Dashboard extends Route {
             blocker.errored(e);
         }
     }
-
-    @action
-    didTransition() {
-        this.analytics.trackPage();
-    }
 }

app/goodbye/route.ts

@@ -1,23 +1,14 @@
-import { action } from '@ember/object';
 import Transition from '@ember/routing/-private/transition';
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
 import Session from 'ember-simple-auth/services/session';
 
-import Analytics from 'ember-osf-web/services/analytics';
-
 export default class Goodbye extends Route {
-    @service analytics!: Analytics;
     @service session!: Session;
 
     async beforeModel(transition: Transition) {
         await super.beforeModel(transition);
         const queryParams = this.session.isAuthenticated ? {} : { goodbye: true };
         this.transitionTo('home', { queryParams });
     }
-
-    @action
-    didTransition() {
-        this.analytics.trackPage();
-    }
 }

app/guid-file/route.ts

@@ -1,4 +1,3 @@
-import { action } from '@ember/object';
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
 import { waitFor } from '@ember/test-waiters';
@@ -8,7 +7,6 @@ import { taskFor } from 'ember-concurrency-ts';
 import moment from 'moment';
 
 import Institution from 'ember-osf-web/models/institution';
-import Analytics from 'ember-osf-web/services/analytics';
 import MetaTags, { HeadTagDef } from 'ember-osf-web/services/meta-tags';
 import Ready from 'ember-osf-web/services/ready';
 import OsfStorageFile from 'ember-osf-web/packages/files/osf-storage-file';
@@ -27,7 +25,6 @@ import CurrentUserService from 'ember-osf-web/services/current-user';
 import RegistrationModel from 'ember-osf-web/models/registration';
 
 export default class GuidFile extends Route {
-    @service analytics!: Analytics;
     @service('head-tags') headTagsService!: HeadTagsService;
     @service metaTags!: MetaTags;
     @service ready!: Ready;
@@ -116,8 +113,11 @@ export default class GuidFile extends Route {
         taskFor(this.setHeadTags).perform(model.fileModel);
     }
 
-    @action
-    didTransition() {
-        this.analytics.trackPage(true, 'files');
+    buildRouteInfoMetadata() {
+        return {
+            osfMetrics: {
+                itemGuid: this.controller.model.id,
+            },
+        };
     }
 }

app/guid-node/forks/route.ts

@@ -1,25 +1,7 @@
-import { action } from '@ember/object';
 import Route from '@ember/routing/route';
-import { inject as service } from '@ember/service';
-
-import Node from 'ember-osf-web/models/node';
-import { GuidRouteModel } from 'ember-osf-web/resolve-guid/guid-route';
-import Analytics from 'ember-osf-web/services/analytics';
-import Ready from 'ember-osf-web/services/ready';
 
 export default class GuidNodeForks extends Route {
-    @service analytics!: Analytics;
-    @service ready!: Ready;
-
     model() {
         return this.modelFor('guid-node');
     }
-
-    @action
-    async didTransition() {
-        const { taskInstance } = this.controller.model as GuidRouteModel<Node>;
-        await taskInstance;
-        const node = taskInstance.value;
-        this.analytics.trackPage(node ? node.public : undefined, 'nodes');
-    }
 }

app/guid-node/registrations/route.ts

@@ -1,18 +1,13 @@
-import { action } from '@ember/object';
 import Transition from '@ember/routing/-private/transition';
 import Route from '@ember/routing/route';
-import { inject as service } from '@ember/service';
 import { taskFor } from 'ember-concurrency-ts';
 
 import Node from 'ember-osf-web/models/node';
 import { GuidRouteModel } from 'ember-osf-web/resolve-guid/guid-route';
-import Analytics from 'ember-osf-web/services/analytics';
 
 import Controller from './controller';
 
 export default class GuidNodeRegistrations extends Route {
-    @service analytics!: Analytics;
-
     model() {
         return this.modelFor('guid-node') as GuidRouteModel<Node>;
     }
@@ -21,12 +16,4 @@ export default class GuidNodeRegistrations extends Route {
         super.setupController(controller, model, transition);
         taskFor(controller.getRegistrationSchemas).perform();
     }
-
-    @action
-    async didTransition() {
-        const { taskInstance } = this.controller.model as GuidRouteModel<Node>;
-        await taskInstance;
-        const node = taskInstance.value;
-        this.analytics.trackPage(node ? node.public : undefined, 'nodes');
-    }
 }

app/guid-registration/forks/route.ts

@@ -1,25 +1,12 @@
-import { action } from '@ember/object';
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
 
-import Registration from 'ember-osf-web/models/registration';
-import { GuidRouteModel } from 'ember-osf-web/resolve-guid/guid-route';
-import Analytics from 'ember-osf-web/services/analytics';
 import Ready from 'ember-osf-web/services/ready';
 
 export default class GuidRegistrationForks extends Route {
-    @service analytics!: Analytics;
     @service ready!: Ready;
 
     model() {
         return this.modelFor('guid-registration');
     }
-
-    @action
-    async didTransition() {
-        const { taskInstance } = this.controller.model as GuidRouteModel<Registration>;
-        await taskInstance;
-        const registration = taskInstance.value;
-        this.analytics.trackPage(registration ? registration.public : undefined, 'registrations');
-    }
 }

app/helpers/open-badges-icon-map.ts

@@ -1,6 +1,6 @@
 import { ResourceTypes } from 'ember-osf-web/models/resource';
 
-export function getBadgeIcon(resourceType: ResourceTypes) {
+export function getBadgeIcon(resourceType: ResourceTypes | 'undefined') {
     switch (resourceType) {
     case ResourceTypes.Data:
         return '/assets/images/badges/data_small_color.png';
@@ -17,7 +17,7 @@ export function getBadgeIcon(resourceType: ResourceTypes) {
     }
 }
 
-export function getBadgeIconDisabled(resourceType: ResourceTypes) {
+export function getBadgeIconDisabled(resourceType: ResourceTypes | 'undefined') {
     switch (resourceType) {
     case ResourceTypes.Data:
         return '/assets/images/badges/data_small_gray.png';

app/home/route.ts

@@ -1,19 +1,10 @@
-import { action } from '@ember/object';
 import Transition from '@ember/routing/-private/transition';
 import Route from '@ember/routing/route';
 import { inject as service } from '@ember/service';
-import Features from 'ember-feature-flags/services/features';
-import config from 'ember-get-config';
 import Session from 'ember-simple-auth/services/session';
 
-import Analytics from 'ember-osf-web/services/analytics';
-
-const { featureFlagNames: { ABTesting } } = config;
-
 export default class Home extends Route {
-  @service analytics!: Analytics;
   @service session!: Session;
-  @service features!: Features;
 
   async beforeModel(transition: Transition) {
       await super.beforeModel(transition);
@@ -22,11 +13,4 @@ export default class Home extends Route {
           this.transitionTo('dashboard');
       }
   }
-
-  @action
-  didTransition() {
-      const shouldShowVersionB = this.features.isEnabled(ABTesting.homePageHeroTextVersionB);
-      const version = shouldShowVersionB ? 'versionB' : 'versionA';
-      this.analytics.trackPage(undefined, undefined, undefined, version);
-  }
 }

app/institutions/dashboard/route.ts

@@ -1,4 +1,3 @@
-import { action } from '@ember/object';
 import Route from '@ember/routing/route';
 import RouterService from '@ember/routing/router-service';
 import { inject as service } from '@ember/service';
@@ -10,7 +9,6 @@ import InstitutionModel from 'ember-osf-web/models/institution';
 import InstitutionDepartmentModel from 'ember-osf-web/models/institution-department';
 import InstitutionSummaryMetricModel from 'ember-osf-web/models/institution-summary-metric';
 import { QueryHasManyResult } from 'ember-osf-web/models/osf-model';
-import Analytics from 'ember-osf-web/services/analytics';
 import captureException from 'ember-osf-web/utils/capture-exception';
 
 export interface InstitutionsDashboardModel {
@@ -19,7 +17,6 @@ export interface InstitutionsDashboardModel {
     summaryMetrics: InstitutionSummaryMetricModel;
 }
 export default class InstitutionsDashboardRoute extends Route {
-    @service analytics!: Analytics;
     @service router!: RouterService;
 
     @task
@@ -57,9 +54,4 @@ export default class InstitutionsDashboardRoute extends Route {
             taskInstance: taskFor(this.modelTask).perform(params.institution_id),
         };
     }
-
-    @action
-    didTransition() {
-        this.analytics.trackPage();
-    }
 }