Connect: Collect usage events

packages/teleterm/src/mainProcess/fixtures/mocks.ts

@@ -14,6 +14,7 @@ export class MockMainProcessClient implements MainProcessClient {
       this.getRuntimeSettings().platform
     );
   }
+
   getRuntimeSettings(): RuntimeSettings {
     return { ...defaultRuntimeSettings, ...this.runtimeSettings };
   }
@@ -22,7 +23,9 @@ export class MockMainProcessClient implements MainProcessClient {
     Promise.resolve({ tsh: '', shared: '' });
 
   openTerminalContextMenu() {}
+
   openClusterContextMenu() {}
+
   openTabContextMenu() {}
 
   showFileSaveDialog() {
@@ -40,6 +43,7 @@ export class MockMainProcessClient implements MainProcessClient {
   async symlinkTshMacOs() {
     return true;
   }
+
   async removeTshSymlinkMacOs() {
     return true;
   }
@@ -67,4 +71,7 @@ const defaultRuntimeSettings = {
     requestedNetworkAddress: '',
   },
   installationId: '123e4567-e89b-12d3-a456-426614174000',
+  arch: 'arm64',
+  osVersion: '22.2.0',
+  appVersion: '11.1.0',
 };

packages/teleterm/src/mainProcess/runtimeSettings.ts

@@ -28,6 +28,8 @@ const dev = env.NODE_ENV === 'development' || env.DEBUG_PROD === 'true';
 // Allows running tsh in insecure mode (development)
 const isInsecure = dev || argv.includes('--insecure');
 
+const PREHOG_ADDR = 'https://reporting-staging.teleportinfra.dev'; // TODO(gzdunek): change to prod before going live
+
 function getRuntimeSettings(): RuntimeSettings {
   const userDataDir = app.getPath('userData');
   const {
@@ -49,6 +51,7 @@ function getRuntimeSettings(): RuntimeSettings {
       // for tshd we have to specify the protocol as well.
       `--addr=${tshAddress}`,
       `--certs-dir=${getCertsDir()}`,
+      `--prehog-addr=${PREHOG_ADDR}`,
     ],
   };
   const sharedProcess = {
@@ -77,6 +80,16 @@ function getRuntimeSettings(): RuntimeSettings {
     installationId: loadInstallationId(
       path.resolve(app.getPath('userData'), 'installation_id')
     ),
+    arch: os.arch(),
+    osVersion: os.release(),
+    // To start the app in dev mode we run `electron path_to_main.js`. It means
+    // that app is run without package.json context, so it can not read the version
+    // from it.
+    // The way we run Electron can be changed (`electron .`), but it has one major
+    // drawback - dev app and bundled app will use the same app data directory.
+    //
+    // A workaround is to read the version from `process.env.npm_package_version`.
+    appVersion: dev ? process.env.npm_package_version : app.getVersion(),
   };
 }
 

packages/teleterm/src/mainProcess/types.ts

@@ -26,6 +26,9 @@ export type RuntimeSettings = {
     requestedNetworkAddress: string;
   };
   installationId: string;
+  arch: string;
+  osVersion: string;
+  appVersion: string;
 };
 
 export type MainProcessClient = {

packages/teleterm/src/services/tshd/createClient.ts

@@ -10,6 +10,8 @@ import middleware, { withLogging } from './middleware';
 import * as types from './types';
 import createAbortController from './createAbortController';
 import { AccessRequest, ResourceID } from './v1/access_request_pb';
+import { mapUsageEvent } from './mapUsageEvent';
+import { ReportUsageEventRequest } from './types';
 
 export default function createClient(
   addr: string,
@@ -655,6 +657,19 @@ export default function createClient(
         });
       });
     },
+
+    reportUsageEvent(event: ReportUsageEventRequest) {
+      const req = mapUsageEvent(event);
+      return new Promise<void>((resolve, reject) => {
+        tshd.reportUsageEvent(req, err => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve();
+          }
+        });
+      });
+    },
   };
   return client;
 }

packages/teleterm/src/services/tshd/fixtures/mocks.ts

