Add test which introduces a EntityClass that has a CA 'QueryView' and a navigation property to exercise ECReferenceTypesCache

.azure-pipelines/generate-docs.yaml

@@ -35,7 +35,7 @@ stages:
             versionSpec: 18
             checkLatest: true
 
-        - script: npm install -g pnpm@7.27.0
+        - script: npm install -g pnpm@9.14.2
           displayName: Install pnpm
 
         - script: pnpm install

.github/workflows/ci.yml

@@ -19,12 +19,12 @@ jobs:
     - name: Install pnpm
       uses: pnpm/action-setup@v4
       with:
-        version: 7.27.0
+        version: 9.14.2
 
-    - name: Use Node.js 18
+    - name: Use Node.js 20
       uses: actions/setup-node@v3
       with:
-        node-version: 18.16.0
+        node-version: 20.18.1
         cache: 'pnpm'
 
     - name: Install dependencies
@@ -46,12 +46,12 @@ jobs:
     - name: Install pnpm
       uses: pnpm/action-setup@v4
       with:
-        version: 7.27.0
+        version: 9.14.2
 
     - name: Use Node.js 18
       uses: actions/setup-node@v3
       with:
-        node-version: 18.16.0
+        node-version: 20.18.1
         cache: 'pnpm'
 
     - id: set-matrix
@@ -102,12 +102,12 @@ jobs:
     - name: Install pnpm
       uses: pnpm/action-setup@v4
       with:
-        version: 7.27.0
+        version: 9.14.2
 
-    - name: Use Node.js 18
+    - name: Use Node.js 20
       uses: actions/setup-node@v3
       with:
-        node-version: 18.16.0
+        node-version: 20.18.1
         cache: 'pnpm'
 
     - name: Force dependency resolution

.github/workflows/extract-api.yaml

@@ -33,12 +33,12 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 7.27.0
+          version: 9.14.2
 
-      - name: Use Node.js 18
+      - name: Use Node.js 20
         uses: actions/setup-node@v3
         with:
-          node-version: 18.16.0
+          node-version: 20.18.1
           cache: 'pnpm'
 
       - name: Pnpm install

.github/workflows/release-dev.yml

@@ -29,12 +29,12 @@ jobs:
     - name: Install pnpm
       uses: pnpm/action-setup@v4
       with:
-        version: 7.27.0
+        version: 9.14.2
 
     - name: Use Node.js 18
       uses: actions/setup-node@v3
       with:
-        node-version: 18.16.0
+        node-version: 20.18.1
         registry-url: https://registry.npmjs.org/
 
     - name: Install dependencies

.github/workflows/release.yml

@@ -22,7 +22,7 @@ jobs:
     - name: Use Node.js 18
       uses: actions/setup-node@v3
       with:
-        node-version: 18.16.0
+        node-version: 20.18.1
         registry-url: https://registry.npmjs.org/
 
     - name: Install dependencies

change/@itwin-imodel-transformer-0f5a9c89-c313-4e41-acd0-5e20e991c35f.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "handle queryViews with navigationProperties in the ECreferenceTypesCache",
+  "packageName": "@itwin/imodel-transformer",
+  "email": "22119573+nick4598@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}

package.json

@@ -43,8 +43,8 @@
     "node": ">=16"
   },
   "pnpm": {
-      "overrides": {
-        "semver": "^7.5.2"
-      }
+    "overrides": {
+      "semver": "^7.5.2"
+    }
   }
 }

packages/transformer/src/ECReferenceTypesCache.ts

@@ -6,7 +6,12 @@
  * @module iModels
  */
 
