chore: add matomo user metrics

Author: LevelbossMike

package.json

@@ -70,6 +70,8 @@
     "ember-export-application-global": "^2.0.1",
     "ember-load-initializers": "^2.1.1",
     "ember-maybe-import-regenerator": "^0.1.6",
+    "ember-metrics": "^0.16.0",
+    "ember-metrics-matomo-adapter": "^0.1.0",
     "ember-qunit": "^4.6.0",
     "ember-qunit-assert-helpers": "^0.2.2",
     "ember-resolver": "^8.0.2",

tests/dummy/app/routes/application.ts

@@ -0,0 +1,31 @@
+import Route from '@ember/routing/route';
+import RouterService from '@ember/routing/router-service';
+import { inject as service } from '@ember/service';
+
+import MetricsService from 'ember-metrics/services/metrics';
+
+export default class ApplicationRoute extends Route {
+  @service
+  router!: RouterService;
+
+  @service
+  metrics!: MetricsService;
+
+  constructor() {
+    // eslint-disable-next-line prefer-rest-params
+    super(...arguments);
+
+    this.setupTracking();
+  }
+
+  private setupTracking() {
+    this.router.on('routeDidChange', () => {
+      const { currentURL, currentRouteName } = this.router;
+
+      this.metrics.trackPage({
+        page: currentURL,
+        title: currentRouteName,
+      });
+    });
+  }
+}

tests/dummy/config/environment.js

@@ -1,8 +1,19 @@
 'use strict';
 
