Merge branch 'tree-widget/next' into JonasD/use-visibility-methods-from-categories-visibility-handler

Author: JonasDov

apps/performance-tests/src/tree-widget/CategoriesTree.test.ts

@@ -90,7 +90,7 @@ describe("categories tree", () => {
         showElements: false,
       };
       const idsCache = new CategoriesTreeIdsCache(imodelAccess, "3d");
-      const handler = createCategoriesTreeVisibilityHandler({ imodelAccess, idsCache, viewport, hierarchyConfig });
+      const handler = createCategoriesTreeVisibilityHandler({ imodelAccess, idsCache, viewport });
       const provider = createIModelHierarchyProvider({
         hierarchyDefinition: new CategoriesTreeDefinition({ idsCache, imodelAccess, viewType: "3d", hierarchyConfig }),
         imodelAccess,
@@ -149,7 +149,7 @@ describe("categories tree", () => {
         showElements: false,
       };
       const idsCache = new CategoriesTreeIdsCache(imodelAccess, "3d");
-      const handler = createCategoriesTreeVisibilityHandler({ imodelAccess, idsCache, viewport, hierarchyConfig });
+      const handler = createCategoriesTreeVisibilityHandler({ imodelAccess, idsCache, viewport });
       const provider = createIModelHierarchyProvider({
         hierarchyDefinition: new CategoriesTreeDefinition({ idsCache, imodelAccess, viewType: "3d", hierarchyConfig }),
         imodelAccess,

packages/itwin/tree-widget/src/test/trees/categories-tree/internal/CategoriesTreeVisibilityHandler.test.ts

@@ -43,11 +43,12 @@ import {
 } from "./Utils.js";
 import { validateHierarchyVisibility } from "./VisibilityValidation.js";
 
-import type { VisibilityExpectations } from "./VisibilityValidation.js";
-import type { InstanceKey } from "@itwin/presentation-common";
 import type { IModelConnection, Viewport } from "@itwin/core-frontend";
-import type { CategoriesTreeHierarchyConfiguration } from "../../../../tree-widget-react/components/trees/categories-tree/CategoriesTreeDefinition.js";
+import type { InstanceKey } from "@itwin/presentation-common";
 import type { GroupingHierarchyNode, HierarchyNodeIdentifiersPath, NonGroupingHierarchyNode } from "@itwin/presentation-hierarchies";
+import type { CategoriesTreeHierarchyConfiguration } from "../../../../tree-widget-react/components/trees/categories-tree/CategoriesTreeDefinition.js";
+import type { VisibilityExpectations } from "./VisibilityValidation.js";
+
 describe("CategoriesTreeVisibilityHandler", () => {
   before(async () => {
     await initializePresentationTesting({
@@ -169,6 +170,7 @@ describe("CategoriesTreeVisibilityHandler", () => {
         expectations: "all-hidden",
       });
     });
+
     describe("definitionContainers", () => {
       it("showing definition container makes it and all of its contained elements visible", async function () {
         await using buildIModelResult = await buildIModel(this, async (builder) => {
@@ -259,13 +261,13 @@ describe("CategoriesTreeVisibilityHandler", () => {
           handler,
           viewport,
           expectations: {
-            [keys.definitionContainerRoot2.id]: "hidden",
             [keys.definitionContainerRoot.id]: "visible",
             [keys.definitionContainerChild.id]: "visible",
-            [keys.category2.id]: "hidden",
             [keys.indirectCategory.id]: "visible",
-            [keys.subCategory2.id]: "hidden",
             [keys.indirectSubCategory.id]: "visible",
+            [keys.definitionContainerRoot2.id]: "hidden",
+            [keys.category2.id]: "hidden",
+            [keys.subCategory2.id]: "hidden",
           },
         });
       });
@@ -780,44 +782,6 @@ describe("CategoriesTreeVisibilityHandler", () => {
       });
     });
 
-    describe("hideSubCategories set to true", () => {
-      it("showing subCategory does not do anything", async function () {
-        await using buildIModelResult = await buildIModel(this, async (builder) => {
-          const physicalModel = insertPhysicalModelWithPartition({ builder, codeValue: "TestPhysicalModel" });
-          const definitionContainerRoot = insertDefinitionContainer({ builder, codeValue: "DefinitionContainerRoot" });
-          const definitionModelRoot = insertSubModel({ builder, classFullName: CLASS_NAME_DefinitionModel, modeledElementId: definitionContainerRoot.id });
-
-          const category = insertSpatialCategory({ builder, codeValue: "SpatialCategory", modelId: definitionModelRoot.id });
-          insertPhysicalElement({ builder, modelId: physicalModel.id, categoryId: category.id });
-          const subCategory = insertSubCategory({
-            builder,
-            parentCategoryId: category.id,
-            codeValue: "subCategory",
-            modelId: definitionModelRoot.id,
-          });
-          return { category, subCategory, definitionContainerRoot, physicalModel };
-        });
-
-        const { imodel, ...keys } = buildIModelResult;
-
-        using visibilityTestData = await createVisibilityTestData({
-          imodel,
-          ...getModelAndCategoryIds(keys),
-          hierarchyConfig: { hideSubCategories: true },
-        });
-        const { handler, provider, viewport } = visibilityTestData;
-        setupInitialDisplayState({ viewport, ...createHiddenTestData(keys) });
-
-        await handler.changeVisibility(createSubCategoryHierarchyNode(keys.subCategory.id, keys.category.id), true);
-        await validateHierarchyVisibility({
-          provider,
-          handler,
-          viewport,
-          expectations: "all-hidden",
-        });
-      });
-    });
-
     describe("showElements set to true", () => {
       describe("definitionContainers", () => {
         it("showing definition container makes it and all of its contained elements visible", async function () {
@@ -1790,9 +1754,7 @@ describe("CategoriesTreeVisibilityHandler", () => {
                   elementId: ids.subModelElement?.id,
                 }),
               expectations: (ids: IModelWithSubModelIds) => ({
-                // This happens because changing element state does not turn on category visiblity, it only turns on model display if it is off.
-                // Since subModelCategory is also displayed at tree root (it does not have children) it's visibility remains hidden.
-                [ids.subModelCategory?.id ?? ""]: "hidden",
+                [ids.subModelCategory?.id ?? ""]: "visible",
                 [`${ids.modeledElement.id}-${ids.subModelCategory?.id ?? ""}`]: "visible",
                 [ids.category.id]: "partial",
                 [ids.modeledElement.id]: "partial",
@@ -2664,38 +2626,6 @@ describe("CategoriesTreeVisibilityHandler", () => {
       });
     });
 
-    describe("hideSubCategories set to true", () => {
-      it("showing subCategory does not do anything", async function () {
-        await using buildIModelResult = await buildIModel(this, async (builder) => {
-          const physicalModel = insertPhysicalModelWithPartition({ builder, codeValue: "TestPhysicalModel" });
-          const definitionContainerRoot = insertDefinitionContainer({ builder, codeValue: "DefinitionContainerRoot" });
-          const definitionModelRoot = insertSubModel({ builder, classFullName: CLASS_NAME_DefinitionModel, modeledElementId: definitionContainerRoot.id });
-
-          const category = insertSpatialCategory({ builder, codeValue: "SpatialCategory", modelId: definitionModelRoot.id });
-          insertPhysicalElement({ builder, modelId: physicalModel.id, categoryId: category.id });
-          const subCategory = insertSubCategory({
-            builder,
-            parentCategoryId: category.id,
-            codeValue: "subCategory",
-            modelId: definitionModelRoot.id,
-          });
-          return { category, subCategory, definitionContainerRoot, physicalModel };
-        });
-
-        const { imodel, ...keys } = buildIModelResult;
-        using visibilityTestData = await createVisibilityTestData({ imodel, ...getModelAndCategoryIds(keys), hierarchyConfig: { hideSubCategories: true } });
-        const { handler, provider, viewport } = visibilityTestData;
-        setupInitialDisplayState({ viewport });
-
-        await handler.changeVisibility(createSubCategoryHierarchyNode(keys.subCategory.id, keys.category.id), true);
-        await validateHierarchyVisibility({
-          provider,
-          handler,
-          viewport,
-          expectations: "all-visible",
-        });
-      });
-    });
     describe("disabling category visibility through overrides", () => {
       it("category is hidden when only one model contains category and override is set to 'Hide'", async function () {
         await using buildIModelResult = await buildIModel(this, async (builder) => {

packages/itwin/tree-widget/src/tree-widget-react/components/trees/categories-tree/UseCategoriesTree.tsx

@@ -19,16 +19,16 @@ import { CategoriesTreeIdsCache } from "./internal/CategoriesTreeIdsCache.js";
 import { createCategoriesTreeVisibilityHandler } from "./internal/CategoriesTreeVisibilityHandler.js";
 import { useFilteredPaths } from "./internal/UseFilteredPaths.js";
 
-import type { CreateCacheProps } from "../common/internal/useTreeHooks/UseIdsCache.js";
-import type { CreateFactoryProps } from "../common/internal/useTreeHooks/UseCachedVisibility.js";
-import type { CategoriesTreeFilteringError } from "./internal/UseFilteredPaths.js";
 import type { ReactNode } from "react";
 import type { Id64Array } from "@itwin/core-bentley";
 import type { Viewport } from "@itwin/core-frontend";
 import type { PresentationHierarchyNode } from "@itwin/presentation-hierarchies-react";
+import type { CreateCacheProps } from "../common/internal/useTreeHooks/UseIdsCache.js";
+import type { CreateFactoryProps } from "../common/internal/useTreeHooks/UseCachedVisibility.js";
 import type { VisibilityTreeProps } from "../common/components/VisibilityTree.js";
 import type { VisibilityTreeRendererProps } from "../common/components/VisibilityTreeRenderer.js";
 import type { CategoryInfo } from "../common/CategoriesVisibilityUtils.js";
+import type { CategoriesTreeFilteringError } from "./internal/UseFilteredPaths.js";
 import type { CategoriesTreeHierarchyConfiguration } from "./CategoriesTreeDefinition.js";
 
 /** @beta */
@@ -79,7 +79,6 @@ export function useCategoriesTree({
   const { visibilityHandlerFactory, onFilteredPathsChanged } = useCategoriesCachedVisibility({
     activeView,
     getCache: getCategoriesTreeIdsCache,
-    hierarchyConfig: hierarchyConfiguration,
   });
 
   const getHierarchyDefinition = useCallback<VisibilityTreeProps["getHierarchyDefinition"]>(
@@ -114,17 +113,14 @@ export function useCategoriesTree({
   };
 }
 
-function createVisibilityHandlerFactory(
-  props: CreateFactoryProps<CategoriesTreeIdsCache, { hierarchyConfig: CategoriesTreeHierarchyConfiguration }>,
-): VisibilityTreeProps["visibilityHandlerFactory"] {
-  const { activeView, factoryProps, idsCacheGetter, filteredPaths } = props;
+function createVisibilityHandlerFactory(props: CreateFactoryProps<CategoriesTreeIdsCache, undefined>): VisibilityTreeProps["visibilityHandlerFactory"] {
+  const { activeView, idsCacheGetter, filteredPaths } = props;
   return ({ imodelAccess }) =>
     createCategoriesTreeVisibilityHandler({
       viewport: activeView,
       idsCache: idsCacheGetter(),
       imodelAccess,
       filteredPaths,
-      hierarchyConfig: factoryProps.hierarchyConfig,
     });
 }
 
@@ -174,19 +170,12 @@ function getSublabel(node: PresentationHierarchyNode) {
   return node.nodeData.extendedData?.description;
 }
 
-function useCategoriesCachedVisibility(props: {
-  activeView: Viewport;
-  getCache: () => CategoriesTreeIdsCache;
-  hierarchyConfig: CategoriesTreeHierarchyConfiguration;
-}) {
-  const { activeView, getCache, hierarchyConfig } = props;
-  const { visibilityHandlerFactory, filteredPaths, onFilteredPathsChanged } = useCachedVisibility<
-    CategoriesTreeIdsCache,
-    { hierarchyConfig: CategoriesTreeHierarchyConfiguration }
-  >({
+function useCategoriesCachedVisibility(props: { activeView: Viewport; getCache: () => CategoriesTreeIdsCache }) {
+  const { activeView, getCache } = props;
+  const { visibilityHandlerFactory, filteredPaths, onFilteredPathsChanged } = useCachedVisibility<CategoriesTreeIdsCache, undefined>({
     activeView,
     getCache,
-    factoryProps: useMemo(() => ({ hierarchyConfig }), [hierarchyConfig]),
+    factoryProps: undefined,
     createFactory: createVisibilityHandlerFactory,
   });