-import { DbResult, TupleKeyedMap } from "@itwin/core-bentley";
+import {
+  DbResult,
+  Logger,
+  StopWatch,
+  TupleKeyedMap,
+} from "@itwin/core-bentley";
 import {
   ConcreteEntityTypes,
   IModelError,
@@ -24,6 +29,7 @@ import {
 } from "@itwin/ecschema-metadata";
 import * as assert from "assert";
 import { IModelDb } from "@itwin/core-backend";
+import { TransformerLoggerCategory } from "./TransformerLoggerCategory";
 
 /** The context for transforming a *source* Element to a *target* Element and remapping internal identifiers to the target iModel.
  * @internal
@@ -54,6 +60,9 @@ export class ECReferenceTypesCache {
   >();
   private _initedSchemas = new Map<string, SchemaKey>();
 
+  private _cumulativeTimeSpentCheckingForQueryView: number = 0;
+  private _classesCheckedForQueryView: number = 0;
+
   private static bisRootClassToRefType: Record<
     string,
     ConcreteEntityTypes | undefined
@@ -140,6 +149,50 @@ export class ECReferenceTypesCache {
           throw new IModelError(status, "unexpected query failure");
       }
     );
+    Logger.logInfo(
+      TransformerLoggerCategory.IModelTransformer,
+      `Checked ${this._classesCheckedForQueryView} classes for QueryView custom attribute. This took ${this._cumulativeTimeSpentCheckingForQueryView}ms.`
+    );
+  }
+
+  /**
+   *
+   * @param cls the class to check for custom attributes
+   * @param isSource whether the class is the source or target class of a relationship
+   * @returns true if the class has a custom attribute that is a QueryView and no type found in the rootClassToRefType map
+   */
+  private hasQueryViewCustomAttributeAndNoRootClass(
+    cls: ECClass,
+    isSource: boolean,
+    rootClassToRefType?: ConcreteEntityTypes
+  ): boolean {
+    const stopwatch = new StopWatch(
+      "hasQueryViewCustomAttributeAndNoRootClass",
+      true
+    );
+    const sourceCAs = cls.getCustomAttributesSync();
+    this._classesCheckedForQueryView++;
+    for (const [customAttributeName, _customAttribute] of sourceCAs) {
+      /*
+       * Since queryViews are typically associated with abstract classes and have no specific table in the database, we can ignore them.
+       */
+      if (
+        customAttributeName.toLowerCase() === "ecdbmap.queryview" &&
+        rootClassToRefType === undefined
+      ) {
+        // no rootClassToRefType means the rootBisClass.name is not in the bisRootClassToRefType map.
+        Logger.logInfo(
+          TransformerLoggerCategory.IModelTransformer,
+          `${isSource ? "sourceClass" : "targetClass"}: ${cls.schema.name}:${cls.name} has customAttribute which is QueryView and no type found in the rootClassToRefType map`
+        );
+        this._cumulativeTimeSpentCheckingForQueryView +=
+          stopwatch.elapsed.milliseconds;
+        return true;
+      }
+    }
+    this._cumulativeTimeSpentCheckingForQueryView +=
+      stopwatch.elapsed.milliseconds;
+    return false;
   }
 
   private async considerInitSchema(schema: Schema): Promise<void> {
@@ -221,6 +274,24 @@ export class ECReferenceTypesCache {
       ECReferenceTypesCache.bisRootClassToRefType[sourceRootBisClass.name];
     const targetType =
       ECReferenceTypesCache.bisRootClassToRefType[targetRootBisClass.name];
+
+    if (
+      this.hasQueryViewCustomAttributeAndNoRootClass(
+        sourceClass,
+        true,
+        sourceType
+      )
+    )
+      return undefined;
+    if (
+      this.hasQueryViewCustomAttributeAndNoRootClass(
+        targetClass,
+        false,
+        targetType
+      )
+    )
+      return undefined;
+
     const makeAssertMsg = (root: ECClass, cls: ECClass) =>
       [
         `An unknown root class '${root.fullName}' was encountered while populating`,

packages/transformer/src/test/assets/TestQueryView.ecschema.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ECSchema schemaName="TestGeneratedClassesNew" alias="tgcn" version="1.0.0"
+    xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+    <ECSchemaReference name="CoreCustomAttributes" version="01.00.03" alias="CoreCA"/>
+    <ECSchemaReference name="BisCustomAttributes" version="01.00.00" alias="bisCA"/>
+    <ECSchemaReference name="ECdbMap" version="02.00.04" alias="ecdbmap"/>
+    <ECSchemaReference name="BisCore" version="01.00.16" alias="bis"/>
+
+    <ECEntityClass typeName="TestView" modifier="Abstract" displayLabel="Test View" description="a sample view">
+        <ECCustomAttributes>
+            <QueryView xmlns="ECDbMap.02.00.04">
+                <Query>
+                    SELECT
+                        pe.ECInstanceId,
+                        pe.ECClassId,
+                        pe.Yaw as Yaw,
+                        NAVIGATION_VALUE(bis.PhysicalElement.Parent, pe.Parent.Id) as Parent
+                    FROM bis.PhysicalElement pe
+                </Query>
+            </QueryView>
+        </ECCustomAttributes>
+        <ECProperty propertyName="Yaw" typeName="double" description="Yaw of the PhysicalElement"/>
+        <ECNavigationProperty propertyName="Parent" relationshipName="PhysicalElementOwnsTestView" direction="backward" description="The parent Element that owns this element"/>
+    </ECEntityClass>
+
+    <ECRelationshipClass typeName="PhysicalElementOwnsTestView" strength="embedding" modifier="None" description="Relationship between an PhysicalElement and a TestView.">
+        <Source multiplicity="(1..1)" roleLabel="owns" polymorphic="true">
+            <Class class="bis:PhysicalElement"/>
+        </Source>
+        <Target multiplicity="(1..*)" roleLabel="is owned by" polymorphic="true">
+            <Class class="TestView"/>
+        </Target>
+    </ECRelationshipClass>
+
+</ECSchema>

packages/transformer/src/test/standalone/ECReferenceTypesCache.test.ts

@@ -13,13 +13,18 @@ import { KnownTestLocations as BackendTestsKnownLocations } from "../TestUtils/K
 import * as Semver from "semver";
 import { Schema, SchemaItemType, SchemaLoader } from "@itwin/ecschema-metadata";
 import * as sinon from "sinon";
+import { version as iTwinCoreBackendVersion } from "@itwin/core-backend/package.json";
 
 describe("ECReferenceTypesCache", () => {
   let testIModel: SnapshotDb;
   const testSchemaPath = path.join(
     BackendTestsKnownLocations.assetsDir,
     "TestGeneratedClasses.ecschema.xml"
   );
+  const testSchemaPathWithQueryView = path.join(
+    BackendTestsKnownLocations.assetsDir,
+    "TestQueryView.ecschema.xml"
+  );
   const testFixtureRefCache = new ECReferenceTypesCache();
   let pathForEmpty: string;
   let emptyWithBrandNewBiscore: SnapshotDb;
@@ -185,6 +190,22 @@ describe("ECReferenceTypesCache", () => {
     ).to.equal(ConcreteEntityTypes.Element);
   });
 
+  it("should handle QueryView", async () => {
+    if (Semver.gte(iTwinCoreBackendVersion, "4.6.0")) {
+      const thisTestRefCache = new ECReferenceTypesCache();
+      const ecdbMapVersion =
+        emptyWithBrandNewBiscore.querySchemaVersion("ECdbMap");
+      assert(ecdbMapVersion !== undefined);
+      assert(Semver.gte(ecdbMapVersion, "2.0.4"));
+      await emptyWithBrandNewBiscore.importSchemas([
+        testSchemaPathWithQueryView,
+      ]);
+      await thisTestRefCache.initAllSchemasInIModel(emptyWithBrandNewBiscore);
+    } else {
+      assert(true); // Pre 4.6.0 does not have QueryView support. https://www.itwinjs.org/bis/domains/ecdbmap.ecschema/#queryview
+    }
+  });
+
   it("should not init schemas of a lower or equal version", async () => {
     const thisTestRefCache = new ECReferenceTypesCache();