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
UXW-2629 Adjust library breadcrumb folder expansion behavior (#67862)
Gabriel Moreno117e2a22a30c
diff --git a/e2e/test/scenarios/data-studio/snippets.cy.spec.ts b/e2e/test/scenarios/data-studio/snippets.cy.spec.tsindex 0faef79c4c6..63fd4e9f007 100644--- a/e2e/test/scenarios/data-studio/snippets.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/snippets.cy.spec.ts@@ -255,4 +255,155 @@ describe("scenarios > data studio > snippets", () => {.should("not.exist");});});++ describe("breadcrumb folder expansion", () => {+ it("should only expand the relevant folder path when navigating back via breadcrumbs", () => {+ // Create nested folder structure: Parent Folder > Child Folder+ H.createSnippetFolder({+ name: "Parent Folder",+ }).then(({ body: parentFolder }) => {+ H.createSnippetFolder({+ name: "Child Folder",+ parent_id: Number(parentFolder.id),+ }).then(({ body: childFolder }) => {+ // Create a snippet in the child folder+ H.createSnippet({+ name: "Nested Snippet",+ content: "SELECT * FROM orders",+ collection_id: childFolder.id,+ });+ });+ });++ // Create a sibling folder with its own nested content+ // This folder should be visible but NOT expanded (its children hidden)+ H.createSnippetFolder({+ name: "Sibling Folder",+ }).then(({ body: siblingFolder }) => {+ H.createSnippet({+ name: "Sibling Snippet",+ content: "SELECT 2",+ collection_id: siblingFolder.id,+ });+ });++ H.DataStudio.Library.visit();++ cy.log("Verify all folders and their contents are initially expanded");+ H.DataStudio.Library.libraryPage()+ .findByText("Parent Folder")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Child Folder")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Sibling Folder")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Nested Snippet")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Sibling Snippet")+ .should("be.visible");++ cy.log("Navigate to the nested snippet");+ H.DataStudio.Library.libraryPage().findByText("Nested Snippet").click();+ H.DataStudio.Snippets.editPage().should("be.visible");++ cy.log("Click the Child Folder breadcrumb to go back to the library");+ H.DataStudio.breadcrumbs()+ .findByRole("link", { name: "Child Folder" })+ .click();++ cy.log(+ "Verify the path to Child Folder is expanded, but sibling folder is collapsed",+ );+ H.DataStudio.Library.libraryPage()+ .findByText("Parent Folder")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Child Folder")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Nested Snippet")+ .should("be.visible");+ // Sibling Folder is visible (it's a child of root which is expanded)+ H.DataStudio.Library.libraryPage()+ .findByText("Sibling Folder")+ .should("be.visible");+ // But Sibling Folder's contents should NOT be visible (folder is collapsed)+ H.DataStudio.Library.libraryPage()+ .findByText("Sibling Snippet")+ .should("not.exist");+ });++ it("should expand all folders when navigating directly to library without expandedId params", () => {+ // Create nested folder structure+ H.createSnippetFolder({+ name: "Folder A",+ });+ H.createSnippetFolder({+ name: "Folder B",+ });++ cy.log("Navigate directly to library (no expandedId params)");+ H.DataStudio.Library.visit();++ cy.log("Verify all folders are expanded by default");+ H.DataStudio.Library.libraryPage()+ .findByText("Folder A")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Folder B")+ .should("be.visible");+ });++ it("should expand parent folders when clicking a nested folder in breadcrumbs", () => {+ // Create deeply nested structure: GrandParent > Parent > Child+ H.createSnippetFolder({+ name: "GrandParent Folder",+ }).then(({ body: grandParentFolder }) => {+ H.createSnippetFolder({+ name: "Parent Folder",+ parent_id: Number(grandParentFolder.id),+ }).then(({ body: parentFolder }) => {+ H.createSnippetFolder({+ name: "Child Folder",+ parent_id: Number(parentFolder.id),+ }).then(({ body: childFolder }) => {+ H.createSnippet({+ name: "Deep Snippet",+ content: "SELECT 1",+ collection_id: childFolder.id,+ });+ });+ });+ });++ H.DataStudio.Library.visit();++ cy.log("Navigate to the deeply nested snippet");+ H.DataStudio.Library.libraryPage().findByText("Deep Snippet").click();+ H.DataStudio.Snippets.editPage().should("be.visible");++ cy.log(+ "Click the Parent Folder breadcrumb (middle of the path) to go back",+ );+ H.DataStudio.breadcrumbs()+ .findByRole("link", { name: "Parent Folder" })+ .click();++ cy.log("Verify the path up to Parent Folder is expanded");+ H.DataStudio.Library.libraryPage()+ .findByText("GrandParent Folder")+ .should("be.visible");+ H.DataStudio.Library.libraryPage()+ .findByText("Parent Folder")+ .should("be.visible");+ // Child Folder should still be visible since it's inside Parent Folder+ H.DataStudio.Library.libraryPage()+ .findByText("Child Folder")+ .should("be.visible");+ });+ });});diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/LibrarySectionLayout.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/LibrarySectionLayout.tsxindex 750d1c96726..619bbd9ada6 100644--- a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/LibrarySectionLayout.tsx+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/LibrarySectionLayout.tsx@@ -1,6 +1,7 @@import { useCallback, useMemo, useState } from "react";import { goBack, push } from "react-router-redux";import { t } from "ttag";+import _ from "underscore";import { useListCollectionsTreeQuery } from "metabase/api";import { isLibraryCollection } from "metabase/collections/utils";@@ -9,6 +10,7 @@ import { usePageTitle } from "metabase/hooks/use-page-title";import { useDispatch, useSelector } from "metabase/lib/redux";import * as Urls from "metabase/lib/urls";import { PLUGIN_SNIPPET_FOLDERS } from "metabase/plugins";+import { useRouter } from "metabase/router";import { getUserIsAdmin } from "metabase/selectors/user";import type { TreeTableColumnDef } from "metabase/ui";import {@@ -28,6 +30,7 @@ import {import { CreateLibraryModal } from "metabase-enterprise/data-studio/common/components/CreateLibraryModal";import { DataStudioBreadcrumbs } from "metabase-enterprise/data-studio/common/components/DataStudioBreadcrumbs";import { PaneHeader } from "metabase-enterprise/data-studio/common/components/PaneHeader";+import type { ExpandedState } from "metabase-enterprise/data-studio/data-model/components/TablePicker/types";import { ListEmptyState } from "metabase-enterprise/transforms/components/ListEmptyState";import type { Collection, CollectionId } from "metabase-types/api";@@ -45,6 +48,7 @@ import { getWritableCollection } from "./utils";export function LibrarySectionLayout() {usePageTitle(t`Library`);const dispatch = useDispatch();+ const { location } = useRouter();const [editingCollection, setEditingCollection] = useState<Collection | null>(null,);@@ -52,6 +56,20 @@ export function LibrarySectionLayout() {useState<CollectionId | null>(null);const [searchQuery, setSearchQuery] = useState("");+ const expandedIdsFromUrl = useMemo(() => {+ const rawIds = location.query?.expandedId;+ if (!rawIds) {+ return null;+ }++ const ids = Array.isArray(rawIds) ? rawIds : [rawIds];+ const expanded = _.object(+ ids.map((id) => [`collection:${id}`, true]),+ ) as ExpandedState;++ return expanded;+ }, [location.query?.expandedId]);+const { data: collections = [], isLoading: isLoadingCollections } =useListCollectionsTreeQuery({"exclude-other-user-collections": true,@@ -188,7 +206,7 @@ export function LibrarySectionLayout() {globalFilter: searchQuery,onGlobalFilterChange: setSearchQuery,isFilterable: (node) => node.model !== "collection",- defaultExpanded: true,+ defaultExpanded: expandedIdsFromUrl ?? true,onRowActivate: handleRowActivate,});diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/snippets/components/SnippetHeader/SnippetHeader.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/snippets/components/SnippetHeader/SnippetHeader.tsxindex f9a0106341f..ea7e95caef9 100644--- a/enterprise/frontend/src/metabase-enterprise/data-studio/snippets/components/SnippetHeader/SnippetHeader.tsx+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/snippets/components/SnippetHeader/SnippetHeader.tsx@@ -61,7 +61,7 @@ export function SnippetHeader({<Linkkey={collection.id}to={Urls.dataStudioLibrary({- expandedIds: path.slice(1, i + 1).map((c) => c.id),+ expandedIds: ["root", ...path.slice(0, i + 1).map((c) => c.id)],})}>{collection.name}