@itwin/core-backend 5.1.0-dev.5 → 5.1.0-dev.52

package/lib/esm/test/imodel/IModel.test.js

@@ -62,7 +62,7 @@ import { DbResult, Guid, Id64, IModelStatus, Logger, OpenMode, ProcessDetector }
 import { BisCodeSpec, BriefcaseIdValue, Code, CodeScopeSpec, CodeSpec, ColorByName, ColorDef, DisplayStyleSettings, EcefLocation, FontMap, FontType, GeoCoordStatus, GeographicCRS, GeometryParams, GeometryStreamBuilder, ImageSourceFormat, IModel, IModelError, RelatedElement, RenderMode, SchemaState, SubCategoryAppearance, TextureMapping, TextureMapUnits, ViewFlags, } from "@itwin/core-common";
 import { Geometry, LineString3d, Loop, Matrix4d, Point3d, PolyfaceBuilder, Range3d, StrokeOptions, Transform, YawPitchRollAngles, } from "@itwin/core-geometry";
 import { V2CheckpointManager } from "../../CheckpointManager";
-import { _nativeDb, BisCoreSchema, Category, ClassRegistry, DefinitionContainer, DefinitionGroup, DefinitionGroupGroupsDefinitions, DefinitionModel, DefinitionPartition, DictionaryModel, DisplayStyle3d, DocumentPartition, DrawingGraphic, Element, ElementDrivesElement, ElementGroupsMembers, ElementOwnsChildElements, GeometricElement2d, GeometricElement3d, GeometricModel, GroupInformationPartition, IModelDb, IModelHost, IModelJsFs, InformationPartitionElement, InformationRecordElement, LinkPartition, Model, PhysicalElement, PhysicalModel, PhysicalObject, PhysicalPartition, RenderMaterialElement, SnapshotDb, SpatialCategory, SqliteValueType, StandaloneDb, SubCategory, Subject, Texture, } from "../../core-backend";
+import { _nativeDb, BisCoreSchema, Category, ClassRegistry, DefinitionContainer, DefinitionGroup, DefinitionGroupGroupsDefinitions, DefinitionModel, DefinitionPartition, DictionaryModel, DisplayStyle3d, DocumentPartition, DrawingGraphic, Element, ElementDrivesElement, ElementGroupsMembers, ElementOwnsChildElements, GenericGraphicalType2d, GeometricElement2d, GeometricElement3d, GeometricModel, GroupInformationPartition, IModelDb, IModelHost, IModelJsFs, InformationPartitionElement, InformationRecordElement, LinkPartition, Model, PhysicalElement, PhysicalModel, PhysicalObject, PhysicalPartition, RenderMaterialElement, SnapshotDb, SpatialCategory, SqliteValueType, StandaloneDb, SubCategory, Subject, Texture, } from "../../core-backend";
 import { BriefcaseDb } from "../../IModelDb";
 import { HubMock } from "../../internal/HubMock";
 import { KnownTestLocations } from "../KnownTestLocations";
