Skip to content

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

PRG-130 Send parse connection string parsing events only on blur (#63558)

Jakub Chodorowiczfd073fb8b165
diff --git a/e2e/test/scenarios/admin/database-connection-strings.cy.spec.ts b/e2e/test/scenarios/admin/database-connection-strings.cy.spec.ts
index bd8c6771bef..952e6a3b341 100644
--- a/e2e/test/scenarios/admin/database-connection-strings.cy.spec.ts
+++ b/e2e/test/scenarios/admin/database-connection-strings.cy.spec.ts
@@ -2,6 +2,8 @@ import { QA_MYSQL_PORT, QA_POSTGRES_PORT } from "e2e/support/cypress_data";
import { waitForDbSync } from "./helpers/e2e-database-helpers";
+const { H } = cy;
+
beforeEach(() => {
cy.H.restore();
cy.signInAsAdmin();
@@ -356,3 +358,59 @@ describe("Database connection strings", () => {
});
});
});
+
+H.describeWithSnowplow("Database connection strings events", () => {
+ beforeEach(() => {
+ H.resetSnowplow();
+ H.restore();
+ H.enableTracking();
+ cy.visit("/admin/databases/create?engine=mysql");
+ });
+
+ it("should track success events correctly", () => {
+ const successEvent = {
+ event: "connection_string_parsed_success",
+ triggered_from: "full-page",
+ };
+
+ cy.findByLabelText("Connection string (optional)")
+ .focus()
+ .paste("jdbc:mysql://testuser:testpass@host:3306/dbname?ssl=true")
+ .paste("jdbc:mysql://a:b@c:3/dbname?ssl=false");
+
+ cy.findByTextEnsureVisible("Connection details pre-filled below.").should(
+ "exist",
+ );
+
+ cy.findByLabelText("Display name").click();
+
+ H.expectUnstructuredSnowplowEvent(successEvent, 1);
+
+ cy.findByLabelText("Connection string (optional)").click();
+ cy.findByLabelText("Display name").click();
+
+ // Should not track the same event again
+ H.expectUnstructuredSnowplowEvent(successEvent, 1);
+ });
+
+ it("should track failure events correctly", () => {
+ cy.findByLabelText("Connection string (optional)")
+ .focus()
+ .paste("broken string")
+ .type("also not a valid string");
+
+ cy.findByTextEnsureVisible("Couldn’t use this connection string.").should(
+ "exist",
+ );
+
+ cy.findByLabelText("Display name").click();
+
+ H.expectUnstructuredSnowplowEvent(
+ {
+ event: "connection_string_parsed_failed",
+ triggered_from: "full-page",
+ },
+ 1,
+ );
+ });
+});
diff --git a/frontend/src/metabase/databases/components/DatabaseConnectionUri/DatabaseConnectionStringField.tsx b/frontend/src/metabase/databases/components/DatabaseConnectionUri/DatabaseConnectionStringField.tsx
index 7d32d8747ea..4a3dae3a2c4 100644
--- a/frontend/src/metabase/databases/components/DatabaseConnectionUri/DatabaseConnectionStringField.tsx
+++ b/frontend/src/metabase/databases/components/DatabaseConnectionUri/DatabaseConnectionStringField.tsx
@@ -1,7 +1,7 @@
import { usePrevious, useTimeout } from "@mantine/hooks";
import type { FormikErrors } from "formik";
import { useField } from "formik";
-import { type SetStateAction, useEffect, useState } from "react";
+import { type SetStateAction, useEffect, useRef, useState } from "react";
import { c, t } from "ttag";
import { Group, Icon, Text, Textarea, Transition } from "metabase/ui";
@@ -35,6 +35,7 @@ export function DatabaseConnectionStringField({
location: FormLocation;
}) {
const [status, setStatus] = useState<"success" | "failure" | null>(null);
+ const lastParseStatusRef = useRef<"success" | "failure" | null>(null);
const { start: delayedClearStatus, clear: clearTimeout } = useTimeout(
() => setStatus(null),
FEEDBACK_TIMEOUT,
@@ -46,6 +47,7 @@ export function DatabaseConnectionStringField({
useEffect(() => {
async function handleConnectionStringChange() {
if (!connectionString || !isEngineKey(engineKey)) {
+ lastParseStatusRef.current = null;
delayedClearStatus();
return () => clearTimeout();
}
@@ -55,8 +57,8 @@ export function DatabaseConnectionStringField({
// it was not possible to parse the connection string
if (!parsedValues) {
setStatus("failure");
+ lastParseStatusRef.current = "failure";
delayedClearStatus();
- connectionStringParsedFailed(location);
return () => clearTimeout();
}
@@ -68,10 +70,11 @@ export function DatabaseConnectionStringField({
// if there are no values, we couldn't get any details from the connection string
const hasValues = hasNonUndefinedValue(fieldsMap);
- setStatus(hasValues ? "success" : "failure");
+ const result = hasValues ? "success" : "failure";
+ setStatus(result);
+ lastParseStatusRef.current = result;
delayedClearStatus();
- connectionStringParsedSuccess(location);
return () => {
clearTimeout();
@@ -97,6 +100,18 @@ export function DatabaseConnectionStringField({
setConnectionString,
]);
+ function handleBlur() {
+ if (lastParseStatusRef.current === "success") {
+ connectionStringParsedSuccess(location);
+ }
+
+ if (lastParseStatusRef.current === "failure") {
+ connectionStringParsedFailed(location);
+ }
+
+ lastParseStatusRef.current = null;
+ }
+
if (!isEngineKey(engineKey)) {
return null;
}
@@ -129,6 +144,7 @@ export function DatabaseConnectionStringField({
labelProps={{
mb: "sm",
}}
+ onBlur={handleBlur}
/>
);
}