Merge branch 'release/23.06.0'

Author: adlius

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [23.06.0] - 2023-03-27
+### Changed
+- Removed Keen dependencies
+
 ## [23.05.0] - 2023-03-16
 ### Changed
 - Fixed `ember-classic` deprecation
@@ -1917,6 +1921,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - Quick Files
 
+[23.05.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.06.0
 [23.05.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.05.0
 [23.04.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.04.0
 [23.03.0]: https://github.com/CenterForOpenScience/ember-osf-web/releases/tag/23.03.0

app/services/analytics.ts

@@ -2,6 +2,7 @@
 import { assert, debug, runInDebug } from '@ember/debug';
 import { action } from '@ember/object';
 import RouterService from '@ember/routing/router-service';
+import RouteInfo from '@ember/routing/-private/route-info';
 import Service, { inject as service } from '@ember/service';
 import { waitFor } from '@ember/test-waiters';
 import { restartableTask, waitForQueue } from 'ember-concurrency';
@@ -380,10 +381,11 @@ export default class Analytics extends Service {
         // for merging, ordered from root to leaf (so values from leafier
         // routes can override those from rootier routes)
         const metricsMetadatums = [];
-        let currentRouteInfo = this.router.currentRoute;
+        let currentRouteInfo: RouteInfo | null = this.router.currentRoute;
         while (currentRouteInfo) {
-            if (currentRouteInfo.metadata?.osfMetrics) {
-                metricsMetadatums.unshift(currentRouteInfo.metadata.osfMetrics);
+            const { metadata } = currentRouteInfo as any;
+            if (metadata && metadata.osfMetrics) {
+                metricsMetadatums.unshift(metadata.osfMetrics);
             }
             currentRouteInfo = currentRouteInfo.parent;
         }

config/environment.d.ts

@@ -80,7 +80,6 @@ declare const config: {
             status: string;
             keenUserId: string;
             keenSessionId: string;
-            analyticsDismissAdblock: string;
             cookieConsent: string;
             newFeaturePopover: string;
             maintenance: string;

config/environment.js

@@ -147,7 +147,6 @@ module.exports = function(environment) {
                 status: statusCookie,
                 keenUserId: 'keenUserId',
                 keenSessionId: 'keenSessionId',
-                analyticsDismissAdblock: 'adBlockDismiss',
                 cookieConsent: 'osf_cookieconsent',
                 newFeaturePopover: 'metadataFeaturePopover',
                 maintenance: 'maintenance',

lib/analytics-page/addon/application/controller.ts

@@ -2,63 +2,38 @@ import Store from '@ember-data/store';
 import Controller from '@ember/controller';
 import { action, computed } from '@ember/object';
 import { reads } from '@ember/object/computed';
+import RouterService from '@ember/routing/router-service';
 import { inject as service } from '@ember/service';
-import Cookies from 'ember-cookies/services/cookies';
-import config from 'ember-get-config';
-import moment, { Moment } from 'moment';
 
 import Node from 'ember-osf-web/models/node';
 import AnalyticsService from 'ember-osf-web/services/analytics';
-
-const {
-    OSF: {
-        cookies: {
-            analyticsDismissAdblock: dismissAdblockCookie,
-        },
-    },
-} = config;
-
-interface DateRange {
-    key: string;
-    start: Moment;
-    end: Moment;
-}
+import { Timespan, TIMESPANS } from './route';
 
 export default class ApplicationController extends Controller {
-    @service cookies!: Cookies;
     @service analytics!: AnalyticsService;
+    @service router!: RouterService;
     @service store!: Store;
 
-    dateRanges: DateRange[] = [
-        {
-            key: 'pastWeek',
-            start: moment().subtract(1, 'weeks'),
-            end: moment(),
-        },
-        {
-            key: 'pastTwoWeeks',
-            start: moment().subtract(2, 'weeks'),
-            end: moment(),
-        },
-        {
-            key: 'pastMonth',
-            start: moment().subtract(1, 'months'),
-            end: moment(),
-        },
-    ];
-
-    activeDateRange = this.dateRanges[0];
+    queryParams = ['timespan'];
+    timespan: Timespan = 'week';
+    allTimespans = TIMESPANS;
+
+    timespanIntlKeys: Record<Timespan, string> = {
+        week: 'analytics.dateRanges.pastWeek',
+        fortnight: 'analytics.dateRanges.pastTwoWeeks',
+        month: 'analytics.dateRanges.pastMonth',
+    };
+
     linksModalShown = false;
 
-    hideAdblockWarning = Boolean(this.cookies.read(dismissAdblockCookie));
     userIsBot = navigator.userAgent.includes('Prerender');
 
     linkedByQueryParams = { embed: 'bibliographic_contributors' };
 
-    @reads('model.taskInstance.value')
+    @reads('model.nodeWithCountsTaskInstance.value.taskInstance.value')
     node?: Node;
 
-    @reads('model.taskInstance.isRunning')
+    @reads('model.nodeWithCountsTaskInstance.isRunning')
     loading?: boolean;
 
     @reads('node.relationshipLinks.forks.links.related.meta.count')
@@ -70,34 +45,24 @@ export default class ApplicationController extends Controller {
     @reads('node.apiMeta.templated_by_count')
     templatedByCount?: number;
 
-    @computed('node.public', 'model.{id,modelName}')
-    get nodePublic() {
-        const node: Node | null = this.node || this.store.peekRecord(this.model.modelName, this.model.id);
-        return node && node.public;
-    }
-
-    @computed('nodePublic', 'userIsBot')
-    get chartsEnabled() {
-        return this.nodePublic && !this.userIsBot;
+    @computed('node.public')
+    get nodePrivate(): boolean {
+        const { node } = this;
+        return Boolean(node && !node.public);
     }
 
-    @action
-    dismissAdblockWarning() {
-        this.cookies.write(dismissAdblockCookie, 1, { path: '/' });
-        this.set('hideAdblockWarning', true);
-        this.analytics.click(
-            'button',
-            'Analytics - Dismiss adblock warning',
-        );
+    @computed('node', 'nodePrivate', 'userIsBot')
+    get chartsEnabled(): boolean {
+        return Boolean(this.node && !this.nodePrivate && !this.userIsBot);
     }
 
     @action
-    setDateRange(dateRange: DateRange) {
-        this.set('activeDateRange', dateRange);
+    setTimespan(timespan: Timespan) {
         this.analytics.click(
             'button',
-            `Analytics - Choose date range "${dateRange.key}"`,
+            `Analytics - Choose date range "${timespan}"`,
         );
+        this.router.transitionTo({ queryParams: { timespan } });
     }
 
     @action

lib/analytics-page/addon/application/route.ts

@@ -3,20 +3,40 @@ import { assert } from '@ember/debug';
 import { action } from '@ember/object';
 import Transition from '@ember/routing/-private/transition';
 import Route from '@ember/routing/route';
+import RouterService from '@ember/routing/router-service';
 import { inject as service } from '@ember/service';
 import { waitFor } from '@ember/test-waiters';
 import { task, TaskInstance } from 'ember-concurrency';
 import { taskFor } from 'ember-concurrency-ts';
+import config from 'ember-get-config';
 
 import Node from 'ember-osf-web/models/node';
 import AnalyticsService from 'ember-osf-web/services/analytics';
+import CurrentUser from 'ember-osf-web/services/current-user';
 import Ready, { Blocker } from 'ember-osf-web/services/ready';
+import captureException from 'ember-osf-web/utils/capture-exception';
+
+const { OSF: { apiUrl } } = config;
+
+export const TIMESPANS = ['week', 'fortnight', 'month'] as const;
+export type Timespan = (typeof TIMESPANS)[number];
+function isValidTimespan(maybeTimespan: string): maybeTimespan is Timespan {
+    return TIMESPANS.includes(maybeTimespan as Timespan);
+}
 
 export default class AnalyticsPageRoute extends Route {
     @service analytics!: AnalyticsService;
+    @service currentUser!: CurrentUser;
     @service ready!: Ready;
+    @service router!: RouterService;
     @service store!: Store;
 
+    queryParams = {
+        timespan: {
+            refreshModel: true,
+        },
+    };
+
     @task
     @waitFor
     async reloadNode(model: Node, blocker: Blocker) {
@@ -49,7 +69,25 @@ export default class AnalyticsPageRoute extends Route {
         };
     }
 
-    model(_: {}, transition: Transition) {
+    @task
+    @waitFor
+    async loadChartsData(nodeTaskInstance: TaskInstance<Node>, timespan: string) {
+        const node = await nodeTaskInstance;
+        if (!node.public) {
+            return null;
+        }
+        try {
+            const responseJson = await this.currentUser.authenticatedAJAX({
+                url: `${apiUrl}/_/metrics/query/node_analytics/${node.id}/${timespan}/`,
+            });
+            return responseJson.data.attributes;
+        } catch (e) {
+            captureException(e);
+            throw e;
+        }
+    }
+
+    model({timespan}: {timespan: string}, transition: Transition) {
         const guidRouteInfo = transition.routeInfos.find(
             routeInfo => Boolean(routeInfo.params) && 'guid' in routeInfo.params!,
         )!;
@@ -64,13 +102,23 @@ export default class AnalyticsPageRoute extends Route {
             model.taskInstance && model.taskInstance.isRunning !== undefined,
         );
 
-        return taskFor(this.getNodeWithCounts).perform(model.taskInstance);
+        if (!isValidTimespan(timespan)) {
+            this.router.transitionTo({ queryParams: { timespan: TIMESPANS[0] } });
+            return null;
+        }
+
+        return {
+            nodeId: model.guid,
+            timespan,
+            nodeWithCountsTaskInstance: taskFor(this.getNodeWithCounts).perform(model.taskInstance),
+            chartsDataTaskInstance: taskFor(this.loadChartsData).perform(model.taskInstance, timespan),
+        };
     }
 
     buildRouteInfoMetadata() {
         return {
             osfMetrics: {
-                itemGuid: (this.controller as any).model.id as string,
+                itemGuid: this.controller.model.nodeId as string,
             },
         };
     }

lib/analytics-page/addon/application/styles.scss

@@ -16,10 +16,17 @@
 .CountBox {
     text-align: center;
 
-    h2,
     h3 {
         margin-top: 0;
     }
+
+    .Count {
+        font-size: var(--stepUp2);
+        font-weight: lighter;
+        line-height: 1.1;
+        min-height: 1em;
+        margin-bottom: 10px;
+    }
 }
 
 .PickDateRange {
@@ -69,6 +76,11 @@
         margin-left: 15px;
         margin-right: 15px;
     }
+
+    .PageContainer {
+        width: 99vw;
+        padding: 0;
+    }
 }
 
 @media screen and (max-device-height: 500px) {