Connect: Collect usage events

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

@@ -31,6 +31,9 @@ export class MockMainProcessClient implements MainProcessClient {
         requestedNetworkAddress: '',
       },
       installationId: '123e4567-e89b-12d3-a456-426614174000',
+      arch: 'arm64',
+      osVersion: '22.2.0',
+      connectVersion: '11.1.0',
     };
   }
 

packages/teleterm/src/mainProcess/runtimeSettings.ts

@@ -77,6 +77,9 @@ function getRuntimeSettings(): RuntimeSettings {
     installationId: loadInstallationId(
       path.resolve(app.getPath('userData'), 'installation_id')
     ),
+    arch: os.arch(),
+    osVersion: os.release(),
+    connectVersion: app.getVersion(),
   };
 }
 

packages/teleterm/src/mainProcess/types.ts

@@ -26,6 +26,9 @@ export type RuntimeSettings = {
     requestedNetworkAddress: string;
   };
   installationId: string;
+  arch: string;
+  osVersion: string;
+  connectVersion: 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 { ReportEventRequest } from './types';
 
 export default function createClient(
   addr: string,
@@ -655,6 +657,19 @@ export default function createClient(
         });
       });
     },
+
+    reportUsageEvent(event: ReportEventRequest) {
+      const req = mapUsageEvent(event);
+      return new Promise<void>((resolve, reject) => {
+        tshd.reportEvent(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,99 @@
+import { Timestamp } from 'google-protobuf/google/protobuf/timestamp_pb';
+
+import {
+  AccessRequestAssumeRoleEvent,
+  AccessRequestCreateEvent,
+  AccessRequestReviewEvent,
+  ClusterProperties,
+  ProtocolRunEvent,
+  ConnectUsageEventOneOf,
+  LoginEvent,
+  FileTransferRunEvent,
+  ReportEventRequest,
+  UserJobRoleUpdateEvent,
+} from 'teleterm/services/tshd/v1/usage_events_pb';
+
+import * as types from './types';
+
+export function mapUsageEvent(event: types.ReportEventRequest) {
+  return new ReportEventRequest()
+    .setDistinctId(event.distinctId)
+    .setTimestamp(Timestamp.fromDate(event.timestamp))
+    .setEvent(mapEventBody(event.event));
+}
+
+function mapEventBody(
+  event: ConnectUsageEventOneOf.AsObject
+): ConnectUsageEventOneOf {
+  if (event.loginEvent) {
+    const { loginEvent } = event;
+    return new ConnectUsageEventOneOf().setLoginEvent(
+      new LoginEvent()
+        .setClusterProperties(mapClusterProperties(loginEvent))
+        .setOs(loginEvent.os)
+        .setArch(loginEvent.arch)
+        .setOsVersion(loginEvent.osVersion)
+        .setConnectVersion(loginEvent.connectVersion)
+    );
+  }
+  if (event.protocolRunEvent) {
+    const { protocolRunEvent } = event;
+    return new ConnectUsageEventOneOf().setProtocolRunEvent(
+      new ProtocolRunEvent()
+        .setClusterProperties(mapClusterProperties(protocolRunEvent))
+        .setProtocol(protocolRunEvent.protocol)
+    );
+  }
+  if (event.accessRequestCreateEvent) {
+    const { accessRequestCreateEvent } = event;
+    return new ConnectUsageEventOneOf().setAccessRequestCreateEvent(
+      new AccessRequestCreateEvent()
+        .setClusterProperties(mapClusterProperties(accessRequestCreateEvent))
+        .setKind(accessRequestCreateEvent.kind)
+    );
+  }
+  if (event.accessRequestReviewEvent) {
+    const { accessRequestReviewEvent } = event;
+    return new ConnectUsageEventOneOf().setAccessRequestReviewEvent(
+      new AccessRequestReviewEvent().setClusterProperties(
+        mapClusterProperties(accessRequestReviewEvent)
+      )
+    );
+  }
+  if (event.accessRequestAssumeRoleEvent) {
+    const { accessRequestAssumeRoleEvent } = event;
+    return new ConnectUsageEventOneOf().setAccessRequestAssumeRoleEvent(
+      new AccessRequestAssumeRoleEvent().setClusterProperties(
+        mapClusterProperties(accessRequestAssumeRoleEvent)
+      )
+    );
+  }
+  if (event.fileTransferRunEvent) {
+    const { fileTransferRunEvent } = event;
+    return new ConnectUsageEventOneOf().setFileTransferRunEvent(
+      new FileTransferRunEvent()
+        .setClusterProperties(mapClusterProperties(fileTransferRunEvent))
+        .setDirection(fileTransferRunEvent.direction)
+    );
+  }
+  if (event.userJobRoleUpdateEvent) {
+    const { userJobRoleUpdateEvent } = event;
+    return new ConnectUsageEventOneOf().setUserJobRoleUpdateEvent(
+      new UserJobRoleUpdateEvent().setJobRole(userJobRoleUpdateEvent.jobRole)
+    );
+  }
+
+  throw new Error(`Unrecognized event: ${JSON.stringify(event)}`);
+}
+
+function mapClusterProperties(e: {
+  clusterProperties?: ClusterProperties.AsObject;
+}): ClusterProperties {
+  if (!e.clusterProperties) {
+    throw new Error('Missing cluster metadata');
+  }
+  return new ClusterProperties()
+    .setAuthClusterId(e.clusterProperties.authClusterId)
+    .setClusterName(e.clusterProperties.clusterName)
+    .setUserName(e.clusterProperties.userName);
+}

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

@@ -14,34 +14,48 @@ import apiApp from './v1/app_pb';
 import apiService from './v1/service_pb';
 import apiAuthSettings from './v1/auth_settings_pb';
 import apiAccessRequest from './v1/access_request_pb';
+import apiUsageEvents from './v1/usage_events_pb';
 
 export type Application = apiApp.App.AsObject;
+
 export interface Kube extends apiKube.Kube.AsObject {
   uri: uri.KubeUri;
 }
+
 export interface Server extends apiServer.Server.AsObject {
   uri: uri.ServerUri;
 }
+
 export interface Gateway extends apigateway.Gateway.AsObject {
   uri: uri.GatewayUri;
   targetUri: uri.DatabaseUri;
 }
+
 export type AccessRequest = apiAccessRequest.AccessRequest.AsObject;
 export type ResourceId = apiAccessRequest.ResourceID.AsObject;
 export type AccessRequestReview = apiAccessRequest.AccessRequestReview.AsObject;
+
 export interface GetServersResponse
   extends apiService.GetServersResponse.AsObject {
   agentsList: Server[];
 }
+
 export interface GetDatabasesResponse
   extends apiService.GetDatabasesResponse.AsObject {
   agentsList: Database[];
 }
+
 export interface GetKubesResponse extends apiService.GetKubesResponse.AsObject {
   agentsList: Kube[];
 }
+
 export type GetRequestableRolesResponse =
   apiService.GetRequestableRolesResponse.AsObject;
+
+export type ReportEventRequest = Modify<
+  apiUsageEvents.ReportEventRequest.AsObject,
+  { timestamp: Date }
+>;
 // Available types are listed here:
 // https://github.com/gravitational/teleport/blob/v9.0.3/lib/defaults/defaults.go#L513-L530
 //
@@ -53,20 +67,26 @@ export type GatewayProtocol =
   | 'cockroachdb'
   | 'redis'
   | 'sqlserver';
+
 export interface Database extends apiDb.Database.AsObject {
   uri: uri.DatabaseUri;
 }
+
 export interface Cluster extends apiCluster.Cluster.AsObject {
   uri: uri.ClusterUri;
   loggedInUser?: LoggedInUser;
 }
+
 export type LoggedInUser = apiCluster.LoggedInUser.AsObject & {
   assumedRequests?: Record<string, AssumedRequest>;
 };
 export type AuthProvider = apiAuthSettings.AuthProvider.AsObject;
 export type AuthSettings = apiAuthSettings.AuthSettings.AsObject;
 
-export type FileTransferRequest = apiService.FileTransferRequest.AsObject;
+export interface FileTransferRequest
+  extends apiService.FileTransferRequest.AsObject {
+  clusterUri: uri.ClusterUri;
+}
 
 export type WebauthnCredentialInfo = apiService.CredentialInfo.AsObject;
 export type WebauthnLoginPrompt =
@@ -160,6 +180,7 @@ export type TshClient = {
     options: FileTransferRequest,
     abortSignal?: TshAbortSignal
   ) => FileTransferListeners;
+  reportUsageEvent: (event: ReportEventRequest) => Promise<void>;
 };
 
 export type TshAbortController = {
@@ -233,3 +254,6 @@ export type AssumedRequest = {
   expires: Date;
   roles: string[];
 };
+
+// Replaces object property with a new type
+type Modify<T, R> = Omit<T, keyof R> & R;