Add ability to filter multiple classes by shared property (#825)

* Add ability to filter multiple classes by shared property

* Update changelog

* Update .changeset/tall-shrimps-beg.md

Co-authored-by: Grigas <[email protected]>

* Adress comments

* Update api

* Update tests

* Update tests

* Update packages/components/src/presentation-components/instance-filter-builder/Utils.ts

Co-authored-by: Saulius Skliutas <[email protected]>

* Rename

---------

Co-authored-by: Grigas <[email protected]>
Co-authored-by: Saulius Skliutas <[email protected]>

Author: 3 people

.changeset/tall-shrimps-beg.md

@@ -0,0 +1,5 @@
+---
+"@itwin/presentation-components": minor
+---
+
+`PresentationInstanceFilterDialog` and `PresentationInstanceFilterBuilder`: Fix classes selector not being updated with all classes that contain selected property. `PresentationInstanceFilterPropertyInfo` now has `sourceClassIds` and `sourceClassId` is deprecated.

packages/components/api/presentation-components.api.md

@@ -463,7 +463,9 @@ export interface PresentationInstanceFilterPropertyInfo {
     className: string;
     field: PropertiesField;
     propertyDescription: PropertyDescription;
+    // @deprecated
     sourceClassId: ClassId;
+    sourceClassIds: ClassId[];
 }
 
 // @public

packages/components/src/presentation-components/instance-filter-builder/InstanceFilterBuilder.tsx

@@ -262,7 +262,7 @@ async function computePropertiesByClasses(
   const filteredProperties: PresentationInstanceFilterPropertyInfo[] = [];
   for (const prop of properties) {
     // property should be shown if at least one of selected classes is derived from property source class
-    if (ecClassInfos.some((info) => info && info.isDerivedFrom(prop.sourceClassId))) {
+    if (ecClassInfos.some((info) => info && prop.sourceClassIds.some((sourceClassId) => info.isDerivedFrom(sourceClassId)))) {
       filteredProperties.push(prop);
     }
   }
@@ -276,16 +276,23 @@ async function computeClassesByProperty(
   imodel: IModelConnection,
 ): Promise<ClassInfo[]> {
   const metadataProvider = getIModelMetadataProvider(imodel);
-  const propertyClass = await metadataProvider.getECClassInfo(property.sourceClassId);
+
+  const propertyClasses = (
+    await Promise.all(
+      property.sourceClassIds.map(async (sourceClassId) => {
+        return metadataProvider.getECClassInfo(sourceClassId);
+      }),
+    )
+  ).filter((propertyClass) => propertyClass !== undefined);
+
   /* c8 ignore next 3 */
-  if (!propertyClass) {
+  if (propertyClasses.length === 0) {
     return classes;
   }
 
   const classesWithProperty: ClassInfo[] = [];
   for (const currentClass of classes) {
-    // add classes that are derived from property source class
-    if (propertyClass.isBaseOf(currentClass.id)) {
+    if (propertyClasses.some((propertyClass) => propertyClass.isBaseOf(currentClass.id))) {
       classesWithProperty.push(currentClass);
     }
   }

packages/components/src/presentation-components/instance-filter-builder/PresentationFilterBuilder.tsx

@@ -61,7 +61,12 @@ export interface PresentationInstanceFilterPropertyInfo {
   field: PropertiesField;
   /** Property description  */
   propertyDescription: PropertyDescription;
-  /** Id of the class where this property is defined. */
+  /** Ids of the classes where this property is defined. */
+  sourceClassIds: ClassId[];
+  /**
+   * Id of the class where this property is defined.
+   * @deprecated in 5.8. Use [[sourceClassIds]] instead.
+   */
   sourceClassId: ClassId;
   /** Name of the class that was used to access this property. */
   className: string;

packages/components/src/presentation-components/instance-filter-builder/Utils.ts

@@ -41,15 +41,15 @@ export function getInstanceFilterFieldName(property: PropertyDescription) {
 /** @internal */
 export const DEFAULT_ROOT_CATEGORY_NAME = "/selected-item/";
 
-function getPropertySourceClassInfo(field: PropertiesField | NestedContentField): ClassInfo {
+function getPropertySourceClassInfos(field: PropertiesField | NestedContentField): ClassInfo[] {
   if (field.parent) {
-    return getPropertySourceClassInfo(field.parent);
+    return getPropertySourceClassInfos(field.parent);
   }
 
   if (field.isPropertiesField()) {
-    return field.properties[0].property.classInfo;
+    return field.properties.map((fieldProperty) => fieldProperty.property.classInfo);
   }
-  return field.pathToPrimaryClass[field.pathToPrimaryClass.length - 1].targetClassInfo;
+  return [field.pathToPrimaryClass[field.pathToPrimaryClass.length - 1].targetClassInfo];
 }
 
 function getPropertyClassInfo(field: PropertiesField): ClassInfo {
@@ -112,9 +112,11 @@ export function createPropertyInfoFromPropertiesField(field: PropertiesField): P
     koqName: field.properties[0].property.kindOfQuantity?.name,
   });
 
+  const sourceClassIds = getPropertySourceClassInfos(field).map((classInfo) => classInfo.id);
   return {
     field,
-    sourceClassId: getPropertySourceClassInfo(field).id,
+    sourceClassIds,
+    sourceClassId: sourceClassIds[0],
     propertyDescription,
     categoryLabel: categoryInfo.label,
     className: getPropertyClassInfo(field).name,

packages/components/src/test/_helpers/Common.ts

@@ -119,6 +119,7 @@ export function stubRaf() {
 
 export const createTestPresentationInstanceFilterPropertyInfo = (props?: Partial<PresentationInstanceFilterPropertyInfo>) => ({
   sourceClassId: "0x1",
+  sourceClassIds: ["0x1"],
   field: createTestPropertiesContentField({ properties: [{ property: createTestPropertyInfo() }], category: createTestCategoryDescription() }),
   propertyDescription: {
     name: "TestName",

packages/components/src/test/instance-filter-builder/IntanceFilterBuilder.test.tsx

@@ -231,6 +231,15 @@ describe("usePresentationInstanceFilteringProps", () => {
     label: "ConcreteField2",
     category,
   });
+  const mergedPropertiesField = createTestPropertiesContentField({
+    properties: [
+      { property: { classInfo: concreteClass1, name: "mergedProp", type: "string" } },
+      { property: { classInfo: concreteClass2, name: "mergedProp", type: "string" } },
+    ],
+    name: "mergedField",
+    label: "MergedField",
+    category,
+  });
   const derivedPropertiesField = createTestPropertiesContentField({
     properties: [{ property: { classInfo: derivedClass, name: "derivedProp", type: "string" } }],
     name: "derivedField",
@@ -243,7 +252,7 @@ describe("usePresentationInstanceFilteringProps", () => {
       { selectClassInfo: concreteClass2, isSelectPolymorphic: false },
     ],
     categories: [category],
-    fields: [basePropertiesField, concretePropertiesField1, concretePropertiesField2, derivedPropertiesField],
+    fields: [basePropertiesField, concretePropertiesField1, concretePropertiesField2, mergedPropertiesField, derivedPropertiesField],
   });
 
   const onCloseEvent = new BeEvent<() => void>();
@@ -350,7 +359,7 @@ describe("usePresentationInstanceFilteringProps", () => {
       act(() => {
         result.current.onSelectedClassesChanged([concreteClass2.id]);
       });
-      await waitFor(() => expect(result.current.properties).to.have.lengthOf(2));
+      await waitFor(() => expect(result.current.properties).to.have.lengthOf(3));
     });
 
     it("return all properties when selected class contains all available properties", async () => {
@@ -414,6 +423,17 @@ describe("usePresentationInstanceFilteringProps", () => {
       await waitFor(() => expect(result.current.selectedClasses).to.have.lengthOf(2).and.containSubset([concreteClass1, concreteClass2]));
     });
 
+    it("selects all classes that have selected property", async () => {
+      const { result } = renderHook((props: HookProps) => usePresentationInstanceFilteringProps(props.descriptor, props.imodel), { initialProps });
+
+      const property = result.current.properties.find((prop) => prop.displayLabel === mergedPropertiesField.label) as PropertyDescription;
+
+      act(() => {
+        result.current.onRulePropertySelected(property);
+      });
+      await waitFor(() => expect(result.current.selectedClasses).to.have.lengthOf(2).and.containSubset([concreteClass1, concreteClass2]));
+    });
+
     it("does not change selected classes when selected property class is already selected", async () => {
       const { result } = renderHook((props: HookProps) => usePresentationInstanceFilteringProps(props.descriptor, props.imodel), { initialProps });
 

packages/components/src/test/instance-filter-builder/Utils.test.snap

@@ -38,6 +38,9 @@ Array [
       "typename": "string",
     },
     "sourceClassId": "0x1",
+    "sourceClassIds": Array [
+      "0x1",
+    ],
   },
   Object {
     "categoryLabel": "Root Category | Nested Category 2 | Nested Category 2 1",
@@ -75,6 +78,9 @@ Array [
       "typename": "string",
     },
     "sourceClassId": "0x1",
+    "sourceClassIds": Array [
+      "0x1",
+    ],
   },
 ]
 `;
@@ -117,6 +123,9 @@ Array [
       "typename": "string",
     },
     "sourceClassId": "0x1",
+    "sourceClassIds": Array [
+      "0x1",
+    ],
   },
   Object {
     "categoryLabel": "Root Category",
@@ -163,6 +172,9 @@ Array [
       "typename": "string",
     },
     "sourceClassId": "0x1",
+    "sourceClassIds": Array [
+      "0x1",
+    ],
   },
 ]
 `;
@@ -205,6 +217,9 @@ Array [
       "typename": "string",
     },
     "sourceClassId": "0x2",
+    "sourceClassIds": Array [
+      "0x2",
+    ],
   },
   Object {
     "categoryLabel": "Root Category",
@@ -242,6 +257,9 @@ Array [
       "typename": "string",
     },
     "sourceClassId": "0x2",
+    "sourceClassIds": Array [
+      "0x2",
+    ],
   },
 ]
 `;