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
Stop the Data Studio index redirect clobbering a live navigation (#82185)
Stas Gavrylovde8bfa2fbbf7
diff --git a/e2e/support/helpers/e2e-data-studio-helpers.ts b/e2e/support/helpers/e2e-data-studio-helpers.tsindex d7835e25d86..29b83a8f581 100644--- a/e2e/support/helpers/e2e-data-studio-helpers.ts+++ b/e2e/support/helpers/e2e-data-studio-helpers.ts@@ -19,6 +19,12 @@ const editSnippetPage = () => cy.findByTestId("edit-snippet-page");export const DataStudio = {nav: () => cy.findByTestId("data-studio-nav"),breadcrumbs: () => cy.findByTestId("data-studio-breadcrumbs"),+ visit: () => {+ cy.visit("/data-studio");+ // The target is only known once the `hasSeenGuide` request comes back.+ cy.location("pathname").should("match", /^\/data-studio\/.+/);+ DataStudio.nav().should("be.visible");+ },Transforms: {header: () => cy.findByTestId("transforms-header"),sectionHeader: () => cy.findByTestId("transforms-section-header"),diff --git a/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.tsindex b30edbbd275..5a766efdb32 100644--- a/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts@@ -41,6 +41,8 @@ describe("scenarios > data studio > library", () => {H.popover().findByText(/Data studio/).click();+ // Let the Data Studio index redirect settle.+ cy.location("pathname").should("not.eq", "/data-studio");cy.log("Verify tracking event when opening Data Studio from the profile menu",diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.tsindex a3532b85b1c..52821c8d695 100644--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts@@ -4354,8 +4354,7 @@ describe("scenarios > data studio > transforms > permissions > oss", () => {cy.findByRole("columnheader", { name: /Transforms/ }).should("not.exist");cy.log("Visit data studio page");- cy.visit("/data-studio");- H.DataStudio.nav().should("be.visible");+ H.DataStudio.visit();cy.log("Verify Transforms menu item is visible");H.DataStudio.nav()@@ -4428,8 +4427,7 @@ describe();cy.log("Visit data studio page");- cy.visit("/data-studio");- H.DataStudio.nav().should("be.visible");+ H.DataStudio.visit();cy.log("Verify Transforms menu item is visible");H.DataStudio.nav()diff --git a/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.ts b/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.tsindex 13dff09eccc..0ed91ba3156 100644--- a/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.ts+++ b/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.ts@@ -506,7 +506,7 @@ describe("scenarios > schema-viewer (entry points + loader/error states)", () =>cy.log("Click 'Schema viewer' tab in the Data Studio sidebar — opens the bare schema viewer URL",);- cy.visit("/data-studio");+ H.DataStudio.visit();H.DataStudio.nav().findByText("Schema viewer").click();cy.url().should("include", "/data-studio/schema-viewer");cy.findByTestId("schema-picker-button")diff --git a/frontend/src/metabase/data-studio/routes.tsx b/frontend/src/metabase/data-studio/routes.tsxindex 75a162ef737..10941584f30 100644--- a/frontend/src/metabase/data-studio/routes.tsx+++ b/frontend/src/metabase/data-studio/routes.tsx@@ -13,6 +13,7 @@ import {Route,type RouteComponent,redirect,+ useIsNavigating,} from "metabase/router";import { getDataStudioTransformRoutes } from "metabase/transforms/routes";import { canAccessTransforms } from "metabase/transforms/selectors";@@ -154,13 +155,14 @@ export function getDataStudioDependencyDiagnosticsRedirects() {export function DataStudioIndexRedirect() {const indexPath = useSelector(getIndexPath);+ const isNavigating = useIsNavigating();const { value: hasSeenGuide, isLoading } = useUserKeyValue({namespace: "data_studio",key: "hasSeenGuide",defaultValue: false,});- if (isLoading) {+ if (isLoading || isNavigating) {return <LoadingAndErrorWrapper loading />;}diff --git a/frontend/src/metabase/data-studio/routes.unit.spec.tsx b/frontend/src/metabase/data-studio/routes.unit.spec.tsxindex 1e7c37f82d2..c1b4f192938 100644--- a/frontend/src/metabase/data-studio/routes.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/routes.unit.spec.tsx@@ -1,8 +1,12 @@+import fetchMock from "fetch-mock";+import { lazyLoaders } from "__support__/lazy-routes";import { setupUserKeyValueEndpoints } from "__support__/server-mocks";import { createMockState } from "__support__/state";-import { renderWithProviders, screen } from "__support__/ui";+import { act, renderWithProviders, screen } from "__support__/ui";+import { delay } from "__support__/utils";import { Route } from "metabase/router";+import { defer } from "metabase/utils/promise";import { createMockUser } from "metabase-types/api/mocks";import { DataStudioIndexRedirect, getDataStudioRoutes } from "./routes";@@ -25,27 +29,52 @@ describe("data-studio routes", () => {function setupIndexRedirect({hasSeenGuide,isAdmin = false,+ transformsLoading,}: {- hasSeenGuide: boolean;+ hasSeenGuide: boolean | Promise<boolean>;isAdmin?: boolean;+ transformsLoading?: Promise<void>;}) {- setupUserKeyValueEndpoints({- namespace: "data_studio",- key: "hasSeenGuide",- value: hasSeenGuide,- });+ if (typeof hasSeenGuide === "boolean") {+ setupUserKeyValueEndpoints({+ namespace: "data_studio",+ key: "hasSeenGuide",+ value: hasSeenGuide,+ });+ } else {+ fetchMock.get(+ "path:/api/user-key-value/namespace/data_studio/key/hasSeenGuide",+ async () =>+ new Response(JSON.stringify(await hasSeenGuide), {+ status: 200,+ headers: { "Content-Type": "application/json" },+ }),+ );+ }- renderWithProviders(+ return renderWithProviders(<Route path="/"><Route path="data-studio"><Route index element={<DataStudioIndexRedirect />} /><Route path="guide" element={<div data-testid="guide-page" />} /><Route path="data" element={<div data-testid="data-index" />} /><Route path="library" element={<div data-testid="library-index" />} />- <Route- path="transforms"- element={<div data-testid="transforms-index" />}- />+ {transformsLoading ? (+ <Route+ path="transforms"+ lazy={async () => {+ await transformsLoading;+ return {+ Component: () => <div data-testid="transforms-index" />,+ };+ }}+ />+ ) : (+ <Route+ path="transforms"+ element={<div data-testid="transforms-index" />}+ />+ )}</Route></Route>,{@@ -79,4 +108,25 @@ describe("Data Studio index redirect", () => {expect(await screen.findByTestId("library-index")).toBeInTheDocument();expect(screen.queryByTestId("guide-page")).not.toBeInTheDocument();});++ it("lets a navigation the user already started finish", async () => {+ const hasSeenGuide = defer<boolean>();+ const transformsModule = defer<void>();+ const { router } = setupIndexRedirect({+ hasSeenGuide: hasSeenGuide.promise,+ isAdmin: true,+ transformsLoading: transformsModule.promise,+ });++ act(() => router?.navigate("/data-studio/transforms"));++ // The redirect resolves while the lazy route is still loading.+ hasSeenGuide.resolve(false);+ await delay(0);++ transformsModule.resolve();++ expect(await screen.findByTestId("transforms-index")).toBeInTheDocument();+ expect(screen.queryByTestId("guide-page")).not.toBeInTheDocument();+ });});