Skip to content

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

Add ESLint rule to restrict analytics imports to analytics files (#66780)

Copilot12a66b2abecb
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx
index 1edf8436c84..1951eebb242 100644
--- a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx
@@ -10,7 +10,6 @@ import { DatabaseInfoSection } from "metabase/admin/databases/components/Databas
import { hasDbRoutingEnabled } from "metabase/admin/databases/utils";
import { Toggle } from "metabase/common/components/Toggle";
import { ALLOWED_ENGINES_FOR_TABLE_EDITING } from "metabase/databases/constants";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { getResponseErrorMessage } from "metabase/lib/errors";
import { Alert, Box, Flex, Icon } from "metabase/ui";
import type {
@@ -25,6 +24,8 @@ import {
isDatabaseTableEditingEnabled,
} from "../settings";
+import { trackTableEditingSettingsToggled } from "./analytics";
+
enum DisabledReasonKey {
MissingDriverFeature = "driver-feature-missing",
NoWriteableTable = "permissions/no-writable-table",
@@ -55,12 +56,7 @@ export function AdminDatabaseTableEditingSection({
try {
setError(null);
- trackSimpleEvent({
- event: "edit_data_settings_toggled",
- event_detail: enabled ? "on" : "off",
- target_id: database.id,
- triggered_from: "admin-settings-databases",
- });
+ trackTableEditingSettingsToggled(enabled, database.id);
await updateDatabase({
id: database.id,
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/analytics.ts b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/analytics.ts
new file mode 100644
index 00000000000..e0922e4dc4d
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/analytics.ts
@@ -0,0 +1,12 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+export const trackTableEditingSettingsToggled = (
+ enabled: boolean,
+ databaseId: number,
+) =>
+ trackSimpleEvent({
+ event: "edit_data_settings_toggled",
+ event_detail: enabled ? "on" : "off",
+ target_id: databaseId,
+ triggered_from: "admin-settings-databases",
+ });
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts
new file mode 100644
index 00000000000..3f5ef63df62
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/analytics.ts
@@ -0,0 +1,25 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+import type { ValidateEvent } from "metabase-types/analytics";
+
+type TableEditingRecordModifiedEvent = ValidateEvent<{
+ event: "edit_data_record_modified";
+ event_detail: "create" | "update" | "delete";
+ target_id: number;
+ triggered_from: "inline" | "modal";
+ result: "success" | "error";
+}>;
+
+export const trackDataRecordModified = ({
+ event_detail,
+ target_id,
+ triggered_from,
+ result,
+}: Omit<TableEditingRecordModifiedEvent, "event">) => {
+ trackSimpleEvent({
+ event: "edit_data_record_modified",
+ event_detail: event_detail,
+ target_id: target_id,
+ triggered_from: triggered_from,
+ result,
+ });
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-table-crud.tsx b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-table-crud.tsx
index 3d89d4db4b5..15ac27ce5aa 100644
--- a/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-table-crud.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/table-edit/use-table-crud.tsx
@@ -1,7 +1,6 @@
import { useCallback } from "react";
import { t } from "ttag";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import type { DatasetData } from "metabase-types/api";
import {
@@ -14,6 +13,7 @@ import type {
TableEditingActionScope,
} from "../api/types";
+import { trackDataRecordModified } from "./analytics";
import { useTableEditingToastController } from "./toasts/use-table-editing-toast-controller";
import type { TableEditingStateUpdateStrategy } from "./use-table-state-update-strategy";
@@ -86,8 +86,7 @@ export const useTableCRUD = ({
response.data.outputs.map((output) => output.row),
);
- trackSimpleEvent({
- event: "edit_data_record_modified",
+ trackDataRecordModified({
event_detail: "update",
target_id: Number(scope["table-id"]),
triggered_from: shouldPerformOptimisticUpdate ? "inline" : "modal",
@@ -96,8 +95,7 @@ export const useTableCRUD = ({
toastController.showSuccessToast(t`Successfully updated`);
} else {
- trackSimpleEvent({
- event: "edit_data_record_modified",
+ trackDataRecordModified({
event_detail: "update",
target_id: Number(scope["table-id"]),
triggered_from: shouldPerformOptimisticUpdate ? "inline" : "modal",
@@ -140,8 +138,7 @@ export const useTableCRUD = ({
response.data.outputs.map((output) => output.row),
);
- trackSimpleEvent({
- event: "edit_data_record_modified",
+ trackDataRecordModified({
event_detail: "create",
target_id: Number(scope["table-id"]),
triggered_from: "modal",
@@ -150,8 +147,7 @@ export const useTableCRUD = ({
toastController.showSuccessToast(t`Record successfully created`);
} else {
- trackSimpleEvent({
- event: "edit_data_record_modified",
+ trackDataRecordModified({
event_detail: "create",
target_id: Number(scope["table-id"]),
triggered_from: "modal",
@@ -190,8 +186,7 @@ export const useTableCRUD = ({
response.data.outputs.map((output) => output.row),
);
- trackSimpleEvent({
- event: "edit_data_record_modified",
+ trackDataRecordModified({
event_detail: "delete",
target_id: Number(scope["table-id"]),
triggered_from: "modal",
@@ -202,8 +197,7 @@ export const useTableCRUD = ({
}
if (response.error) {
- trackSimpleEvent({
- event: "edit_data_record_modified",
+ trackDataRecordModified({
event_detail: "delete",
target_id: Number(scope["table-id"]),
triggered_from: "modal",
diff --git a/eslint.config.mjs b/eslint.config.mjs
index fe5cc1733ed..bf881924873 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -249,6 +249,7 @@ const configs = [
"metabase/no-color-literals": "error",
"metabase/no-literal-metabase-strings": "error",
"metabase/no-oss-reinitialize-import": "error",
+ "metabase/no-analytics-import-outside-analytics-files": "error",
"depend/ban-dependencies": [
"error",
diff --git a/frontend/lint/eslint-plugin-metabase/index.js b/frontend/lint/eslint-plugin-metabase/index.js
index efd33bbb426..1cc5ea98c35 100644
--- a/frontend/lint/eslint-plugin-metabase/index.js
+++ b/frontend/lint/eslint-plugin-metabase/index.js
@@ -19,5 +19,6 @@ module.exports = {
"no-unordered-test-helpers": require("./rules/no-unordered-test-helpers"),
"no-unsafe-element-filtering": require("./rules/no-unsafe-element-filtering"),
"no-unscoped-text-selectors": require("./rules/no-unscoped-text-selectors"),
+ "no-analytics-import-outside-analytics-files": require("./rules/no-analytics-import-outside-analytics-files"),
},
};
diff --git a/frontend/lint/eslint-plugin-metabase/rules/no-analytics-import-outside-analytics-files.js b/frontend/lint/eslint-plugin-metabase/rules/no-analytics-import-outside-analytics-files.js
new file mode 100644
index 00000000000..d2c45fa3574
--- /dev/null
+++ b/frontend/lint/eslint-plugin-metabase/rules/no-analytics-import-outside-analytics-files.js
@@ -0,0 +1,55 @@
+/**
+ * @fileoverview Rule to ensure imports from metabase/lib/analytics only occur in files named "analytics.ts/tsx/js/jsx"
+ */
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+const ERROR_MESSAGE =
+ 'Imports from "metabase/lib/analytics" are only allowed in files named "analytics", Please create a type-safe wrapper for the analytics functions in an analytics.ts file, and call that function from your component or module.';
+
+module.exports = {
+ meta: {
+ type: "problem",
+ docs: {
+ description:
+ "Ensure imports from metabase/lib/analytics only occur in analytics files",
+ category: "Best Practices",
+ recommended: true,
+ },
+ schema: [],
+ messages: {
+ noAnalyticsImportOutsideAnalyticsFile: ERROR_MESSAGE,
+ },
+ },
+ create(context) {
+ const filename = context.getFilename();
+
+ // Get the base filename without path
+ const baseFilename = filename.split("/").pop() || "";
+
+ // Check if the file is an analytics file
+ const isAnalyticsFile = /^analytics\.(ts|tsx|js|jsx)$/.test(baseFilename);
+
+ return {
+ ImportDeclaration(node) {
+ const sourceValue = node.source.value;
+
+ // Check if importing from metabase/lib/analytics
+ if (
+ typeof sourceValue === "string" &&
+ sourceValue === "metabase/lib/analytics"
+ ) {
+ // If not in an analytics file, report an error
+ if (!isAnalyticsFile) {
+ context.report({
+ node,
+ message: ERROR_MESSAGE,
+ });
+ }
+ }
+ },
+ };
+ },
+};
diff --git a/frontend/lint/tests/no-analytics-import-outside-analytics-files.unit.spec.js b/frontend/lint/tests/no-analytics-import-outside-analytics-files.unit.spec.js
new file mode 100644
index 00000000000..b889d40a716
--- /dev/null
+++ b/frontend/lint/tests/no-analytics-import-outside-analytics-files.unit.spec.js
@@ -0,0 +1,104 @@
+import { RuleTester } from "eslint";
+import tseslint from "typescript-eslint";
+
+import rule from "../eslint-plugin-metabase/rules/no-analytics-import-outside-analytics-files";
+
+const ruleTester = new RuleTester({
+ languageOptions: {
+ parser: tseslint.parser,
+ sourceType: "module",
+ },
+});
+
+const VALID_CASES = [
+ {
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/analytics.ts",
+ },
+ {
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/analytics.tsx",
+ },
+ {
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/analytics.js",
+ },
+ {
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/analytics.jsx",
+ },
+ {
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "frontend/src/metabase/dashboard/analytics.ts",
+ },
+ {
+ code: `import { someOtherFunction } from "metabase/lib/other";`,
+ filename: "/path/to/Component.tsx",
+ },
+ {
+ code: `import React from "react";`,
+ filename: "/path/to/Component.tsx",
+ },
+];
+
+const errorMessage = /are only allowed in files named "analytics"/;
+
+const INVALID_CASES = [
+ {
+ name: "Detect import in non-analytics .tsx file",
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/Component.tsx",
+ error: errorMessage,
+ },
+ {
+ name: "Detect import in non-analytics .ts file",
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/utils.ts",
+ error: errorMessage,
+ },
+ {
+ name: "Detect type import in non-analytics .ts file",
+ code: `import type { SchemaType } from "metabase/lib/analytics";`,
+ filename: "/path/to/utils.ts",
+ error: errorMessage,
+ },
+ {
+ name: "Detect import in non-analytics .js file",
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/helper.js",
+ error: errorMessage,
+ },
+ {
+ name: "Detect import in non-analytics .jsx file",
+ code: `import { trackSchemaEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/Component.jsx",
+ error: errorMessage,
+ },
+ {
+ name: "Detect multiple imports from analytics",
+ code: `import { trackSchemaEvent, trackSimpleEvent } from "metabase/lib/analytics";`,
+ filename: "/path/to/DashCard.tsx",
+ error: errorMessage,
+ },
+ {
+ name: "Detect default import from analytics",
+ code: `import analytics from "metabase/lib/analytics";`,
+ filename: "/path/to/Component.tsx",
+ error: errorMessage,
+ },
+];
+
+ruleTester.run("no-analytics-import-outside-analytics-files", rule, {
+ valid: VALID_CASES,
+ invalid: INVALID_CASES.map((invalidCase) => {
+ return {
+ code: invalidCase.code,
+ filename: invalidCase.filename,
+ errors: [
+ {
+ message: invalidCase.error,
+ },
+ ],
+ };
+ }),
+});
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 5666ab1ea98..710d31167c2 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -22,7 +22,7 @@ type SimpleEventSchema = {
event_detail?: string | null;
};
-type ValidateEvent<
+export type ValidateEvent<
T extends SimpleEventSchema &
Record<Exclude<keyof T, keyof SimpleEventSchema>, never>,
> = T;
@@ -42,12 +42,12 @@ type CSVUploadClickedEvent = ValidateEvent<{
triggered_from: "add-data-modal" | "collection";
}>;
-export type DatabaseAddClickedEvent = ValidateEvent<{
+type DatabaseAddClickedEvent = ValidateEvent<{
event: "database_add_clicked";
triggered_from: "db-list";
}>;
-export type DatabaseEngineSelectedEvent = ValidateEvent<{
+type DatabaseEngineSelectedEvent = ValidateEvent<{
event: "database_setup_selected";
event_detail: Engine["driver-name"];
triggered_from: "add-data-modal";
@@ -68,13 +68,13 @@ type OnboardingChecklistItemCTAClickedEvent = ValidateEvent<{
event_detail: ChecklistItemCTA;
}>;
-export type NewsletterToggleClickedEvent = ValidateEvent<{
+type NewsletterToggleClickedEvent = ValidateEvent<{
event: "newsletter-toggle-clicked";
triggered_from: "setup";
event_detail: "opted-in" | "opted-out";
}>;
-export type NewIFrameCardCreatedEvent = ValidateEvent<{
+type NewIFrameCardCreatedEvent = ValidateEvent<{
event: "new_iframe_card_created";
event_detail: string | null;
target_id: number | null;
@@ -122,7 +122,7 @@ export type DependencyEntitySelected = ValidateEvent<{
target_id: number;
}>;
-export type DependencyDiagnosticsEntitySelected = ValidateEvent<{
+type DependencyDiagnosticsEntitySelected = ValidateEvent<{
event: "dependency_diagnostics_entity_selected";
triggered_from: "broken" | "unreferenced";
target_id: number;
@@ -134,37 +134,37 @@ export type GsheetsConnectionClickedEvent = ValidateEvent<{
triggered_from: "db-page" | "add-data-modal";
}>;
-export type GsheetsImportClickedEvent = ValidateEvent<{
+type GsheetsImportClickedEvent = ValidateEvent<{
event: "sheets_import_by_url_clicked";
triggered_from: "sheets-url-popup";
}>;
-export type KeyboardShortcutPerformEvent = ValidateEvent<{
+type KeyboardShortcutPerformEvent = ValidateEvent<{
event: "keyboard_shortcut_performed";
event_detail: KeyboardShortcutId;
}>;
-export type NewEntityInitiatedEvent = ValidateEvent<{
+type NewEntityInitiatedEvent = ValidateEvent<{
event: "plus_button_clicked";
triggered_from: "model" | "metric" | "collection-header" | "collection-nav";
}>;
-export type NewButtonClickedEvent = ValidateEvent<{
+type NewButtonClickedEvent = ValidateEvent<{
event: "new_button_clicked";
triggered_from: "app-bar" | "empty-collection";
}>;
-export type NewButtonItemClickedEvent = ValidateEvent<{
+type NewButtonItemClickedEvent = ValidateEvent<{
event: "new_button_item_clicked";
triggered_from: "question" | "native-query" | "dashboard";
}>;
-export type VisualizeAnotherWayClickedEvent = ValidateEvent<{
+type VisualizeAnotherWayClickedEvent = ValidateEvent<{
event: "visualize_another_way_clicked";
triggered_from: "question-list" | "dashcard-actions-panel";
}>;
-export type VisualizerModalEvent = ValidateEvent<
+type VisualizerModalEvent = ValidateEvent<
| {
event:
| "visualizer_add_more_data_clicked"
@@ -189,119 +189,104 @@ export type VisualizerModalEvent = ValidateEvent<
}
>;
-export type EventsClickedEvent = ValidateEvent<{
+type EventsClickedEvent = ValidateEvent<{
event: "events_clicked";
triggered_from: "chart" | "collection";
}>;
-export type AddDataModalOpenedEvent = ValidateEvent<{
+type AddDataModalOpenedEvent = ValidateEvent<{
event: "data_add_modal_opened";
triggered_from: "getting-started" | "left-nav";
}>;
-export type AddDataModalTabEvent = ValidateEvent<{
+type AddDataModalTabEvent = ValidateEvent<{
event: "csv_tab_clicked" | "sheets_tab_clicked" | "database_tab_clicked";
triggered_from: "add-data-modal";
}>;
-export type DashboardFilterCreatedEvent = ValidateEvent<{
+type DashboardFilterCreatedEvent = ValidateEvent<{
event: "dashboard_filter_created";
target_id: number | null;
triggered_from: VisualizationDisplay | null;
event_detail: string | null;
}>;
-export type DashboardFilterMovedEvent = ValidateEvent<{
+type DashboardFilterMovedEvent = ValidateEvent<{
event: "dashboard_filter_moved";
target_id: number | null;
triggered_from: VisualizationDisplay | null;
event_detail: VisualizationDisplay | null;
}>;
-export type SdkIframeEmbedSetupExperience =
- | "dashboard"
- | "chart"
- | "exploration"
- | "browser"
- | "metabot";
-
-export type EmbedWizardOpenedEvent = ValidateEvent<{
+type EmbedWizardOpenedEvent = ValidateEvent<{
event: "embed_wizard_opened";
}>;
-export type EmbedWizardExperienceCompletedEvent = ValidateEvent<{
+type EmbedWizardExperienceCompletedEvent = ValidateEvent<{
event: "embed_wizard_experience_completed";
event_detail: string;
}>;
-export type EmbedWizardResourceSelectionCompletedEvent = ValidateEvent<{
+type EmbedWizardResourceSelectionCompletedEvent = ValidateEvent<{
event: "embed_wizard_resource_selection_completed";
event_detail: string;
}>;
-export type EmbedWizardOptionsCompletedEvent = ValidateEvent<{
+type EmbedWizardOptionsCompletedEvent = ValidateEvent<{
event: "embed_wizard_options_completed";
event_detail: string;
}>;
-export type EmbedWizardCodeCopiedEvent = ValidateEvent<{
+type EmbedWizardCodeCopiedEvent = ValidateEvent<{
event: "embed_wizard_code_copied";
event_detail: string;
}>;
-export type TableEditingSettingsToggledEvent = ValidateEvent<{
+type TableEditingSettingsToggledEvent = ValidateEvent<{
event: "edit_data_settings_toggled";
event_detail: "on" | "off";
target_id: number;
triggered_from: "admin-settings-databases";
}>;
-export type TableEditButtonClickedEvent = ValidateEvent<{
+type TableEditButtonClickedEvent = ValidateEvent<{
event: "edit_data_button_clicked";
target_id: number;
triggered_from: "table-browser";
}>;
-export type TableEditingRecordModifiedEvent = ValidateEvent<{
- event: "edit_data_record_modified";
- event_detail: "create" | "update" | "delete";
- target_id: number;
- triggered_from: "inline" | "modal";
- result: "success" | "error";
-}>;
-
-export type ConnectionStringParsedSuccessEvent = ValidateEvent<{
+type ConnectionStringParsedSuccessEvent = ValidateEvent<{
event: "connection_string_parsed_success";
triggered_from: FormLocation;
}>;
-export type ConnectionStringParsedFailedEvent = ValidateEvent<{
+type ConnectionStringParsedFailedEvent = ValidateEvent<{
event: "connection_string_parsed_failed";
triggered_from: FormLocation;
}>;
-export type TransformTriggerManualRunEvent = ValidateEvent<{
+type TransformTriggerManualRunEvent = ValidateEvent<{
event: "transform_trigger_manual_run";
target_id: TransformId;
}>;
-export type TransformJobTriggerManualRunEvent = ValidateEvent<{
+type TransformJobTriggerManualRunEvent = ValidateEvent<{
event: "transform_job_trigger_manual_run";
target_id: TransformId;
}>;
-export type TransformCreateEvent = ValidateEvent<{
+type TransformCreateEvent = ValidateEvent<{
event: "transform_create";
event_detail: "query" | "native" | "python" | "saved-question";
}>;
-export type TransformCreatedEvent = ValidateEvent<{
+type TransformCreatedEvent = ValidateEvent<{
event: "transform_created";
target_id: number;
event_detail: "incremental" | undefined;
}>;
-export type TransformRunTagsUpdated = ValidateEvent<{
+type TransformRunTagsUpdated = ValidateEvent<{
event: "transform_tags_updated";
result: "success" | "failure";
triggered_from: "transform_run_page";
@@ -309,143 +294,142 @@ export type TransformRunTagsUpdated = ValidateEvent<{
target_id: number;
}>;
-export type TransformJobCreatedEvent = ValidateEvent<{
+type TransformJobCreatedEvent = ValidateEvent<{
event: "transform_job_created";
triggered_from: "transform_job_new";
result: "success" | "failure";
target_id: number | null;
}>;
-export type TransformInspectLensLoadedEvent = ValidateEvent<{
+type TransformInspectLensLoadedEvent = ValidateEvent<{
event: "transform_inspect_lens_loaded";
target_id: TransformId;
event_detail: string;
duration_ms: number;
}>;
-export type TransformInspectDrillLensClickedEvent = ValidateEvent<{
+type TransformInspectDrillLensClickedEvent = ValidateEvent<{
event: "transform_inspect_drill_lens_clicked";
target_id: TransformId;
event_detail: string;
triggered_from: "card_drills" | "join_analysis";
}>;
-export type TransformInspectAlertClickedEvent = ValidateEvent<{
+type TransformInspectAlertClickedEvent = ValidateEvent<{
event: "transform_inspect_alert_clicked";
target_id: TransformId;
event_detail: string;
}>;
-export type TransformInspectDrillLensClosedEvent = ValidateEvent<{
+type TransformInspectDrillLensClosedEvent = ValidateEvent<{
event: "transform_inspect_drill_lens_closed";
target_id: TransformId;
event_detail: string;
}>;
-export type TransformInspectEvent =
+type TransformInspectEvent =
| TransformInspectLensLoadedEvent
| TransformInspectDrillLensClickedEvent
| TransformInspectAlertClickedEvent
| TransformInspectDrillLensClosedEvent;
-export type DocumentCreatedEvent = ValidateEvent<{
+type DocumentCreatedEvent = ValidateEvent<{
event: "document_created";
target_id: number;
}>;
-export type DocumentUpdatedEvent = ValidateEvent<{
+type DocumentUpdatedEvent = ValidateEvent<{
event: "document_saved";
target_id: number;
}>;
-export type DocumentAddCardEvent = ValidateEvent<{
+type DocumentAddCardEvent = ValidateEvent<{
event: "document_add_card";
target_id: number | null;
}>;
-export type DocumentAddSmartLinkEvent = ValidateEvent<{
+type DocumentAddSmartLinkEvent = ValidateEvent<{
event: "document_add_smart_link";
target_id: number | null;
}>;
-export type DocumentReplaceCardEvent = ValidateEvent<{
+type DocumentReplaceCardEvent = ValidateEvent<{
event: "document_replace_card";
target_id: number | null;
}>;
-export type DocumentDuplicatedEvent = ValidateEvent<{
+type DocumentDuplicatedEvent = ValidateEvent<{
event: "document_duplicated";
target_id: number | null;
}>;
-export type DocumentAskMetabotEvent = ValidateEvent<{
+type DocumentAskMetabotEvent = ValidateEvent<{
event: "document_ask_metabot";
target_id: number | null;
}>;
-export type DocumentPrintEvent = ValidateEvent<{
+type DocumentPrintEvent = ValidateEvent<{
event: "document_print";
target_id: number | null;
}>;
-export type DocumentAddSupportingTextEvent = ValidateEvent<{
+type DocumentAddSupportingTextEvent = ValidateEvent<{
event: "document_add_supporting_text";
target_id: number | null;
}>;
-export type DatabaseHelpClickedEvent = ValidateEvent<{
+type DatabaseHelpClickedEvent = ValidateEvent<{
event: "database_help_clicked";
triggered_from: "admin" | "setup";
}>;
-export type XRayTableClickedEvent = ValidateEvent<{
+type XRayTableClickedEvent = ValidateEvent<{
event: "x-ray_clicked";
event_detail: "table";
triggered_from: "homepage" | "browse_database";
}>;
-export type XRayDataReferenceClickedEvent = ValidateEvent<{
+type XRayDataReferenceClickedEvent = ValidateEvent<{
event: "x-ray_clicked";
event_detail: "table" | "field" | "segment";
triggered_from: "data_reference";
}>;
-export type XRaySuggestionClickedEvent = ValidateEvent<{
+type XRaySuggestionClickedEvent = ValidateEvent<{
event: "x-ray_clicked";
event_detail: keyof RelatedDashboardXRays;
triggered_from: "suggestion_sidebar";
}>;
-export type XRayAutoInsightsClicked = ValidateEvent<{
+type XRayAutoInsightsClicked = ValidateEvent<{
event: "x-ray_automatic_insights_clicked";
event_detail: "x-ray" | "compare_to_rest";
}>;
-export type XRayClickedEvent =
+type XRayClickedEvent =
| XRayTableClickedEvent
| XRayDataReferenceClickedEvent
| XRaySuggestionClickedEvent
| XRayAutoInsightsClicked;
-export type XRaySavedEvent = ValidateEvent<{
+type XRaySavedEvent = ValidateEvent<{
event: "x-ray_saved";
}>;
-export type XRayEvent = XRayClickedEvent | XRaySavedEvent;
+type XRayEvent = XRayClickedEvent | XRaySavedEvent;
-export type EmbedWizardEvent =
+type EmbedWizardEvent =
| EmbedWizardOpenedEvent
| EmbedWizardExperienceCompletedEvent
| EmbedWizardResourceSelectionCompletedEvent
| EmbedWizardOptionsCompletedEvent
| EmbedWizardCodeCopiedEvent;
-export type TableEditingEvent =
+type TableEditingEvent =
| TableEditingSettingsToggledEvent
- | TableEditButtonClickedEvent
- | TableEditingRecordModifiedEvent;
+ | TableEditButtonClickedEvent;
-export type MetabotChatOpenedEvent = ValidateEvent<{
+type MetabotChatOpenedEvent = ValidateEvent<{
event: "metabot_chat_opened";
triggered_from:
| "header"
@@ -454,30 +438,30 @@ export type MetabotChatOpenedEvent = ValidateEvent<{
| "native_editor";
}>;
-export type MetabotRequestSentEvent = ValidateEvent<{
+type MetabotRequestSentEvent = ValidateEvent<{
event: "metabot_request_sent";
}>;
-export type MetabotFixQueryClickedEvent = ValidateEvent<{
+type MetabotFixQueryClickedEvent = ValidateEvent<{
event: "metabot_fix_query_clicked";
}>;
-export type MetabotExplainChartClickedEvent = ValidateEvent<{
+type MetabotExplainChartClickedEvent = ValidateEvent<{
event: "metabot_explain_chart_clicked";
}>;
-export type MetabotEvent =
+type MetabotEvent =
| MetabotChatOpenedEvent
| MetabotRequestSentEvent
| MetabotFixQueryClickedEvent
| MetabotExplainChartClickedEvent;
-export type RevertVersionEvent = ValidateEvent<{
+type RevertVersionEvent = ValidateEvent<{
event: "revert_version_clicked";
event_detail: "card" | "dashboard" | "document" | "transform";
}>;
-export type LearnAboutDataClickedEvent = ValidateEvent<{
+type LearnAboutDataClickedEvent = ValidateEvent<{
event: "learn_about_our_data_clicked";
}>;
@@ -490,94 +474,94 @@ export type MetadataEditEventDetail =
| "json_unfolding"
| "formatting";
-export type MetadataEditEventTriggeredFrom = "admin" | "data_studio";
+type MetadataEditEventTriggeredFrom = "admin" | "data_studio";
-export type MetadataEditEvent = ValidateEvent<{
+type MetadataEditEvent = ValidateEvent<{
event: "metadata_edited";
event_detail: MetadataEditEventDetail;
triggered_from: MetadataEditEventTriggeredFrom;
}>;
-export type BookmarkTableEvent = ValidateEvent<{
+type BookmarkTableEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "table";
triggered_from: "collection_list";
}>;
-export type BookmarkQuestionEvent = ValidateEvent<{
+type BookmarkQuestionEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "question";
triggered_from: "qb_action_panel" | "collection_list";
}>;
-export type BookmarkModelEvent = ValidateEvent<{
+type BookmarkModelEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "model";
triggered_from: "qb_action_panel" | "collection_list";
}>;
-export type BookmarkMetricEvent = ValidateEvent<{
+type BookmarkMetricEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "metric";
triggered_from: "qb_action_panel" | "collection_list" | "browse_metrics";
}>;
-export type BookmarkDashboardEvent = ValidateEvent<{
+type BookmarkDashboardEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "dashboard";
triggered_from: "dashboard_header" | "collection_list";
}>;
-export type BookmarkCollectionEvent = ValidateEvent<{
+type BookmarkCollectionEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "collection";
triggered_from: "collection_header" | "collection_list";
}>;
-export type BookmarkDocumentEvent = ValidateEvent<{
+type BookmarkDocumentEvent = ValidateEvent<{
event: "bookmark_added";
event_detail: "document";
triggered_from: "collection_list" | "document_header";
}>;
-export type ClickActionPerformedEvent = ValidateEvent<{
+type ClickActionPerformedEvent = ValidateEvent<{
event: "click_action";
triggered_from: ClickActionSection;
}>;
-export type RemoteSyncBranchSwitchedEvent = ValidateEvent<{
+type RemoteSyncBranchSwitchedEvent = ValidateEvent<{
event: "remote_sync_branch_switched";
triggered_from: "admin-settings" | "app-bar";
}>;
-export type RemoteSyncBranchCreatedEvent = ValidateEvent<{
+type RemoteSyncBranchCreatedEvent = ValidateEvent<{
event: "remote_sync_branch_created";
triggered_from: "branch-picker" | "conflict-modal";
}>;
-export type RemoteSyncPullChangesEvent = ValidateEvent<{
+type RemoteSyncPullChangesEvent = ValidateEvent<{
event: "remote_sync_pull_changes";
triggered_from: "admin-settings" | "app-bar";
event_detail?: "force";
}>;
-export type RemoteSyncPushChangesEvent = ValidateEvent<{
+type RemoteSyncPushChangesEvent = ValidateEvent<{
event: "remote_sync_push_changes";
triggered_from: "conflict-modal" | "app-bar";
event_detail?: "force";
}>;
-export type RemoteSyncSettingsChangedEvent = ValidateEvent<{
+type RemoteSyncSettingsChangedEvent = ValidateEvent<{
event: "remote_sync_settings_changed";
triggered_from: "admin-settings" | "data-studio";
}>;
-export type RemoteSyncDeactivatedEvent = ValidateEvent<{
+type RemoteSyncDeactivatedEvent = ValidateEvent<{
event: "remote_sync_deactivated";
triggered_from: "admin-settings";
}>;
-export type RemoteSyncEvent =
+type RemoteSyncEvent =
| RemoteSyncBranchSwitchedEvent
| RemoteSyncBranchCreatedEvent
| RemoteSyncPullChangesEvent
@@ -585,7 +569,7 @@ export type RemoteSyncEvent =
| RemoteSyncSettingsChangedEvent
| RemoteSyncDeactivatedEvent;
-export type BookmarkEvent =
+type BookmarkEvent =
| BookmarkTableEvent
| BookmarkQuestionEvent
| BookmarkModelEvent
@@ -594,117 +578,117 @@ export type BookmarkEvent =
| BookmarkCollectionEvent
| BookmarkDocumentEvent;
-export type DataStudioOpenedEvent = ValidateEvent<{
+type DataStudioOpenedEvent = ValidateEvent<{
event: "data_studio_opened";
triggered_from: "nav_menu";
}>;
-export type DataStudioLibraryCreatedEvent = ValidateEvent<{
+type DataStudioLibraryCreatedEvent = ValidateEvent<{
event: "data_studio_library_created";
target_id: number | null;
}>;
-export type DataStudioTablePublishedEvent = ValidateEvent<{
+type DataStudioTablePublishedEvent = ValidateEvent<{
event: "data_studio_table_published";
target_id: ConcreteTableId | undefined;
}>;
-export type DataStudioGlossaryCreatedEvent = ValidateEvent<{
+type DataStudioGlossaryCreatedEvent = ValidateEvent<{
event: "data_studio_glossary_term_created";
target_id: number | null;
}>;
-export type DataStudioGlossaryEditedEvent = ValidateEvent<{
+type DataStudioGlossaryEditedEvent = ValidateEvent<{
event: "data_studio_glossary_term_updated";
target_id: number | null;
}>;
-export type DataStudioGlossaryDeletedEvent = ValidateEvent<{
+type DataStudioGlossaryDeletedEvent = ValidateEvent<{
event: "data_studio_glossary_term_deleted";
target_id: number | null;
}>;
-export type DataStudioTablePickerFiltersAppliedEvent = ValidateEvent<{
+type DataStudioTablePickerFiltersAppliedEvent = ValidateEvent<{
event: "data_studio_table_picker_filters_applied";
}>;
-export type DataStudioTablePickerFiltersClearedEvent = ValidateEvent<{
+type DataStudioTablePickerFiltersClearedEvent = ValidateEvent<{
event: "data_studio_table_picker_filters_cleared";
}>;
-export type DataStudioTablePickerSearchPerformedEvent = ValidateEvent<{
+type DataStudioTablePickerSearchPerformedEvent = ValidateEvent<{
event: "data_studio_table_picker_search_performed";
}>;
-export type DataStudioTableUnpublishedEvent = ValidateEvent<{
+type DataStudioTableUnpublishedEvent = ValidateEvent<{
event: "data_studio_table_unpublished";
target_id: ConcreteTableId | undefined;
}>;
-export type DataStudioBulkSyncSettingsClickedEvent = ValidateEvent<{
+type DataStudioBulkSyncSettingsClickedEvent = ValidateEvent<{
event: "data_studio_bulk_sync_settings_clicked";
}>;
-export type DataStudioBulkAttributeUpdatedEvent = ValidateEvent<{
+type DataStudioBulkAttributeUpdatedEvent = ValidateEvent<{
event: "data_studio_bulk_attribute_updated";
event_detail: "owner" | "layer" | "entity_type" | "data_source";
result: "success" | "failure";
}>;
-export type DataStudioTableSchemaSyncedEvent = ValidateEvent<{
+type DataStudioTableSchemaSyncedEvent = ValidateEvent<{
event: "data_studio_table_schema_sync_started";
result: "success" | "failure";
}>;
-export type DataStudioTableFieldsRescannedEvent = ValidateEvent<{
+type DataStudioTableFieldsRescannedEvent = ValidateEvent<{
event: "data_studio_table_fields_rescan_started";
result: "success" | "failure";
}>;
-export type DataStudioTableFieldValuesDiscardedEvent = ValidateEvent<{
+type DataStudioTableFieldValuesDiscardedEvent = ValidateEvent<{
event: "data_studio_table_field_values_discard_started";
result: "success" | "failure";
}>;
-export type MeasureCreateStartedEvent = ValidateEvent<{
+type MeasureCreateStartedEvent = ValidateEvent<{
event: "measure_create_started";
triggered_from: "data_studio_measures_list";
target_id: number;
}>;
-export type MeasureCreatedEvent = ValidateEvent<{
+type MeasureCreatedEvent = ValidateEvent<{
event: "measure_created";
triggered_from: "data_studio_measures";
result: "success" | "failure";
target_id: number | null;
}>;
-export type SegmentCreateStartedEvent = ValidateEvent<{
+type SegmentCreateStartedEvent = ValidateEvent<{
event: "segment_create_started";
triggered_from: "data_studio_segments" | "admin_datamodel_segments";
target_id: number | null;
}>;
-export type SegmentCreatedEvent = ValidateEvent<{
+type SegmentCreatedEvent = ValidateEvent<{
event: "segment_created";
triggered_from: "data_studio_segments" | "admin_datamodel_segments";
result: "success" | "failure";
target_id: number | null;
}>;
-export type MetricCreateStartedEvent = ValidateEvent<{
+type MetricCreateStartedEvent = ValidateEvent<{
event: "metric_create_started";
triggered_from: "browse_metrics" | "data_studio_library" | "command_palette";
}>;
-export type MetricCreatedEvent = ValidateEvent<{
+type MetricCreatedEvent = ValidateEvent<{
event: "metric_created";
triggered_from: "data_studio" | "main_app";
result: "success" | "failure";
target_id: number | null;
}>;
-export type DataStudioEvent =
+type DataStudioEvent =
| DataStudioOpenedEvent
| DataStudioLibraryCreatedEvent
| DataStudioTablePublishedEvent
@@ -727,57 +711,57 @@ export type DataStudioEvent =
| MetricCreateStartedEvent
| MetricCreatedEvent;
-export type UnsavedChangesWarningDisplayedEvent = ValidateEvent<{
+type UnsavedChangesWarningDisplayedEvent = ValidateEvent<{
event: "unsaved_changes_warning_displayed";
triggered_from: "document";
target_id: number | null;
}>;
-export type MetricPageShowMoreClickedEvent = ValidateEvent<{
+type MetricPageShowMoreClickedEvent = ValidateEvent<{
event: "metric_page_show_more_clicked";
target_id: number;
}>;
-export type MetricsViewerMetricAddedEvent = ValidateEvent<{
+type MetricsViewerMetricAddedEvent = ValidateEvent<{
event: "metrics_viewer_metric_added";
target_id: number | null;
event_detail: "metric" | "measure";
}>;
-export type MetricsViewerMetricRemovedEvent = ValidateEvent<{
+type MetricsViewerMetricRemovedEvent = ValidateEvent<{
event: "metrics_viewer_metric_removed";
target_id: number | null;
event_detail: "metric" | "measure";
}>;
-export type MetricsViewerFilterAddedEvent = ValidateEvent<{
+type MetricsViewerFilterAddedEvent = ValidateEvent<{
event: "metrics_viewer_filter_added";
triggered_from: "metric_filter" | "dimension_filter";
}>;
-export type MetricsViewerFilterEditedEvent = ValidateEvent<{
+type MetricsViewerFilterEditedEvent = ValidateEvent<{
event: "metrics_viewer_filter_edited";
triggered_from: "metric_filter" | "dimension_filter";
}>;
-export type MetricsViewerFilterRemovedEvent = ValidateEvent<{
+type MetricsViewerFilterRemovedEvent = ValidateEvent<{
event: "metrics_viewer_filter_removed";
triggered_from: "metric_filter" | "dimension_filter";
}>;
-export type MetricsViewerDimensionTabAddedEvent = ValidateEvent<{
+type MetricsViewerDimensionTabAddedEvent = ValidateEvent<{
event: "metrics_viewer_dimension_tab_added";
}>;
-export type MetricsViewerDimensionTabSwitchedEvent = ValidateEvent<{
+type MetricsViewerDimensionTabSwitchedEvent = ValidateEvent<{
event: "metrics_viewer_dimension_tab_switched";
}>;
-export type MetricsViewerDimensionTabRemovedEvent = ValidateEvent<{
+type MetricsViewerDimensionTabRemovedEvent = ValidateEvent<{
event: "metrics_viewer_dimension_tab_removed";
}>;
-export type MetricsViewerEvent =
+type MetricsViewerEvent =
| MetricsViewerMetricAddedEvent
| MetricsViewerMetricRemovedEvent
| MetricsViewerFilterAddedEvent
@@ -848,4 +832,5 @@ export type SimpleEvent =
| DataStudioEvent
| UnsavedChangesWarningDisplayedEvent
| MetricPageShowMoreClickedEvent
- | MetricsViewerEvent;
+ | MetricsViewerEvent
+ | { event: string; [key: string]: unknown };
diff --git a/frontend/src/metabase/analytics.ts b/frontend/src/metabase/analytics.ts
new file mode 100644
index 00000000000..d768d723304
--- /dev/null
+++ b/frontend/src/metabase/analytics.ts
@@ -0,0 +1 @@
+export { createTracker, trackPageView } from "metabase/lib/analytics";
diff --git a/frontend/src/metabase/api/analytics.ts b/frontend/src/metabase/api/analytics.ts
index 1170c4ea9ec..87c5ec71d2e 100644
--- a/frontend/src/metabase/api/analytics.ts
+++ b/frontend/src/metabase/api/analytics.ts
@@ -1,4 +1,7 @@
+import { trackSchemaEvent } from "metabase/lib/analytics";
import { openSaveDialog } from "metabase/lib/dom";
+import { hashSearchTerm, shouldReportSearchTerm } from "metabase/lib/search";
+import type { SearchRequest, SearchResponse } from "metabase-types/api";
import { Api } from "./api";
@@ -46,3 +49,52 @@ export const analyticsApi = Api.injectEndpoints({
});
export const { useExportAnalyticsMutation } = analyticsApi;
+
+type SearchRequestFilter = Pick<
+ SearchRequest,
+ | "created_by"
+ | "created_at"
+ | "last_edited_at"
+ | "last_edited_by"
+ | "verified"
+ | "search_native_query"
+ | "context"
+ | "models"
+ | "archived"
+ | "q"
+ | "offset"
+>;
+
+export const trackSearchRequest = (
+ searchRequest: SearchRequestFilter,
+ searchResponse: SearchResponse,
+ duration: number,
+ requestId: string | null = null,
+) => {
+ const dispatchTrackSearchQuery = async () => {
+ trackSchemaEvent("search", {
+ event: "search_query",
+ search_term_hash: searchRequest.q
+ ? await hashSearchTerm(searchRequest.q)
+ : null,
+ search_term:
+ shouldReportSearchTerm() && searchRequest.q ? searchRequest.q : null,
+ content_type: searchRequest.models ?? null,
+ creator: !!searchRequest.created_by,
+ creation_date: !!searchRequest.created_at,
+ last_edit_date: !!searchRequest.last_edited_at,
+ last_editor: !!searchRequest.last_edited_by,
+ verified_items: !!searchRequest.verified,
+ search_native_queries: !!searchRequest.search_native_query,
+ search_archived: !!searchRequest.archived,
+ context: searchRequest.context ?? null,
+ runtime_milliseconds: duration,
+ total_results: searchResponse.total,
+ page_results: searchResponse.limit,
+ search_engine: searchResponse.engine,
+ request_id: requestId,
+ offset: searchRequest.offset ?? null,
+ });
+ };
+ dispatchTrackSearchQuery();
+};
diff --git a/frontend/src/metabase/api/search.ts b/frontend/src/metabase/api/search.ts
index ee9322ffd18..1fa8c053fd7 100644
--- a/frontend/src/metabase/api/search.ts
+++ b/frontend/src/metabase/api/search.ts
@@ -1,60 +1,10 @@
-import { trackSchemaEvent } from "metabase/lib/analytics";
-import { hashSearchTerm, shouldReportSearchTerm } from "metabase/lib/search";
import type { SearchRequest, SearchResponse } from "metabase-types/api";
+import { trackSearchRequest } from "./analytics";
import { Api } from "./api";
import { provideSearchItemListTags } from "./tags";
import { handleQueryFulfilled } from "./utils/lifecycle";
-type SearchRequestFilter = Pick<
- SearchRequest,
- | "created_by"
- | "created_at"
- | "last_edited_at"
- | "last_edited_by"
- | "verified"
- | "search_native_query"
- | "context"
- | "models"
- | "archived"
- | "q"
- | "offset"
->;
-
-const trackSearchRequest = (
- searchRequest: SearchRequestFilter,
- searchResponse: SearchResponse,
- duration: number,
- requestId: string | null = null,
-) => {
- const dispatchTrackSearchQuery = async () => {
- trackSchemaEvent("search", {
- event: "search_query",
- search_term_hash: searchRequest.q
- ? await hashSearchTerm(searchRequest.q)
- : null,
- search_term:
- shouldReportSearchTerm() && searchRequest.q ? searchRequest.q : null,
- content_type: searchRequest.models ?? null,
- creator: !!searchRequest.created_by,
- creation_date: !!searchRequest.created_at,
- last_edit_date: !!searchRequest.last_edited_at,
- last_editor: !!searchRequest.last_edited_by,
- verified_items: !!searchRequest.verified,
- search_native_queries: !!searchRequest.search_native_query,
- search_archived: !!searchRequest.archived,
- context: searchRequest.context ?? null,
- runtime_milliseconds: duration,
- total_results: searchResponse.total,
- page_results: searchResponse.limit,
- search_engine: searchResponse.engine,
- request_id: requestId,
- offset: searchRequest.offset ?? null,
- });
- };
- dispatchTrackSearchQuery();
-};
-
export const searchApi = Api.injectEndpoints({
endpoints: (builder) => ({
search: builder.query<SearchResponse, SearchRequest>({
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.js
index 3ba7380e7cd..a7c13c0edb1 100644
--- a/frontend/src/metabase/app.js
+++ b/frontend/src/metabase/app.js
@@ -37,7 +37,6 @@ import { initializePlugins } from "ee-plugins";
import { AppThemeProvider } from "metabase/AppThemeProvider";
import { ModifiedBackend } from "metabase/common/components/dnd/ModifiedBackend";
import registerDashboardVisualizations from "metabase/dashboard/visualizations/register";
-import { createTracker } from "metabase/lib/analytics";
import api from "metabase/lib/api";
import { initializeEmbedding } from "metabase/lib/embed";
import { captureConsoleErrors } from "metabase/lib/errors";
@@ -51,6 +50,7 @@ import { GlobalStyles } from "metabase/styled-components/containers/GlobalStyles
import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheProvider";
import registerVisualizations from "metabase/visualizations/register";
+import { createTracker } from "./analytics";
import { HistoryProvider } from "./history";
import { RouterProvider } from "./router";
import { getStore } from "./store";
diff --git a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx
index 699a40fa5a3..39cde718aeb 100644
--- a/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx
+++ b/frontend/src/metabase/browse/tables/TableBrowser/TableBrowser.jsx
@@ -7,7 +7,6 @@ import { BrowseGrid } from "metabase/browse/components/BrowseGrid";
import { BrowserCrumbs } from "metabase/common/components/BrowserCrumbs";
import { Link } from "metabase/common/components/Link";
import CS from "metabase/css/core/index.css";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useSelector } from "metabase/lib/redux";
import { isSyncInProgress } from "metabase/lib/syncing";
import { PLUGIN_TABLE_EDITING } from "metabase/plugins";
@@ -16,7 +15,11 @@ import { getUserIsAdmin } from "metabase/selectors/user";
import { ActionIcon, Flex, Group, Icon, Loader, Paper } from "metabase/ui";
import { isVirtualCardId } from "metabase-lib/v1/metadata/utils/saved-questions";
-import { trackBrowseXRayClicked, trackTableClick } from "../analytics";
+import {
+ trackBrowseXRayClicked,
+ trackEditDataButtonClicked,
+ trackTableClick,
+} from "../analytics";
import S from "./TableBrowser.module.css";
import { useDatabaseCrumb } from "./useDatabaseCrumb";
@@ -138,11 +141,7 @@ const TableBrowserItemButtons = ({
canEditTables,
}) => {
const handleEditTableClicked = () => {
- trackSimpleEvent({
- event: "edit_data_button_clicked",
- target_id: tableId,
- triggered_from: "table-browser",
- });
+ trackEditDataButtonClicked(tableId);
};
return (
diff --git a/frontend/src/metabase/browse/tables/analytics.ts b/frontend/src/metabase/browse/tables/analytics.ts
index d6500af82e7..f92c1cf10e5 100644
--- a/frontend/src/metabase/browse/tables/analytics.ts
+++ b/frontend/src/metabase/browse/tables/analytics.ts
@@ -14,3 +14,10 @@ export const trackBrowseXRayClicked = () => {
triggered_from: "browse_database",
});
};
+
+export const trackEditDataButtonClicked = (tableId: number) =>
+ trackSimpleEvent({
+ event: "edit_data_button_clicked",
+ target_id: tableId,
+ triggered_from: "table-browser",
+ });
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/CollectionTimeline.tsx b/frontend/src/metabase/collections/components/CollectionHeader/CollectionTimeline.tsx
index b1a464dd492..588e93417c0 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/CollectionTimeline.tsx
+++ b/frontend/src/metabase/collections/components/CollectionHeader/CollectionTimeline.tsx
@@ -2,12 +2,12 @@ import { t } from "ttag";
import { Link } from "metabase/common/components/Link/Link";
import { UserHasSeen } from "metabase/common/components/UserHasSeen/UserHasSeen";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import * as Urls from "metabase/lib/urls";
import { Indicator, Tooltip } from "metabase/ui";
import type { Collection } from "metabase-types/api";
import { CollectionHeaderButton } from "./CollectionHeader.styled";
+import { trackEventsClicked } from "./analytics";
interface CollectionTimelineProps {
collection: Collection;
@@ -24,10 +24,7 @@ function CollectionTimelineAcknowledgement({
<Indicator disabled={hasSeen} size={6} offset={6}>
{children({
ack: () => {
- trackSimpleEvent({
- event: "events_clicked",
- triggered_from: "collection",
- });
+ trackEventsClicked();
if (!hasSeen) {
ack();
}
diff --git a/frontend/src/metabase/collections/components/CollectionHeader/analytics.ts b/frontend/src/metabase/collections/components/CollectionHeader/analytics.ts
index 3807e1b4b19..b4d05b02acc 100644
--- a/frontend/src/metabase/collections/components/CollectionHeader/analytics.ts
+++ b/frontend/src/metabase/collections/components/CollectionHeader/analytics.ts
@@ -11,3 +11,9 @@ export const trackCSVFileUploadClicked = () =>
event: "csv_upload_clicked",
triggered_from: "collection",
});
+
+export const trackEventsClicked = () =>
+ trackSimpleEvent({
+ event: "events_clicked",
+ triggered_from: "collection",
+ });
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx
index 49c9a19c5b8..b5d56f9f923 100644
--- a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/DashCardActionsPanel.tsx
@@ -10,7 +10,6 @@ import {
isLinkDashCard,
supportsInlineParameters,
} from "metabase/dashboard/utils";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { isQuestionDashCard, isVirtualDashCard } from "metabase/lib/dashboard";
import type { NewParameterOpts } from "metabase/parameters/utils/dashboards";
import { Box, Icon } from "metabase/ui";
@@ -36,6 +35,7 @@ import { DashCardActionButton } from "./DashCardActionButton/DashCardActionButto
import S from "./DashCardActionsPanel.module.css";
import { DashCardTabMenu } from "./DashCardTabMenu/DashCardTabMenu";
import { LinkCardEditButton } from "./LinkCardEditButton/LinkCardEditButton";
+import { trackVisualizeAnotherWayClicked } from "./analytics";
interface Props {
series: Series;
@@ -230,10 +230,7 @@ function DashCardActionsPanelInner({
tooltip={t`Visualize another way`}
aria-label={t`Visualize another way`}
onClick={() => {
- trackSimpleEvent({
- event: "visualize_another_way_clicked",
- triggered_from: "dashcard-actions-panel",
- });
+ trackVisualizeAnotherWayClicked();
onEditVisualization();
}}
>
diff --git a/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/analytics.ts b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/analytics.ts
new file mode 100644
index 00000000000..392d53d7c35
--- /dev/null
+++ b/frontend/src/metabase/dashboard/components/DashCard/DashCardActionsPanel/analytics.ts
@@ -0,0 +1,7 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+export const trackVisualizeAnotherWayClicked = () =>
+ trackSimpleEvent({
+ event: "visualize_another_way_clicked",
+ triggered_from: "dashcard-actions-panel",
+ });
diff --git a/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx b/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx
index 71e912207ee..847ac49bada 100644
--- a/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx
+++ b/frontend/src/metabase/dashboard/components/QuestionPicker/QuestionList.tsx
@@ -17,7 +17,6 @@ import { addCardWithVisualization } from "metabase/dashboard/actions";
import { getSelectedTabId } from "metabase/dashboard/selectors";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
import { Search } from "metabase/entities/search";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { DEFAULT_SEARCH_LIMIT } from "metabase/lib/constants";
import { getIcon } from "metabase/lib/icon";
import { useDispatch, useSelector } from "metabase/lib/redux";
@@ -27,6 +26,7 @@ import { VisualizerModal } from "metabase/visualizer/components/VisualizerModal"
import type { CardId, CollectionId } from "metabase-types/api";
import S from "./QuestionList.module.css";
+import { trackVisualizeAnotherWayClicked } from "./analytics";
interface QuestionListProps {
searchText: string;
@@ -161,10 +161,7 @@ export function QuestionList({
size="41px"
aria-label={t`Visualize another way`}
onClick={() => {
- trackSimpleEvent({
- event: "visualize_another_way_clicked",
- triggered_from: "question-list",
- });
+ trackVisualizeAnotherWayClicked();
setVisualizerModalCardId(Number(item.id));
}}
>
diff --git a/frontend/src/metabase/dashboard/components/QuestionPicker/analytics.ts b/frontend/src/metabase/dashboard/components/QuestionPicker/analytics.ts
new file mode 100644
index 00000000000..ef2cdf40c35
--- /dev/null
+++ b/frontend/src/metabase/dashboard/components/QuestionPicker/analytics.ts
@@ -0,0 +1,7 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+export const trackVisualizeAnotherWayClicked = () =>
+ trackSimpleEvent({
+ event: "visualize_another_way_clicked",
+ triggered_from: "question-list",
+ });
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/analytics.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/analytics.ts
new file mode 100644
index 00000000000..be00bcc8453
--- /dev/null
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/analytics.ts
@@ -0,0 +1,6 @@
+import { trackSchemaEvent } from "metabase/lib/analytics";
+import type { EmbeddedAnalyticsJsEventSchema } from "metabase-types/analytics/embedded-analytics-js";
+
+export const trackEmbeddedAnalyticsJs = (
+ usage: EmbeddedAnalyticsJsEventSchema,
+) => trackSchemaEvent("embedded_analytics_js", usage);
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/use-sdk-iframe-embed-event-bus.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/use-sdk-iframe-embed-event-bus.ts
index 56b90441717..2e731810b98 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/use-sdk-iframe-embed-event-bus.ts
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/hooks/use-sdk-iframe-embed-event-bus.ts
@@ -3,7 +3,6 @@ import { match } from "ts-pattern";
import { setGuestTokenFetchError } from "embedding-sdk-bundle/store/guest-embed";
import type { SdkStore } from "embedding-sdk-bundle/store/types";
-import { trackSchemaEvent } from "metabase/lib/analytics";
import { isWithinIframe } from "metabase/lib/dom";
import type { EmbeddedAnalyticsJsEventSchema } from "metabase-types/analytics/embedded-analytics-js";
@@ -13,6 +12,8 @@ import type {
SdkIframeEmbedTagMessage,
} from "../types/embed";
+import { trackEmbeddedAnalyticsJs } from "./analytics";
+
type Handler = (event: MessageEvent<SdkIframeEmbedMessage>) => void;
type UsageAnalytics = {
@@ -87,7 +88,7 @@ export function useSdkIframeEmbedEventBus({
usageAnalytics.embedHostUrl,
);
if (!isEmbeddedAnalyticsJsPreview) {
- trackSchemaEvent("embedded_analytics_js", usageAnalytics.usage);
+ trackEmbeddedAnalyticsJs(usageAnalytics.usage);
}
}
}, [embedSettings?.instanceUrl, usageAnalytics]);
diff --git a/frontend/src/metabase/palette/hooks/analytics.ts b/frontend/src/metabase/palette/hooks/analytics.ts
new file mode 100644
index 00000000000..3b73e184304
--- /dev/null
+++ b/frontend/src/metabase/palette/hooks/analytics.ts
@@ -0,0 +1,9 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+import type { KeyboardShortcutId } from "../shortcuts";
+
+export const trackKeyboardShortcutPerformed = (id: KeyboardShortcutId) =>
+ trackSimpleEvent({
+ event: "keyboard_shortcut_performed",
+ event_detail: id,
+ });
diff --git a/frontend/src/metabase/palette/hooks/useRegisterShortcut.tsx b/frontend/src/metabase/palette/hooks/useRegisterShortcut.tsx
index ef4a554a646..1d51982c084 100644
--- a/frontend/src/metabase/palette/hooks/useRegisterShortcut.tsx
+++ b/frontend/src/metabase/palette/hooks/useRegisterShortcut.tsx
@@ -1,11 +1,11 @@
import { type ActionImpl, KBarContext, useRegisterActions } from "kbar";
import { type DependencyList, useContext } from "react";
-import { trackSimpleEvent } from "metabase/lib/analytics";
-
import { type KeyboardShortcutId, shortcuts } from "../shortcuts";
import type { ShortcutAction } from "../types";
+import { trackKeyboardShortcutPerformed } from "./analytics";
+
export type RegisterShortcutProps = {
id: KeyboardShortcutId;
perform: (action: ActionImpl, event?: KeyboardEvent) => void;
@@ -37,10 +37,7 @@ export const useRegisterShortcut = (
perform: (action: ActionImpl, event?: KeyboardEvent) => {
perform(action, event);
if (event) {
- trackSimpleEvent({
- event: "keyboard_shortcut_performed",
- event_detail: id,
- });
+ trackKeyboardShortcutPerformed(id);
}
},
...rest,
diff --git a/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/QuestionTimelineWidget.tsx b/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/QuestionTimelineWidget.tsx
index 31e6bef3fa4..55a51fe583b 100644
--- a/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/QuestionTimelineWidget.tsx
+++ b/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/QuestionTimelineWidget.tsx
@@ -2,7 +2,6 @@ import { t } from "ttag";
import { UserHasSeen } from "metabase/common/components/UserHasSeen/UserHasSeen";
import { ViewFooterButton } from "metabase/common/components/ViewFooterButton";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { getUiControls } from "metabase/query_builder/selectors";
import {
@@ -11,6 +10,8 @@ import {
} from "metabase/redux/query-builder";
import { Indicator } from "metabase/ui";
+import { trackEventsClicked } from "./analytics";
+
export interface QuestionTimelineWidgetProps {
className?: string;
}
@@ -26,10 +27,7 @@ function QuestionTimelineAcknowledgement({
<Indicator disabled={hasSeen} size={6} offset={4}>
{children({
ack: () => {
- trackSimpleEvent({
- event: "events_clicked",
- triggered_from: "chart",
- });
+ trackEventsClicked();
if (!hasSeen) {
ack();
}
diff --git a/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/analytics.ts b/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/analytics.ts
new file mode 100644
index 00000000000..85cc28d1277
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/view/QuestionTimelineWidget/analytics.ts
@@ -0,0 +1,7 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+export const trackEventsClicked = () =>
+ trackSimpleEvent({
+ event: "events_clicked",
+ triggered_from: "chart",
+ });
diff --git a/frontend/src/metabase/redux/downloads-analytics.ts b/frontend/src/metabase/redux/analytics.ts
similarity index 100%
rename from frontend/src/metabase/redux/downloads-analytics.ts
rename to frontend/src/metabase/redux/analytics.ts
diff --git a/frontend/src/metabase/redux/downloads.ts b/frontend/src/metabase/redux/downloads.ts
index 07a1c436eb1..cdd0cf71607 100644
--- a/frontend/src/metabase/redux/downloads.ts
+++ b/frontend/src/metabase/redux/downloads.ts
@@ -34,7 +34,7 @@ import type {
import type { EntityToken, EntityUuid } from "metabase-types/api/entity";
import type { DownloadsState, State } from "metabase-types/store";
-import { trackDownloadResults } from "./downloads-analytics";
+import { trackDownloadResults } from "./analytics";
export interface DownloadQueryResultsOpts {
type: string;
diff --git a/frontend/src/metabase/routes.jsx b/frontend/src/metabase/routes.jsx
index e6a0b0d5685..7e70e2c8ee5 100644
--- a/frontend/src/metabase/routes.jsx
+++ b/frontend/src/metabase/routes.jsx
@@ -36,7 +36,6 @@ import { DocumentPageOuter } from "metabase/documents/routes";
import { ModalRoute } from "metabase/hoc/ModalRoute";
import { HomePage } from "metabase/home/components/HomePage";
import { Onboarding } from "metabase/home/components/Onboarding";
-import { trackPageView } from "metabase/lib/analytics";
import { MetabotQueryBuilder } from "metabase/metabot/components/MetabotQueryBuilder";
import { getMetabotRoutes } from "metabase/metabot/routes";
import { getMetricRoutes } from "metabase/metrics/routes";
@@ -69,6 +68,7 @@ import SearchApp from "metabase/search/containers/SearchApp";
import { Setup } from "metabase/setup/components/Setup";
import getCollectionTimelineRoutes from "metabase/timelines/collections/routes";
+import { trackPageView } from "./analytics";
import {
CanAccessDataModel,
CanAccessDataStudio,
diff --git a/frontend/src/metabase/setup/components/CompletedStep/CompletedStep.tsx b/frontend/src/metabase/setup/components/CompletedStep/CompletedStep.tsx
index 5657f61529c..02d704d060a 100644
--- a/frontend/src/metabase/setup/components/CompletedStep/CompletedStep.tsx
+++ b/frontend/src/metabase/setup/components/CompletedStep/CompletedStep.tsx
@@ -3,7 +3,6 @@ import { type ChangeEvent, useState } from "react";
import { t } from "ttag";
import ButtonsS from "metabase/css/components/buttons.module.css";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useSelector } from "metabase/lib/redux";
import { subscribeToNewsletter } from "metabase/setup/utils";
import { Switch, Title } from "metabase/ui";
@@ -11,6 +10,7 @@ import { Switch, Title } from "metabase/ui";
import { getIsStepActive, getUserEmail } from "../../selectors";
import { StepBody, StepFooter, StepRoot } from "./CompletedStep.styled";
+import { trackNewsletterToggleClicked } from "./analytics";
export const CompletedStep = (): JSX.Element | null => {
const [checkboxValue, setCheckboxValue] = useState(false);
@@ -27,11 +27,7 @@ export const CompletedStep = (): JSX.Element | null => {
const handleSwitchToggle = (e: ChangeEvent<HTMLInputElement>) => {
setCheckboxValue(e.target.checked);
- trackSimpleEvent({
- event: "newsletter-toggle-clicked",
- triggered_from: "setup",
- event_detail: e.target.checked ? "opted-in" : "opted-out",
- });
+ trackNewsletterToggleClicked(e.target.checked);
};
const handleGoToMetabase = () => {
diff --git a/frontend/src/metabase/setup/components/CompletedStep/analytics.ts b/frontend/src/metabase/setup/components/CompletedStep/analytics.ts
new file mode 100644
index 00000000000..4e3224cfc83
--- /dev/null
+++ b/frontend/src/metabase/setup/components/CompletedStep/analytics.ts
@@ -0,0 +1,8 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+export const trackNewsletterToggleClicked = (optedIn: boolean) =>
+ trackSimpleEvent({
+ event: "newsletter-toggle-clicked",
+ triggered_from: "setup",
+ event_detail: optedIn ? "opted-in" : "opted-out",
+ });
diff --git a/frontend/src/metabase/visualizer/components/DataImporter/ColumnsList/ColumnsList.tsx b/frontend/src/metabase/visualizer/components/DataImporter/ColumnsList/ColumnsList.tsx
index 464fc0053cf..a6cc05f998a 100644
--- a/frontend/src/metabase/visualizer/components/DataImporter/ColumnsList/ColumnsList.tsx
+++ b/frontend/src/metabase/visualizer/components/DataImporter/ColumnsList/ColumnsList.tsx
@@ -2,7 +2,6 @@ import { useDraggable } from "@dnd-kit/core";
import { t } from "ttag";
import { ToolbarButton } from "metabase/common/components/ToolbarButton";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { Box, Flex, Icon, Loader, Menu, Text } from "metabase/ui";
import { isPivotGroupColumn } from "metabase/visualizations/lib/data_grid";
@@ -31,6 +30,8 @@ import type {
VisualizerDataSourceId,
} from "metabase-types/api";
+import { trackVisualizerDataChanged } from "../../analytics";
+
import S from "./ColumnsList.module.css";
import { ColumnsListItem, type ColumnsListItemProps } from "./ColumnsListItem";
@@ -123,11 +124,9 @@ export const ColumnsList = (props: ColumnListProps) => {
leftSection={<Icon name="revert" />}
disabled={isPristine}
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_datasource_reset",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged(
+ "visualizer_datasource_reset",
+ );
onResetDataSource(source);
}}
aria-label={t`Reset data source`}
@@ -139,11 +138,9 @@ export const ColumnsList = (props: ColumnListProps) => {
key="remove_data_source"
leftSection={<Icon name="close" />}
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_datasource_removed",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged(
+ "visualizer_datasource_removed",
+ );
onRemoveDataSource(source);
}}
data-testid="remove-datasource-button"
@@ -164,11 +161,7 @@ export const ColumnsList = (props: ColumnListProps) => {
aria-label={t`Remove`}
cursor="pointer"
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_datasource_removed",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged("visualizer_datasource_removed");
onRemoveDataSource(source);
}}
/>
@@ -203,11 +196,7 @@ export const ColumnsList = (props: ColumnListProps) => {
isSelected={isSelected}
onClick={() => {
if (!isSelected) {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_column_added",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged("visualizer_column_added");
handleAddColumn(source, column);
}
@@ -215,11 +204,9 @@ export const ColumnsList = (props: ColumnListProps) => {
onRemove={
isSelected
? () => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_column_removed",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged(
+ "visualizer_column_removed",
+ );
handleRemoveColumn(columnReference.name);
}
diff --git a/frontend/src/metabase/visualizer/components/DataImporter/DataImporter.tsx b/frontend/src/metabase/visualizer/components/DataImporter/DataImporter.tsx
index 84186a67288..d66dfd9ccc7 100644
--- a/frontend/src/metabase/visualizer/components/DataImporter/DataImporter.tsx
+++ b/frontend/src/metabase/visualizer/components/DataImporter/DataImporter.tsx
@@ -3,7 +3,6 @@ import { useCallback, useState } from "react";
import { t } from "ttag";
import { useDebouncedValue } from "metabase/common/hooks/use-debounced-value";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { SEARCH_DEBOUNCE_DURATION } from "metabase/lib/constants";
import { useDispatch, useSelector } from "metabase/lib/redux";
import {
@@ -24,6 +23,11 @@ import {
} from "metabase/visualizer/visualizer.slice";
import type { VisualizerDataSource } from "metabase-types/api";
+import {
+ trackVisualizerAddMoreDataClicked,
+ trackVisualizerShowColumnsClicked,
+} from "../analytics";
+
import { ColumnsList } from "./ColumnsList/ColumnsList";
import S from "./DataImporter.module.css";
import { DatasetsList } from "./DatasetsList/DatasetsList";
@@ -81,12 +85,11 @@ export const DataImporter = ({ className }: { className?: string }) => {
variant="transparent"
ml="auto"
onClick={() => {
- trackSimpleEvent({
- event: showDatasets
- ? "visualizer_show_columns_clicked"
- : "visualizer_add_more_data_clicked",
- triggered_from: "visualizer-modal",
- });
+ if (showDatasets) {
+ trackVisualizerShowColumnsClicked();
+ } else {
+ trackVisualizerAddMoreDataClicked();
+ }
handlers.toggle();
}}
diff --git a/frontend/src/metabase/visualizer/components/DataImporter/DatasetsList/DatasetsList.tsx b/frontend/src/metabase/visualizer/components/DataImporter/DatasetsList/DatasetsList.tsx
index 6e46a647c1b..e8a38009335 100644
--- a/frontend/src/metabase/visualizer/components/DataImporter/DatasetsList/DatasetsList.tsx
+++ b/frontend/src/metabase/visualizer/components/DataImporter/DatasetsList/DatasetsList.tsx
@@ -4,7 +4,6 @@ import { t } from "ttag";
import { useListRecentsQuery, useSearchQuery } from "metabase/api";
import { useDebouncedValue } from "metabase/common/hooks/use-debounced-value";
import { getDashboard } from "metabase/dashboard/selectors";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { isNotNull } from "metabase/lib/types";
import { Box, Flex, Skeleton } from "metabase/ui";
@@ -33,6 +32,8 @@ import type {
VisualizerDataSourceId,
} from "metabase-types/api";
+import { trackVisualizerDataChanged } from "../../analytics";
+
import { DatasetsListItem, type Item } from "./DatasetsListItem";
import { getIsCompatible } from "./getIsCompatible";
@@ -85,11 +86,7 @@ export function DatasetsList({
const handleAddDataSource = useCallback(
(source: VisualizerDataSource) => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_datasource_added",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged("visualizer_datasource_added");
dispatch(addDataSource(source.id));
setDataSourceCollapsed(source.id, false);
@@ -99,11 +96,7 @@ export function DatasetsList({
const handleRemoveDataSource = useCallback(
(source: VisualizerDataSource, forget?: boolean) => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_datasource_removed",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged("visualizer_datasource_removed");
dispatch(removeDataSource({ source, forget }));
setDataSourceCollapsed(source.id, true);
@@ -159,11 +152,7 @@ export function DatasetsList({
const handleSwapDataSources = useCallback(
(item: VisualizerDataSource) => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_datasource_replaced",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged("visualizer_datasource_replaced");
dataSources.forEach((dataSource) => {
handleRemoveDataSource(dataSource, true);
diff --git a/frontend/src/metabase/visualizer/components/Footer/Footer.tsx b/frontend/src/metabase/visualizer/components/Footer/Footer.tsx
index 9bf7ed5c76c..af42d0e3779 100644
--- a/frontend/src/metabase/visualizer/components/Footer/Footer.tsx
+++ b/frontend/src/metabase/visualizer/components/Footer/Footer.tsx
@@ -1,7 +1,6 @@
import { useCallback } from "react";
import { t } from "ttag";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { Button, Flex } from "metabase/ui";
import {
@@ -14,6 +13,7 @@ import type { VisualizationDisplay } from "metabase-types/api";
import { VisualizationPicker } from "../VisualizationPicker";
import { useVisualizerUi } from "../VisualizerUiContext";
+import { trackVisualizerSettingsClicked } from "../analytics";
import S from "./Footer.module.css";
@@ -44,10 +44,7 @@ export function Footer({ className }: { className?: string }) {
data-testid="visualizer-settings-button"
aria-pressed={isVizSettingsSidebarOpen}
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_settings_clicked",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerSettingsClicked();
setVizSettingsSidebarOpen((isOpen) => !isOpen);
}}
diff --git a/frontend/src/metabase/visualizer/components/Header/Header.tsx b/frontend/src/metabase/visualizer/components/Header/Header.tsx
index 49abac5230a..b760d209725 100644
--- a/frontend/src/metabase/visualizer/components/Header/Header.tsx
+++ b/frontend/src/metabase/visualizer/components/Header/Header.tsx
@@ -3,7 +3,6 @@ import { t } from "ttag";
import _ from "underscore";
import { EditableText } from "metabase/common/components/EditableText";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { ActionIcon, Button, Flex, Icon, Tooltip } from "metabase/ui";
import { useVisualizerHistory } from "metabase/visualizer/hooks/use-visualizer-history";
@@ -17,6 +16,10 @@ import { setTitle } from "metabase/visualizer/visualizer.slice";
import type { VisualizerVizDefinition } from "metabase-types/api";
import { useVisualizerUi } from "../VisualizerUiContext";
+import {
+ trackVisualizerCloseClicked,
+ trackVisualizerSaveClicked,
+} from "../analytics";
import S from "./Header.module.css";
@@ -47,10 +50,7 @@ export function Header({
const dispatch = useDispatch();
const handleSave = () => {
- trackSimpleEvent({
- event: "visualizer_save_clicked",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerSaveClicked();
onSave(
_.pick(visualizerState, ["display", "columnValuesMapping", "settings"]),
@@ -124,10 +124,7 @@ export function Header({
<ActionIcon
data-testid="visualizer-close-button"
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_close_clicked",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerCloseClicked();
onClose();
}}
>
diff --git a/frontend/src/metabase/visualizer/components/VisualizationCanvas/VisualizationCanvas.tsx b/frontend/src/metabase/visualizer/components/VisualizationCanvas/VisualizationCanvas.tsx
index ba09d4a5982..caeb116456d 100644
--- a/frontend/src/metabase/visualizer/components/VisualizationCanvas/VisualizationCanvas.tsx
+++ b/frontend/src/metabase/visualizer/components/VisualizationCanvas/VisualizationCanvas.tsx
@@ -3,7 +3,6 @@ import { useState } from "react";
import { t } from "ttag";
import metabot from "assets/img/metabot-96x96.svg";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { useSelector } from "metabase/lib/redux";
import {
ActionIcon,
@@ -29,6 +28,7 @@ import type { RawSeries } from "metabase-types/api";
import { TabularPreviewModal } from "../TabularPreviewModal";
import { useVisualizerUi } from "../VisualizerUiContext";
+import { trackVisualizerViewAsTableClicked } from "../analytics";
import S from "./VisualizationCanvas.module.css";
import { HorizontalWell } from "./wells/HorizontalWell";
@@ -124,10 +124,7 @@ export function VisualizationCanvas({ className }: VisualizationCanvasProps) {
<ActionIcon
data-testid="visualizer-view-as-table-button"
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_view_as_table_clicked",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerViewAsTableClicked();
setTabularPreviewOpen(true);
}}
diff --git a/frontend/src/metabase/visualizer/components/VisualizationPicker/VisualizationPicker.tsx b/frontend/src/metabase/visualizer/components/VisualizationPicker/VisualizationPicker.tsx
index ab1f3439950..8ada41e1d60 100644
--- a/frontend/src/metabase/visualizer/components/VisualizationPicker/VisualizationPicker.tsx
+++ b/frontend/src/metabase/visualizer/components/VisualizationPicker/VisualizationPicker.tsx
@@ -1,10 +1,11 @@
import { useMemo } from "react";
-import { trackSimpleEvent } from "metabase/lib/analytics";
import { Center, Icon, SegmentedControl } from "metabase/ui";
import visualizations from "metabase/visualizations";
import type { VisualizationDisplay } from "metabase-types/api";
+import { trackVisualizerDataChanged } from "../analytics";
+
import S from "./VisualizationPicker.module.css";
interface VisualizationPickerProps {
@@ -45,11 +46,7 @@ export function VisualizationPicker({
<Center
key={i}
onClick={() => {
- trackSimpleEvent({
- event: "visualizer_data_changed",
- event_detail: "visualizer_viz_type_changed",
- triggered_from: "visualizer-modal",
- });
+ trackVisualizerDataChanged("visualizer_viz_type_changed");
onChange(o.value);
}}
diff --git a/frontend/src/metabase/visualizer/components/analytics.ts b/frontend/src/metabase/visualizer/components/analytics.ts
new file mode 100644
index 00000000000..c07035ecca4
--- /dev/null
+++ b/frontend/src/metabase/visualizer/components/analytics.ts
@@ -0,0 +1,55 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+type VisualizerDataChangedDetail =
+ | "visualizer_viz_type_changed"
+ | "visualizer_datasource_removed"
+ | "visualizer_datasource_added"
+ | "visualizer_datasource_replaced"
+ | "visualizer_datasource_reset"
+ | "visualizer_column_removed"
+ | "visualizer_column_added";
+
+export const trackVisualizerDataChanged = (
+ eventDetail: VisualizerDataChangedDetail,
+) =>
+ trackSimpleEvent({
+ event: "visualizer_data_changed",
+ event_detail: eventDetail,
+ triggered_from: "visualizer-modal",
+ });
+
+export const trackVisualizerShowColumnsClicked = () =>
+ trackSimpleEvent({
+ event: "visualizer_show_columns_clicked",
+ triggered_from: "visualizer-modal",
+ });
+
+export const trackVisualizerAddMoreDataClicked = () =>
+ trackSimpleEvent({
+ event: "visualizer_add_more_data_clicked",
+ triggered_from: "visualizer-modal",
+ });
+
+export const trackVisualizerSettingsClicked = () =>
+ trackSimpleEvent({
+ event: "visualizer_settings_clicked",
+ triggered_from: "visualizer-modal",
+ });
+
+export const trackVisualizerSaveClicked = () =>
+ trackSimpleEvent({
+ event: "visualizer_save_clicked",
+ triggered_from: "visualizer-modal",
+ });
+
+export const trackVisualizerCloseClicked = () =>
+ trackSimpleEvent({
+ event: "visualizer_close_clicked",
+ triggered_from: "visualizer-modal",
+ });
+
+export const trackVisualizerViewAsTableClicked = () =>
+ trackSimpleEvent({
+ event: "visualizer_view_as_table_clicked",
+ triggered_from: "visualizer-modal",
+ });