+function matomoSiteIdForDeployTarget(deployTarget) {
+  if (deployTarget === 'production') {
+    return '3';
+  }
+
+  return '2';
+}
+
 module.exports = function (environment) {
+  const deployTarget = process.env.DEPLOY_TARGET || 'development';
+
   let ENV = {
     modulePrefix: 'dummy',
+    deployTarget,
     environment,
     rootURL: '/',
     locationType: 'auto',
@@ -21,6 +32,18 @@ module.exports = function (environment) {
       // Here you can pass flags/options to your application instance
       // when it is created
     },
+    metricsAdapters: [
+      {
+        name: 'Matomo',
+        environments: ['development', 'production'],
+        config: {
+          scriptUrl: '//cdn.matomo.cloud/effective-ember.matomo.cloud',
+          trackerUrl: 'https://effective-ember.matomo.cloud',
+          siteId: matomoSiteIdForDeployTarget(deployTarget),
+          disableCookies: true,
+        },
+      },
+    ],
   };
 
   if (environment === 'development') {

types/ember-metrics/index.d.ts

@@ -0,0 +1,10 @@
+declare module 'ember-metrics/services/metrics' {
+  import Service from '@ember/service';
+
+  export default class Metrics extends Service {
+    trackEvent(params: Record<string, unknown>): void;
+
+    trackPage(params: Record<string, unknown>): void;
+    trackPage(adapterName: string, params: Record<string, unknown>): void;
+  }
+}

yarn.lock

@@ -5295,7 +5295,7 @@ broccoli-funnel@^3.0.0:
     path-posix "^1.0.0"
     walk-sync "^2.0.2"
 
-broccoli-funnel@^3.0.3:
+broccoli-funnel@^3.0.2, broccoli-funnel@^3.0.3:
   version "3.0.3"
   resolved "https://registry.yarnpkg.com/broccoli-funnel/-/broccoli-funnel-3.0.3.tgz#26fd42632471f67a91f4770d1987118087219937"
   integrity sha512-LPzZ91BwStoHZXdXHQAJeYORl189OrRKM5NdIi86SDU9wZ4s/3lV1PRFOiobDT/jKM10voM7CDzfvicHbCYxAQ==
@@ -8317,6 +8317,22 @@ ember-cli-typescript@^3.1.4:
     stagehand "^1.0.0"
     walk-sync "^2.0.0"
 
+ember-cli-typescript@^4.0.0:
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/ember-cli-typescript/-/ember-cli-typescript-4.0.0.tgz#690f0cd3d15f4a69ae6d89f25b70b5997ae59161"
+  integrity sha512-ZwnBbBJ0yAIKq4FVgNFkxfMwqJhw6PyT45Enp2RvWIgzgaYCId8brrSgg3tvVWWjA7N5hiT4Ilyz5jrQwrnU1Q==
+  dependencies:
+    ansi-to-html "^0.6.6"
+    broccoli-stew "^3.0.0"
+    debug "^4.0.0"
+    execa "^4.0.0"
+    fs-extra "^9.0.1"
+    resolve "^1.5.0"
+    rsvp "^4.8.1"
+    semver "^7.3.2"
+    stagehand "^1.0.0"
+    walk-sync "^2.2.0"
+
 ember-cli-valid-component-name@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/ember-cli-valid-component-name/-/ember-cli-valid-component-name-1.0.0.tgz#71550ce387e0233065f30b30b1510aa2dfbe87ef"
@@ -8690,6 +8706,23 @@ ember-maybe-import-regenerator@^0.1.6:
     ember-cli-babel "^6.0.0-beta.4"
     regenerator-runtime "^0.9.5"
 
+ember-metrics-matomo-adapter@^0.1.0:
+  version "0.1.0"
+  resolved "https://registry.yarnpkg.com/ember-metrics-matomo-adapter/-/ember-metrics-matomo-adapter-0.1.0.tgz#cf04b2c92c7e80996ca17c1851d7105b0c1d637a"
+  integrity sha512-eA9WfUFUsb/M+JDOawuQqmn07lBKtvTVhxczhN3c28KXQUNJnfGl1MP/DTl9iL8uiYUYLT3cOUKd+AbR4RLT2w==
+  dependencies:
+    ember-cli-babel "^7.22.1"
+    ember-cli-htmlbars "^5.3.1"
+    ember-cli-typescript "^4.0.0"
+
+ember-metrics@^0.16.0:
+  version "0.16.0"
+  resolved "https://registry.yarnpkg.com/ember-metrics/-/ember-metrics-0.16.0.tgz#7d6879f419c5c581d54094ceb617ca1b0dfa26d4"
+  integrity sha512-TmnXPjwh1uHuqSo9yjYr1R3gzw/4j2jENjsvn3CGs8+nYglQ2+kbkuMAbkxWo/Nc6Z6ZGprPkWvJ2YgugUwCdw==
+  dependencies:
+    broccoli-funnel "^3.0.2"
+    ember-cli-babel "^7.19.0"
+
 ember-modal-dialog@^3.0.0-beta.4:
   version "3.0.0-beta.4"
   resolved "https://registry.yarnpkg.com/ember-modal-dialog/-/ember-modal-dialog-3.0.0-beta.4.tgz#2da8b5424cf33fd87117624dcaabfe9727f967e9"
@@ -9511,7 +9544,7 @@ execa@^3.0.0, execa@^3.2.0:
     signal-exit "^3.0.2"
     strip-final-newline "^2.0.0"
 
-execa@^4.0.3:
+execa@^4.0.0, execa@^4.0.3:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/execa/-/execa-4.0.3.tgz#0a34dabbad6d66100bd6f2c576c8669403f317f2"
   integrity sha512-WFDXGHckXPWZX19t1kCsXzOpqX9LWYNqn4C+HqZlk/V0imTkzJZqf87ZBhvpHaftERYknpk0fjSylnXVlVgI0A==
@@ -10164,7 +10197,7 @@ fs-extra@^8.0.0, fs-extra@^8.0.1, fs-extra@^8.1.0:
     jsonfile "^4.0.0"
     universalify "^0.1.0"
 
-fs-extra@^9.0.0:
+fs-extra@^9.0.0, fs-extra@^9.0.1:
   version "9.0.1"
   resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-9.0.1.tgz#910da0062437ba4c39fedd863f1675ccfefcb9fc"
   integrity sha512-h2iAoN838FqAFJY2/qVpzFXy+EBxfVE220PalAqQLDVsFOHLJrZvut5puAbCdNv6WJk+B8ihI+k0c7JK5erwqQ==