@@ -1301,12 +1301,15 @@ describe("iModel", () => {
         // Delete the model
         testImodel.models.deleteModel(newModelId);
         // Test insertModel error handling
-        assert.throws(() => {
+        try {
             testImodel.models.insertModel({
                 classFullName: DefinitionModel.classFullName,
                 modeledElement: { id: "0x10000000bad" },
             });
-        }, IModelError);
+        }
+        catch (error) {
+            assert.isTrue(error instanceof IModelError || error.iTwinErrorId !== undefined);
+        }
     });
     it("should create model with custom relationship to modeled element", async () => {
         const testImodel = imodel1;
@@ -1605,6 +1608,33 @@ describe("iModel", () => {
         assert.isTrue(iModel2.ecefLocation !== undefined);
         iModel2.close();
     });
+    describe("async coordinate conversions", () => {
+        it("should output same number of points as input", async () => {
+            const iModelCoords = [];
+            const geoCoords = [];
+            for (let numPts = 0; numPts < 3; numPts++) {
+                const geoResponse = await imodel5.getGeoCoordinatesFromIModelCoordinates({ target: "WGS84", iModelCoords });
+                expect(geoResponse.geoCoords.length).to.equal(numPts);
+                const iModelResponse = await imodel5.getIModelCoordinatesFromGeoCoordinates({ source: "WGS84", geoCoords });
+                expect(iModelResponse.iModelCoords.length).to.equal(numPts);
+                iModelCoords.push(new Point3d());
+                geoCoords.push(new Point3d());
+            }
+        });
+        it("should always have fromCache = 0", async () => {
+            const iModelCoords = [];
+            const geoCoords = [];
+            for (let numPts = 0; numPts < 3; numPts++) {
+                const geoResponse = await imodel5.getGeoCoordinatesFromIModelCoordinates({ target: "WGS84", iModelCoords });
+                expect(geoResponse.fromCache).to.equal(0);
+                const iModelResponse = await imodel5.getIModelCoordinatesFromGeoCoordinates({ source: "WGS84", geoCoords });
+                expect(iModelResponse.iModelCoords.length).to.equal(numPts);
+                expect(iModelResponse.fromCache).to.equal(0);
+                iModelCoords.push(new Point3d());
+                geoCoords.push(new Point3d());
+            }
+        });
+    });
     if (!ProcessDetector.isIOSAppBackend) {
         it("should be able to reproject with iModel coordinates to or from any other GeographicCRS", async () => {
             const convertTest = async (fileName, fileGCS, datum, inputCoord, outputCoord) => {
@@ -2086,10 +2116,41 @@ describe("iModel", () => {
         db.abandonChanges();
         db.close();
     });
+    it("Cache cleared on abandonChanges", () => {
+        const standaloneFile = IModelTestUtils.prepareOutputFile("IModel", "StandaloneReadWrite.bim");
+        const db = StandaloneDb.createEmpty(standaloneFile, { rootSubject: { name: "Standalone" } });
+        db.saveChanges();
+        const code = Code.createEmpty();
+        code.value = "foo";
+        const props = {
+            classFullName: GenericGraphicalType2d.classFullName,
+            model: IModel.dictionaryId,
+            code,
+        };
+        const id = db.elements.insertElement(props);
+        const element1 = db.elements.getElementProps(id);
+        db.abandonChanges();
+        code.value = "bar";
+        const props2 = {
+            classFullName: GenericGraphicalType2d.classFullName,
+            model: IModel.dictionaryId,
+            code,
+        };
+        const id2 = db.elements.insertElement(props2);
+        expect(id2).to.equal(id);
+        const element2 = db.elements.getElementProps(id2);
+        expect(element2).to.not.equal(element1);
+        db.abandonChanges();
+        db.close();
+    });
     it("Standalone iModel properties", () => {
         const standaloneRootSubjectName = "Standalone";
         const standaloneFile1 = IModelTestUtils.prepareOutputFile("IModel", "Standalone1.bim");
-        let standaloneDb1 = StandaloneDb.createEmpty(standaloneFile1, { rootSubject: { name: standaloneRootSubjectName } });
+        const ecefLocation = new EcefLocation({ origin: [1, 2, 3], orientation: { yaw: 0, pitch: 0, roll: 0 } });
+        const geographicCoordinateSystem = {
+            horizontalCRS: { id: "10TM115-27" },
+        };
+        let standaloneDb1 = StandaloneDb.createEmpty(standaloneFile1, { rootSubject: { name: standaloneRootSubjectName }, ecefLocation, geographicCoordinateSystem });
         assert.isTrue(standaloneDb1.isStandaloneDb());
         assert.isTrue(standaloneDb1.isStandalone);
         assert.isFalse(standaloneDb1.isReadonly, "Expect standalone iModels to be read-write during create");
@@ -2102,6 +2163,8 @@ describe("iModel", () => {
         assert.equal(standaloneDb1.iTwinId, Guid.empty);
         assert.strictEqual("", standaloneDb1.changeset.id);
         assert.strictEqual(0, standaloneDb1.changeset.index);
+        assert.deepEqual(standaloneDb1.ecefLocation?.origin, ecefLocation.origin, "standalone ecefLocation should be set");
+        assert.strictEqual(standaloneDb1.geographicCoordinateSystem?.horizontalCRS?.id, "10TM115-27", "standalone coordinate system should be set");
         assert.equal(standaloneDb1.openMode, OpenMode.ReadWrite);
         standaloneDb1.close();
         assert.isFalse(standaloneDb1.isOpen);
@@ -2119,7 +2182,11 @@ describe("iModel", () => {
         const snapshotFile2 = IModelTestUtils.prepareOutputFile("IModel", "Snapshot2.bim");
         const snapshotFile3 = IModelTestUtils.prepareOutputFile("IModel", "Snapshot3.bim");
         const imodel = await generateTestSnapshot("test_for_snapshot.bim", "test.bim");
-        let snapshotDb1 = SnapshotDb.createEmpty(snapshotFile1, { rootSubject: { name: snapshotRootSubjectName }, createClassViews: true });
+        const ecefLocation = new EcefLocation({ origin: [1, 2, 3], orientation: { yaw: 0, pitch: 0, roll: 0 } });
+        const geographicCoordinateSystem = {
+            horizontalCRS: { id: "10TM115-27" },
+        };
+        let snapshotDb1 = SnapshotDb.createEmpty(snapshotFile1, { rootSubject: { name: snapshotRootSubjectName }, createClassViews: true, ecefLocation, geographicCoordinateSystem });
         let snapshotDb2 = SnapshotDb.createFrom(snapshotDb1, snapshotFile2);
         let snapshotDb3 = SnapshotDb.createFrom(imodel, snapshotFile3, { createClassViews: true });
         assert.isTrue(snapshotDb1.isSnapshotDb());
@@ -2156,6 +2223,8 @@ describe("iModel", () => {
         assert.isTrue(snapshotDb1.isOpen);
         assert.isTrue(snapshotDb2.isOpen);
         assert.isTrue(snapshotDb3.isOpen);
+        assert.deepEqual(snapshotDb1.ecefLocation?.origin, ecefLocation.origin, "snapshot ecefLocation should be set");
+        assert.strictEqual(snapshotDb1.geographicCoordinateSystem?.horizontalCRS?.id, "10TM115-27", "snapshot coordinate system should be set");
         snapshotDb1.close();
         snapshotDb2.close();
         snapshotDb3.close();
@@ -2587,6 +2656,32 @@ describe("iModel", () => {
         expect(categ3.code.value).to.equal(code3.trimmedCodeVal);
         imodel.close();
     });
+    it("should throw iTwinErrors on element CRUD opertion fails", async () => {
+        const code = Code.createEmpty();
+        code.value = "foo";
+        const props = {
+            classFullName: GenericGraphicalType2d.classFullName,
+            model: IModel.dictionaryId,
+            code,
+        };
+        imodel1.elements.insertElement(props);
+        expect(() => imodel1.elements.insertElement(props)).throws("Error inserting element [duplicate code]").to.have.property("iTwinErrorId");
+        const updateProps = {
+            id: Id64.fromString("0x111111"),
+            classFullName: GenericGraphicalType2d.classFullName,
+            model: IModel.dictionaryId,
+            code,
+        };
+        expect(() => imodel1.elements.updateElement(updateProps)).throws(`Error updating element [missing id], id: ${updateProps.id}`).to.have.property("iTwinErrorId");
+        expect(() => imodel1.elements.deleteElement(updateProps.id)).throws(`Error deleting element [missing id], id: ${updateProps.id}`).to.have.property("iTwinErrorId");
+        expect(() => imodel1.models.insertModel({ classFullName: DefinitionModel.classFullName, modeledElement: { id: "0x10000000bad" } })).throws("Error inserting model [error=10004], class=BisCore:DefinitionModel").to.have.property("iTwinErrorId");
+        expect(() => imodel1.models.updateModel({
+            id: Id64.fromString("0x111111"),
+            modeledElement: { id: Id64.fromString("0x111111") },
+            classFullName: ""
+        })).throws(`Error updating model [missing id], id: ${Id64.fromString("0x111111")}`).to.have.property("iTwinErrorId");
+        expect(() => imodel1.models.deleteModel(Id64.fromString("0x111111"))).throws(`Error deleting model [missing id], id: ${Id64.fromString("0x111111")}`).to.have.property("iTwinErrorId");
+    });
     it("throws NotFound when attempting to access element props after closing the iModel", () => {
         const imodelPath = IModelTestUtils.prepareOutputFile("IModel", "accessAfterClose.bim");
         const imodel = SnapshotDb.createEmpty(imodelPath, { rootSubject: { name: "accessAfterClose" } });
@@ -2622,5 +2717,160 @@ describe("iModel", () => {
         expect(() => imodel.relationships.insertInstance(props)).to.throw(`Failed to insert relationship [${imodelPath}]: rc=2067, constraint failed (BE_SQLITE_CONSTRAINT_UNIQUE)`);
         imodel.close();
     });
+    function createElemProps(_imodel, modId, catId, className) {
+        // Create props
+        const elementProps = {
+            classFullName: className,
+            model: modId,
+            category: catId,
+            code: Code.createEmpty(),
+        };
+        return elementProps;
+    }
+    function insertElement(imodel, mId, cId, cName, propName) {
+        const elementProps = createElemProps(imodel, mId, cId, cName);
+        const geomElement = imodel.elements.createElement(elementProps);
+        geomElement.name = propName; // Add a custom property to the element
+        const id = imodel.elements.insertElement(geomElement.toJSON());
+        assert.isTrue(Id64.isValidId64(id), "insert failed");
+        return id;
+    }
+    function validateADrivesBRowCount(imodel, expectedRows) {
+        const reader = IModelTestUtils.executeQuery(imodel, `select * from trs.ADrivesB`);
+        assert.strictEqual(reader.length, expectedRows, `Expected ${expectedRows} rows in trs.ADrivesB table`);
+    }
+    function validateNavProp(imodel, expectedNavPropValue) {
+        const reader = IModelTestUtils.executeQuery(imodel, `select NavPropChildB from trs.ChildA`);
+        assert.strictEqual(reader.length, 1);
+        assert.deepEqual(reader[0].navPropChildB, expectedNavPropValue, `Expected NavPropChildB to be "${expectedNavPropValue}"`);
+    }
+    it("Validate invalid relationship classes being inserted/updated", async () => {
+        const imodelPath = IModelTestUtils.prepareOutputFile("IModel", "invalidRelationshipClass.bim");
+        if (IModelJsFs.existsSync(imodelPath))
+            IModelJsFs.unlinkSync(imodelPath);
+        const testImodel = SnapshotDb.createEmpty(imodelPath, { rootSubject: { name: "invalidRelationshipClass" } });
+        await testImodel.importSchemaStrings([
+            `<?xml version="1.0" encoding="UTF-8"?>
+      <ECSchema schemaName="TestRelationSchema" alias="trs" version="01.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
+          <ECSchemaReference name="BisCore" version="01.00" alias="bis"/>
+          <ECEntityClass typeName="TestElement">
+              <BaseClass>bis:PhysicalElement</BaseClass>
+              <ECProperty propertyName="Name" typeName="string" />
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildA" >
+            <BaseClass>TestElement</BaseClass>
+            <ECNavigationProperty propertyName="NavPropChildB" relationshipName="ADrivesB" direction="Forward" readOnly="True">
+            </ECNavigationProperty>
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildB" >
+            <BaseClass>TestElement</BaseClass>
+          </ECEntityClass>
+
+          <ECRelationshipClass typeName="ADrivesB" strengthDirection="Backward" strength="referencing" modifier="Sealed">
+            <Source multiplicity="(0..*)" polymorphic="true" roleLabel="drives">
+              <Class class="ChildA"/>
+            </Source>
+            <Target multiplicity="(0..1)" polymorphic="true" roleLabel="is driven by">
+              <Class class="ChildB"/>
+            </Target>
+          </ECRelationshipClass>
+
+          <ECEntityClass typeName="ChildC">
+            <BaseClass>TestElement</BaseClass>
+          </ECEntityClass>
+
+          <ECEntityClass typeName="ChildD">
+            <BaseClass>TestElement</BaseClass>
+          </ECEntityClass>
+
+          <ECRelationshipClass typeName="CIsRelatedToD" strength="referencing" modifier="Sealed">
+             <BaseClass>bis:ElementRefersToElements</BaseClass>
+            <Source multiplicity="(0..*)" roleLabel="IsRelatedTo" polymorphic="true">
+              <Class class="ChildC"/>
+            </Source>
+            <Target multiplicity="(0..*)" roleLabel="IsRelatedTo (Reversed)" polymorphic="true">
+              <Class class="ChildD"/>
+            </Target>
+          </ECRelationshipClass>
+        </ECSchema>`
+        ]);
+        // Enable ECSQL write validation and verify it's set
+        const pragmaRows = IModelTestUtils.executeQuery(testImodel, `PRAGMA validate_ecsql_writes=true`);
+        assert.exists(pragmaRows);
+        assert.strictEqual(pragmaRows[0].validate_ecsql_writes, true);
+        // Ensure ADrivesB table is empty before test
+        validateADrivesBRowCount(testImodel, 0);
+        // Create a physical model and spatial category if needed
+        const [, newModelId] = IModelTestUtils.createAndInsertPhysicalPartitionAndModel(testImodel, Code.createEmpty(), true);
+        let spatialCategoryId = SpatialCategory.queryCategoryIdByName(testImodel, IModel.dictionaryId, "MySpatialCategory");
+        if (!spatialCategoryId) {
+            spatialCategoryId = SpatialCategory.insert(testImodel, IModel.dictionaryId, "MySpatialCategory", new SubCategoryAppearance({ color: ColorDef.fromString("rgb(255,0,0)").toJSON() }));
+        }
+        // Insert a ChildB element to be referenced by ChildA
+        const idB = insertElement(testImodel, newModelId, spatialCategoryId, "TestRelationSchema:ChildB", "ChildBElement");
+        assert.isTrue(Id64.isValidId64(idB), "Insert ChildBElement failed");
+        testImodel.saveChanges();
+        // Prepare base props for ChildA
+        const elementProps = createElemProps(testImodel, newModelId, spatialCategoryId, "TestRelationSchema:ChildA");
+        // Test various relationship class names for navigation property
+        const testCases = [
+            { name: "trs:ADrivesB", shouldSucceed: true, expectedRows: 1 },
+            { name: "trs.FakeClass", shouldSucceed: true, expectedRows: 0 },
+            { name: "trs:ChildA", shouldSucceed: false, expectedRows: 0 },
+            { name: "trs:ChildB", shouldSucceed: false, expectedRows: 0 },
+            { name: "trs:CIsRelatedToD", shouldSucceed: false, expectedRows: 0 },
+        ];
+        for (const { name, shouldSucceed, expectedRows } of testCases) {
+            const elemRef = new RelatedElement({ id: idB, relClassName: name });
+            elementProps.navPropChildB = elemRef;
+            elementProps.name = "ChildAElement";
+            const geomElement = testImodel.elements.createElement(elementProps);
+            let idA;
+            try {
+                idA = testImodel.elements.insertElement(geomElement.toJSON());
+                if (shouldSucceed)
+                    assert.isTrue(Id64.isValidId64(idA), `Insert should have succeeded for ${name}.`);
+                else
+                    assert.fail(`Insert should have failed for ${name}.`);
+            }
+            catch (err) {
+                if (shouldSucceed)
+                    assert.fail(`Insert should have succeeded for ${name}. Error: ${err.message}`);
+                // If should not succeed, error is expected
+            }
+            // Validate row count in ADrivesB table
+            validateADrivesBRowCount(testImodel, expectedRows);
+            // If insert succeeded, test update and delete scenarios
+            if (expectedRows === 1 && idA !== undefined) {
+                validateNavProp(testImodel, { id: idB, relClassName: "TestRelationSchema.ADrivesB" });
+                const editElem = testImodel.elements.getElement(idA);
+                editElem.navPropChildB = new RelatedElement({ id: idB, relClassName: "trs.FakeClass" });
+                editElem.name = "ChildAElementUpdated";
+                testImodel.elements.updateElement(editElem);
+                validateADrivesBRowCount(testImodel, 1);
+                validateNavProp(testImodel, { id: idB, relClassName: "TestRelationSchema.ADrivesB" });
+                const editedElem = testImodel.elements.getElement(idA);
+                assert.equal(editedElem.name, "ChildAElementUpdated", `Expected name to be "ChildAElementUpdated" after update, but got "${editedElem.name}"`);
+                assert.strictEqual(editedElem.navPropChildB.relClassName, "TestRelationSchema.ADrivesB", `Expected navPropChildB to be "TestRelationSchema.ADrivesB" after update, but got "${editedElem.navPropChildB}"`);
+                // Set the nav prop value to null
+                editElem.name = "ChildAElementNulled";
+                editElem.navPropChildB = null;
+                testImodel.elements.updateElement(editElem);
+                validateADrivesBRowCount(testImodel, 0);
+                const nulledElem = testImodel.elements.getElement(idA);
+                assert.equal(nulledElem.name, "ChildAElementNulled", `Expected name to be "ChildAElementNulled" after nulling, but got "${nulledElem.name}"`);
+                assert.isUndefined(nulledElem.navPropChildB, `Expected navPropChildB to be undefined after nulling, but got "${nulledElem.navPropChildB}"`);
+                if (shouldSucceed) {
+                    // Delete the element
+                    testImodel.elements.deleteElement(idA);
+                    assert.isUndefined(testImodel.elements.tryGetElement(idA), `Expected element with id ${idA} to be deleted, but it still exists.`);
+                }
+            }
+            testImodel.abandonChanges();
+        }
+        testImodel.close();
+    });
 });
 //# sourceMappingURL=IModel.test.js.map