The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Improve modular embedding analytics (#70449)
Mahatthana (Kelvin) Nomsawadib22ab2010d36
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/sdk-iframe-embedding.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/sdk-iframe-embedding.cy.spec.tsindex 7f3b6dfe957..09d9febc993 100644--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/sdk-iframe-embedding.cy.spec.ts+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/sdk-iframe-embedding.cy.spec.ts@@ -591,59 +591,223 @@ describe("scenarios > embedding > modular embedding", () => {event: "setup",global: {auth_method: "sso",+ locale_used: false,},- dashboard: {- with_title: {- false: 0,- true: 1,- },- with_downloads: {- false: 1,- true: 0,- },- drills: {- false: 0,- true: 1,- },- with_subscriptions: {- false: 0,- true: 1,- },- },- question: {- drills: {- false: 0,- true: 1,+ components: [+ {+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_subscriptions",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "auto_refresh_interval",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],},- with_downloads: {- false: 1,- true: 0,+ {+ name: "question",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_alerts",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],},- with_title: {- false: 0,- true: 1,+ {+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new_native",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ ],},- is_save_enabled: {- false: 1,- true: 0,+ {+ name: "browser",+ properties: [+ {+ name: "read_only",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],},- with_alerts: {- false: 1,- true: 0,+ ],+ });+ });++ it("should send locale_used=true when locale is configured", () => {+ cy.signOut();+ cy.visit("http://localhost:4000");+ const frame = H.loadSdkIframeEmbedTestPage({+ origin: "http://different-than-metabase-instance.com",+ elements: [+ {+ component: "metabase-dashboard",+ attributes: {+ dashboardId: ORDERS_DASHBOARD_ID,+ },},+ ],+ metabaseConfig: {+ locale: "de",},- exploration: {- is_save_enabled: {- false: 1,- true: 0,- },+ selector: `[dashboard-id="${ORDERS_DASHBOARD_ID}"] > iframe`,+ });++ frame.within(() => {+ cy.findByText("Orders in a dashboard").should("be.visible");+ });++ H.expectUnstructuredSnowplowEvent({+ event: "setup",+ global: {+ auth_method: "sso",+ locale_used: true,},- browser: {- read_only: {- false: 0,- true: 1,+ components: [+ {+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_subscriptions",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "auto_refresh_interval",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],},- },+ ],});});@@ -663,7 +827,9 @@ describe("scenarios > embedding > modular embedding", () => {event: "setup",global: {auth_method: "session",+ locale_used: false,},+ components: [],},// Expect that the usage event shouldn't be sent0,diff --git a/frontend/src/metabase-types/analytics/embedded-analytics-js.ts b/frontend/src/metabase-types/analytics/embedded-analytics-js.tsindex 7403b1fb6f2..375888109fc 100644--- a/frontend/src/metabase-types/analytics/embedded-analytics-js.ts+++ b/frontend/src/metabase-types/analytics/embedded-analytics-js.ts@@ -1,27 +1,26 @@+// V3-0-0 Schema Typesexport type EmbeddedAnalyticsJsEventSchema = {event: EVENTS;global: {auth_method: AUTH_TYPES;+ locale_used: boolean;};- dashboard?: {- drills: BOOLEAN_COUNT;- with_downloads: BOOLEAN_COUNT;- with_title: BOOLEAN_COUNT;- with_subscriptions: BOOLEAN_COUNT;- };- question?: {- drills: BOOLEAN_COUNT;- with_downloads: BOOLEAN_COUNT;- with_title: BOOLEAN_COUNT;- is_save_enabled: BOOLEAN_COUNT;- with_alerts: BOOLEAN_COUNT;- };- exploration?: {- is_save_enabled: BOOLEAN_COUNT;- };- browser?: {- read_only: BOOLEAN_COUNT;- };+ components: ComponentData[];+};++type ComponentData = {+ name: "dashboard" | "question" | "exploration" | "browser" | "metabot";+ properties: ComponentProperty[];+};++type ComponentProperty = {+ name: string;+ values: PropertyValue[];+};++export type PropertyValue = {+ group: string; // "true", "false", "auto", "sidebar", "stacked", etc.+ value: number; // count};/**@@ -34,28 +33,33 @@ type EVENTS = "setup";*/export type AUTH_TYPES = "session" | "api_key" | "sso" | "guest";-type BOOLEAN_COUNT = {- true: number;- false: number;-};-export type DefaultValues = {- dashboard: Record<- keyof NonNullable<EmbeddedAnalyticsJsEventSchema["dashboard"]>,- boolean- >;- question: Record<- keyof NonNullable<EmbeddedAnalyticsJsEventSchema["question"]>,- boolean- >;- exploration: Record<- keyof NonNullable<EmbeddedAnalyticsJsEventSchema["exploration"]>,- boolean- >;- browser: Record<- keyof NonNullable<EmbeddedAnalyticsJsEventSchema["browser"]>,- boolean- >;+ dashboard: {+ drills: boolean;+ withDownloads: boolean;+ withTitle: boolean;+ withSubscriptions: boolean;+ autoRefreshInterval: boolean;+ enableEntityNavigation: boolean;+ };+ question: {+ drills: boolean;+ withDownloads: boolean;+ withTitle: boolean;+ isSaveEnabled: boolean;+ withAlerts: boolean;+ };+ exploration: {+ isSaveEnabled: boolean;+ questionId: undefined;+ };+ browser: {+ readOnly: boolean;+ enableEntityNavigation: boolean;+ };+ metabot: {+ layout: "auto" | "sidebar" | "stacked";+ };};type ValidateEvent<@@ -67,26 +71,9 @@ type EmbeddedAnalyticsJsSetupEvent = ValidateEvent<{event: "setup";global: {auth_method: AUTH_TYPES;+ locale_used: boolean;};- dashboard?: {- drills: BOOLEAN_COUNT;- with_downloads: BOOLEAN_COUNT;- with_title: BOOLEAN_COUNT;- with_subscriptions: BOOLEAN_COUNT;- };- question?: {- drills: BOOLEAN_COUNT;- with_downloads: BOOLEAN_COUNT;- with_title: BOOLEAN_COUNT;- is_save_enabled: BOOLEAN_COUNT;- with_alerts: BOOLEAN_COUNT;- };- exploration?: {- is_save_enabled: BOOLEAN_COUNT;- };- browser?: {- read_only: BOOLEAN_COUNT;- };+ components: ComponentData[];}>;export type EmbeddedAnalyticsJsEvent = EmbeddedAnalyticsJsSetupEvent;diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.ts b/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.tsindex 3bb4fc67ea4..4cc4e24140f 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.ts+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.ts@@ -1,13 +1,12 @@-import { assocIn, getIn, merge, updateIn } from "icepick";+import { merge } from "icepick";import { P, match } from "ts-pattern";import _ from "underscore";-import type { FlattenObjectKeys } from "metabase/embedding-sdk/types/utils";import type {AUTH_TYPES,DefaultValues,- EmbeddedAnalyticsJsEvent,EmbeddedAnalyticsJsEventSchema,+ PropertyValue,} from "metabase-types/analytics/embedded-analytics-js";import type { MetabaseEmbedElement } from "./embed";@@ -17,34 +16,57 @@ const DEFAULT_VALUES: DefaultValues = {/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx#L188} */drills: true,/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx#L160} */- with_downloads: false,+ withDownloads: false,/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx#L159} */- with_title: true,+ withTitle: true,/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx#L161} */- with_subscriptions: false,+ withSubscriptions: false,+ /**+ * @see {@link https://github.com/metabase/metabase/blob/c8b1767e66352738553211dea3d7b1addc81da27/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx#L125}+ * Since this is optional, the default value is undefined.+ *+ * Unused, but documented for completeness.+ */+ autoRefreshInterval: false,+ /** @see {@link https://github.com/metabase/metabase/blob/c8b1767e66352738553211dea3d7b1addc81da27/frontend/src/embedding-sdk-bundle/components/public/dashboard/SdkDashboard.tsx#L175} */+ enableEntityNavigation: false,},question: {/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx#L241} */drills: true,/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx#L132} */- with_downloads: false,+ withDownloads: false,/*** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx#L234}* @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx#L255}*/- with_title: true,+ withTitle: true,/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx#L256} */- is_save_enabled: false,+ isSaveEnabled: false,/** @see {@link https://github.com/metabase/metabase/blob/c1b57eeb3f6f99126cc52e3a960b98f5c8bbc109/frontend/src/embedding-sdk-bundle/components/public/SdkQuestion/SdkQuestion.tsx#L137} */- with_alerts: false,+ withAlerts: false,},exploration: {/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/SdkIframeEmbedRoute.tsx#L256} */- is_save_enabled: false,+ isSaveEnabled: false,+ /**+ * @see {@link https://github.com/metabase/metabase/blob/c8b1767e66352738553211dea3d7b1addc81da27/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts#L170-L171}+ * Since this is optional, the default value is undefined.+ *+ * Unused, but documented for completeness.+ */+ questionId: undefined, // used to derive exploration id_new/id_new_native},browser: {/** @see {@link https://github.com/metabase/metabase/blob/9e62f8c2b7d3739670d9f4259e1d4e28f5b654cc/frontend/src/metabase/embedding/embedding-iframe-sdk/components/MetabaseBrowser.tsx#L39} */- read_only: true,+ readOnly: true,+ /** @see {@link https://github.com/metabase/metabase/blob/c8b1767e66352738553211dea3d7b1addc81da27/frontend/src/metabase/embedding/embedding-iframe-sdk/types/embed.ts#L166} */+ enableEntityNavigation: false,+ },+ // NEW: EMB-1334 - new component+ metabot: {+ /** @see {@link https://github.com/metabase/metabase/blob/c8b1767e66352738553211dea3d7b1addc81da27/frontend/src/embedding-sdk-bundle/components/public/MetabotQuestion/types.ts#L17} */+ layout: "auto",},};@@ -90,123 +112,286 @@ export function createEmbeddedAnalyticsJsUsage(activeEmbeds: Set<MetabaseEmbedElement>,): EmbeddedAnalyticsJsEventSchema {const [firstEmbed] = activeEmbeds;- let usage = {+ const event: EmbeddedAnalyticsJsEventSchema = {event: "setup",global: {auth_method: getAuthMethod(firstEmbed),+ locale_used: hasLocaleUsed(activeEmbeds),},- } as EmbeddedAnalyticsJsEventSchema;-- activeEmbeds.forEach((embed) => {- match(embed.properties)- .with({ componentName: "metabase-dashboard" }, (properties) => {- if (!usage.dashboard) {- usage = assocIn(usage, ["dashboard"], {- drills: { true: 0, false: 0 },- with_downloads: { true: 0, false: 0 },- with_title: { true: 0, false: 0 },- with_subscriptions: { true: 0, false: 0 },- } satisfies EmbeddedAnalyticsJsEvent["dashboard"]);- }- usage = incrementComponentPropertyCount(- "dashboard.drills",- properties.drills,- usage,- properties.isGuest- ? (path) => getIn(DEFAULT_GUEST_EMBED_VALUES, path)- : undefined,- );- usage = incrementComponentPropertyCount(- "dashboard.with_downloads",- properties.withDownloads,- usage,- );- usage = incrementComponentPropertyCount(- "dashboard.with_title",- properties.withTitle,- usage,- );- usage = incrementComponentPropertyCount(- "dashboard.with_subscriptions",- properties.withSubscriptions,- usage,- );- })- .with(- { componentName: "metabase-question", questionId: "new" },- { componentName: "metabase-question", questionId: "new-native" },- (properties) => {- if (!usage.exploration) {- usage = assocIn(usage, ["exploration"], {- is_save_enabled: { true: 0, false: 0 },- } satisfies EmbeddedAnalyticsJsEvent["exploration"]);- }- usage = incrementComponentPropertyCount(- "exploration.is_save_enabled",- properties.isSaveEnabled,- usage,- );- },- )- .with(- {- componentName: "metabase-question",- },- (properties) => {- if (!usage.question) {- usage = assocIn(usage, ["question"], {- drills: { true: 0, false: 0 },- with_downloads: { true: 0, false: 0 },- with_title: { true: 0, false: 0 },- is_save_enabled: { true: 0, false: 0 },- with_alerts: { true: 0, false: 0 },- } satisfies EmbeddedAnalyticsJsEvent["question"]);- }- usage = incrementComponentPropertyCount(- "question.drills",- properties.drills,- usage,- properties.isGuest- ? (path) => getIn(DEFAULT_GUEST_EMBED_VALUES, path)- : undefined,- );- usage = incrementComponentPropertyCount(- "question.with_downloads",- properties.withDownloads,- usage,- );- usage = incrementComponentPropertyCount(- "question.with_title",- properties.withTitle,- usage,- );- usage = incrementComponentPropertyCount(- "question.is_save_enabled",- properties.isSaveEnabled,- usage,- );- usage = incrementComponentPropertyCount(- "question.with_alerts",- properties.withAlerts,- usage,- );- },- )- .with({ componentName: "metabase-browser" }, (properties) => {- if (!usage.browser) {- usage = assocIn(usage, ["browser"], {- read_only: { true: 0, false: 0 },- } satisfies EmbeddedAnalyticsJsEvent["browser"]);- }- usage = incrementComponentPropertyCount(- "browser.read_only",- properties.readOnly,- usage,- );- });- });+ components: [],+ };++ // Filter embeds by type+ const dashboardEmbeds = Array.from(activeEmbeds).filter(+ (element) => element.properties.componentName === "metabase-dashboard",+ );+ const questionEmbeds = Array.from(activeEmbeds).filter(+ (element) =>+ element.properties.componentName === "metabase-question" &&+ element.properties.questionId !== "new" &&+ element.properties.questionId !== "new-native",+ );+ const explorationEmbeds = Array.from(activeEmbeds).filter(+ (element) =>+ element.properties.componentName === "metabase-question" &&+ (element.properties.questionId === "new" ||+ element.properties.questionId === "new-native"),+ );+ const browserEmbeds = Array.from(activeEmbeds).filter(+ (element) => element.properties.componentName === "metabase-browser",+ );+ const metabotEmbeds = Array.from(activeEmbeds).filter(+ (element) => element.properties.componentName === "metabase-metabot",+ );++ // Build dashboard component+ if (dashboardEmbeds.length > 0) {+ event.components.push({+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: countPropertyValues({+ embeds: dashboardEmbeds,+ component: "dashboard",+ propertyName: "drills",+ getValue: (drills, properties) =>+ String(+ drills ??+ (properties.isGuest+ ? DEFAULT_GUEST_EMBED_VALUES.dashboard.drills+ : DEFAULT_VALUES.dashboard.drills),+ ),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "with_downloads",+ values: countPropertyValues({+ embeds: dashboardEmbeds,+ component: "dashboard",+ propertyName: "withDownloads",+ getValue: (withDownloads) =>+ String(withDownloads ?? DEFAULT_VALUES.dashboard.withDownloads),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "with_title",+ values: countPropertyValues({+ embeds: dashboardEmbeds,+ component: "dashboard",+ propertyName: "withTitle",+ getValue: (withTitle) =>+ String(withTitle ?? DEFAULT_VALUES.dashboard.withTitle),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "with_subscriptions",+ values: countPropertyValues({+ embeds: dashboardEmbeds,+ component: "dashboard",+ propertyName: "withSubscriptions",+ getValue: (withSubscriptions) =>+ String(+ withSubscriptions ?? DEFAULT_VALUES.dashboard.withSubscriptions,+ ),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "auto_refresh_interval",+ values: countPropertyValues({+ embeds: dashboardEmbeds,+ component: "dashboard",+ propertyName: "autoRefreshInterval",+ getValue: (autoRefreshInterval) =>+ String(autoRefreshInterval != null),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "enable_entity_navigation",+ values: countPropertyValues({+ embeds: dashboardEmbeds,+ component: "dashboard",+ propertyName: "enableEntityNavigation",+ getValue: (enableEntityNavigation) =>+ String(+ enableEntityNavigation ??+ DEFAULT_VALUES.dashboard.enableEntityNavigation,+ ),+ allPossibleValues: ["false", "true"],+ }),+ },+ ],+ });+ }++ // Build question component+ if (questionEmbeds.length > 0) {+ event.components.push({+ name: "question",+ properties: [+ {+ name: "drills",+ values: countPropertyValues({+ embeds: questionEmbeds,+ component: "question",+ propertyName: "drills",+ getValue: (drills, properties) =>+ String(+ drills ??+ (properties.isGuest+ ? DEFAULT_GUEST_EMBED_VALUES.question.drills+ : DEFAULT_VALUES.question.drills),+ ),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "with_downloads",+ values: countPropertyValues({+ embeds: questionEmbeds,+ component: "question",+ propertyName: "withDownloads",+ getValue: (withDownloads) =>+ String(withDownloads ?? DEFAULT_VALUES.question.withDownloads),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "with_title",+ values: countPropertyValues({+ embeds: questionEmbeds,+ component: "question",+ propertyName: "withTitle",+ getValue: (withTitle) =>+ String(withTitle ?? DEFAULT_VALUES.question.withTitle),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "is_save_enabled",+ values: countPropertyValues({+ embeds: questionEmbeds,+ component: "question",+ propertyName: "isSaveEnabled",+ getValue: (isSaveEnabled) =>+ String(isSaveEnabled ?? DEFAULT_VALUES.question.isSaveEnabled),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "with_alerts",+ values: countPropertyValues({+ embeds: questionEmbeds,+ component: "question",+ propertyName: "withAlerts",+ getValue: (withAlerts) =>+ String(withAlerts ?? DEFAULT_VALUES.question.withAlerts),+ allPossibleValues: ["false", "true"],+ }),+ },+ ],+ });+ }++ // Build exploration component+ if (explorationEmbeds.length > 0) {+ event.components.push({+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: countPropertyValues({+ embeds: explorationEmbeds,+ component: "exploration",+ propertyName: "isSaveEnabled",+ getValue: (isSaveEnabled) =>+ String(isSaveEnabled ?? DEFAULT_VALUES.exploration.isSaveEnabled),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "id_new_native",+ values: countPropertyValues({+ embeds: explorationEmbeds,+ component: "exploration",+ propertyName: "questionId",+ getValue: (questionId) => String(questionId === "new-native"),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "id_new",+ values: countPropertyValues({+ embeds: explorationEmbeds,+ component: "exploration",+ propertyName: "questionId",+ getValue: (questionId) => String(questionId === "new"),+ allPossibleValues: ["false", "true"],+ }),+ },+ ],+ });+ }++ // Build browser component+ if (browserEmbeds.length > 0) {+ event.components.push({+ name: "browser",+ properties: [+ {+ name: "read_only",+ values: countPropertyValues({+ embeds: browserEmbeds,+ component: "browser",+ propertyName: "readOnly",+ getValue: (readOnly) =>+ String(readOnly ?? DEFAULT_VALUES.browser.readOnly),+ allPossibleValues: ["false", "true"],+ }),+ },+ {+ name: "enable_entity_navigation",+ values: countPropertyValues({+ embeds: browserEmbeds,+ component: "browser",+ propertyName: "enableEntityNavigation",+ getValue: (enableEntityNavigation) =>+ String(+ enableEntityNavigation ??+ DEFAULT_VALUES.browser.enableEntityNavigation,+ ),+ allPossibleValues: ["false", "true"],+ }),+ },+ ],+ });+ }- return usage;+ // Build metabot component+ if (metabotEmbeds.length > 0) {+ event.components.push({+ name: "metabot",+ properties: [+ {+ name: "layout",+ values: countPropertyValues({+ embeds: metabotEmbeds,+ component: "metabot",+ propertyName: "layout",+ getValue: (layout) =>+ String(layout ?? DEFAULT_VALUES.metabot.layout),+ }),+ },+ ],+ });+ }++ return event;}function getAuthMethod(firstEmbed: MetabaseEmbedElement): AUTH_TYPES {@@ -235,21 +420,49 @@ function getAuthMethod(firstEmbed: MetabaseEmbedElement): AUTH_TYPES {});}-function incrementComponentPropertyCount(- propertyPath: FlattenObjectKeys<DefaultValues>,- value: boolean | undefined,- usage: EmbeddedAnalyticsJsEventSchema,- getDefaultValue: (path: string[]) => boolean = defaultGetDefaultValue,-) {- const path = propertyPath.split(".");-- return updateIn(- usage,- [...path, String(value ?? getDefaultValue(path))],- (value) => value + 1,+function hasLocaleUsed(activeEmbeds: Set<MetabaseEmbedElement>): boolean {+ return Array.from(activeEmbeds).some(+ (embed) => embed.properties.locale != null,);}-function defaultGetDefaultValue(path: string[]): boolean {- return getIn(DEFAULT_VALUES, path);+function countPropertyValues<+ ComponentName extends keyof DefaultValues,+ PropertyName extends Extract<keyof DefaultValues[ComponentName], string>,+>(options: {+ embeds: MetabaseEmbedElement[];+ component: ComponentName;+ propertyName: PropertyName;+ getValue: (+ propertyValue: any,+ properties: MetabaseEmbedElement["properties"],+ ) => string;+ allPossibleValues?: string[];+}): PropertyValue[] {+ const counts = new Map<string, number>();++ options.embeds.forEach((embed) => {+ const propertyValue = (embed.properties as Record<string, any>)[+ options.propertyName+ ];+ const value = options.getValue(propertyValue, embed.properties);+ const group = String(value);+ counts.set(group, (counts.get(group) || 0) + 1);+ });++ // Fill in missing values with 0+ if (options.allPossibleValues) {+ options.allPossibleValues.forEach((value) => {+ if (!counts.has(value)) {+ counts.set(value, 0);+ }+ });+ }++ return Array.from(counts.entries())+ .sort(([a], [b]) => a.localeCompare(b))+ .map(([group, value]) => ({+ group,+ value,+ }));}diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.unit.spec.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.unit.spec.tsxindex 0367bccfd58..c3bc71a6a26 100644--- a/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.unit.spec.tsx+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk/analytics.unit.spec.tsx@@ -28,9 +28,9 @@ describe("createEmbeddedAnalyticsJsUsage", () => {),).toEqual(expect.objectContaining({- global: {+ global: expect.objectContaining({auth_method: "session",- },+ }),}),);});@@ -48,9 +48,9 @@ describe("createEmbeddedAnalyticsJsUsage", () => {),).toEqual(expect.objectContaining({- global: {+ global: expect.objectContaining({auth_method: "api_key",- },+ }),}),);});@@ -66,9 +66,9 @@ describe("createEmbeddedAnalyticsJsUsage", () => {),).toEqual(expect.objectContaining({- global: {+ global: expect.objectContaining({auth_method: "sso",- },+ }),}),);});@@ -85,9 +85,46 @@ describe("createEmbeddedAnalyticsJsUsage", () => {),).toEqual(expect.objectContaining({- global: {+ global: expect.objectContaining({auth_method: "guest",- },+ }),+ }),+ );+ });++ it("should track locale_used when locale is set", () => {+ defineMetabaseConfig({+ instanceUrl: "https://example.com",+ locale: "de",+ });++ expect(+ createEmbeddedAnalyticsJsUsage(+ new Set([createEmbeddedAnalyticsJsElement("metabase-dashboard")]),+ ),+ ).toEqual(+ expect.objectContaining({+ global: expect.objectContaining({+ locale_used: true,+ }),+ }),+ );+ });++ it("should track locale_used as false when locale is not set", () => {+ defineMetabaseConfig({+ instanceUrl: "https://example.com",+ });++ expect(+ createEmbeddedAnalyticsJsUsage(+ new Set([createEmbeddedAnalyticsJsElement("metabase-dashboard")]),+ ),+ ).toEqual(+ expect.objectContaining({+ global: expect.objectContaining({+ locale_used: false,+ }),}),);});@@ -96,360 +133,990 @@ describe("createEmbeddedAnalyticsJsUsage", () => {describe("Component usage", () => {describe("dashboard", () => {it("should count default values", () => {- expect(- createEmbeddedAnalyticsJsUsage(- new Set([createEmbeddedAnalyticsJsElement("metabase-dashboard")]),- ),- ).toEqual(- expect.objectContaining({- dashboard: {- drills: { true: 1, false: 0 },- with_downloads: { true: 0, false: 1 },- with_title: { true: 1, false: 0 },- with_subscriptions: { true: 0, false: 1 },- },- }),+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([createEmbeddedAnalyticsJsElement("metabase-dashboard")]),);++ expect(usage.components).toContainEqual({+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_subscriptions",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "auto_refresh_interval",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });});it("should count properties correctly", () => {// Explicit default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-dashboard", {- drills: true,- "with-downloads": false,- "with-title": true,- "with-subscriptions": false,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- dashboard: {- drills: { true: 1, false: 0 },- with_downloads: { true: 0, false: 1 },- with_title: { true: 1, false: 0 },- with_subscriptions: { true: 0, false: 1 },- },- }),+ const usageWithDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ drills: true,+ "with-downloads": false,+ "with-title": true,+ "with-subscriptions": false,+ }),+ ]),);- // Flip the default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-dashboard", {- drills: false,- "with-downloads": true,- "with-title": false,- "with-subscriptions": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- dashboard: {- drills: { true: 0, false: 1 },- with_downloads: { true: 1, false: 0 },- with_title: { true: 0, false: 1 },- with_subscriptions: { true: 1, false: 0 },+ expect(usageWithDefaults.components).toContainEqual({+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],},- }),+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_subscriptions",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "auto_refresh_interval",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });++ // Flip the default values+ const usageWithInvertedDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ drills: false,+ "with-downloads": true,+ "with-title": false,+ "with-subscriptions": true,+ }),+ ]),);+ expect(usageWithInvertedDefaults.components).toContainEqual({+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_subscriptions",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "auto_refresh_interval",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });+// Multiple components- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-dashboard"),- createEmbeddedAnalyticsJsElement("metabase-dashboard"),- createEmbeddedAnalyticsJsElement("metabase-dashboard", {- drills: false,- "with-downloads": true,- "with-title": false,- "with-subscriptions": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- dashboard: {- drills: { true: 2, false: 1 },- with_downloads: { true: 1, false: 2 },- with_title: { true: 2, false: 1 },- with_subscriptions: { true: 1, false: 2 },+ const usageWithMultipleComponents = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-dashboard"),+ createEmbeddedAnalyticsJsElement("metabase-dashboard"),+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ drills: false,+ "with-downloads": true,+ "with-title": false,+ "with-subscriptions": true,+ }),+ ]),+ );++ expect(usageWithMultipleComponents.components).toContainEqual({+ name: "dashboard",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 2 },+ ],},- }),+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 2 },+ ],+ },+ {+ name: "with_subscriptions",+ values: [+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "auto_refresh_interval",+ values: [+ { group: "false", value: 3 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 3 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });+ });++ it("should track auto_refresh_interval property", () => {+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ "auto-refresh-interval": 60,+ }),+ createEmbeddedAnalyticsJsElement("metabase-dashboard"),+ ]),+ );++ const dashboardComponent = usage.components.find(+ (component) => component.name === "dashboard",+ );+ const autoRefreshProp = dashboardComponent?.properties.find(+ (property) => property.name === "auto_refresh_interval",);++ expect(autoRefreshProp?.values).toEqual([+ { group: "false", value: 1 },+ { group: "true", value: 1 },+ ]);+ });++ it("should track enable_entity_navigation property", () => {+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ "enable-entity-navigation": true,+ }),+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ "enable-entity-navigation": false,+ }),+ createEmbeddedAnalyticsJsElement("metabase-dashboard"),+ ]),+ );++ const dashboardComponent = usage.components.find(+ (component) => component.name === "dashboard",+ );+ const enableEntityNavigationProp = dashboardComponent?.properties.find(+ (property) => property.name === "enable_entity_navigation",+ );++ expect(enableEntityNavigationProp?.values).toEqual([+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ]);});});describe("question", () => {it("should count default values", () => {- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": 1,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- question: {- drills: { true: 1, false: 0 },- with_downloads: { true: 0, false: 1 },- with_title: { true: 1, false: 0 },- is_save_enabled: { true: 0, false: 1 },- with_alerts: { true: 0, false: 1 },- },- }),+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": 1,+ }),+ ]),);++ expect(usage.components).toContainEqual({+ name: "question",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_alerts",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });});it("should count properties correctly", () => {// Explicit default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": 1,- drills: true,- "with-downloads": false,- "with-title": true,- "is-save-enabled": false,- "with-alerts": false,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- question: {- drills: { true: 1, false: 0 },- with_downloads: { true: 0, false: 1 },- with_title: { true: 1, false: 0 },- is_save_enabled: { true: 0, false: 1 },- with_alerts: { true: 0, false: 1 },- },- }),+ const usageWithDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": 1,+ drills: true,+ "with-downloads": false,+ "with-title": true,+ "is-save-enabled": false,+ "with-alerts": false,+ }),+ ]),);- // Flip the default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": 1,- drills: false,- "with-downloads": true,- "with-title": false,- "is-save-enabled": true,- "with-alerts": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- question: {- drills: { true: 0, false: 1 },- with_downloads: { true: 1, false: 0 },- with_title: { true: 0, false: 1 },- is_save_enabled: { true: 1, false: 0 },- with_alerts: { true: 1, false: 0 },+ expect(usageWithDefaults.components).toContainEqual({+ name: "question",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],},- }),+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_alerts",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });++ // Flip the default values+ const usageWithInvertedDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": 1,+ drills: false,+ "with-downloads": true,+ "with-title": false,+ "is-save-enabled": true,+ "with-alerts": true,+ }),+ ]),);+ expect(usageWithInvertedDefaults.components).toContainEqual({+ name: "question",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_alerts",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ ],+ });+// Multiple components- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question"),- createEmbeddedAnalyticsJsElement("metabase-question"),- createEmbeddedAnalyticsJsElement("metabase-question", {- drills: false,- "with-downloads": true,- "with-title": false,- "is-save-enabled": true,- "with-alerts": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- question: {- drills: { true: 2, false: 1 },- with_downloads: { true: 1, false: 2 },- with_title: { true: 2, false: 1 },- is_save_enabled: { true: 1, false: 2 },- with_alerts: { true: 1, false: 2 },+ const usageWithMultipleComponents = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question"),+ createEmbeddedAnalyticsJsElement("metabase-question"),+ createEmbeddedAnalyticsJsElement("metabase-question", {+ drills: false,+ "with-downloads": true,+ "with-title": false,+ "is-save-enabled": true,+ "with-alerts": true,+ }),+ ]),+ );++ expect(usageWithMultipleComponents.components).toContainEqual({+ name: "question",+ properties: [+ {+ name: "drills",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 2 },+ ],},- }),+ {+ name: "with_downloads",+ values: [+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_title",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 2 },+ ],+ },+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "with_alerts",+ values: [+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ],+ },+ ],+ });+ });++ it("should track id_new_native and id_new properties", () => {+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new-native",+ }),+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ }),+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": 123,+ }),+ ]),+ );++ const explorationComponent = usage.components.find(+ (component) => component.name === "exploration",+ );+ const idNewNativeProp = explorationComponent?.properties.find(+ (property) => property.name === "id_new_native",);+ const idNewProp = explorationComponent?.properties.find(+ (property) => property.name === "id_new",+ );++ expect(idNewNativeProp?.values).toEqual([+ { group: "false", value: 1 },+ { group: "true", value: 1 },+ ]);+ expect(idNewProp?.values).toEqual([+ { group: "false", value: 1 },+ { group: "true", value: 1 },+ ]);});});describe("question with exploration", () => {it("should count default values", () => {- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": "new",- }),- ]),- ),- ).toEqual(- expect.objectContaining({- exploration: {- is_save_enabled: { true: 0, false: 1 },- },- }),+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ }),+ ]),);++ expect(usage.components).toContainEqual({+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new_native",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ ],+ });});it("should count question components with exploration", () => {// Explicit default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": "new",- "is-save-enabled": false,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- exploration: {- is_save_enabled: { true: 0, false: 1 },- },- }),+ const usageWithDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ "is-save-enabled": false,+ }),+ ]),);- // Flip the default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": "new",- "is-save-enabled": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- exploration: {- is_save_enabled: { true: 1, false: 0 },+ expect(usageWithDefaults.components).toContainEqual({+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],},- }),+ {+ name: "id_new_native",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ ],+ });++ // Flip the default values+ const usageWithInvertedDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ "is-save-enabled": true,+ }),+ ]),);+ expect(usageWithInvertedDefaults.components).toContainEqual({+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "id_new_native",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ ],+ });+// Multiple components- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": "new",- }),- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": "new",- }),- createEmbeddedAnalyticsJsElement("metabase-question", {- "question-id": "new",- "is-save-enabled": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- exploration: {- is_save_enabled: { true: 1, false: 2 },+ const usageWithMultipleComponents = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ }),+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ }),+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new",+ "is-save-enabled": true,+ }),+ ]),+ );++ expect(usageWithMultipleComponents.components).toContainEqual({+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ],},- }),+ {+ name: "id_new_native",+ values: [+ { group: "false", value: 3 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 3 },+ ],+ },+ ],+ });+ });++ it("should track exploration with new-native questionId", () => {+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": "new-native",+ }),+ ]),);++ expect(usage.components).toContainEqual({+ name: "exploration",+ properties: [+ {+ name: "is_save_enabled",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "id_new_native",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "id_new",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });});});describe("browser", () => {it("should count default values", () => {- expect(- createEmbeddedAnalyticsJsUsage(- new Set([createEmbeddedAnalyticsJsElement("metabase-browser")]),- ),- ).toEqual(- expect.objectContaining({- browser: {- read_only: { true: 1, false: 0 },- },- }),+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([createEmbeddedAnalyticsJsElement("metabase-browser")]),);++ expect(usage.components).toContainEqual({+ name: "browser",+ properties: [+ {+ name: "read_only",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });});it("should count properties correctly", () => {// Explicit default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-browser", {- "read-only": true,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- browser: {- read_only: { true: 1, false: 0 },- },- }),+ const usageWithDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-browser", {+ "read-only": true,+ }),+ ]),);- // Flip the default values- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-browser", {- "read-only": false,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- browser: {- read_only: { true: 0, false: 1 },+ expect(usageWithDefaults.components).toContainEqual({+ name: "browser",+ properties: [+ {+ name: "read_only",+ values: [+ { group: "false", value: 0 },+ { group: "true", value: 1 },+ ],},- }),+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });++ // Flip the default values+ const usageWithInvertedDefaults = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-browser", {+ "read-only": false,+ }),+ ]),);+ expect(usageWithInvertedDefaults.components).toContainEqual({+ name: "browser",+ properties: [+ {+ name: "read_only",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });+// Multiple components- expect(- createEmbeddedAnalyticsJsUsage(- new Set([- createEmbeddedAnalyticsJsElement("metabase-browser"),- createEmbeddedAnalyticsJsElement("metabase-browser"),- createEmbeddedAnalyticsJsElement("metabase-browser", {- "read-only": false,- }),- ]),- ),- ).toEqual(- expect.objectContaining({- browser: {- read_only: { true: 2, false: 1 },+ const usageWithMultipleComponents = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-browser"),+ createEmbeddedAnalyticsJsElement("metabase-browser"),+ createEmbeddedAnalyticsJsElement("metabase-browser", {+ "read-only": false,+ }),+ ]),+ );++ expect(usageWithMultipleComponents.components).toContainEqual({+ name: "browser",+ properties: [+ {+ name: "read_only",+ values: [+ { group: "false", value: 1 },+ { group: "true", value: 2 },+ ],},- }),+ {+ name: "enable_entity_navigation",+ values: [+ { group: "false", value: 3 },+ { group: "true", value: 0 },+ ],+ },+ ],+ });+ });++ it("should track enable_entity_navigation property", () => {+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-browser", {+ "enable-entity-navigation": true,+ }),+ createEmbeddedAnalyticsJsElement("metabase-browser", {+ "enable-entity-navigation": false,+ }),+ createEmbeddedAnalyticsJsElement("metabase-browser"),+ ]),);++ const browserComponent = usage.components.find(+ (component) => component.name === "browser",+ );+ const enableEntityNavigationProp = browserComponent?.properties.find(+ (property) => property.name === "enable_entity_navigation",+ );++ expect(enableEntityNavigationProp?.values).toEqual([+ { group: "false", value: 2 },+ { group: "true", value: 1 },+ ]);});});++ describe("metabot", () => {+ it("should track metabot component with layout property", () => {+ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-metabot", {+ layout: "auto",+ }),+ createEmbeddedAnalyticsJsElement("metabase-metabot", {+ layout: "sidebar",+ }),+ createEmbeddedAnalyticsJsElement("metabase-metabot", {+ layout: "stacked",+ }),+ createEmbeddedAnalyticsJsElement("metabase-metabot"),+ ]),+ );++ expect(usage.components).toContainEqual({+ name: "metabot",+ properties: [+ {+ name: "layout",+ values: [+ { group: "auto", value: 2 },+ { group: "sidebar", value: 1 },+ { group: "stacked", value: 1 },+ ],+ },+ ],+ });+ });+ });+ });++ describe("Guest embed defaults", () => {+ it("should use different default for drills in guest dashboard embeds", () => {+ defineMetabaseConfig({+ isGuest: true,+ instanceUrl: "https://example.com",+ });++ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-dashboard"),+ createEmbeddedAnalyticsJsElement("metabase-dashboard", {+ drills: true,+ }),+ ]),+ );++ const dashboardComponent = usage.components.find(+ (component) => component.name === "dashboard",+ );+ const drillsProp = dashboardComponent?.properties.find(+ (property) => property.name === "drills",+ );++ expect(drillsProp?.values).toEqual([+ { group: "false", value: 1 }, // Guest default+ { group: "true", value: 1 }, // Explicit true+ ]);+ });++ it("should use different default for drills in guest question embeds", () => {+ defineMetabaseConfig({+ isGuest: true,+ instanceUrl: "https://example.com",+ });++ const usage = createEmbeddedAnalyticsJsUsage(+ new Set([+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": 1,+ }),+ createEmbeddedAnalyticsJsElement("metabase-question", {+ "question-id": 2,+ drills: true,+ }),+ ]),+ );++ const questionComponent = usage.components.find(+ (component) => component.name === "question",+ );+ const drillsProp = questionComponent?.properties.find(+ (property) => property.name === "drills",+ );++ expect(drillsProp?.values).toEqual([+ { group: "false", value: 1 }, // Guest default+ { group: "true", value: 1 }, // Explicit true+ ]);+ });});});type Component =| "metabase-dashboard"| "metabase-question"- | "metabase-browser";+ | "metabase-browser"+ | "metabase-metabot";function createEmbeddedAnalyticsJsElement(componentName: Component,properties: Record<string, any> = {},diff --git a/frontend/src/metabase/lib/analytics.ts b/frontend/src/metabase/lib/analytics.tsindex 402c7a24706..32bc7c9e280 100644--- a/frontend/src/metabase/lib/analytics.ts+++ b/frontend/src/metabase/lib/analytics.ts@@ -23,7 +23,7 @@ const VERSIONS: Record<SchemaType, SchemaVersion> = {downloads: "1-0-0",embed_flow: "1-0-3",embed_share: "1-0-1",- embedded_analytics_js: "2-0-1",+ embedded_analytics_js: "3-0-0",embedding_homepage: "1-0-0",simple_event: "1-0-0",invite: "1-0-1",diff --git a/snowplow/iglu-client-embedded/schemas/com.metabase/embedded_analytics_js/jsonschema/3-0-0 b/snowplow/iglu-client-embedded/schemas/com.metabase/embedded_analytics_js/jsonschema/3-0-0new file mode 100644index 00000000000..bb72d381dfc--- /dev/null+++ b/snowplow/iglu-client-embedded/schemas/com.metabase/embedded_analytics_js/jsonschema/3-0-0@@ -0,0 +1,121 @@+{+ "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",+ "description": "Modular embedding configuration with extensible component tracking",+ "self": {+ "vendor": "com.metabase",+ "name": "embedded_analytics_js",+ "format": "jsonschema",+ "version": "3-0-0"+ },+ "type": "object",+ "properties": {+ "event": {+ "description": "The type of event being recorded. For example, when the modular embedding is initialized, or when the Metabase configuration is updated.",+ "type": "string",+ "enum": [+ "setup"+ ],+ "maxLength": 1024+ },+ "global": {+ "description": "Global configuration for modular embedding.",+ "type": "object",+ "properties": {+ "auth_method": {+ "description": "Authentication method used for the modular embedding.",+ "type": [+ "string",+ "null"+ ],+ "enum": [+ "session",+ "api_key",+ "sso",+ "guest"+ ],+ "maxLength": 1024+ },+ "locale_used": {+ "description": "Whether the locale has been set",+ "type": [+ "boolean",+ "null"+ ]+ }+ },+ "additionalProperties": true+ },+ "components": {+ "description": "Configuration for embedded components",+ "type": "array",+ "items": {+ "type": "object",+ "description": "A single embedded component and its properties",+ "properties": {+ "name": {+ "description": "Component name (e.g., dashboard, question, exploration, browser, metabot, etc.)",+ "type": "string",+ "maxLength": 255+ },+ "properties": {+ "description": "Properties and their value counts",+ "type": "array",+ "items": {+ "type": "object",+ "description": "A single property and its value counts",+ "properties": {+ "name": {+ "description": "Property name",+ "type": "string",+ "maxLength": 255+ },+ "values": {+ "description": "Value counts for this property",+ "type": "array",+ "items": {+ "type": "object",+ "description": "A single property value and its count",+ "properties": {+ "group": {+ "type": "string",+ "description": "The value group (e.g., 'true', 'false', 'auto', 'sidebar', 'stacked')",+ "maxLength": 255+ },+ "value": {+ "type": "integer",+ "description": "Count for this group",+ "minimum": 0,+ "maximum": 2147483647+ }+ },+ "required": [+ "group",+ "value"+ ],+ "additionalProperties": false+ }+ }+ },+ "required": [+ "name",+ "values"+ ],+ "additionalProperties": false+ }+ }+ },+ "required": [+ "name",+ "properties"+ ],+ "additionalProperties": false+ }+ }+ },+ "required": [+ "event",+ "global",+ "components"+ ],+ "additionalProperties": true+}