The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Add tracking events for transform run tags update and dependency diagnostics row selection (#69531)
Anderson8a39fdc126bd
diff --git a/e2e/support/helpers/e2e-snowplow-helpers.js b/e2e/support/helpers/e2e-snowplow-helpers.jsindex 6e2250c0614..a4939f1cfe1 100644--- a/e2e/support/helpers/e2e-snowplow-helpers.js+++ b/e2e/support/helpers/e2e-snowplow-helpers.js@@ -127,11 +127,18 @@ const retrySnowplowRequest = (timeout - SNOWPLOW_INTERVAL,);} else {- const message =+ let message =typeof messageOrMessageFn === "function"? messageOrMessageFn(response): messageOrMessageFn;- throw new Error("Snowplow retry timeout " + message);++ if (!message) {+ message =+ "Response body (trimmed): " ++ JSON.stringify(response.body)?.slice(0, 512);+ }++ throw new Error("Snowplow retry timeout: " + message);}});};diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.tsindex cb29b4c5f83..fb9ab25568f 100644--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts@@ -807,15 +807,32 @@ LIMITH.popover().findByText("hourly").click();cy.wait("@updateTransform");+ H.expectUnstructuredSnowplowEvent({+ event: "transform_tags_updated",+ triggered_from: "transform_run_page",+ event_detail: "tag_added",+ target_id: 1,+ result: "success",+ });+assertOptionSelected("hourly");assertOptionNotSelected("daily");H.popover().findByText("daily").click();+cy.wait("@updateTransform");assertOptionSelected("hourly");assertOptionSelected("daily");-getTagsInput().type("{backspace}");+ cy.wait("@updateTransform");+ H.expectUnstructuredSnowplowEvent({+ event: "transform_tags_updated",+ triggered_from: "transform_run_page",+ event_detail: "tag_removed",+ target_id: 1,+ result: "success",+ });+assertOptionSelected("hourly");assertOptionNotSelected("daily");});diff --git a/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.ts b/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.tsindex 63b5e304564..af6ca8a035c 100644--- a/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.ts+++ b/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.ts@@ -84,10 +84,12 @@ describe("scenarios > dependencies > broken list", () => {cy.signInAsAdmin();H.activateToken("bleeding-edge");createContent();+ H.resetSnowplow();});afterEach(() => {dropTransformTable();+ H.expectNoBadSnowplowEvents();});describe("analysis", () => {@@ -100,8 +102,8 @@ describe("scenarios > dependencies > broken list", () => {});});- describe("sidebar", () => {- it("should show broken dependents", () => {+ describe("selecting entities", () => {+ it("should show sidebar for broken dependents and trigger snowplow event", () => {H.DependencyDiagnostics.visitBrokenDependencies();cy.log("table dependents");@@ -112,6 +114,11 @@ describe("scenarios > dependencies > broken list", () => {missingColumns: ["score"],brokenDependents: BROKEN_TABLE_DEPENDENTS,});+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_diagnostics_entity_selected",+ triggered_from: "broken",+ event_detail: "table",+ });cy.log("question dependents");H.DependencyDiagnostics.list().findByText(TABLE_BASED_QUESTION).click();diff --git a/e2e/test/scenarios/dependencies/dependency-unreferenced-list.cy.spec.ts b/e2e/test/scenarios/dependencies/dependency-unreferenced-list.cy.spec.tsindex 5a53b66bdd4..6f0b89c3132 100644--- a/e2e/test/scenarios/dependencies/dependency-unreferenced-list.cy.spec.ts+++ b/e2e/test/scenarios/dependencies/dependency-unreferenced-list.cy.spec.ts@@ -110,6 +110,11 @@ describe("scenarios > dependencies > unreferenced list", () => {H.activateToken("bleeding-edge");H.resyncDatabase({ dbId: WRITABLE_DB_ID, tableName: TABLE_NAME });cy.viewport(1600, 1400);+ H.resetSnowplow();+ });++ afterEach(() => {+ H.expectNoBadSnowplowEvents();});describe("analysis", () => {@@ -300,12 +305,17 @@ describe("scenarios > dependencies > unreferenced list", () => {});});- describe("sidebar", () => {- it("should show the sidebar for supported entities", () => {+ describe("selecting entities", () => {+ it("should show the sidebar for supported entities and trigger snowplow event", () => {setupEntities();H.DependencyDiagnostics.visitUnreferencedEntities();H.DependencyDiagnostics.list().findByText(TABLE_DISPLAY_NAME).click();+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_diagnostics_entity_selected",+ triggered_from: "unreferenced",+ event_detail: "table",+ });checkSidebar({title: TABLE_DISPLAY_NAME,location: DATABASE_NAME,diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsxindex 18908269629..16f2ec353f9 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsx@@ -4,6 +4,7 @@ import { useLayoutEffect, useState } from "react";import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";import type * as Urls from "metabase/lib/urls";+import { trackDependencyDiagnosticsEntitySelected } from "metabase/transforms/analytics";import { Center, Flex, Stack } from "metabase/ui";import {useListBreakingGraphNodesQuery,@@ -149,6 +150,15 @@ export function DependencyList({}}, [selectedEntry, selectedNode]);+ const onRowClick = (node: DependencyEntry) => {+ setSelectedEntry(node);+ trackDependencyDiagnosticsEntitySelected({+ triggeredFrom: mode,+ entityId: node.id,+ entityType: node.type,+ });+ };+return (<FlexclassName={cx({ [S.resizing]: isResizing })}@@ -177,7 +187,7 @@ export function DependencyList({mode={mode}sortOptions={getSortOptions(params)}isLoading={isLoading}- onSelect={setSelectedEntry}+ onSelect={onRowClick}onSortOptionsChange={handleSortOptionsChange}/>)}diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.tsindex 84397f9a05b..e75c1978f93 100644--- a/frontend/src/metabase-types/analytics/event.ts+++ b/frontend/src/metabase-types/analytics/event.ts@@ -110,6 +110,13 @@ export type ErrorDiagnosticModalSubmittedEvent = ValidateEvent<{event_detail: "download-diagnostics" | "submit-report";}>;+export type DependencyDiagnosticsEntitySelected = ValidateEvent<{+ event: "dependency_diagnostics_entity_selected";+ triggered_from: "broken" | "unreferenced";+ target_id: number;+ event_detail?: string;+}>;+export type GsheetsConnectionClickedEvent = ValidateEvent<{event: "sheets_connection_clicked";triggered_from: "db-page" | "add-data-modal";@@ -281,6 +288,14 @@ export type TransformCreatedEvent = ValidateEvent<{target_id: number;}>;+export type TransformRunTagsUpdated = ValidateEvent<{+ event: "transform_tags_updated";+ result: "success" | "failure";+ triggered_from: "transform_run_page";+ event_detail: "tag_added" | "tag_removed";+ target_id: number;+}>;+export type DocumentCreatedEvent = ValidateEvent<{event: "document_created";target_id: number;@@ -622,6 +637,7 @@ export type SimpleEvent =| CSVUploadClickedEvent| DatabaseAddClickedEvent| DatabaseEngineSelectedEvent+ | DependencyDiagnosticsEntitySelected| NewIFrameCardCreatedEvent| NewsletterToggleClickedEvent| OnboardingChecklistOpenedEvent@@ -651,6 +667,7 @@ export type SimpleEvent =| TransformJobTriggerManualRunEvent| TransformCreatedEvent| TransformCreateEvent+ | TransformRunTagsUpdated| DocumentAddCardEvent| DocumentAddSmartLinkEvent| DocumentAddSupportingTextEventdiff --git a/frontend/src/metabase/transforms/analytics.ts b/frontend/src/metabase/transforms/analytics.tsindex a16dfbab380..c17f1a4d281 100644--- a/frontend/src/metabase/transforms/analytics.ts+++ b/frontend/src/metabase/transforms/analytics.ts@@ -44,3 +44,38 @@ export function trackTransformCreated({target_id: transformId,});}++export function trackTransformRunTagsUpdated({+ added,+ transformId,+ result,+}: {+ added: boolean;+ transformId: number;+ result: "success" | "failure";+}) {+ trackSimpleEvent({+ event: "transform_tags_updated",+ triggered_from: "transform_run_page",+ event_detail: added ? "tag_added" : "tag_removed",+ target_id: transformId,+ result,+ });+}++export function trackDependencyDiagnosticsEntitySelected({+ triggeredFrom,+ entityId,+ entityType,+}: {+ entityId: number;+ entityType: string;+ triggeredFrom: "broken" | "unreferenced";+}) {+ trackSimpleEvent({+ event: "dependency_diagnostics_entity_selected",+ triggered_from: triggeredFrom,+ target_id: entityId,+ event_detail: entityType,+ });+}diff --git a/frontend/src/metabase/transforms/pages/TransformRunPage/RunSection/RunSection.tsx b/frontend/src/metabase/transforms/pages/TransformRunPage/RunSection/RunSection.tsxindex 1aa3680f90c..4de91bccd66 100644--- a/frontend/src/metabase/transforms/pages/TransformRunPage/RunSection/RunSection.tsx+++ b/frontend/src/metabase/transforms/pages/TransformRunPage/RunSection/RunSection.tsx@@ -17,7 +17,10 @@ import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";import { Anchor, Box, Divider, Group, Stack } from "metabase/ui";import type { Transform, TransformTagId } from "metabase-types/api";-import { trackTransformTriggerManualRun } from "../../../analytics";+import {+ trackTransformRunTagsUpdated,+ trackTransformTriggerManualRun,+} from "../../../analytics";import { RunButton } from "../../../components/RunButton";import { RunStatus } from "../../../components/RunStatus";import { TagMultiSelect } from "../../../components/TagMultiSelect";@@ -182,6 +185,9 @@ function TagSection({ transform, readOnly }: TagSectionProps) {tagIds: TransformTagId[],undoable: boolean = false,) => {+ const prevTagCount = transform.tag_ids?.length ?? 0;+ const isAdding = prevTagCount < tagIds.length;+const { error } = await updateTransform({id: transform.id,tag_ids: tagIds,@@ -200,6 +206,12 @@ function TagSection({ transform, readOnly }: TagSectionProps) {sendSuccessToast(t`Transform tags updated`, undoable ? undo : undefined);}++ trackTransformRunTagsUpdated({+ added: isAdding,+ result: error ? "failure" : "success",+ transformId: transform.id,+ });};return (