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
e2e2unit: Unit test the internal analytics POST payload (#85643)
Romeo Van Snickb5ec1e71d6e4
diff --git a/e2e/test/scenarios/admin/internal-analytics.cy.spec.ts b/e2e/test/scenarios/admin/internal-analytics.cy.spec.tsindex 4faac99d323..13204a71a3e 100644--- a/e2e/test/scenarios/admin/internal-analytics.cy.spec.ts+++ b/e2e/test/scenarios/admin/internal-analytics.cy.spec.ts@@ -12,14 +12,13 @@ describe("internal analytics", () => {cy.visit("/");cy.window().then((win: any) => {- // Send more than flush-buffer-size (50) events to trigger an immediate flush.- // See metabase.analytics.impl/flush-buffer-size.+ // The buffer flushes on a timer, not on size: see metabase.analytics.impl/flush-interval-ms.for (let i = 0; i < 51; i++) {win.__internalAnalytics.inc("e2e-test/counter", { test: "true" }, 1);}});- cy.wait("@internalAnalytics").then((interception) => {+ cy.wait("@internalAnalytics", { timeout: 15000 }).then((interception) => {expect(interception.response?.statusCode).to.equal(204);expect(interception.request.body.events).to.be.an("array");expect(interception.request.body.events.length).to.be.greaterThan(0);diff --git a/frontend/src/metabase/api/internal-analytics.unit.spec.ts b/frontend/src/metabase/api/internal-analytics.unit.spec.tsnew file mode 100644index 00000000000..d5459a2cb3a--- /dev/null+++ b/frontend/src/metabase/api/internal-analytics.unit.spec.ts@@ -0,0 +1,73 @@+import fetchMock from "fetch-mock";++import {+ findRequests,+ setupInternalAnalyticsEndpoint,+} from "__support__/server-mocks";++import { postInternalAnalytics } from "./internal-analytics";++// The CLJS reporter resolves this module by name at runtime, so rspack is the only thing that+// checks the string. See `post-events!` in src/metabase/analytics/impl.cljs.+const REPORTER_MODULE_NAME = "metabase/api/internal-analytics";++describe("postInternalAnalytics", () => {+ beforeEach(() => {+ setupInternalAnalyticsEndpoint();+ });++ afterEach(() => {+ fetchMock.removeRoutes().clearHistory();+ });++ it("posts a batch to /api/analytics/internal under an events key", async () => {+ // Metrics are namespaced, as the backend allowlist in metabase.analytics.api keys on them.+ await postInternalAnalytics([+ {+ op: "inc",+ metric: "experiment/runs-total",+ labels: { experiment: "my-exp" },+ amount: 1,+ },+ {+ op: "inc",+ metric: "metabase-frontend/analytics-events-dropped",+ labels: null,+ amount: 3,+ },+ ]);++ const posts = await findRequests("POST");+ expect(posts).toHaveLength(1);++ const [{ url, body }] = posts;+ const payload: unknown = body;++ expect(url).toContain("/api/analytics/internal");+ expect(payload).toEqual({+ events: [+ {+ op: "inc",+ metric: "experiment/runs-total",+ labels: { experiment: "my-exp" },+ amount: 1,+ },+ {+ op: "inc",+ metric: "metabase-frontend/analytics-events-dropped",+ labels: null,+ amount: 3,+ },+ ],+ });+ });++ it("is reachable under the module name the CLJS reporter requires", () => {+ const reporterModule: unknown = jest.requireActual(REPORTER_MODULE_NAME);++ expect(reporterModule).toHaveProperty(+ "postInternalAnalytics",+ expect.any(Function),+ );+ });+});diff --git a/frontend/test/__support__/server-mocks/analytics.ts b/frontend/test/__support__/server-mocks/analytics.tsnew file mode 100644index 00000000000..5250df5e72e--- /dev/null+++ b/frontend/test/__support__/server-mocks/analytics.ts@@ -0,0 +1,5 @@+import fetchMock from "fetch-mock";++export function setupInternalAnalyticsEndpoint() {+ fetchMock.post("path:/api/analytics/internal", 204);+}diff --git a/frontend/test/__support__/server-mocks/index.ts b/frontend/test/__support__/server-mocks/index.tsindex 3c4623304d5..4fb0e89a026 100644--- a/frontend/test/__support__/server-mocks/index.ts+++ b/frontend/test/__support__/server-mocks/index.ts@@ -2,6 +2,7 @@ export * from "./action";export * from "./activity";export * from "./advanced-config";export * from "./alert";+export * from "./analytics";export * from "./api-key";export * from "./audit";export * from "./automagic-dashboards";