add telemetry events

Author: paula-stacho

packages/compass-data-modeling/src/store/diagram.ts

@@ -314,8 +314,11 @@ export function selectBackground(): DiagramBackgroundSelectedAction {
 export function createNewRelationship(
   namespace: string
 ): DataModelingThunkAction<void, RelationSelectedAction> {
-  return (dispatch) => {
+  return (dispatch, getState, { track }) => {
     const relationshipId = new UUID().toString();
+    const currentNumberOfRelationships = getCurrentNumberOfRelationships(
+      getState()
+    );
     dispatch(
       applyEdit({
         type: 'AddRelationship',
@@ -333,6 +336,9 @@ export function createNewRelationship(
       type: DiagramActionTypes.RELATIONSHIP_SELECTED,
       relationshipId,
     });
+    track('Data Modeling Relationship Added', {
+      num_relationships: currentNumberOfRelationships + 1,
+    });
   };
 }
 
@@ -469,8 +475,23 @@ export function updateRelationship(
   });
 }
 
-export function deleteRelationship(relationshipId: string) {
-  return applyEdit({ type: 'RemoveRelationship', relationshipId });
+export function deleteRelationship(
+  relationshipId: string
+): DataModelingThunkAction<void, RelationSelectedAction> {
+  return (dispatch, getState, { track }) => {
+    const currentNumberOfRelationships = getCurrentNumberOfRelationships(
+      getState()
+    );
+    dispatch(
+      applyEdit({
+        type: 'RemoveRelationship',
+        relationshipId,
+      })
+    );
+    track('Data Modeling Relationship Deleted', {
+      num_relationships: currentNumberOfRelationships - 1,
+    });
+  };
 }
 
 export function closeDrawer(): DrawerClosedAction {
@@ -628,3 +649,8 @@ export function getRelationshipForCurrentModel(
     (r) => r.id === relationshipId
   );
 }
+
+function getCurrentNumberOfRelationships(state: DataModelingState): number {
+  return selectCurrentModel(getCurrentDiagramFromState(state).edits)
+    .relationships.length;
+}

packages/compass-telemetry/src/telemetry-events.ts

@@ -2901,6 +2901,40 @@ type DataModelingDiagramExported = CommonEvent<{
   };
 }>;
 
+/**
+ * This event is fired when user adds a new relationship to a data modeling diagram.
+ *
+ * @category Data Modeling
+ */
+type DataModelingDiagramRelationshipAdded = CommonEvent<{
+  name: 'Data Modeling Relationship Added';
+  payload: {
+    num_relationships: number;
+  };
+}>;
+
+/**
+ * This event is fired when user edits a relationship in a data modeling diagram.
+ *
+ * @category Data Modeling
+ */
+type DataModelingDiagramRelationshipEdited = CommonEvent<{
+  name: 'Data Modeling Relationship Edited';
+  payload: Record<string, never>;
+}>;
+
+/**
+ * This event is fired when user deletes a relationship from a data modeling diagram.
+ *
+ * @category Data Modeling
+ */
+type DataModelingDiagramRelationshipDeleted = CommonEvent<{
+  name: 'Data Modeling Relationship Deleted';
+  payload: {
+    num_relationships: number;
+  };
+}>;
+
 export type TelemetryEvent =
   | AggregationCanceledEvent
   | AggregationCopiedEvent
@@ -3048,4 +3082,7 @@ export type TelemetryEvent =
   | CreateIndexIndexSuggestionsCopied
   | CreateIndexStrategiesDocumentationClicked
   | UUIDEncounteredEvent
-  | DataModelingDiagramExported;
+  | DataModelingDiagramExported
+  | DataModelingDiagramRelationshipAdded
+  | DataModelingDiagramRelationshipEdited
+  | DataModelingDiagramRelationshipDeleted;