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
GRO-388 mimic Snowplow.setUserId with metaplow (#75565)
Brad Andersona866b4827c15
diff --git a/frontend/src/metabase/app.js b/frontend/src/metabase/app.jsindex f17e4fd7661..1dbab368f0b 100644--- a/frontend/src/metabase/app.js+++ b/frontend/src/metabase/app.js@@ -46,6 +46,7 @@ import { GlobalStyles } from "metabase/styled-components/containers/GlobalStylesimport { PortalContainer } from "metabase/ui";import { EmotionCacheProvider } from "metabase/ui/components/theme/EmotionCacheProvider";import { captureConsoleErrors } from "metabase/utils/errors";+import { initMetaplow } from "metabase/utils/metaplow";import { initTracing, rotateTraceId } from "metabase/utils/otel";import MetabaseSettings from "metabase/utils/settings";import registerVisualizations from "metabase/visualizations/register";@@ -72,6 +73,12 @@ function _init(reducers, getRoutes, callback) {const syncedHistory = syncHistoryWithStore(browserHistory, store);createSnowplowTracker(() => getUserId(store.getState()));+ initMetaplow({+ beforeSend: (_type, payload) => ({+ ...payload,+ data: { ...payload.data, user_id: getUserId(store.getState()) },+ }),+ });// Initialize distributed tracing if enabled via MB_TRACING_ENABLED.// Uses bootstrap data so it's available before the first API call.diff --git a/frontend/src/metabase/utils/metaplow.ts b/frontend/src/metabase/utils/metaplow.tsindex eac8cec26d2..e1ace3d2c50 100644--- a/frontend/src/metabase/utils/metaplow.ts+++ b/frontend/src/metabase/utils/metaplow.ts@@ -58,20 +58,41 @@ async function send(payload: MetaplowPayload): Promise<unknown> {});}+interface MetaplowConfig {+ beforeSend: (+ type: string,+ payload: MetaplowPayload,+ ) => MetaplowPayload | void;+}++let _config: MetaplowConfig = {+ beforeSend: (_type, payload) => payload,+};++export function initMetaplow(config: Partial<MetaplowConfig>): void {+ _config = { ..._config, ...config };+}+export function trackMetaplowEvent(name: MetaplowPayload["name"],data: MetaplowPayload["data"] = {},): void {- send({+ const payload = _config.beforeSend("event", {...getBasePayload(window.location.href),name,data,- }).catch(() => undefined);+ });+ if (payload) {+ send(payload).catch(() => undefined);+ }}-export function trackMetaplowPageView(url: string): Promise<unknown> {- return send({+export function trackMetaplowPageView(url: string) {+ const payload = _config.beforeSend("event", {...getBasePayload(url),name: "pageview",- }).catch(() => undefined);+ });+ if (payload) {+ send(payload).catch(() => undefined);+ }}diff --git a/frontend/src/metabase/utils/metaplow.unit.spec.ts b/frontend/src/metabase/utils/metaplow.unit.spec.tsindex 4ec2b562745..e6fa0ac8e4b 100644--- a/frontend/src/metabase/utils/metaplow.unit.spec.ts+++ b/frontend/src/metabase/utils/metaplow.unit.spec.ts@@ -1,6 +1,10 @@import Settings from "metabase/utils/settings";-import { trackMetaplowEvent, trackMetaplowPageView } from "./metaplow";+import {+ initMetaplow,+ trackMetaplowEvent,+ trackMetaplowPageView,+} from "./metaplow";const METAPLOW_URL = "https://metaplow.example.com/api/send";const METAPLOW_WEBSITE_ID = "23eefa30-4c4f-490e-aa4f-084cd23b1561";@@ -32,6 +36,36 @@ describe("metaplow", () => {return JSON.parse(init?.body as string);};+ describe("initMetaplow", () => {+ describe("beforeSend", () => {+ afterEach(() => {+ initMetaplow({ beforeSend: (_type, payload) => payload });+ });++ it("can modify the payload before it's sent", () => {+ initMetaplow({+ beforeSend: (_type, payload) => ({+ ...payload,+ data: { ...payload.data, user_id: 123 },+ }),+ });++ trackMetaplowEvent("button_clicked");++ const { payload } = getSentPayload();+ expect(payload.data.user_id).toBe(123);+ });++ it("suppresses the fetch call when a falsy value is returned", () => {+ initMetaplow({ beforeSend: () => undefined });++ trackMetaplowEvent("button_clicked");++ expect(fetchSpy).not.toHaveBeenCalled();+ });+ });+ });+describe("trackMetaplowEvent", () => {it("does not call fetch when metaplow-url is not set", () => {Settings.set("metaplow-url", null);