Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

add recent graphy features analytics tracking (#74800)

Aleksandr Lesnenkoe2786c683034
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index e25444a0f9b..3d9f579643d 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -3208,7 +3208,8 @@
enterprise/replacement
{:team "Graphy"
:api #{metabase-enterprise.replacement.api}
- :uses #{api
+ :uses #{analytics
+ api
app-db
events
lib
diff --git a/enterprise/backend/src/metabase_enterprise/replacement/api.clj b/enterprise/backend/src/metabase_enterprise/replacement/api.clj
index a9b6b043d52..b6c6cd2dd96 100644
--- a/enterprise/backend/src/metabase_enterprise/replacement/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/replacement/api.clj
@@ -6,6 +6,7 @@
[metabase-enterprise.replacement.runner :as replacement.runner]
[metabase-enterprise.replacement.schema :as replacement.schema]
[metabase-enterprise.replacement.source-check :as replacement.source-check]
+ [metabase.analytics.core :as analytics]
[metabase.api.common :as api]
[metabase.api.macros :as api.macros]
[metabase.api.routes.common :refer [+auth]]
@@ -54,10 +55,19 @@
(throw (ex-info "Sources are not replaceable" {:status-code 400
:errors (:errors result)}))))
(let [work-fn (fn [progress]
- (replacement.runner/run-swap-source!
- [source_entity_type source_entity_id]
- [target_entity_type target_entity_id]
- progress))
+ (analytics/track-event! :snowplow/simple_event
+ {:event "replace_data_source_started"})
+ (try
+ (replacement.runner/run-swap-source!
+ [source_entity_type source_entity_id]
+ [target_entity_type target_entity_id]
+ progress)
+ (analytics/track-event! :snowplow/simple_event
+ {:event "replace_data_source_succeeded"})
+ (catch Throwable e
+ (analytics/track-event! :snowplow/simple_event
+ {:event "replace_data_source_failed"})
+ (throw e))))
job-row (replacement-run/create-run!
source_entity_type source_entity_id
target_entity_type target_entity_id api/*current-user-id*)
@@ -106,7 +116,20 @@
user-id)
progress (replacement-run/run-row->progress job-row)
work-fn (fn [progress]
- (replacement.runner/run-swap-model-with-transform! card_id (:id transform) progress :user-id user-id))]
+ (analytics/track-event! :snowplow/simple_event
+ {:event "model_to_transforms_migration_started"
+ :target_id card_id})
+ (try
+ (replacement.runner/run-swap-model-with-transform!
+ card_id (:id transform) progress :user-id user-id)
+ (analytics/track-event! :snowplow/simple_event
+ {:event "model_to_transforms_migration_success"
+ :target_id card_id})
+ (catch Throwable e
+ (analytics/track-event! :snowplow/simple_event
+ {:event "model_to_transforms_migration_failure"
+ :target_id card_id})
+ (throw e))))]
(replacement.execute/execute-async! work-fn progress)
(-> (response/response {:run_id (:id job-row)})
(assoc :status 202))))
diff --git a/enterprise/backend/test/metabase_enterprise/replacement/api_test.clj b/enterprise/backend/test/metabase_enterprise/replacement/api_test.clj
index e11a3ad6ba1..1330d11d375 100644
--- a/enterprise/backend/test/metabase_enterprise/replacement/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/replacement/api_test.clj
@@ -6,6 +6,7 @@
[metabase-enterprise.replacement.execute :as replacement.execute]
[metabase-enterprise.replacement.models.replacement-run :as replacement-run]
[metabase-enterprise.replacement.protocols :as replacement.protocols]
+ [metabase.analytics.snowplow-test :as snowplow-test]
[metabase.events.core :as events]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
@@ -31,6 +32,13 @@
(do (Thread/sleep (long interval-ms))
(recur)))))))
+(defn- tracked-event-names!
+ "Drain the fake Snowplow collector and return the set of `simple_event` names tracked during the run."
+ []
+ (into #{}
+ (keep #(get (:data %) "event"))
+ (snowplow-test/pop-event-data-and-user-id!)))
+
;;; ------------------------------------------------ POST /check-replace-source ------------------------------------------------
(deftest check-replace-source-success-test
@@ -259,21 +267,27 @@
(mt/with-model-cleanup [:model/ReplacementRun :model/Dependency]
(events/publish-event! :event/card-create {:object child-card :user-id (mt/user->id :crowberto)})
(deps.test/synchronously-run-backfill!)
- (let [response (mt/user-http-request :crowberto :post 202 "ee/replacement/replace-source"
- {:source_entity_id old-id
- :source_entity_type :card
- :target_entity_id new-id
- :target_entity_type :card})
- run-id (:run_id response)
- final-run (poll-run run-id)]
- (is (= "succeeded" (:status final-run))
- "Run should reach 'succeeded' status")
- (is (= 1.0 (:progress final-run))
- "Progress should be 1.0 when done")
- (is (nil? (:is_active final-run))
- "is_active should be nil when run is complete")
- (is (some? (:end_time final-run))
- "end_time should be set")))))))
+ (snowplow-test/with-fake-snowplow-collector
+ (let [response (mt/user-http-request :crowberto :post 202 "ee/replacement/replace-source"
+ {:source_entity_id old-id
+ :source_entity_type :card
+ :target_entity_id new-id
+ :target_entity_type :card})
+ run-id (:run_id response)
+ final-run (poll-run run-id)]
+ (is (= "succeeded" (:status final-run))
+ "Run should reach 'succeeded' status")
+ (is (= 1.0 (:progress final-run))
+ "Progress should be 1.0 when done")
+ (is (nil? (:is_active final-run))
+ "is_active should be nil when run is complete")
+ (is (some? (:end_time final-run))
+ "end_time should be set")
+ (testing "tracks the replace_data_source started and succeeded analytics events, not failed"
+ (let [events (tracked-event-names!)]
+ (is (contains? events "replace_data_source_started"))
+ (is (contains? events "replace_data_source_succeeded"))
+ (is (not (contains? events "replace_data_source_failed"))))))))))))
(deftest get-run-not-found-test
(testing "GET /runs/:id — returns 404 for non-existent run"
@@ -369,28 +383,34 @@
(doseq [card [model-card question-card]]
(events/publish-event! :event/card-create {:object card :user-id (mt/user->id :crowberto)}))
(deps.test/synchronously-run-backfill!)
- (let [response (mt/user-http-request :crowberto :post 202
- "ee/replacement/replace-model-with-transform"
- {:card_id model-id
- :transform_name "Orders Transform"
- :transform_target {:type "table"
- :schema schema
- :name (:name target)
- :database (mt/id)}
- :target_collection_id nil})
- run-id (:run_id response)
- final (poll-run run-id :timeout-ms 30000)]
- (is (= "succeeded" (:status final)))
- (testing "model is converted to a saved question"
- (is (= :question (t2/select-one-fn :type :model/Card :id model-id))))
- (testing "dependent question now references the output table"
- (let [question-query (t2/select-one-fn :dataset_query :model/Card :id question-id-id)
- transform (t2/select-one :model/Transform :name "Orders Transform")
- output-table (transforms/output-table transform)]
- (is (some? output-table)
- "transforms/output-table should return the output table")
- (is (= (:id output-table)
- (lib/primary-source-table-id question-query))))))))))))))
+ (snowplow-test/with-fake-snowplow-collector
+ (let [response (mt/user-http-request :crowberto :post 202
+ "ee/replacement/replace-model-with-transform"
+ {:card_id model-id
+ :transform_name "Orders Transform"
+ :transform_target {:type "table"
+ :schema schema
+ :name (:name target)
+ :database (mt/id)}
+ :target_collection_id nil})
+ run-id (:run_id response)
+ final (poll-run run-id :timeout-ms 30000)]
+ (is (= "succeeded" (:status final)))
+ (testing "model is converted to a saved question"
+ (is (= :question (t2/select-one-fn :type :model/Card :id model-id))))
+ (testing "dependent question now references the output table"
+ (let [question-query (t2/select-one-fn :dataset_query :model/Card :id question-id-id)
+ transform (t2/select-one :model/Transform :name "Orders Transform")
+ output-table (transforms/output-table transform)]
+ (is (some? output-table)
+ "transforms/output-table should return the output table")
+ (is (= (:id output-table)
+ (lib/primary-source-table-id question-query)))))
+ (testing "tracks the migration started and success analytics events, not failure"
+ (let [events (tracked-event-names!)]
+ (is (contains? events "model_to_transforms_migration_started"))
+ (is (contains? events "model_to_transforms_migration_success"))
+ (is (not (contains? events "model_to_transforms_migration_failure")))))))))))))))
(deftest replace-model-with-transform-failure-test
(testing "POST /replace-model-with-transform — transform execution failure leaves model unchanged"
@@ -403,22 +423,28 @@
:name "Model"}]
(mt/with-model-cleanup [:model/ReplacementRun :model/Transform]
(with-redefs [transforms/execute! (fn [_ _] (throw (ex-info "Simulated transform failure" {})))]
- (let [response (mt/user-http-request :crowberto :post 202
- "ee/replacement/replace-model-with-transform"
- {:card_id model-id
- :transform_name "Failing Transform"
- :transform_target {:type "table"
- :schema "PUBLIC"
- :name "fail_transform"
- :database (mt/id)}})
- run-id (:run_id response)
- final (poll-run run-id)]
- (testing "run reaches failed status"
- (is (= "failed" (:status final))))
- (testing "error message is captured"
- (is (some? (:message final))))
- (testing "model is NOT converted to a question"
- (is (= :model (t2/select-one-fn :type :model/Card :id model-id))))))))))))
+ (snowplow-test/with-fake-snowplow-collector
+ (let [response (mt/user-http-request :crowberto :post 202
+ "ee/replacement/replace-model-with-transform"
+ {:card_id model-id
+ :transform_name "Failing Transform"
+ :transform_target {:type "table"
+ :schema "PUBLIC"
+ :name "fail_transform"
+ :database (mt/id)}})
+ run-id (:run_id response)
+ final (poll-run run-id)]
+ (testing "run reaches failed status"
+ (is (= "failed" (:status final))))
+ (testing "error message is captured"
+ (is (some? (:message final))))
+ (testing "model is NOT converted to a question"
+ (is (= :model (t2/select-one-fn :type :model/Card :id model-id))))
+ (testing "tracks the migration started and failure analytics events, not success"
+ (let [events (tracked-event-names!)]
+ (is (contains? events "model_to_transforms_migration_started"))
+ (is (contains? events "model_to_transforms_migration_failure"))
+ (is (not (contains? events "model_to_transforms_migration_success"))))))))))))))
(deftest all-endpoints-require-superuser-test
(testing "All /ee/replacement/ endpoints return 403 for non-admin users"
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphInfoPanel/PanelHeader/PanelHeader.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphInfoPanel/PanelHeader/PanelHeader.tsx
index 9cf15ffef2f..49072724e5c 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphInfoPanel/PanelHeader/PanelHeader.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphInfoPanel/PanelHeader/PanelHeader.tsx
@@ -80,6 +80,7 @@ export function PanelHeader({ node, onClose }: PanelHeaderProps) {
<PLUGIN_REPLACEMENT.SourceReplacementModal
opened={isReplaceModalOpened}
initialSource={sourceEntry}
+ triggeredFrom="dependency_graph"
onClose={closeReplaceModal}
/>
)}
diff --git a/enterprise/frontend/src/metabase-enterprise/replacement/analytics.ts b/enterprise/frontend/src/metabase-enterprise/replacement/analytics.ts
new file mode 100644
index 00000000000..c7bbcc7d5ab
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/replacement/analytics.ts
@@ -0,0 +1,25 @@
+import { trackSimpleEvent } from "metabase/analytics";
+import type { SourceReplacementTriggeredFrom } from "metabase/plugins";
+import type { CardId } from "metabase-types/api";
+
+export function trackModelToTransformsMigrationModalOpened({
+ cardId,
+}: {
+ cardId: CardId;
+}) {
+ trackSimpleEvent({
+ event: "model_to_transforms_migration_modal_opened",
+ target_id: cardId,
+ });
+}
+
+export function trackReplaceDataSourceConfirmed({
+ triggeredFrom,
+}: {
+ triggeredFrom: SourceReplacementTriggeredFrom;
+}) {
+ trackSimpleEvent({
+ event: "replace_data_source_confirmed",
+ triggered_from: triggeredFrom,
+ });
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/replacement/components/SourceReplacementModal/SourceReplacementModal.tsx b/enterprise/frontend/src/metabase-enterprise/replacement/components/SourceReplacementModal/SourceReplacementModal.tsx
index 8a5c28dc60e..53db0cf7dd8 100644
--- a/enterprise/frontend/src/metabase-enterprise/replacement/components/SourceReplacementModal/SourceReplacementModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/replacement/components/SourceReplacementModal/SourceReplacementModal.tsx
@@ -3,7 +3,10 @@ import { t } from "ttag";
import { useGetCardQuery, useGetTableQuery } from "metabase/api";
import { useConfirmation } from "metabase/common/hooks/use-confirmation";
-import type { SourceReplacementModalProps } from "metabase/plugins";
+import type {
+ SourceReplacementModalProps,
+ SourceReplacementTriggeredFrom,
+} from "metabase/plugins";
import { Flex, Modal } from "metabase/ui";
import {
useCheckReplaceSourceQuery,
@@ -12,6 +15,8 @@ import {
import { useReplaceSourceMutation } from "metabase-enterprise/api/replacement";
import type { SourceReplacementEntry } from "metabase-types/api";
+import { trackReplaceDataSourceConfirmed } from "../../analytics";
+
import { ModalBody } from "./ModalBody";
import { ModalSidebar } from "./ModalSidebar";
import type { TabType } from "./types";
@@ -29,6 +34,7 @@ import {
export function SourceReplacementModal({
initialSource,
initialTarget,
+ triggeredFrom,
opened,
onClose,
}: SourceReplacementModalProps) {
@@ -39,6 +45,7 @@ export function SourceReplacementModal({
<ModalContent
initialSource={initialSource}
initialTarget={initialTarget}
+ triggeredFrom={triggeredFrom}
onClose={onClose}
/>
</Modal.Content>
@@ -49,12 +56,14 @@ export function SourceReplacementModal({
type ModalContentProps = {
initialSource: SourceReplacementEntry | undefined;
initialTarget: SourceReplacementEntry | undefined;
+ triggeredFrom: SourceReplacementTriggeredFrom;
onClose: () => void;
};
function ModalContent({
initialSource,
initialTarget,
+ triggeredFrom,
onClose,
}: ModalContentProps) {
const [sourceEntry, setSourceEntry] = useState(initialSource);
@@ -110,6 +119,7 @@ function ModalContent({
confirmButtonText: getConfirmSubmitLabel(dependents.length),
confirmButtonProps: { variant: "filled", color: "error" },
onConfirm: async () => {
+ trackReplaceDataSourceConfirmed({ triggeredFrom });
await replaceSource({
source_entity_id: sourceEntry.id,
source_entity_type: sourceEntry.type,
diff --git a/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ActionSection/ActionSection.tsx b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ActionSection/ActionSection.tsx
index c434430e0c3..7d4f6497879 100644
--- a/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ActionSection/ActionSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/replacement/pages/MigrateModelsPage/ModelSidebar/ActionSection/ActionSection.tsx
@@ -5,6 +5,7 @@ import { validateDatabase } from "metabase/transforms/utils";
import { Button, Icon, Tooltip } from "metabase/ui";
import type { Card, Database } from "metabase-types/api";
+import { trackModelToTransformsMigrationModalOpened } from "../../../../analytics";
import { SourceReplacementButton } from "../../../../components/SourceReplacementButton";
import { ReplaceWithTransformModal } from "../../ReplaceWithTransformModal";
@@ -30,7 +31,12 @@ export function ActionSection({ card, database }: ActionSectionProps) {
variant="filled"
leftSection={<Icon name="transform" />}
disabled={isButtonDisabled}
- onClick={() => setOpened(true)}
+ onClick={() => {
+ trackModelToTransformsMigrationModalOpened({
+ cardId: card.id,
+ });
+ setOpened(true);
+ }}
>
{t`Convert to a transform`}
</Button>
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/analytics.ts b/enterprise/frontend/src/metabase-enterprise/workspaces/analytics.ts
new file mode 100644
index 00000000000..7f538dc6859
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/analytics.ts
@@ -0,0 +1,54 @@
+import { trackSimpleEvent } from "metabase/analytics";
+import type { WorkspaceId } from "metabase-types/api";
+
+export function trackWorkspaceCreated({
+ workspaceId,
+}: {
+ workspaceId: WorkspaceId;
+}) {
+ trackSimpleEvent({
+ event: "workspaces_new_created",
+ target_id: workspaceId,
+ });
+}
+
+export function trackWorkspaceDatabaseAdded({
+ workspaceId,
+}: {
+ workspaceId: WorkspaceId;
+}) {
+ trackSimpleEvent({
+ event: "workspaces_database_added",
+ target_id: workspaceId,
+ });
+}
+
+export function trackWorkspaceConfigDownloaded({
+ workspaceId,
+}: {
+ workspaceId: WorkspaceId;
+}) {
+ trackSimpleEvent({
+ event: "workspaces_config_downloaded",
+ target_id: workspaceId,
+ });
+}
+
+export function trackWorkspaceSetupButtonClicked() {
+ trackSimpleEvent({
+ event: "workspaces_setup_button_clicked",
+ });
+}
+
+export function trackWorkspaceInstanceSetup() {
+ trackSimpleEvent({
+ event: "workspaces_instance_setup",
+ triggered_from: "upload",
+ });
+}
+
+export function trackWorkspaceInstanceTeardown() {
+ trackSimpleEvent({
+ event: "workspaces_instance_teardown",
+ });
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.tsx
index 28a2ec050ef..bcf91d5ff07 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.tsx
@@ -5,6 +5,8 @@ import { TitleSection } from "metabase/data-studio/common/components/TitleSectio
import { Button, Code, Group, Text } from "metabase/ui";
import { useDeleteWorkspaceInstanceMutation } from "metabase-enterprise/api";
+import { trackWorkspaceInstanceTeardown } from "../../../analytics";
+
const CONFIG_FILENAME = "config.yml";
export function DeleteSection() {
@@ -21,6 +23,7 @@ export function DeleteSection() {
confirmButtonProps: { color: "danger" },
onConfirm: async () => {
await deleteInstance().unwrap();
+ trackWorkspaceInstanceTeardown();
},
});
};
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.unit.spec.tsx
index 00b591996e9..54f99a7e602 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/DeleteSection/DeleteSection.unit.spec.tsx
@@ -7,6 +7,8 @@ import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
import { DeleteSection } from "./DeleteSection";
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
function setup() {
setupDeleteWorkspaceInstanceEndpoint();
@@ -16,6 +18,10 @@ function setup() {
}
describe("DeleteSection", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
it("calls DELETE /api/ee/workspace-instance/current after confirming", async () => {
setup();
@@ -36,4 +42,22 @@ describe("DeleteSection", () => {
).toBe(true);
});
});
+
+ it("tracks an analytics event when the instance is torn down", async () => {
+ setup();
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Leave workspace" }),
+ );
+ const dialog = await screen.findByRole("dialog");
+ await userEvent.click(
+ within(dialog).getByRole("button", { name: "Leave workspace" }),
+ );
+
+ await waitFor(() =>
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "workspaces_instance_teardown",
+ }),
+ );
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.tsx
index 99357826558..a41ae2575eb 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.tsx
@@ -22,6 +22,8 @@ import {
import * as Urls from "metabase/urls";
import { useApplyAdvancedConfigMutation } from "metabase-enterprise/api";
+import { trackWorkspaceInstanceSetup } from "../../../analytics";
+
const CONFIG_FILENAME = "config.yml";
type SetupWorkspaceModalProps = {
@@ -67,6 +69,7 @@ function SetupWorkspaceForm({ onClose }: SetupWorkspaceFormProps) {
return;
}
await applyConfig({ config }).unwrap();
+ trackWorkspaceInstanceSetup();
onClose();
dispatch(push(Urls.workspaces()));
};
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.unit.spec.tsx
new file mode 100644
index 00000000000..1a22b01a418
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/SetupWorkspaceModal/SetupWorkspaceModal.unit.spec.tsx
@@ -0,0 +1,67 @@
+import userEvent from "@testing-library/user-event";
+import { Route } from "react-router";
+
+import { setupApplyAdvancedConfigEndpoint } from "__support__/server-mocks";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+
+import { SetupWorkspaceModal } from "./SetupWorkspaceModal";
+
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
+function setup() {
+ const onClose = jest.fn();
+
+ setupApplyAdvancedConfigEndpoint();
+
+ renderWithProviders(
+ <Route
+ path="*"
+ component={() => <SetupWorkspaceModal opened onClose={onClose} />}
+ />,
+ { withRouter: true },
+ );
+
+ return { onClose };
+}
+
+async function uploadConfigAndSubmit() {
+ const submitButton = await screen.findByRole("button", { name: "Set up" });
+ const file = new File(["name: Dev workspace"], "config.yml", {
+ type: "application/yaml",
+ });
+ // Mantine's FileInput keeps the native file input hidden with no accessible
+ // handle, so query the DOM directly to drive the upload.
+ await userEvent.upload(
+ // eslint-disable-next-line testing-library/no-node-access
+ document.querySelector<HTMLInputElement>('input[type="file"]')!,
+ file,
+ );
+ await userEvent.click(submitButton);
+}
+
+describe("SetupWorkspaceModal", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
+ it("uploads the config and closes the modal", async () => {
+ const { onClose } = setup();
+
+ await uploadConfigAndSubmit();
+
+ await waitFor(() => expect(onClose).toHaveBeenCalled());
+ });
+
+ it("tracks the workspaces_instance_setup event when the config is applied", async () => {
+ setup();
+
+ await uploadConfigAndSubmit();
+
+ await waitFor(() =>
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "workspaces_instance_setup",
+ triggered_from: "upload",
+ }),
+ );
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.tsx
index 56df91589a3..c64c1ad38a6 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.tsx
@@ -4,6 +4,7 @@ import { t } from "ttag";
import { useSelector } from "metabase/redux";
import { Box, Button } from "metabase/ui";
+import { trackWorkspaceSetupButtonClicked } from "../../../analytics";
import { WorkspaceEmptyState } from "../../../components/WorkspaceEmptyState";
import { getIsDevelopmentMode } from "../../../selectors";
import { SetupWorkspaceModal } from "../SetupWorkspaceModal";
@@ -19,7 +20,13 @@ export function WorkspaceInstanceEmptyState() {
>
{isDevelopmentMode && (
<Box pb="xl">
- <Button variant="filled" onClick={open}>
+ <Button
+ variant="filled"
+ onClick={() => {
+ trackWorkspaceSetupButtonClicked();
+ open();
+ }}
+ >
{t`Set up a workspace`}
</Button>
</Box>
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.unit.spec.tsx
new file mode 100644
index 00000000000..09f9d6d59d1
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceInstancePage/WorkspaceInstanceEmptyState/WorkspaceInstanceEmptyState.unit.spec.tsx
@@ -0,0 +1,60 @@
+import userEvent from "@testing-library/user-event";
+
+import { renderWithProviders, screen } from "__support__/ui";
+import { createMockSettingsState } from "metabase/redux/store/mocks";
+import {
+ createMockSettings,
+ createMockTokenFeatures,
+} from "metabase-types/api/mocks";
+
+import { WorkspaceInstanceEmptyState } from "./WorkspaceInstanceEmptyState";
+
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
+function setup({ isDevelopmentMode = true } = {}) {
+ renderWithProviders(<WorkspaceInstanceEmptyState />, {
+ storeInitialState: {
+ settings: createMockSettingsState(
+ createMockSettings({
+ "token-features": createMockTokenFeatures({
+ development_mode: isDevelopmentMode,
+ }),
+ }),
+ ),
+ },
+ });
+}
+
+describe("WorkspaceInstanceEmptyState", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
+ it("shows the set up button in development mode", () => {
+ setup({ isDevelopmentMode: true });
+
+ expect(
+ screen.getByRole("button", { name: "Set up a workspace" }),
+ ).toBeInTheDocument();
+ });
+
+ it("hides the set up button outside of development mode", () => {
+ setup({ isDevelopmentMode: false });
+
+ expect(
+ screen.queryByRole("button", { name: "Set up a workspace" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("tracks an analytics event when the set up button is clicked", async () => {
+ setup({ isDevelopmentMode: true });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Set up a workspace" }),
+ );
+
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "workspaces_setup_button_clicked",
+ });
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.tsx
index d673f947120..914ea73725e 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.tsx
@@ -13,6 +13,8 @@ import * as Errors from "metabase/utils/errors";
import { useCreateWorkspaceMutation } from "metabase-enterprise/api";
import type { Workspace } from "metabase-types/api";
+import { trackWorkspaceCreated } from "../../../analytics";
+
type NewWorkspaceModalProps = {
opened: boolean;
onCreate: (workspace: Workspace) => void;
@@ -58,6 +60,7 @@ function NewWorkspaceForm({ onCreate, onClose }: NewWorkspaceFormProps) {
const handleSubmit = async ({ name }: NewWorkspaceFormValues) => {
const workspace = await createWorkspace({ name }).unwrap();
+ trackWorkspaceCreated({ workspaceId: workspace.id });
onCreate(workspace);
};
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.unit.spec.tsx
index b7d4dedaae6..6f93d1b4aa9 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspaceListPage/NewWorkspaceModal/NewWorkspaceModal.unit.spec.tsx
@@ -7,6 +7,8 @@ import { createMockWorkspace } from "metabase-types/api/mocks";
import { NewWorkspaceModal } from "./NewWorkspaceModal";
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
type SetupOpts = {
createdWorkspace?: Workspace;
};
@@ -27,6 +29,10 @@ function setup({
}
describe("NewWorkspaceModal", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
it("can create a workspace", async () => {
const { onCreate, createdWorkspace } = setup();
@@ -37,4 +43,18 @@ describe("NewWorkspaceModal", () => {
expect(onCreate).toHaveBeenCalledWith(createdWorkspace),
);
});
+
+ it("tracks an analytics event when a workspace is created", async () => {
+ const { createdWorkspace } = setup();
+
+ await userEvent.type(screen.getByLabelText("Name"), "Brand new workspace");
+ await userEvent.click(screen.getByRole("button", { name: "Create" }));
+
+ await waitFor(() =>
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "workspaces_new_created",
+ target_id: createdWorkspace.id,
+ }),
+ );
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.tsx
index 643ca5dc3bd..15346d2c1e0 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.tsx
@@ -23,6 +23,7 @@ import * as Errors from "metabase/utils/errors";
import { useCreateWorkspaceDatabaseMutation } from "metabase-enterprise/api";
import type { Database, DatabaseId, Workspace } from "metabase-types/api";
+import { trackWorkspaceDatabaseAdded } from "../../../../analytics";
import { supportsWorkspaces } from "../../../../utils";
import { SchemaMultiSelect } from "../SchemaMultiSelect";
@@ -119,6 +120,7 @@ function NewDatabaseForm({
database_id: values.database_id,
input_schemas: values.input_schemas,
}).unwrap();
+ trackWorkspaceDatabaseAdded({ workspaceId: workspace.id });
onCreate(updated);
};
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx
index ca2cb2b7619..acad5292eca 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx
@@ -16,6 +16,8 @@ import {
import { NewDatabaseModal } from "./NewDatabaseModal";
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
const POSTGRES_DATABASE = createMockDatabase({
id: 10,
name: "Postgres",
@@ -76,6 +78,10 @@ function setup({
}
describe("NewDatabaseModal", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
it("can create a workspace database", async () => {
const { onCreate, createdWorkspace } = setup();
@@ -90,6 +96,22 @@ describe("NewDatabaseModal", () => {
);
});
+ it("tracks an analytics event when a database is added", async () => {
+ const { workspace } = setup();
+
+ await userEvent.click(
+ await screen.findByRole("checkbox", { name: "public" }),
+ );
+ await userEvent.click(screen.getByRole("button", { name: "Add database" }));
+
+ await waitFor(() =>
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "workspaces_database_added",
+ target_id: workspace.id,
+ }),
+ );
+ });
+
it("renders a single database as text without a select", () => {
setup({ availableDatabases: [POSTGRES_DATABASE] });
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.tsx
index 034bb3267bf..07497721f65 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.tsx
@@ -4,6 +4,8 @@ import { TitleSection } from "metabase/data-studio/common/components/TitleSectio
import { Button, Code, FixedSizeIcon, Group, Text, Tooltip } from "metabase/ui";
import type { Workspace } from "metabase-types/api";
+import { trackWorkspaceConfigDownloaded } from "../../../analytics";
+
const CONFIG_FILENAME = "config.yml";
export type SetupSectionProps = {
@@ -35,6 +37,9 @@ export function SetupSection({ workspace }: SetupSectionProps) {
component="a"
href={`/api/ee/workspace-manager/${workspace.id}/config`}
download={CONFIG_FILENAME}
+ onClick={() =>
+ trackWorkspaceConfigDownloaded({ workspaceId: workspace.id })
+ }
leftSection={<FixedSizeIcon name="download" aria-hidden />}
>
{t`Download ${CONFIG_FILENAME}`}
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.unit.spec.tsx
index 0857a39035c..f1665490e30 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/SetupSection/SetupSection.unit.spec.tsx
@@ -8,11 +8,17 @@ import {
import { SetupSection } from "./SetupSection";
+const { trackSimpleEvent } = jest.requireMock("metabase/analytics");
+
function setup({ workspace = createMockWorkspace() } = {}) {
renderWithProviders(<SetupSection workspace={workspace} />);
}
describe("SetupSection", () => {
+ beforeEach(() => {
+ trackSimpleEvent.mockClear();
+ });
+
it("renders an enabled download link when the workspace has databases", () => {
const workspace = createMockWorkspace({
databases: [createMockWorkspaceDatabase()],
@@ -27,6 +33,22 @@ describe("SetupSection", () => {
);
});
+ it("tracks an analytics event when the config is downloaded", async () => {
+ const workspace = createMockWorkspace({
+ databases: [createMockWorkspaceDatabase()],
+ });
+ setup({ workspace });
+
+ await userEvent.click(
+ screen.getByRole("link", { name: /Download config\.yml/ }),
+ );
+
+ expect(trackSimpleEvent).toHaveBeenCalledWith({
+ event: "workspaces_config_downloaded",
+ target_id: workspace.id,
+ });
+ });
+
it("disables the download button and shows a tooltip when the workspace has no databases", async () => {
setup({ workspace: createMockWorkspace({ databases: [] }) });
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.tsx
index ca4f0dc4060..06a607d5730 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
@@ -444,6 +444,7 @@ const TableSectionBase = ({
<PLUGIN_REPLACEMENT.SourceReplacementModal
opened={modalType === "replace"}
initialSource={{ id: Number(table.id), type: "table" }}
+ triggeredFrom="table_list"
onClose={handleCloseModal}
/>
</Stack>
diff --git a/frontend/src/metabase/plugins/index.ts b/frontend/src/metabase/plugins/index.ts
index 0e4c2d0fd33..980c9d6d159 100644
--- a/frontend/src/metabase/plugins/index.ts
+++ b/frontend/src/metabase/plugins/index.ts
@@ -111,6 +111,7 @@ export {
type SourceReplacementButtonChildProps,
type SourceReplacementButtonProps,
type SourceReplacementModalProps,
+ type SourceReplacementTriggeredFrom,
} from "./oss/replacement";
export { PLUGIN_RESOURCE_DOWNLOADS } from "./oss/resource-downloads";
export {
diff --git a/frontend/src/metabase/plugins/oss/replacement.ts b/frontend/src/metabase/plugins/oss/replacement.ts
index a90ae46e44a..06bddf0e04a 100644
--- a/frontend/src/metabase/plugins/oss/replacement.ts
+++ b/frontend/src/metabase/plugins/oss/replacement.ts
@@ -5,9 +5,12 @@ import type { SourceReplacementEntry } from "metabase-types/api";
import { PluginPlaceholder } from "../components/PluginPlaceholder";
+export type SourceReplacementTriggeredFrom = "table_list" | "dependency_graph";
+
export type SourceReplacementModalProps = {
initialSource?: SourceReplacementEntry;
initialTarget?: SourceReplacementEntry;
+ triggeredFrom: SourceReplacementTriggeredFrom;
opened: boolean;
onClose: () => void;
};