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
Add Data Studio guide page and reorganize sidebar navigation (#76707)
Maz Ameli662e74ba16f4
diff --git a/e2e/support/helpers/e2e-data-studio-helpers.ts b/e2e/support/helpers/e2e-data-studio-helpers.tsindex 1ac09958c62..d7835e25d86 100644--- a/e2e/support/helpers/e2e-data-studio-helpers.ts+++ b/e2e/support/helpers/e2e-data-studio-helpers.ts@@ -21,6 +21,11 @@ export const DataStudio = {breadcrumbs: () => cy.findByTestId("data-studio-breadcrumbs"),Transforms: {header: () => cy.findByTestId("transforms-header"),+ sectionHeader: () => cy.findByTestId("transforms-section-header"),+ transformsTab: () =>+ DataStudio.Transforms.sectionHeader().findByText("Transforms"),+ jobsTab: () => DataStudio.Transforms.sectionHeader().findByText("Jobs"),+ runsTab: () => DataStudio.Transforms.sectionHeader().findByText("Runs"),list: () => cy.findByTestId("transforms-list"),saveChangesButton: () => DataStudio.Transforms.queryEditor().button("Save"),editTransform: () => cy.findByRole("button", { name: "Edit" }),diff --git a/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts b/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.tsindex 50e8b9875a5..b0ae7a203a0 100644--- a/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts@@ -99,7 +99,7 @@ describe("Table editing", () => {TablePicker.getTable("Orders").findByTestId("table-published").should("not.exist");- H.DataStudio.nav().findByLabelText("Library").click();+ H.DataStudio.nav().findByLabelText("Semantic layer").click();H.DataStudio.Library.allTableItems().should("have.length", 0);},);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 fbfbc26a2aa..b30edbbd275 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@@ -49,7 +49,7 @@ describe("scenarios > data studio > library", () => {event: "data_studio_opened",triggered_from: "nav_menu",});- H.DataStudio.nav().findByLabelText("Library").click();+ H.DataStudio.nav().findByLabelText("Semantic layer").click();cy.log("Create library via inline empty state");H.DataStudio.Library.libraryPage().within(() => {diff --git a/e2e/test/scenarios/data-studio/snippets.cy.spec.ts b/e2e/test/scenarios/data-studio/snippets.cy.spec.tsindex 13d4e7a31bf..3f877802e05 100644--- a/e2e/test/scenarios/data-studio/snippets.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/snippets.cy.spec.ts@@ -48,7 +48,7 @@ describe("scenarios > data studio > snippets", () => {cy.findByText(/by Bobby Tables/).should("be.visible");});- H.DataStudio.nav().findByRole("link", { name: "Library" }).click();+ H.DataStudio.nav().findByRole("link", { name: "Semantic layer" }).click();H.DataStudio.Library.libraryPage().findByText("Test snippet").should("be.visible");diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.tsindex b0476f79ef0..5e88e89e49b 100644--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts@@ -872,7 +872,9 @@ LIMITcy.wait("@createTag");cy.log("Navigate to transform B");- H.DataStudio.nav().findByRole("link", { name: "Transforms" }).click();+ H.DataStudio.nav()+ .findByRole("link", { name: "Data transformation" })+ .click();cy.findByRole("treegrid").findByText("Transform B").click();cy.log("Remove the new tag from transform B");@@ -1937,6 +1939,7 @@ LIMITgetRunButton().should("have.text", "Running now…");getRunStatus().should("have.text", "Run in progress…");+ H.DataStudio.breadcrumbs().findByText("Transforms").click();getRunsNavLink().click();getDetailedViewSwitch().click();getTransformRunTable().findByText("In progress").click();@@ -3124,6 +3127,8 @@ describe("scenarios > admin > transforms > jobs", () => {.findByText("Last ran a few seconds ago successfully.").should("be.visible");+ H.DataStudio.breadcrumbs().findByText("Jobs").click();+getRunsNavLink().click();getDetailedViewSwitch().click();getTransformRunTable().within(() => {@@ -3228,7 +3233,7 @@ describe("scenarios > admin > transforms > jobs", () => {.should("deep.equal", { active: true });H.DataStudio.Jobs.editor().findByText("Disabled").should("not.exist");- H.DataStudio.nav().findByRole("link", { name: "Jobs" }).click();+ H.DataStudio.breadcrumbs().findByText("Jobs").click();cy.log("bulk-disable: cancel from the modal does not fire the mutation");openBulkActionsMenu();@@ -3666,6 +3671,7 @@ describe("scenarios > admin > transforms > runs", () => {}createInitialData();+ H.DataStudio.breadcrumbs().findByText("Transforms").click();getRunsNavLink().click();getDetailedViewSwitch().click();testTransformFilter();@@ -3716,6 +3722,7 @@ describe("scenarios > admin > transforms > runs", () => {}createInitialData();+ H.DataStudio.breadcrumbs().findByText("Transforms").click();getRunsNavLink().click();getDetailedViewSwitch().click();@@ -3890,6 +3897,15 @@ describe("scenarios > admin > transforms", () => {cy.findByRole("link", { name: "View your database connections" }).should("exist",);+ cy.findByTestId("transforms-section-header")+ .findByRole("tab", { name: "Transforms" })+ .should("not.exist");+ cy.findByTestId("transforms-section-header")+ .findByRole("tab", { name: "Jobs" })+ .should("not.exist");+ cy.findByTestId("transforms-section-header")+ .findByRole("tab", { name: "Runs" })+ .should("not.exist");});});@@ -3904,11 +3920,11 @@ function verifyDisconnectedDatabaseBanner() {}function getTransformsNavLink() {- return H.DataStudio.nav().findByRole("link", { name: "Transforms" });+ return H.DataStudio.nav().findByRole("link", { name: "Data transformation" });}function getRunsNavLink() {- return H.DataStudio.nav().findByRole("link", { name: "Runs" });+ return H.DataStudio.Transforms.runsTab();}function getTransformsList() {@@ -4308,23 +4324,27 @@ describe("scenarios > data studio > transforms > permissions > oss", () => {H.DataStudio.nav().should("be.visible");cy.log("Verify Transforms menu item is visible");- H.DataStudio.nav().findByText("Transforms").should("be.visible");+ H.DataStudio.nav()+ .findByText("Data transformation")+ .should("be.visible")+ .click();cy.log("Verify no upsell gem icon is displayed in Transforms menu item");H.DataStudio.nav()- .findByText("Transforms")+ .findByText("Data transformation").closest("a").within(() => {cy.findByTestId("upsell-gem").should("not.exist");});cy.log("Verify transforms page is accessible");- H.DataStudio.nav().findByText("Transforms").click();H.DataStudio.Transforms.enableTransformPage().findByRole("button", { name: "Enable transforms" }).click();+ H.DataStudio.nav().findByText("Data transformation").click();+H.DataStudio.Transforms.list().should("be.visible");cy.log("Verify can create transforms in OSS");@@ -4376,20 +4396,22 @@ describe(H.DataStudio.nav().should("be.visible");cy.log("Verify Transforms menu item is visible");- H.DataStudio.nav().findByText("Transforms").should("be.visible");+ H.DataStudio.nav()+ .findByText("Data transformation")+ .should("be.visible");cy.log("Verify no upsell gem icon is displayed in Transforms menu item",);H.DataStudio.nav()- .findByText("Transforms")+ .findByText("Data transformation").closest("a").within(() => {cy.findByTestId("upsell-gem").should("not.exist");});cy.log("Verify transforms page is accessible");- H.DataStudio.nav().findByText("Transforms").click();+ H.DataStudio.nav().findByText("Data transformation").click();H.DataStudio.Transforms.enableTransformPage().findByRole("button", { name: "Enable transforms" }).click();diff --git a/e2e/test/scenarios/permissions/transforms-permissions.cy.spec.ts b/e2e/test/scenarios/permissions/transforms-permissions.cy.spec.tsindex 375b51ba1e2..6eb53a2c2ee 100644--- a/e2e/test/scenarios/permissions/transforms-permissions.cy.spec.ts+++ b/e2e/test/scenarios/permissions/transforms-permissions.cy.spec.ts@@ -424,5 +424,5 @@ function denyTransformsPermissionToAllGroups() {}function getTransformsNavLink() {- return H.DataStudio.nav().findByRole("link", { name: "Transforms" });+ return H.DataStudio.nav().findByRole("link", { name: "Data transformation" });}diff --git a/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.ts b/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.tsindex e9746cc5a55..13dff09eccc 100644--- a/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.ts+++ b/e2e/test/scenarios/schema-viewer/schema-viewer.cy.spec.ts@@ -514,7 +514,7 @@ describe("scenarios > schema-viewer (entry points + loader/error states)", () =>.should("be.visible");cy.log("Navigate to the Orders Data Model page via the table picker tree");- H.DataStudio.nav().findByText("Tables").click();+ H.DataStudio.nav().findByText("Connected data").click();cy.findAllByTestId("tree-item").contains("Orders").click();cy.log(@@ -551,7 +551,7 @@ describe("scenarios > schema-viewer (entry points + loader/error states)", () =>});req.continue();}).as("slowErd");- H.DataStudio.nav().findByLabelText("Library").click();+ H.DataStudio.nav().findByLabelText("Semantic layer").click();H.DataStudio.nav().findByLabelText("Schema viewer").click();H.miniPicker().findByText("Sample Database").click();H.miniPicker().findByText("PUBLIC").click();diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/GitSyncSetupMenuItem/GitSyncSetupMenuItem.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/GitSyncSetupMenuItem/GitSyncSetupMenuItem.tsxindex 9bd133d90e7..56e4df321e8 100644--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/GitSyncSetupMenuItem/GitSyncSetupMenuItem.tsx+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/GitSyncSetupMenuItem/GitSyncSetupMenuItem.tsx@@ -32,7 +32,7 @@ export const GitSyncSetupMenuItem = (props: GitSyncSetupMenuItemProps) => {onClick={onClick}p="0.5rem">- <FixedSizeIcon name="gear" className={S.icon} />+ <FixedSizeIcon name="git_branch" className={S.icon} />{isNavbarOpened && <Text lh="sm">{t`Set up remote sync`}</Text>}</UnstyledButton></Tooltip>diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/upsells/pages/TransformsUpsellPage/TransformsUpsellPage.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/upsells/pages/TransformsUpsellPage/TransformsUpsellPage.tsxindex 45c3866a39c..9db5467fb44 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/upsells/pages/TransformsUpsellPage/TransformsUpsellPage.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/upsells/pages/TransformsUpsellPage/TransformsUpsellPage.tsx@@ -5,12 +5,11 @@ import { jt, t } from "ttag";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import { DottedBackground } from "metabase/common/components/upsells/components/DottedBackground";import { LineDecorator } from "metabase/common/components/upsells/components/LineDecorator";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useMetadataToasts } from "metabase/metadata/hooks/useMetadataToasts";import { useSelector } from "metabase/redux";import { getStoreUsers } from "metabase/selectors/store-users";import { getUserIsAdmin } from "metabase/selectors/user";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import { EnableTransformsCard } from "metabase/transforms/pages/EnableTransformsPage/EnableTransformsCard";import { Button, Center, Flex, Text, Title } from "metabase/ui";import { reload } from "metabase/utils/dom";@@ -63,11 +62,7 @@ export function TransformsUpsellPage() {if (error || isLoading) {return (<DottedBackground px="3.5rem" pb="2rem">- <PaneHeader- breadcrumbs={- <DataStudioBreadcrumbs>{t`Transforms`}</DataStudioBreadcrumbs>- }- />+ <TransformsHeader showTabs={false} /><Center h="100%" bg="background_page-secondary"><LoadingAndErrorWrapperloading={isLoading}@@ -93,11 +88,7 @@ export function TransformsUpsellPage() {pb="2rem"style={{ display: "flex", flexDirection: "column" }}>- <PaneHeader- breadcrumbs={- <DataStudioBreadcrumbs>{t`Transforms`}</DataStudioBreadcrumbs>- }- />+ <TransformsHeader showTabs={false} /><Flex justify="center" pos="relative" flex={1} mt="lg"><LineDecorator pos="absolute" mah="100%"><EnableTransformsCarddiff --git a/frontend/src/metabase-types/api/user.ts b/frontend/src/metabase-types/api/user.tsindex 3c4b454a6de..7037a48e019 100644--- a/frontend/src/metabase-types/api/user.ts+++ b/frontend/src/metabase-types/api/user.ts@@ -199,7 +199,7 @@ export type UserKeyValue =}| {namespace: "data_studio";- key: string;+ key: "isNavbarOpened" | "hasSeenGuide";value: boolean;}| {diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsxindex 41fc50d2393..80ff71147b5 100644--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/DataStudioLayout.tsx@@ -5,7 +5,11 @@ import DataStudioLogo from "assets/img/data-studio-logo.svg";import { useHasTokenFeature } from "metabase/common/hooks";import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";import { useDataStudioSettings } from "metabase/data-studio/settings/hooks";-import { AreaLayout, AreaTab } from "metabase/nav/components/AreaLayout";+import {+ AreaLayout,+ AreaTab,+ AreaTabGroup,+} from "metabase/nav/components/AreaLayout";import {PLUGIN_FEATURE_LEVEL_PERMISSIONS,PLUGIN_REMOTE_SYNC,@@ -52,71 +56,86 @@ export function DataStudioLayout() {const shouldShowTransforms = canUseTransforms || !isTransformsSetupComplete;const settings = useDataStudioSettings();-const currentTab = getCurrentTab(pathname);const upperNav = (<><AreaTab- label={t`Library`}- icon="repository"- to={Urls.dataStudioLibrary()}- isSelected={currentTab === "library"}- showLabel={isNavbarOpened}- isGated={!hasLibraryFeature}- rightSection={- hasDirtyChanges && PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (- <PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />- ) : null- }- />- {canAccessDataModel && (- <AreaTab- label={t`Tables`}- icon="open_folder"- to={Urls.dataStudioData()}- isSelected={currentTab === "data"}- showLabel={isNavbarOpened}- />- )}- <AreaTab- label={t`Schema viewer`}- icon="network"- to={Urls.dataStudioSchemaViewer()}- isSelected={currentTab === "schema-viewer"}- showLabel={isNavbarOpened}- isGated={!hasSchemaViewerFeature}- />- <AreaTab- label={t`Dependency graph`}- icon="dependencies"- to={Urls.dependencyGraph()}- isSelected={currentTab === "dependencies"}+ label={t`Guide`}+ icon="book_open"+ to={Urls.dataStudioGuide()}+ isSelected={currentTab === "guide"}showLabel={isNavbarOpened}- isGated={!hasDependenciesFeature}/>- {shouldShowTransforms && (++ <AreaTabGroup label={t`Data`} showLabel={isNavbarOpened}>+ {canAccessDataModel && (+ <AreaTab+ label={t`Connected data`}+ icon="database"+ to={Urls.dataStudioData()}+ isSelected={currentTab === "data"}+ showLabel={isNavbarOpened}+ />+ )}+ {shouldShowTransforms && (+ <AreaTab+ label={t`Data transformation`}+ icon="transform"+ to={Urls.transformList()}+ isSelected={currentTab === "transforms"}+ showLabel={isNavbarOpened}+ rightSection={+ hasTransformDirtyChanges &&+ PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (+ <PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />+ ) : null+ }+ />+ )}+ </AreaTabGroup>++ <AreaTabGroup label={t`Library`} showLabel={isNavbarOpened}><AreaTab- label={t`Transforms`}- icon="transform"- to={Urls.transformList()}- isSelected={currentTab === "transforms"}+ label={t`Semantic layer`}+ icon="repository"+ to={Urls.dataStudioLibrary()}+ isSelected={currentTab === "library"}showLabel={isNavbarOpened}+ isGated={!hasLibraryFeature}rightSection={- hasTransformDirtyChanges &&- PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (+ hasDirtyChanges && PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge ? (<PLUGIN_REMOTE_SYNC.CollectionSyncStatusBadge />) : null}/>- )}- <AreaTab- label={t`Glossary`}- icon="glossary"- to={Urls.dataStudioGlossary()}- isSelected={currentTab === "glossary"}- showLabel={isNavbarOpened}- />+ <AreaTab+ label={t`Glossary`}+ icon="glossary"+ to={Urls.dataStudioGlossary()}+ isSelected={currentTab === "glossary"}+ showLabel={isNavbarOpened}+ />+ </AreaTabGroup>++ <AreaTabGroup label={t`Tools`} showLabel={isNavbarOpened}>+ <AreaTab+ label={t`Schema viewer`}+ icon="network"+ to={Urls.dataStudioSchemaViewer()}+ isSelected={currentTab === "schema-viewer"}+ showLabel={isNavbarOpened}+ isGated={!hasSchemaViewerFeature}+ />+ <AreaTab+ label={t`Dependency graph`}+ icon="dependencies"+ to={Urls.dependencyGraph()}+ isSelected={currentTab === "dependencies"}+ showLabel={isNavbarOpened}+ isGated={!hasDependenciesFeature}+ />+ </AreaTabGroup></>);@@ -135,32 +154,14 @@ export function DataStudioLayout() {</>) : (<AreaTab- label={t`Set up remote sync`}- icon="gear"+ label={t`Remote sync`}+ icon="git_branch"to={Urls.dataStudioGitSync()}isSelected={currentTab === "git-sync"}showLabel={isNavbarOpened}isGated/>)}- {canUseTransforms && (- <AreaTab- label={t`Jobs`}- icon="clock"- to={Urls.transformJobList()}- isSelected={currentTab === "jobs"}- showLabel={isNavbarOpened}- />- )}- {canUseTransforms && (- <AreaTab- label={t`Runs`}- icon="play_outlined"- to={Urls.transformGraphRunList()}- isSelected={currentTab === "runs"}- showLabel={isNavbarOpened}- />- )}{settings.length > 0 && (<AreaTablabel={t`Settings`}diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/common.unit.spec.tsx b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/common.unit.spec.tsxindex 077981bcf46..6db46d7d86d 100644--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/common.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/common.unit.spec.tsx@@ -24,7 +24,7 @@ describe("DataStudioLayout", () => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- expect(screen.getByText("Tables")).toBeInTheDocument();+ expect(screen.getByText("Connected data")).toBeInTheDocument();});it("should render content area", async () => {@@ -38,35 +38,31 @@ describe("DataStudioLayout", () => {});});- describe("transforms nav tabs", () => {- it("shows Transforms but not Jobs or Runs when setup is incomplete", async () => {+ describe("transforms nav tab", () => {+ it("shows Data transformation when setup is incomplete", async () => {setup({ transformsSetupComplete: false, transformsEnabled: false });expect(await screen.findByTestId("data-studio-nav")).toBeInTheDocument();- expect(screen.getByLabelText("Transforms")).toBeInTheDocument();- expect(screen.queryByLabelText("Jobs")).not.toBeInTheDocument();- expect(screen.queryByLabelText("Runs")).not.toBeInTheDocument();+ expect(screen.getByLabelText("Data transformation")).toBeInTheDocument();});- it("hides Transforms, Jobs, and Runs when setup is complete but transforms are disabled", async () => {+ it("hides Data transformation when setup is complete but transforms are disabled", async () => {setup({ transformsSetupComplete: true, transformsEnabled: false });expect(await screen.findByTestId("data-studio-nav")).toBeInTheDocument();- expect(screen.queryByLabelText("Transforms")).not.toBeInTheDocument();- expect(screen.queryByLabelText("Jobs")).not.toBeInTheDocument();- expect(screen.queryByLabelText("Runs")).not.toBeInTheDocument();+ expect(+ screen.queryByLabelText("Data transformation"),+ ).not.toBeInTheDocument();});- it("shows Transforms, Jobs, and Runs when setup is complete and transforms are enabled", async () => {+ it("shows Data transformation when transforms are enabled", async () => {setup({ transformsSetupComplete: true, transformsEnabled: true });expect(await screen.findByTestId("data-studio-nav")).toBeInTheDocument();- expect(screen.getByLabelText("Transforms")).toBeInTheDocument();- expect(screen.getByLabelText("Jobs")).toBeInTheDocument();- expect(screen.getByLabelText("Runs")).toBeInTheDocument();+ expect(screen.getByLabelText("Data transformation")).toBeInTheDocument();});- it("shows Transforms for non-admins when setup is incomplete", async () => {+ it("shows Data transformation for non-admins when setup is incomplete", async () => {setup({isAdmin: false,transformsSetupComplete: false,@@ -74,11 +70,11 @@ describe("DataStudioLayout", () => {});expect(await screen.findByTestId("data-studio-nav")).toBeInTheDocument();- expect(screen.getByLabelText("Transforms")).toBeInTheDocument();+ expect(screen.getByLabelText("Data transformation")).toBeInTheDocument();expect(screen.queryByLabelText("Jobs")).not.toBeInTheDocument();});- it("hides transform tabs for non-admins without access when setup is complete", async () => {+ it("hides the transform nav tab for non-admins without access when setup is complete", async () => {setup({isAdmin: false,canAccessTransforms: false,@@ -87,12 +83,12 @@ describe("DataStudioLayout", () => {});expect(await screen.findByTestId("data-studio-nav")).toBeInTheDocument();- expect(screen.queryByLabelText("Transforms")).not.toBeInTheDocument();- expect(screen.queryByLabelText("Jobs")).not.toBeInTheDocument();- expect(screen.queryByLabelText("Runs")).not.toBeInTheDocument();+ expect(+ screen.queryByLabelText("Data transformation"),+ ).not.toBeInTheDocument();});- it("shows Jobs and Runs for non-admins with transform access when enabled", async () => {+ it("shows Data transformation for non-admins with transform access when enabled", async () => {setup({isAdmin: false,canAccessTransforms: true,@@ -101,12 +97,9 @@ describe("DataStudioLayout", () => {});expect(await screen.findByTestId("data-studio-nav")).toBeInTheDocument();- expect(screen.getByLabelText("Transforms")).toBeInTheDocument();- expect(screen.getByLabelText("Jobs")).toBeInTheDocument();- expect(screen.getByLabelText("Runs")).toBeInTheDocument();+ expect(screen.getByLabelText("Data transformation")).toBeInTheDocument();});});-describe("settings tab", () => {it("shows Settings for admins after transform setup is complete", async () => {setup({ isAdmin: true, transformsSetupComplete: true });diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/enterprise.unit.spec.tsx b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/enterprise.unit.spec.tsxindex 091504a43e8..e5c40cad9c1 100644--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/enterprise.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/tests/enterprise.unit.spec.tsx@@ -16,30 +16,28 @@ describe("DataStudioLayout", () => {jest.restoreAllMocks();});- describe("Set up remote sync button", () => {- it("should show Set up remote sync button when git settings is visible", async () => {+ describe("Remote sync button", () => {+ it("should show Remote sync button when git settings is visible", async () => {setup({ remoteSyncEnabled: false });await waitFor(() => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- expect(screen.getByLabelText("Set up remote sync")).toBeInTheDocument();+ expect(screen.getByLabelText("Remote sync")).toBeInTheDocument();});- it("should hide Set up remote sync button when git settings is not visible", async () => {+ it("should hide Remote sync button when git settings is not visible", async () => {setup({ ...DEFAULT_EE_SETTINGS, remoteSyncEnabled: true });await waitFor(() => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- expect(- screen.queryByLabelText("Set up remote sync"),- ).not.toBeInTheDocument();+ expect(screen.queryByLabelText("Remote sync")).not.toBeInTheDocument();});- it("should open modal when Set up remote sync button is clicked", async () => {+ it("should open modal when Remote sync button is clicked", async () => {setup({ ...DEFAULT_EE_SETTINGS, remoteSyncEnabled: false });await waitFor(() => {@@ -106,7 +104,7 @@ describe("DataStudioLayout", () => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- expect(screen.getByText("Library")).toBeInTheDocument();+ expect(screen.getByText("Semantic layer")).toBeInTheDocument();});it("should render GitSyncAppBarControls when sidebar is expanded", async () => {@@ -158,7 +156,7 @@ describe("DataStudioLayout", () => {remoteSyncTransforms: true,});- const transformsTab = await screen.findByLabelText("Transforms");+ const transformsTab = await screen.findByLabelText("Data transformation");await waitFor(() => {expect(within(transformsTab).getByTestId("remote-sync-status"),@@ -179,7 +177,7 @@ describe("DataStudioLayout", () => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- const transformsTab = screen.getByLabelText("Transforms");+ const transformsTab = screen.getByLabelText("Data transformation");expect(within(transformsTab).queryByTestId("remote-sync-status"),).not.toBeInTheDocument();@@ -198,7 +196,7 @@ describe("DataStudioLayout", () => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- const transformsTab = screen.getByLabelText("Transforms");+ const transformsTab = screen.getByLabelText("Data transformation");expect(within(transformsTab).queryByTestId("remote-sync-status"),).not.toBeInTheDocument();@@ -222,7 +220,7 @@ describe("DataStudioLayout", () => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- expect(screen.getByLabelText("Transforms")).toBeInTheDocument();+ expect(screen.getByLabelText("Data transformation")).toBeInTheDocument();});it("should show Transforms tab for a non-admin with transforms permission", async () => {@@ -237,7 +235,7 @@ describe("DataStudioLayout", () => {expect(screen.getByTestId("data-studio-nav")).toBeInTheDocument();});- expect(screen.getByLabelText("Transforms")).toBeInTheDocument();+ expect(screen.getByLabelText("Data transformation")).toBeInTheDocument();});it("should hide Transforms tab for a non-admin without transforms permission", async () => {diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.tsindex 2e09b37a4a6..7619c466892 100644--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.ts@@ -1,11 +1,10 @@import * as Urls from "metabase/urls";type TabName =+ | "guide"| "data"| "library"| "transforms"- | "jobs"- | "runs"| "dependencies"| "schema-viewer"| "glossary"@@ -14,25 +13,25 @@ type TabName =export const getCurrentTab = (pathname: string): TabName => {switch (true) {+ case pathname.startsWith(Urls.dataStudioGuide()):+ return "guide";case pathname.startsWith(Urls.dataStudioGlossary()):return "glossary";case pathname.startsWith(Urls.dataStudioGitSync()):return "git-sync";- case pathname.startsWith(Urls.transformJobList()):- return "jobs";case pathname.startsWith(Urls.dependencyGraph()):return "dependencies";case pathname.startsWith(Urls.dataStudioSchemaViewer()):return "schema-viewer";case pathname.startsWith(Urls.dataStudioLibrary()):return "library";- case pathname.startsWith(Urls.transformGraphRunList()):- return "runs";case pathname.startsWith(Urls.transformList()):return "transforms";+ case pathname.startsWith(Urls.dataStudioData()):+ return "data";case pathname.startsWith(Urls.dataStudioSettings()):return "settings";default:- return "data";+ return "guide";}};diff --git a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.tsindex 70825d733d4..cd03901d2bf 100644--- a/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts+++ b/frontend/src/metabase/data-studio/app/pages/DataStudioLayout/utils.unit.spec.ts@@ -2,26 +2,30 @@ import { getCurrentTab } from "./utils";describe("getCurrentTab", () => {it.each`- pathname | expectedTab- ${"/data-studio/glossary"} | ${"glossary"}- ${"/data-studio/glossary/some-path"} | ${"glossary"}- ${"/data-studio/transforms/jobs"} | ${"jobs"}- ${"/data-studio/transforms/jobs/123"} | ${"jobs"}- ${"/data-studio/transforms/jobs/new"} | ${"jobs"}- ${"/data-studio/dependencies"} | ${"dependencies"}- ${"/data-studio/dependencies?id=1&type=card"} | ${"dependencies"}- ${"/data-studio/library"} | ${"library"}- ${"/data-studio/library/collections/123"} | ${"library"}- ${"/data-studio/library/metrics/456"} | ${"library"}- ${"/data-studio/transforms/runs"} | ${"runs"}- ${"/data-studio/transforms/runs?page=2"} | ${"runs"}- ${"/data-studio/transforms"} | ${"transforms"}- ${"/data-studio/transforms/123"} | ${"transforms"}- ${"/data-studio/transforms/new/query"} | ${"transforms"}- ${"/data-studio/data"} | ${"data"}- ${"/data-studio/data/database/1"} | ${"data"}- ${"/data-studio/settings"} | ${"settings"}- ${"/data-studio"} | ${"data"}+ pathname | expectedTab+ ${"/data-studio/guide"} | ${"guide"}+ ${"/data-studio/glossary"} | ${"glossary"}+ ${"/data-studio/glossary/some-path"} | ${"glossary"}+ ${"/data-studio/transforms/jobs"} | ${"transforms"}+ ${"/data-studio/transforms/jobs/123"} | ${"transforms"}+ ${"/data-studio/transforms/jobs/new"} | ${"transforms"}+ ${"/data-studio/dependencies"} | ${"dependencies"}+ ${"/data-studio/dependencies?id=1&type=card"} | ${"dependencies"}+ ${"/data-studio/library"} | ${"library"}+ ${"/data-studio/library/collections/123"} | ${"library"}+ ${"/data-studio/library/metrics/456"} | ${"library"}+ ${"/data-studio/library/metrics/456/overview"} | ${"library"}+ ${"/data-studio/library/tables/42"} | ${"library"}+ ${"/data-studio/transforms/runs"} | ${"transforms"}+ ${"/data-studio/transforms/runs?page=2"} | ${"transforms"}+ ${"/data-studio/transforms"} | ${"transforms"}+ ${"/data-studio/transforms/123"} | ${"transforms"}+ ${"/data-studio/transforms/new/query"} | ${"transforms"}+ ${"/data-studio/data"} | ${"data"}+ ${"/data-studio/data/database/1"} | ${"data"}+ ${"/data-studio/schema-viewer"} | ${"schema-viewer"}+ ${"/data-studio"} | ${"guide"}+ ${"/data-studio/settings"} | ${"settings"}`("should return '$expectedTab' for pathname '$pathname'",({ pathname, expectedTab }) => {diff --git a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsx b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsxindex c621f11f70c..cde500d7530 100644--- a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsx+++ b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsx@@ -1,11 +1,10 @@import { t } from "ttag";import { Link } from "metabase/common/components/Link";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";import { PageContainer } from "metabase/common/data-studio/components/PageContainer";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useSelector } from "metabase/redux";import { getUser, getUserIsAdmin } from "metabase/selectors/user";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import { Button, Center, Icon, Stack, Text, Title } from "metabase/ui";import * as Urls from "metabase/urls";@@ -17,11 +16,7 @@ export function NoWritableDatabasesEmptyState() {return (<PageContainer data-testid="no-writable-databases-empty-state">- <PaneHeader- breadcrumbs={- <DataStudioBreadcrumbs>{t`Transforms`}</DataStudioBreadcrumbs>- }- />+ <TransformsHeader showTabs={false} /><Center flex={1}><Stack align="center" maw="30rem" gap="md"><Icon name="database" size={48} c="text-disabled" />diff --git a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsx b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsxindex d2ffbdeaf14..5b8df7f0db9 100644--- a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsx@@ -292,7 +292,13 @@ const assertEnableScreen = async () =>await screen.findByText("Customize and clean up your data"),).toBeInTheDocument();-const assertNoWritableDatabasesEmptyState = async () =>+const assertNoWritableDatabasesEmptyState = async () => {expect(await screen.findByText("No compatible database connection"),).toBeInTheDocument();+ expect(+ screen.queryByRole("tab", { name: "Transforms" }),+ ).not.toBeInTheDocument();+ expect(screen.queryByRole("tab", { name: "Jobs" })).not.toBeInTheDocument();+ expect(screen.queryByRole("tab", { name: "Runs" })).not.toBeInTheDocument();+};diff --git a/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.module.css b/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.module.cssnew file mode 100644index 00000000000..d4ab9263027--- /dev/null+++ b/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.module.css@@ -0,0 +1,14 @@+.page {+ flex: 1;+ overflow: auto;+}++.content {+ margin: 0 auto;+ max-width: 45rem;+ width: 100%;+}++.cardContent {+ padding: 2.5rem;+}diff --git a/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.tsx b/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.tsxnew file mode 100644index 00000000000..cb570c65643--- /dev/null+++ b/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.tsx@@ -0,0 +1,156 @@+import { type ReactNode, useEffect } from "react";+import { jt, t } from "ttag";++import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";+import { PageContainer } from "metabase/common/data-studio/components/PageContainer";+import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";+import { useHasTokenFeature } from "metabase/common/hooks";+import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";+import { usePageTitle } from "metabase/hooks/use-page-title";+import { Box, Card, Group, Icon, Stack, Text, Title } from "metabase/ui";+import type { IconName } from "metabase-types/api";++import S from "./GuidePage.module.css";++export function GuidePage() {+ usePageTitle(t`Guide`);+ useMarkGuideAsSeen();++ const hasLibraryFeature = useHasTokenFeature("library");++ return (+ <PageContainer className={S.page} gap={0}>+ <PaneHeader+ breadcrumbs={+ <DataStudioBreadcrumbs role="heading">{t`Guide`}</DataStudioBreadcrumbs>+ }+ />+ <Box className={S.content}>+ <Title mb="xl" order={2}>+ {t`Build your semantic layer in Data Studio`}+ </Title>++ <Card shadow="none" withBorder>+ <Stack className={S.cardContent} gap="2rem">+ <TransformsSection />+ {hasLibraryFeature ? (+ <SemanticLayerSection />+ ) : (+ <ConnectedDataSection />+ )}+ {hasLibraryFeature ? (+ <LibraryMetricsSection />+ ) : (+ <GlossarySection />+ )}+ </Stack>+ </Card>+ </Box>+ </PageContainer>+ );+}++function TransformsSection() {+ return (+ <GuideSection+ icon="transform"+ title={t`Transform your data to make it easier to query`}+ >+ {jt`Use ${(+ <strong key="transforms">{t`Transforms`}</strong>+ )} to write new tables to your database. Set up ${(+ <strong key="data">{t`Jobs`}</strong>+ )} to schedule transforms, and view each transform’s execution under ${(+ <strong key="jobs">{t`Runs`}</strong>+ )}`}+ </GuideSection>+ );+}++const SemanticLayerSection = () => (+ <GuideSection+ icon="repository"+ title={t`Publish query-ready tables to the Semantic Layer`}+ >+ {jt`Find all your tables in ${(+ <strong key="connected-data">{t`Connected data`}</strong>+ )}. To let people (and agents) know which tables they should prefer, publish tables to the ${(+ <strong key="semantic-layer">{t`Semantic layer`}</strong>+ )}. Use ${(+ <strong key="segments">{t`Segments`}</strong>+ )} to define canonical filters for these tables, and ${(+ <strong key="measures">{t`Measures`}</strong>+ )} for key aggregations.`}+ </GuideSection>+);++const LibraryMetricsSection = () => (+ <GuideSection icon="metric" title={t`Define key metrics and terms`}>+ {jt`Build on tables’ segments and measures to define important numbers like KPIs as ${(+ <strong key="metrics">{t`Metrics`}</strong>+ )}. Document terms in the ${(+ <strong key="glossary">{t`Glossary`}</strong>+ )} to help both your team and your agents understand what they’re looking at.`}+ </GuideSection>+);++// OSS sections+const ConnectedDataSection = () => (+ <GuideSection icon="database" title={t`Add context to your data`}>+ {jt`Find all your tables in ${(+ <strong key="connected-data">{t`Connected data`}</strong>+ )}. Add descriptions to tables and their fields. Use ${(+ <strong key="segments">{t`Segments`}</strong>+ )} to define canonical filters for these tables, and ${(+ <strong key="measures">{t`Measures`}</strong>+ )} for key aggregations.`}+ </GuideSection>+);++const GlossarySection = () => (+ <GuideSection icon="glossary" title={t`Define key terms in the Glossary`}>+ {jt`Document terms in the ${(+ <strong key="glossary">{t`Glossary`}</strong>+ )} to help both your team and your agents understand what they’re looking at.`}+ </GuideSection>+);++function useMarkGuideAsSeen() {+ const {+ value: hasSeenGuide,+ setValue: setHasSeenGuide,+ isLoading,+ } = useUserKeyValue({+ namespace: "data_studio",+ key: "hasSeenGuide",+ defaultValue: false,+ });++ useEffect(() => {+ if (!isLoading && !hasSeenGuide) {+ setHasSeenGuide(true);+ }+ }, [isLoading, hasSeenGuide, setHasSeenGuide]);+}++function GuideSection({+ icon,+ title,+ children,+}: {+ icon: IconName;+ title: string;+ children: ReactNode;+}) {+ return (+ <Box>+ <Group gap={8} align="center" mb={8} wrap="nowrap">+ <Icon name={icon} size={20} c="core-brand" />+ <Title order={3}>{title}</Title>+ </Group>+ <Stack gap="md">+ <Text c="text-secondary">{children}</Text>+ </Stack>+ </Box>+ );+}diff --git a/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.unit.spec.tsx b/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.unit.spec.tsxnew file mode 100644index 00000000000..0b2710834e7--- /dev/null+++ b/frontend/src/metabase/data-studio/guide/pages/GuidePage/GuidePage.unit.spec.tsx@@ -0,0 +1,99 @@+import fetchMock from "fetch-mock";++import { setupUserKeyValueEndpoints } from "__support__/server-mocks";+import { mockSettings } from "__support__/settings";+import { renderWithProviders, screen, waitFor } from "__support__/ui";+import { createMockState } from "metabase/redux/store/mocks";+import {+ createMockSettings,+ createMockTokenFeatures,+} from "metabase-types/api/mocks";++import { GuidePage } from "./GuidePage";++jest.mock("metabase/nav/components/AppSwitcher", () => ({+ AppSwitcher: () => <div data-testid="app-switcher" />,+}));++const HAS_SEEN_GUIDE_PATH =+ "path:/api/user-key-value/namespace/data_studio/key/hasSeenGuide";++interface SetupOpts {+ hasSeenGuide?: boolean;+ hasLibraryFeature?: boolean;+}++function setup({+ hasSeenGuide = false,+ hasLibraryFeature = false,+}: SetupOpts = {}) {+ setupUserKeyValueEndpoints({+ namespace: "data_studio",+ key: "hasSeenGuide",+ value: hasSeenGuide,+ });++ const state = createMockState({+ settings: mockSettings(+ createMockSettings({+ "token-features": createMockTokenFeatures({+ library: hasLibraryFeature,+ }),+ }),+ ),+ });++ renderWithProviders(<GuidePage />, { storeInitialState: state });+}++function wasVisitRecorded() {+ return fetchMock.callHistory.called(HAS_SEEN_GUIDE_PATH, { method: "PUT" });+}++describe("GuidePage", () => {+ it("records the visit the first time the guide is seen", async () => {+ setup({ hasSeenGuide: false });++ await waitFor(() => expect(wasVisitRecorded()).toBe(true));++ const [request] = fetchMock.callHistory.calls(HAS_SEEN_GUIDE_PATH, {+ method: "PUT",+ });+ expect(request?.options?.body).toBe(JSON.stringify({ value: true }));+ });++ it("does not re-record the visit when the guide was already seen", async () => {+ setup({ hasSeenGuide: true });++ expect(+ await screen.findByText("Build your semantic layer in Data Studio"),+ ).toBeInTheDocument();+ expect(wasVisitRecorded()).toBe(false);+ });++ it("renders the guide sections without the library feature", async () => {+ setup({ hasSeenGuide: true, hasLibraryFeature: false });++ expect(+ await screen.findByText("Transform your data to make it easier to query"),+ ).toBeInTheDocument();+ expect(screen.getByText("Add context to your data")).toBeInTheDocument();+ expect(+ screen.getByText("Define key terms in the Glossary"),+ ).toBeInTheDocument();+ });++ it("renders the guide sections with the library feature", async () => {+ setup({ hasSeenGuide: true, hasLibraryFeature: true });++ expect(+ await screen.findByText("Transform your data to make it easier to query"),+ ).toBeInTheDocument();+ expect(+ screen.getByText("Publish query-ready tables to the Semantic Layer"),+ ).toBeInTheDocument();+ expect(+ screen.getByText("Define key metrics and terms"),+ ).toBeInTheDocument();+ });+});diff --git a/frontend/src/metabase/data-studio/routes.tsx b/frontend/src/metabase/data-studio/routes.tsxindex 071e41ddeaa..ca209e89e4a 100644--- a/frontend/src/metabase/data-studio/routes.tsx+++ b/frontend/src/metabase/data-studio/routes.tsx@@ -1,4 +1,6 @@import { NotFound } from "metabase/common/components/ErrorPages";+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";+import { useUserKeyValue } from "metabase/common/hooks/use-user-key-value";import {PLUGIN_DEPENDENCIES,PLUGIN_FEATURE_LEVEL_PERMISSIONS,@@ -19,6 +21,7 @@ import * as Urls from "metabase/urls";import { getDataStudioMetadataRoutes } from "./data-model/routes";import { getDataStudioGlossaryRoutes } from "./glossary/routes";+import { GuidePage } from "./guide/pages/GuidePage/GuidePage";import { CanAccessDataModel, CanAccessDataStudio } from "./route-guards";import { getDataStudioSettingsRoutes } from "./settings/routes";@@ -82,6 +85,7 @@ export function getDataStudioRoutes(IsAdmin: RouteComponent) {<Route element={<CanAccessDataStudio />}><Route path="data-studio" lazy={dataStudioLayout}><Route index element={<DataStudioIndexRedirect />} />+ <Route path="guide" element={<GuidePage />} /><Route path="data" element={<CanAccessDataModel />}><Route lazy={dataSectionLayout}>{getDataStudioMetadataRoutes(IsAdmin)}@@ -137,9 +141,21 @@ export function getDataStudioDependencyDiagnosticsRedirects() {);}-function DataStudioIndexRedirect() {+export function DataStudioIndexRedirect() {const indexPath = useSelector(getIndexPath);- return <Navigate to={indexPath} replace />;+ const { value: hasSeenGuide, isLoading } = useUserKeyValue({+ namespace: "data_studio",+ key: "hasSeenGuide",+ defaultValue: false,+ });++ if (isLoading) {+ return <LoadingAndErrorWrapper loading />;+ }++ return (+ <Navigate to={hasSeenGuide ? indexPath : Urls.dataStudioGuide()} replace />+ );}function getIndexPath(state: State) {diff --git a/frontend/src/metabase/data-studio/routes.unit.spec.tsx b/frontend/src/metabase/data-studio/routes.unit.spec.tsxindex 92fcf87a176..29a8b761b20 100644--- a/frontend/src/metabase/data-studio/routes.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/routes.unit.spec.tsx@@ -1,6 +1,11 @@import { lazyLoaders } from "__support__/lazy-routes";+import { setupUserKeyValueEndpoints } from "__support__/server-mocks";+import { renderWithProviders, screen } from "__support__/ui";+import { createMockState } from "metabase/redux/store/mocks";+import { Route } from "metabase/router";+import { createMockUser } from "metabase-types/api/mocks";-import { getDataStudioRoutes } from "./routes";+import { DataStudioIndexRedirect, getDataStudioRoutes } from "./routes";const Guard = () => null;describe("data-studio routes", () => {@@ -15,3 +20,62 @@ describe("data-studio routes", () => {}});});++function setupIndexRedirect({+ hasSeenGuide,+ isAdmin = false,+}: {+ hasSeenGuide: boolean;+ isAdmin?: boolean;+}) {+ setupUserKeyValueEndpoints({+ namespace: "data_studio",+ key: "hasSeenGuide",+ value: hasSeenGuide,+ });++ 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" />}+ />+ </Route>+ </Route>,+ {+ withRouter: true,+ initialRoute: "/data-studio",+ storeInitialState: createMockState({+ currentUser: createMockUser({ is_superuser: isAdmin }),+ }),+ },+ );+}++describe("Data Studio index redirect", () => {+ it("sends first-time visitors to the guide without recording the visit itself", async () => {+ setupIndexRedirect({ hasSeenGuide: false, isAdmin: true });++ expect(await screen.findByTestId("guide-page")).toBeInTheDocument();+ expect(screen.queryByTestId("data-index")).not.toBeInTheDocument();+ });++ it("sends returning admins to their data index", async () => {+ setupIndexRedirect({ hasSeenGuide: true, isAdmin: true });++ expect(await screen.findByTestId("data-index")).toBeInTheDocument();+ expect(screen.queryByTestId("guide-page")).not.toBeInTheDocument();+ });++ it("sends returning non-admins to their computed index", async () => {+ setupIndexRedirect({ hasSeenGuide: true });++ expect(await screen.findByTestId("library-index")).toBeInTheDocument();+ expect(screen.queryByTestId("guide-page")).not.toBeInTheDocument();+ });+});diff --git a/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsx b/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsxindex 609256e9c94..dedf5b64b8d 100644--- a/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsx+++ b/frontend/src/metabase/nav/components/AreaLayout/AreaTabGroup.tsx@@ -18,7 +18,7 @@ export function AreaTabGroup({mb,}: AreaTabGroupProps) {return (- <Stack component="section" gap="0.75rem" mb={mb} aria-label={label}>+ <Stack component="section" gap="0" mb={mb} aria-label={label}>{showLabel && (<Text component="h4" className={S.groupHeading} px="sm">{label}diff --git a/frontend/src/metabase/transforms/components/JobHeader/JobHeader.tsx b/frontend/src/metabase/transforms/components/JobHeader/JobHeader.tsxindex ea15a8e1cce..b351b479adf 100644--- a/frontend/src/metabase/transforms/components/JobHeader/JobHeader.tsx+++ b/frontend/src/metabase/transforms/components/JobHeader/JobHeader.tsx@@ -62,6 +62,9 @@ export function JobHeader({py={0}breadcrumbs={<DataStudioBreadcrumbs>+ <Link key="data-transformation" to={Urls.transformList()}>+ {t`Data transformation`}+ </Link><Link key="transform-job-list" to={Urls.transformJobList()}>{t`Jobs`}</Link>diff --git a/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.tsx b/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.tsxindex 88adf8688a3..10dad936df2 100644--- a/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.tsx+++ b/frontend/src/metabase/transforms/components/TransformHeader/TransformHeader.tsx@@ -48,7 +48,7 @@ export function TransformHeader({data-testid="transforms-header"breadcrumbs={<DataStudioBreadcrumbs loading={isLoadingPath}>- <Link to={Urls.transformList()}>{t`Transforms`}</Link>+ <Link to={Urls.transformList()}>{t`Data transformation`}</Link>{path?.map((folder) => (<Linkkey={folder.id}diff --git a/frontend/src/metabase/transforms/components/TransformsHeader/TransformsHeader.tsx b/frontend/src/metabase/transforms/components/TransformsHeader/TransformsHeader.tsxnew file mode 100644index 00000000000..c89a9b44cb5--- /dev/null+++ b/frontend/src/metabase/transforms/components/TransformsHeader/TransformsHeader.tsx@@ -0,0 +1,60 @@+import { memo } from "react";+import { t } from "ttag";++import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";+import {+ PaneHeader,+ type PaneHeaderTab,+ PaneHeaderTabs,+} from "metabase/common/data-studio/components/PaneHeader";+import * as Urls from "metabase/urls";++import {+ isTransformsJobsRoute,+ isTransformsMainRoute,+ isTransformsRunsRoute,+} from "./utils";++type TransformsHeaderProps = {+ showMetabotButton?: boolean;+ showTabs?: boolean;+};++export const TransformsHeader = memo(function TransformsHeader({+ showMetabotButton,+ showTabs = true,+}: TransformsHeaderProps) {+ const tabs: PaneHeaderTab[] = [+ {+ label: t`Transforms`,+ to: Urls.transformList(),+ icon: "transform",+ isSelected: isTransformsMainRoute,+ },+ {+ label: t`Jobs`,+ to: Urls.transformJobList(),+ icon: "clock",+ isSelected: isTransformsJobsRoute,+ },+ {+ label: t`Runs`,+ to: Urls.transformGraphRunList(),+ icon: "play_outlined",+ isSelected: isTransformsRunsRoute,+ },+ ];++ return (+ <PaneHeader+ data-testid="transforms-section-header"+ breadcrumbs={+ <DataStudioBreadcrumbs>{t`Data transformation`}</DataStudioBreadcrumbs>+ }+ tabs={showTabs ? <PaneHeaderTabs tabs={tabs} /> : undefined}+ py={0}+ mb="md"+ showMetabotButton={showMetabotButton}+ />+ );+});diff --git a/frontend/src/metabase/transforms/components/TransformsHeader/index.ts b/frontend/src/metabase/transforms/components/TransformsHeader/index.tsnew file mode 100644index 00000000000..d90c9fbb2dc--- /dev/null+++ b/frontend/src/metabase/transforms/components/TransformsHeader/index.ts@@ -0,0 +1 @@+export { TransformsHeader } from "./TransformsHeader";diff --git a/frontend/src/metabase/transforms/components/TransformsHeader/utils.ts b/frontend/src/metabase/transforms/components/TransformsHeader/utils.tsnew file mode 100644index 00000000000..d0daac20900--- /dev/null+++ b/frontend/src/metabase/transforms/components/TransformsHeader/utils.ts@@ -0,0 +1,17 @@+import * as Urls from "metabase/urls";++export function isTransformsJobsRoute(pathname: string) {+ return pathname.startsWith(Urls.transformJobList());+}++export function isTransformsRunsRoute(pathname: string) {+ return pathname.startsWith(Urls.transformGraphRunList());+}++export function isTransformsMainRoute(pathname: string) {+ return (+ pathname.startsWith(Urls.transformList()) &&+ !isTransformsJobsRoute(pathname) &&+ !isTransformsRunsRoute(pathname)+ );+}diff --git a/frontend/src/metabase/transforms/components/TransformsHeader/utils.unit.spec.ts b/frontend/src/metabase/transforms/components/TransformsHeader/utils.unit.spec.tsnew file mode 100644index 00000000000..8fc18b56015--- /dev/null+++ b/frontend/src/metabase/transforms/components/TransformsHeader/utils.unit.spec.ts@@ -0,0 +1,51 @@+import {+ isTransformsJobsRoute,+ isTransformsMainRoute,+ isTransformsRunsRoute,+} from "./utils";++describe("TransformsHeader/utils", () => {+ describe("isTransformsMainRoute", () => {+ it.each`+ pathname | expected+ ${"/data-studio/transforms"} | ${true}+ ${"/data-studio/transforms/123"} | ${true}+ ${"/data-studio/transforms/new/query"} | ${true}+ ${"/data-studio/transforms/jobs"} | ${false}+ ${"/data-studio/transforms/jobs/123"} | ${false}+ ${"/data-studio/transforms/runs"} | ${false}+ ${"/data-studio/transforms/runs/individual"} | ${false}+ ${"/data-studio/library"} | ${false}+ `("returns $expected for $pathname", ({ pathname, expected }) => {+ expect(isTransformsMainRoute(pathname)).toBe(expected);+ });+ });++ describe("isTransformsRunsRoute", () => {+ // Both the grouped (/runs) and detailed (/runs/individual) views keep the+ // Runs tab selected.+ it.each`+ pathname | expected+ ${"/data-studio/transforms/runs"} | ${true}+ ${"/data-studio/transforms/runs?page=2"} | ${true}+ ${"/data-studio/transforms/runs/individual"} | ${true}+ ${"/data-studio/transforms/runs/individual?page=2"} | ${true}+ ${"/data-studio/transforms"} | ${false}+ ${"/data-studio/transforms/jobs"} | ${false}+ `("returns $expected for $pathname", ({ pathname, expected }) => {+ expect(isTransformsRunsRoute(pathname)).toBe(expected);+ });+ });++ describe("isTransformsJobsRoute", () => {+ it.each`+ pathname | expected+ ${"/data-studio/transforms/jobs"} | ${true}+ ${"/data-studio/transforms/jobs/123"} | ${true}+ ${"/data-studio/transforms/runs"} | ${false}+ ${"/data-studio/transforms"} | ${false}+ `("returns $expected for $pathname", ({ pathname, expected }) => {+ expect(isTransformsJobsRoute(pathname)).toBe(expected);+ });+ });+});diff --git a/frontend/src/metabase/transforms/pages/EnableTransformsPage/EnableTransformsPage.tsx b/frontend/src/metabase/transforms/pages/EnableTransformsPage/EnableTransformsPage.tsxindex c1a47daaddf..7480b2bba71 100644--- a/frontend/src/metabase/transforms/pages/EnableTransformsPage/EnableTransformsPage.tsx+++ b/frontend/src/metabase/transforms/pages/EnableTransformsPage/EnableTransformsPage.tsx@@ -1,11 +1,10 @@import { t } from "ttag";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";import { PageContainer } from "metabase/common/data-studio/components/PageContainer";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useSelector } from "metabase/redux";import { getUserIsAdmin } from "metabase/selectors/user";import { useSetting, useUpdateSettingMutation } from "metabase/settings";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import { Center, Text } from "metabase/ui";import { EnableTransformsCard } from "./EnableTransformsCard";@@ -24,11 +23,7 @@ export const EnableTransformsPage = () => {return (<PageContainer data-testid="enable-transform-page">- <PaneHeader- breadcrumbs={- <DataStudioBreadcrumbs>{t`Transforms`}</DataStudioBreadcrumbs>- }- />+ <TransformsHeader showTabs={false} /><Center><EnableTransformsCardonEnableClick={enableTransforms}diff --git a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsxindex 144a0c110b8..33e1d3e758e 100644--- a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx+++ b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx@@ -6,15 +6,14 @@ import { DateTime } from "metabase/common/components/DateTime";import { ForwardRefLink } from "metabase/common/components/Link";import { ListEmptyState } from "metabase/common/components/ListEmptyState";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";import { PageContainer } from "metabase/common/data-studio/components/PageContainer";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useSelector } from "metabase/redux";import { useNavigate } from "metabase/router";import { getUserIsAdmin } from "metabase/selectors/user";import { useSetting } from "metabase/settings";import { LockedTransformsBanner } from "metabase/transforms/components/LockedTransformsBanner/LockedTransformsBanner";import { TransformBadge } from "metabase/transforms/components/TransformBadge/TransformBadge";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import type { TreeTableColumnDef } from "metabase/ui";import {Button,@@ -120,11 +119,7 @@ export const JobListPage = () => {return (<PageContainer data-testid="transforms-job-list" gap={0}>- <PaneHeader- breadcrumbs={<DataStudioBreadcrumbs>{t`Jobs`}</DataStudioBreadcrumbs>}- py={0}- showMetabotButton- />+ <TransformsHeader showMetabotButton /><Stack style={{ overflow: "hidden" }}>{isMeterLocked && <LockedTransformsBanner />}<Flex gap="0.5rem">diff --git a/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx b/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsxindex 0de31c0e90f..ed2971f4613 100644--- a/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx+++ b/frontend/src/metabase/transforms/pages/NewTransformPage/NewTransformPage.tsx@@ -71,7 +71,7 @@ function NewTransformPage({ initialSource }: NewTransformPageProps) {breadcrumbs={<DataStudioBreadcrumbs><Link key="transform-list" to={Urls.transformList()}>- {t`Transforms`}+ {t`Data transformation`}</Link></DataStudioBreadcrumbs>}@@ -164,7 +164,7 @@ function NewTransformPageBody({breadcrumbs={<DataStudioBreadcrumbs><Link key="transform-list" to={Urls.transformList()}>- {t`Transforms`}+ {t`Data transformation`}</Link>{t`New transform`}</DataStudioBreadcrumbs>diff --git a/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx b/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsxindex c18e9ec85ed..ffdd45a960f 100644--- a/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx+++ b/frontend/src/metabase/transforms/pages/RunListPage/RunListPage.tsx@@ -1,7 +1,6 @@import { useDisclosure, useElementSize } from "@mantine/hooks";import cx from "classnames";import { useCallback, useLayoutEffect, useMemo, useState } from "react";-import { t } from "ttag";import {useListTransformRunsQuery,@@ -9,12 +8,11 @@ import {useListTransformsQuery,} from "metabase/api";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useLocation, useNavigate } from "metabase/router";import { useSetting } from "metabase/settings";import { DetailedViewSwitch } from "metabase/transforms/components/DetailedViewSwitch";import { LockedTransformsBanner } from "metabase/transforms/components/LockedTransformsBanner/LockedTransformsBanner";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import { POLLING_INTERVAL } from "metabase/transforms/constants";import { isActiveRunStatus } from "metabase/transforms/utils";import { Center, Flex, Group, Stack } from "metabase/ui";@@ -158,11 +156,7 @@ export function RunListPage() {data-testid="transforms-run-list"><Stack className={S.main} flex={1} px="3.5rem" pb="md" gap={0}>- <PaneHeader- breadcrumbs={<DataStudioBreadcrumbs>{t`Runs`}</DataStudioBreadcrumbs>}- py={0}- showMetabotButton- />+ <TransformsHeader showMetabotButton />{!data || isLoading || error != null ? (<Center h="100%"><LoadingAndErrorWrapper loading={isLoading} error={error} />diff --git a/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx b/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsxindex a6f99cdda46..63c51d832bb 100644--- a/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx+++ b/frontend/src/metabase/transforms/pages/TransformGraphRunListPage/TransformGraphRunListPage.tsx@@ -1,7 +1,6 @@import { useDisclosure, useElementSize } from "@mantine/hooks";import cx from "classnames";import { useCallback, useEffect, useMemo, useState } from "react";-import { t } from "ttag";import {useListTransformGraphRunsQuery,@@ -9,10 +8,9 @@ import {} from "metabase/api";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import { PaginationControls } from "metabase/common/components/PaginationControls";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useLocation, useNavigate } from "metabase/router";import { DetailedViewSwitch } from "metabase/transforms/components/DetailedViewSwitch";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import { POLLING_INTERVAL } from "metabase/transforms/constants";import { isActiveRunStatus } from "metabase/transforms/utils";import { Center, Flex, Group, Stack } from "metabase/ui";@@ -139,11 +137,7 @@ export function TransformGraphRunListPage() {data-testid="transform-graph-run-list"><Stack className={S.main} flex={1} px="3.5rem" pb="md" gap={0}>- <PaneHeader- breadcrumbs={<DataStudioBreadcrumbs>{t`Runs`}</DataStudioBreadcrumbs>}- py={0}- showMetabotButton- />+ <TransformsHeader showMetabotButton />{isLoading || error != null ? (<Center h="100%"><LoadingAndErrorWrapper loading={isLoading} error={error} />diff --git a/frontend/src/metabase/transforms/pages/TransformListPage/TransformListPage.tsx b/frontend/src/metabase/transforms/pages/TransformListPage/TransformListPage.tsxindex fa8c5da3672..cd349f59cd8 100644--- a/frontend/src/metabase/transforms/pages/TransformListPage/TransformListPage.tsx+++ b/frontend/src/metabase/transforms/pages/TransformListPage/TransformListPage.tsx@@ -13,9 +13,7 @@ import { Link } from "metabase/common/components/Link";import { ListEmptyState } from "metabase/common/components/ListEmptyState";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";-import { DataStudioBreadcrumbs } from "metabase/common/data-studio/components/DataStudioBreadcrumbs";import { PageContainer } from "metabase/common/data-studio/components/PageContainer";-import { PaneHeader } from "metabase/common/data-studio/components/PaneHeader";import { useHasTokenFeature } from "metabase/common/hooks";import CS from "metabase/css/core/index.css";import { PLUGIN_REPLACEMENT, PLUGIN_TRANSFORMS_PYTHON } from "metabase/plugins";@@ -23,6 +21,7 @@ import { useSelector } from "metabase/redux";import { Outlet, useLocation } from "metabase/router";import { useSetting } from "metabase/settings";import { LockedTransformsBanner } from "metabase/transforms/components/LockedTransformsBanner/LockedTransformsBanner";+import { TransformsHeader } from "metabase/transforms/components/TransformsHeader";import { useTransformPermissions } from "metabase/transforms/hooks/use-transform-permissions";import { getShouldShowPythonTransformsUpsell } from "metabase/transforms/selectors";import { Ellipsified } from "metabase/ui";@@ -325,13 +324,7 @@ export const TransformListPage = () => {return (<PageContainer data-testid="transforms-list" gap={0}>- <PaneHeader- breadcrumbs={- <DataStudioBreadcrumbs>{t`Transforms`}</DataStudioBreadcrumbs>- }- showMetabotButton- py={0}- />+ <TransformsHeader showMetabotButton /><Stack className={CS.overflowHidden}>{isMeterLocked && <LockedTransformsBanner />}<Flex gap="md">diff --git a/frontend/src/metabase/urls/data-studio.ts b/frontend/src/metabase/urls/data-studio.tsindex dfdedead635..280ba7cbf72 100644--- a/frontend/src/metabase/urls/data-studio.ts+++ b/frontend/src/metabase/urls/data-studio.ts@@ -56,6 +56,10 @@ export function dataStudio() {return ROOT_URL;}+export function dataStudioGuide() {+ return `${ROOT_URL}/guide`;+}+export function dataStudioData({databaseId,schemaName,diff --git a/frontend/src/metabase/urls/data-studio.unit.spec.ts b/frontend/src/metabase/urls/data-studio.unit.spec.tsindex 5880f4bd08e..5261330e9b8 100644--- a/frontend/src/metabase/urls/data-studio.unit.spec.ts+++ b/frontend/src/metabase/urls/data-studio.unit.spec.ts@@ -4,6 +4,7 @@ import {dataStudioDataModelSegment,dataStudioDataModelSegmentDependencies,dataStudioDataModelSegmentRevisions,+ dataStudioGuide,dataStudioLibrary,dataStudioTable,dataStudioTableFields,@@ -18,6 +19,12 @@ describe("urls > data-studio", () => {});});+ describe("dataStudioGuide", () => {+ it("should return guide URL", () => {+ expect(dataStudioGuide()).toBe("/data-studio/guide");+ });+ });+describe("dataStudioData", () => {it("should return base data URL when no params", () => {expect(dataStudioData()).toBe("/data-studio/data");