@@ -89,6 +89,7 @@ export class MockTshClient implements TshClient {
   ) => Promise<undefined>;
   logout: (clusterUri: string) => Promise<undefined>;
   transferFile: () => undefined;
+  reportUsageEvent: () => undefined;
 }
 
 export const gateway: Gateway = {

packages/teleterm/src/services/tshd/mapUsageEvent.ts

@@ -0,0 +1,93 @@
+import { Timestamp } from 'google-protobuf/google/protobuf/timestamp_pb';
+
+import * as api from './v1/usage_events_pb';
+import * as prehogApi from './prehog/v1alpha/connect_pb';
+
+import * as types from './types';
+
+/**
+ * Maps a plain JS object into a gRPC request object.
+ */
+export function mapUsageEvent(event: types.ReportUsageEventRequest) {
+  return new api.ReportUsageEventRequest()
+    .setAuthClusterId(event.authClusterId)
+    .setPrehogReq(mapPrehogBody(event.prehogReq));
+}
+
+function mapPrehogBody(
+  plainReq: types.ReportUsageEventRequest['prehogReq']
+): prehogApi.SubmitConnectEventRequest {
+  const req = new prehogApi.SubmitConnectEventRequest()
+    .setTimestamp(Timestamp.fromDate(plainReq.timestamp))
+    .setDistinctId(plainReq.distinctId);
+
+  // Non-anonymized events.
+  if (plainReq.userJobRoleUpdate) {
+    const event = plainReq.userJobRoleUpdate;
+    const reqEvent = new prehogApi.ConnectUserJobRoleUpdateEvent().setJobRole(
+      event.jobRole
+    );
+
+    return req.setUserJobRoleUpdate(reqEvent);
+  }
+
+  // Anonymized events.
+  if (plainReq.clusterLogin) {
+    const event = plainReq.clusterLogin;
+    const reqEvent = new prehogApi.ConnectClusterLoginEvent()
+      .setClusterName(event.clusterName)
+      .setUserName(event.userName)
+      .setConnectorType(event.connectorType)
+      .setOs(event.os)
+      .setArch(event.arch)
+      .setOsVersion(event.osVersion)
+      .setAppVersion(event.appVersion);
+
+    return req.setClusterLogin(reqEvent);
+  }
+  if (plainReq.protocolUse) {
+    const event = plainReq.protocolUse;
+    const reqEvent = new prehogApi.ConnectProtocolUseEvent()
+      .setClusterName(event.clusterName)
+      .setUserName(event.userName)
+      .setProtocol(event.protocol);
+
+    return req.setProtocolUse(reqEvent);
+  }
+  if (plainReq.accessRequestCreate) {
+    const event = plainReq.accessRequestCreate;
+    const reqEvent = new prehogApi.ConnectAccessRequestCreateEvent()
+      .setClusterName(event.clusterName)
+      .setUserName(event.userName)
+      .setKind(event.kind);
+
+    return req.setAccessRequestCreate(reqEvent);
+  }
+  if (plainReq.accessRequestReview) {
+    const event = plainReq.accessRequestReview;
+    const reqEvent = new prehogApi.ConnectAccessRequestReviewEvent()
+      .setClusterName(event.clusterName)
+      .setUserName(event.userName);
+
+    return req.setAccessRequestReview(reqEvent);
+  }
+  if (plainReq.accessRequestAssumeRole) {
+    const event = plainReq.accessRequestAssumeRole;
+    const reqEvent = new prehogApi.ConnectAccessRequestAssumeRoleEvent()
+      .setClusterName(event.clusterName)
+      .setUserName(event.userName);
+
+    return req.setAccessRequestAssumeRole(reqEvent);
+  }
+  if (plainReq.fileTransferRun) {
+    const event = plainReq.fileTransferRun;
+    const reqEvent = new prehogApi.ConnectFileTransferRunEvent()
+      .setClusterName(event.clusterName)
+      .setUserName(event.userName)
+      .setIsUpload(event.isUpload);
+
+    return req.setFileTransferRun(reqEvent);
+  }
+
+  throw new Error(`Unrecognized event: ${JSON.stringify(plainReq)}`);
+}