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 when Dependency Graph is opened for an entity (#69604)
Anderson98f4633388df
diff --git a/e2e/support/helpers/e2e-datamodel-helpers.ts b/e2e/support/helpers/e2e-datamodel-helpers.tsindex 2140bf8119d..87e1a66ddf0 100644--- a/e2e/support/helpers/e2e-datamodel-helpers.ts+++ b/e2e/support/helpers/e2e-datamodel-helpers.ts@@ -36,6 +36,7 @@ export const DataModel = {getNameInput: getTableNameInput,getDescriptionInput: getTableDescriptionInput,getQueryBuilderLink: getTableQueryBuilderLink,+ getDependencyGraphLink: getDependencyGraphLink,getSortButton: getTableSortButton,getSortDoneButton: getTableSortDoneButton,getSortOrderInput: getTableSortOrderInput,@@ -319,6 +320,10 @@ function getTableQueryBuilderLink() {return getTableSection().findByLabelText("Go to this table");}+function getDependencyGraphLink() {+ return getTableSection().findByRole("link", { name: "Dependency graph" });+}+function getTableDescriptionInput() {return getTableSection().findByPlaceholderText("Give this table a description",diff --git a/e2e/test/scenarios/data-studio/data-model/datamodel-data-studio.cy.spec.ts b/e2e/test/scenarios/data-studio/data-model/datamodel-data-studio.cy.spec.tsindex 55861a6d81b..6fdea91ebff 100644--- a/e2e/test/scenarios/data-studio/data-model/datamodel-data-studio.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/data-model/datamodel-data-studio.cy.spec.ts@@ -619,6 +619,20 @@ describe("scenarios > data studio > datamodel", () => {cy.log("verify changes in data reference as admin");cy.signInAsAdmin();++ H.DataModel.visitDataStudio({+ databaseId: SAMPLE_DB_ID,+ schemaId: SAMPLE_DB_SCHEMA_ID,+ tableId: ORDERS_ID,+ });+ cy.log("snowplow event when dependency graph link is clicked");+ TableSection.getDependencyGraphLink().click();+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_entity_selected",+ triggered_from: "data-structure",+ event_detail: "table",+ });+cy.visit(`/reference/databases/${SAMPLE_DB_ID}/tables/${ORDERS_ID}`);cy.get("main").within(() => {cy.findByText("Analyst Orders").should("be.visible");diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.tsindex fb9ab25568f..eeb69565fb3 100644--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts@@ -3051,6 +3051,14 @@ describe("scenarios > admin > transforms > jobs", () => {});describe("schedule", () => {+ beforeEach(() => {+ H.resetSnowplow();+ });++ afterEach(() => {+ H.expectNoBadSnowplowEvents();+ });+it("should be able to run a job on a schedule", () => {H.createTransformTag({ name: "New tag" }).then(({ body: tag }) => {createMbqlTransform({@@ -3069,6 +3077,26 @@ describe("scenarios > admin > transforms > jobs", () => {cy.findAllByText("Success").should("have.length.gte", 1);cy.findAllByText("Schedule").should("have.length.gte", 1);});++ cy.log("open detail sidebar");+ cy.findAllByText("MBQL transform").first().click();+ cy.findByRole("img", { name: "close icon" }).should("be.visible");+ cy.findByRole("link", { name: "View this transform" })+ .should("be.visible")+ .should("have.attr", "href", "/data-studio/transforms/1");+ cy.findByRole("link", { name: "View in dependency graph" })+ .should("be.visible")+ .should(+ "have.attr",+ "href",+ "/data-studio/dependencies?id=1&type=transform",+ )+ .click();+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_entity_selected",+ triggered_from: "transform-run-list",+ event_detail: "transform-run",+ });});it("should be able to change the schedule after creation", () => {diff --git a/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.ts b/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.tsindex af6ca8a035c..127e21cee15 100644--- a/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.ts+++ b/e2e/test/scenarios/dependencies/dependency-broken-list.cy.spec.ts@@ -135,6 +135,14 @@ describe("scenarios > dependencies > broken list", () => {missingColumns: ["AMOUNT"],brokenDependents: BROKEN_MODEL_DEPENDENTS,});++ cy.log("snowplow event when dependency graph link is clicked");+ cy.findByRole("link", { name: "View in dependency graph" }).click();+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_entity_selected",+ triggered_from: "diagnostics-broken-list",+ event_detail: "card",+ });});});diff --git a/e2e/test/scenarios/dependencies/dependency-graph.cy.spec.ts b/e2e/test/scenarios/dependencies/dependency-graph.cy.spec.tsindex 9c134fad2d8..981972195cb 100644--- a/e2e/test/scenarios/dependencies/dependency-graph.cy.spec.ts+++ b/e2e/test/scenarios/dependencies/dependency-graph.cy.spec.ts@@ -71,6 +71,7 @@ describe("scenarios > dependencies > dependency graph", () => {H.activateToken("bleeding-edge");H.resyncDatabase({ dbId: WRITABLE_DB_ID, tableName: TABLE_NAME });H.getTableId({ name: TABLE_NAME }).as(TABLE_ID_ALIAS);+ H.resetSnowplow();});describe("entity search", () => {@@ -86,6 +87,12 @@ describe("scenarios > dependencies > dependency graph", () => {cy.log(`verify that "${itemName}" can be found via search`);H.DependencyGraph.entrySearchInput().clear().type(itemName);H.popover().findByText(itemName).click();+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_entity_selected",+ triggered_from: "dependency-graph",+ event_detail: "table",+ });+H.DependencyGraph.entryButton().should("have.text", itemName);H.DependencyGraph.entryButton().icon(itemIcon).should("be.visible");H.DependencyGraph.entryButton().icon("close").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 6f0b89c3132..f921eae7c73 100644--- a/e2e/test/scenarios/dependencies/dependency-unreferenced-list.cy.spec.ts+++ b/e2e/test/scenarios/dependencies/dependency-unreferenced-list.cy.spec.ts@@ -378,6 +378,14 @@ describe("scenarios > dependencies > unreferenced list", () => {location: "SQL snippets",createdBy: "Bobby Tables",});++ cy.log("snowplow event when dependency graph link is clicked");+ cy.findByRole("link", { name: "View in dependency graph" }).click();+ H.expectUnstructuredSnowplowEvent({+ event: "dependency_entity_selected",+ triggered_from: "diagnostics-unreferenced-list",+ event_detail: "snippet",+ });});});});diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsxindex 8e8af6aa034..c01caca1870 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/GraphEntryInput.tsx@@ -2,6 +2,7 @@ import { useDisclosure } from "@mantine/hooks";import { useState } from "react";import { push } from "react-router-redux";+import { trackDependencyEntitySelected } from "metabase/data-studio/analytics";import { useDispatch } from "metabase/lib/redux";import { Card } from "metabase/ui";import type {@@ -34,6 +35,14 @@ export function GraphEntryInput({const handleEntryChange = (newEntry: DependencyEntry | undefined) => {dispatch(push(getGraphUrl(newEntry)));++ if (newEntry) {+ trackDependencyEntitySelected({+ entityId: newEntry.id,+ triggeredFrom: "dependency-graph",+ eventDetail: newEntry.type,+ });+ }};const handlePickerChange = (newEntry: DependencyEntry) => {diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsxindex 16f2ec353f9..1e4573f0ef1 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencyList.tsx@@ -3,8 +3,8 @@ import cx from "classnames";import { useLayoutEffect, useState } from "react";import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";+import { trackDependencyDiagnosticsEntitySelected } from "metabase/data-studio/analytics";import type * as Urls from "metabase/lib/urls";-import { trackDependencyDiagnosticsEntitySelected } from "metabase/transforms/analytics";import { Center, Flex, Stack } from "metabase/ui";import {useListBreakingGraphNodesQuery,diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/BrokenDependentsSection/BrokenDependentsSection.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/BrokenDependentsSection/BrokenDependentsSection.tsxindex 65abee4dd49..a3f07057e44 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/BrokenDependentsSection/BrokenDependentsSection.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/BrokenDependentsSection/BrokenDependentsSection.tsx@@ -4,6 +4,7 @@ import { t } from "ttag";import { ForwardRefLink } from "metabase/common/components/Link";import CS from "metabase/css/core/index.css";+import { trackDependencyEntitySelected } from "metabase/data-studio/analytics";import * as Urls from "metabase/lib/urls";import {Badge,@@ -131,6 +132,13 @@ function DependentItem({ node }: DependentItemProps) {const icon = getNodeIcon(node);const location = getNodeLocationInfo(node);const viewCount = getNodeViewCount(node);+ const registerTrackingEvent = () => {+ trackDependencyEntitySelected({+ entityId: node.id,+ triggeredFrom: "diagnostics-broken-list",+ eventDetail: node.type,+ });+ };return (<Menu opened={isOpened} onChange={setIsOpened}>@@ -191,6 +199,8 @@ function DependentItem({ node }: DependentItemProps) {to={Urls.dependencyGraph({ entry: node })}target="_blank"leftSection={<FixedSizeIcon name="dependencies" />}+ onClickCapture={registerTrackingEvent}+ onAuxClick={registerTrackingEvent}>{t`View in dependency graph`}</Menu.Item>diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/DependencySidebar.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/DependencySidebar.tsxindex 63848d8d147..ab3ce8f6225 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/DependencySidebar.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/DependencySidebar.tsx@@ -45,7 +45,7 @@ export const DependencySidebar = memo(function DependencySidebar({data-testid="dependency-list-sidebar"><Stack gap="lg">- <SidebarHeader node={node} onClose={onClose} />+ <SidebarHeader node={node} onClose={onClose} mode={mode} /><LocationSection node={node} /><InfoSection node={node} /></Stack>diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.tsxindex 5cfcee11d07..38a0742a0b0 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.tsx@@ -3,8 +3,10 @@ import { t } from "ttag";import { ForwardRefLink } from "metabase/common/components/Link";import CS from "metabase/css/core/index.css";+import { trackDependencyEntitySelected } from "metabase/data-studio/analytics";import * as Urls from "metabase/lib/urls";import { ActionIcon, Anchor, FixedSizeIcon, Group, Tooltip } from "metabase/ui";+import type { DependencyListMode } from "metabase-enterprise/dependencies/components/DependencyList/types";import type { DependencyNode } from "metabase-types/api";import { TOOLTIP_OPEN_DELAY_MS } from "../../../../constants";@@ -13,12 +15,23 @@ import { getNodeLabel, getNodeLink } from "../../../../utils";import S from "./SidebarHeader.module.css";type SidebarHeaderProps = {+ mode: DependencyListMode;node: DependencyNode;onClose: () => void;};-export function SidebarHeader({ node, onClose }: SidebarHeaderProps) {+export function SidebarHeader({ node, onClose, mode }: SidebarHeaderProps) {const link = getNodeLink(node);+ const registerTrackingEvent = () => {+ trackDependencyEntitySelected({+ entityId: node.id,+ triggeredFrom:+ mode === "broken"+ ? "diagnostics-broken-list"+ : "diagnostics-unreferenced-list",+ eventDetail: node.type,+ });+ };return (<Group@@ -61,6 +74,8 @@ export function SidebarHeader({ node, onClose }: SidebarHeaderProps) {to={Urls.dependencyGraph({ entry: node })}target="_blank"aria-label={t`View in dependency graph`}+ onClickCapture={registerTrackingEvent}+ onAuxClick={registerTrackingEvent}><FixedSizeIcon name="dependencies" /></ActionIcon>diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.unit.spec.tsxindex 42f808fda3a..97fd6570d9e 100644--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.unit.spec.tsx+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyList/DependencySidebar/SidebarHeader/SidebarHeader.unit.spec.tsx@@ -20,7 +20,9 @@ function setup({ node = createMockCardDependencyNode() }: SetupOpts = {}) {renderWithProviders(<Routepath="/"- component={() => <SidebarHeader node={node} onClose={onClose} />}+ component={() => (+ <SidebarHeader node={node} onClose={onClose} mode="unreferenced" />+ )}/>,{ withRouter: true, initialRoute: "/" },);diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.tsindex e75c1978f93..0c890f61c03 100644--- a/frontend/src/metabase-types/analytics/event.ts+++ b/frontend/src/metabase-types/analytics/event.ts@@ -110,6 +110,18 @@ export type ErrorDiagnosticModalSubmittedEvent = ValidateEvent<{event_detail: "download-diagnostics" | "submit-report";}>;+export type DependencyEntitySelected = ValidateEvent<{+ event: "dependency_entity_selected";+ triggered_from:+ | "dependency-graph"+ | "diagnostics-broken-list"+ | "diagnostics-unreferenced-list"+ | "data-structure"+ | "transform-run-list";+ event_detail?: string;+ target_id: number;+}>;+export type DependencyDiagnosticsEntitySelected = ValidateEvent<{event: "dependency_diagnostics_entity_selected";triggered_from: "broken" | "unreferenced";@@ -637,6 +649,7 @@ export type SimpleEvent =| CSVUploadClickedEvent| DatabaseAddClickedEvent| DatabaseEngineSelectedEvent+ | DependencyEntitySelected| DependencyDiagnosticsEntitySelected| NewIFrameCardCreatedEvent| NewsletterToggleClickedEventdiff --git a/frontend/src/metabase-types/api/dependencies.ts b/frontend/src/metabase-types/api/dependencies.tsindex 51f4919ee75..19b360edd78 100644--- a/frontend/src/metabase-types/api/dependencies.ts+++ b/frontend/src/metabase-types/api/dependencies.ts@@ -11,7 +11,7 @@ import type { PaginationRequest, PaginationResponse } from "./pagination";import type { Segment } from "./segment";import type { NativeQuerySnippet } from "./snippets";import type { SortDirection } from "./sorting";-import type { Table, TableId } from "./table";+import type { ConcreteTableId, Table } from "./table";import type { Transform } from "./transform";import type { WorkspaceTransform } from "./workspace";@@ -73,7 +73,7 @@ export type TableDependencyNodeData = Pick<| "fields"| "transform"| "owner"-> & { table_id?: TableId };+> & { table_id?: ConcreteTableId };export type TransformDependencyNodeData = Pick<Transform,@@ -149,7 +149,7 @@ export type DocumentDependencyNodeData = Pick<>;export type SandboxDependencyNodeData = {- table_id: TableId;+ table_id: ConcreteTableId;table?: Table | null;};diff --git a/frontend/src/metabase/data-studio/analytics.ts b/frontend/src/metabase/data-studio/analytics.tsindex 911281f0be9..32b1b9acd05 100644--- a/frontend/src/metabase/data-studio/analytics.ts+++ b/frontend/src/metabase/data-studio/analytics.ts@@ -1,4 +1,5 @@import { trackSimpleEvent } from "metabase/lib/analytics";+import type { DependencyEntitySelected } from "metabase-types/analytics";import type { CollectionId, ConcreteTableId } from "metabase-types/api";export const trackDataStudioLibraryCreated = (id: CollectionId) => {@@ -104,3 +105,37 @@ export const trackDataStudioTableFieldValuesDiscardStarted = (result,});};++export const 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,+ });+};++export const trackDependencyEntitySelected = ({+ entityId,+ eventDetail,+ triggeredFrom,+}: {+ entityId: number;+ eventDetail?: string;+ triggeredFrom: DependencyEntitySelected["triggered_from"];+}) => {+ trackSimpleEvent({+ event: "dependency_entity_selected",+ triggered_from: triggeredFrom,+ event_detail: eventDetail,+ target_id: entityId,+ });+};diff --git a/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx b/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsxindex 8288267afcc..296fe49a11e 100644--- a/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx+++ b/frontend/src/metabase/data-studio/data-model/components/TableSection/TableSection.tsx@@ -8,6 +8,7 @@ import {} from "metabase/api";import { EmptyState } from "metabase/common/components/EmptyState";import { ForwardRefLink } from "metabase/common/components/Link";+import { trackDependencyEntitySelected } from "metabase/data-studio/analytics";import { useDispatch, useSelector } from "metabase/lib/redux";import * as Urls from "metabase/lib/urls";import type { DataStudioTableMetadataTab } from "metabase/lib/urls/data-studio";@@ -36,7 +37,12 @@ import {Tabs,Tooltip,} from "metabase/ui";-import type { FieldId, Table, TableFieldOrder } from "metabase-types/api";+import {+ type FieldId,+ type Table,+ type TableFieldOrder,+ isConcreteTableId,+} from "metabase-types/api";import S from "./TableSection.module.css";import { MeasureList } from "./components/MeasureList";@@ -206,6 +212,16 @@ const TableSectionBase = ({setModalType(undefined);};+ const registerDependencyGraphTrackingEvent = () => {+ if (isConcreteTableId(table.id)) {+ trackDependencyEntitySelected({+ entityId: table.id,+ triggeredFrom: "data-structure",+ eventDetail: "table",+ });+ }+ };+return (<Stack data-testid="table-section" gap="md" pb="xl"><Box className={S.header}>@@ -255,6 +271,8 @@ const TableSectionBase = ({width: 40,}}aria-label={t`Dependency graph`}+ onClickCapture={registerDependencyGraphTrackingEvent}+ onAuxClick={registerDependencyGraphTrackingEvent}/></Tooltip>)}diff --git a/frontend/src/metabase/transforms/analytics.ts b/frontend/src/metabase/transforms/analytics.tsindex c17f1a4d281..05dc916a554 100644--- a/frontend/src/metabase/transforms/analytics.ts+++ b/frontend/src/metabase/transforms/analytics.ts@@ -62,20 +62,3 @@ export function trackTransformRunTagsUpdated({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/RunListPage/RunSidebar/SidebarHeader/SidebarHeader.tsx b/frontend/src/metabase/transforms/pages/RunListPage/RunSidebar/SidebarHeader/SidebarHeader.tsxindex e00121e69c2..7898f5a9112 100644--- a/frontend/src/metabase/transforms/pages/RunListPage/RunSidebar/SidebarHeader/SidebarHeader.tsx+++ b/frontend/src/metabase/transforms/pages/RunListPage/RunSidebar/SidebarHeader/SidebarHeader.tsx@@ -3,6 +3,7 @@ import { t } from "ttag";import { ForwardRefLink } from "metabase/common/components/Link";import CS from "metabase/css/core/index.css";+import { trackDependencyEntitySelected } from "metabase/data-studio/analytics";import * as Urls from "metabase/lib/urls";import { PLUGIN_DEPENDENCIES } from "metabase/plugins";import { ActionIcon, Anchor, FixedSizeIcon, Group, Tooltip } from "metabase/ui";@@ -22,6 +23,13 @@ type SidebarHeaderProps = {export function SidebarHeader({ run, onClose }: SidebarHeaderProps) {const transform = run.transform;const label = getTransformRunName(run);+ const registerTrackingEvent = () => {+ trackDependencyEntitySelected({+ entityId: run.id,+ triggeredFrom: "transform-run-list",+ eventDetail: "transform-run",+ });+ };return (<Group@@ -70,6 +78,8 @@ export function SidebarHeader({ run, onClose }: SidebarHeaderProps) {})}target="_blank"aria-label={t`View in dependency graph`}+ onClickCapture={registerTrackingEvent}+ onAuxClick={registerTrackingEvent}><FixedSizeIcon name="dependencies" /></ActionIcon>