(core) Add telemetry

Test Plan: Server tests.

Reviewers: jarek

Differential Revision: https://phab.getgrist.com/D3818

app/client/lib/helpScout.ts

@@ -15,6 +15,7 @@
 
 // tslint:disable:unified-signatures
 
+import {logTelemetryEvent} from 'app/client/lib/telemetry';
 import {AppModel} from 'app/client/models/AppModel';
 import {reportWarning} from 'app/client/models/errors';
 import {IAppError} from 'app/client/models/NotifyModel';
@@ -54,6 +55,11 @@ interface ISessionData {
   [key: string]: string;
 }
 
+interface ICallbackAttributes {
+  id?: string;
+  query?: string;
+}
+
 /**
  * This provides the HelpScout Beacon API, taking care of initializing Beacon on first use.
  */
@@ -65,7 +71,8 @@ export function Beacon(method: 'navigate', route: string): void;
 export function Beacon(method: 'identify', userObj: IUserObj): void;
 export function Beacon(method: 'prefill', formObj: IFormObj): void;
 export function Beacon(method: 'config', configObj: object): void;
-export function Beacon(method: 'on'|'once', event: string, callback: () => void): void;
+export function Beacon(method: 'on'|'once', event: string,
+  callback: (attrs?: ICallbackAttributes) => void): void;
 export function Beacon(method: 'off', event: string, callback?: () => void): void;
 export function Beacon(method: 'session-data', data: ISessionData): void;
 export function Beacon(method: BeaconCmd): void;
@@ -187,6 +194,15 @@ function _beaconOpen(userObj: IUserObj|null, options: IBeaconOpenOptions) {
   if (!skipNav) {
     Beacon('navigate', route);
   }
+
+  Beacon('once', 'open', () => logTelemetryEvent('beaconOpen'));
+  Beacon('on', 'article-viewed', (article) => logTelemetryEvent('beaconArticleViewed', {
+    articleId: article!.id,
+  }));
+  Beacon('on', 'email-sent', () => logTelemetryEvent('beaconEmailSent'));
+  Beacon('on', 'search', (search) => logTelemetryEvent('beaconSearch', {
+    searchQuery: search!.query,
+  }));
 }
 
 function fixBeaconBaseHref() {

app/client/lib/telemetry.ts

@@ -0,0 +1,23 @@
+import {logError} from 'app/client/models/errors';
+import {TelemetryEventName} from 'app/common/Telemetry';
+import {fetchFromHome, pageHasHome} from 'app/common/urlUtils';
+
+export async function logTelemetryEvent(name: TelemetryEventName, metadata?: Record<string, any>) {
+  if (!pageHasHome()) { return; }
+
+  await fetchFromHome('/api/telemetry', {
+    method: 'POST',
+    body: JSON.stringify({
+      name,
+      metadata,
+    }),
+    credentials: 'include',
+    headers: {
+      'Content-Type': 'application/json',
+      'X-Requested-With': 'XMLHttpRequest',
+    },
+  }).catch((e: Error) => {
+    console.warn(`Failed to log telemetry event ${name}`, e);
+    logError(e);
+  });
+}