@itwin/core-backend 5.0.0-dev.98 → 5.0.0

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

@@ -62,9 +62,9 @@ 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 "../../HubMock";
+import { HubMock } from "../../internal/HubMock";
 import { KnownTestLocations } from "../KnownTestLocations";
 import { IModelTestUtils } from "../IModelTestUtils";
 import { DisableNativeAssertions } from "../TestUtils";
@@ -87,7 +87,17 @@ function expectIModelError(expectedErrorNumber, error) {
     expect(error).instanceof(IModelError);
     expect(error.errorNumber).to.equal(expectedErrorNumber);
 }
+async function generateTestSnapshot(targetFileName, seedAssetName) {
+    const seedFile = IModelTestUtils.resolveAssetFile(seedAssetName);
+    const snapshotFile = IModelTestUtils.prepareOutputFile("IModel", targetFileName);
+    const imodel = IModelTestUtils.createSnapshotFromSeed(snapshotFile, seedFile);
+    const schemaPathname = path.join(KnownTestLocations.assetsDir, "TestBim.ecschema.xml");
+    await imodel.importSchemas([schemaPathname]); // will throw an exception if import fails
+    imodel.saveChanges();
+    return imodel;
+}
 describe("iModel", () => {
+    //TODO: These imodels are used and modified across multiple tests. This is not a good practice and should be refactored.
     let imodel1;
     let imodel2;
     let imodel3;
@@ -97,13 +107,11 @@ describe("iModel", () => {
     before(async () => {
         originalEnv = { ...process.env };
         IModelTestUtils.registerTestBimSchema();
-        imodel1 = IModelTestUtils.createSnapshotFromSeed(IModelTestUtils.prepareOutputFile("IModel", "test.bim"), IModelTestUtils.resolveAssetFile("test.bim"));
+        imodel1 = await generateTestSnapshot("test.bim", "test.bim");
         imodel2 = IModelTestUtils.createSnapshotFromSeed(IModelTestUtils.prepareOutputFile("IModel", "CompatibilityTestSeed.bim"), IModelTestUtils.resolveAssetFile("CompatibilityTestSeed.bim"));
         imodel3 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("GetSetAutoHandledStructProperties.bim"));
         imodel4 = IModelTestUtils.createSnapshotFromSeed(IModelTestUtils.prepareOutputFile("IModel", "GetSetAutoHandledArrayProperties.bim"), IModelTestUtils.resolveAssetFile("GetSetAutoHandledArrayProperties.bim"));
         imodel5 = IModelTestUtils.createSnapshotFromSeed(IModelTestUtils.prepareOutputFile("IModel", "mirukuru.ibim"), IModelTestUtils.resolveAssetFile("mirukuru.ibim"));
-        const schemaPathname = path.join(KnownTestLocations.assetsDir, "TestBim.ecschema.xml");
-        await imodel1.importSchemas([schemaPathname]); // will throw an exception if import fails
     });
     after(() => {
         process.env = originalEnv;
@@ -711,6 +719,7 @@ describe("iModel", () => {
     });
     it("should be some categories", () => {
         const categorySql = `SELECT ECInstanceId FROM ${Category.classFullName}`;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel1.withPreparedStatement(categorySql, (categoryStatement) => {
             let numCategories = 0;
             while (DbResult.BE_SQLITE_ROW === categoryStatement.step()) {
@@ -729,6 +738,7 @@ describe("iModel", () => {
                 }
                 // get the subcategories
                 const subCategorySql = `SELECT ECInstanceId FROM ${SubCategory.classFullName} WHERE Parent.Id=:parentId`;
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
                 imodel1.withPreparedStatement(subCategorySql, (subCategoryStatement) => {
                     let numSubCategories = 0;
                     subCategoryStatement.bindId("parentId", categoryId);
@@ -747,6 +757,7 @@ describe("iModel", () => {
     });
     it("should be some 2d elements", () => {
         const sql = `SELECT ECInstanceId FROM ${DrawingGraphic.classFullName}`;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel2.withPreparedStatement(sql, (statement) => {
             let numDrawingGraphics = 0;
             let found25 = false;
@@ -833,6 +844,7 @@ describe("iModel", () => {
     });
     it("should be children of RootSubject", () => {
         const sql = `SELECT ECInstanceId FROM ${Model.classFullName} WHERE ParentModel.Id=:parentModelId`;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel2.withPreparedStatement(sql, (statement) => {
             statement.bindId("parentModelId", IModel.repositoryModelId);
             let numModels = 0;
@@ -1078,6 +1090,7 @@ describe("iModel", () => {
     it("should exercise ECSqlStatement (backend only)", () => {
         // Reject an invalid statement
         try {
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             imodel2.prepareStatement("select no_such_property, codeValue from bis.element", false);
             assert.fail("prepare should have failed with an exception");
         }
@@ -1087,6 +1100,7 @@ describe("iModel", () => {
         }
         let lastId = "";
         let firstCodeValue = "";
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel2.withPreparedStatement("select ecinstanceid, codeValue from bis.element", (stmt) => {
             assert.isNotNull(stmt);
             // Reject an attempt to bind when there are no placeholders in the statement
@@ -1133,6 +1147,7 @@ describe("iModel", () => {
             assert.equal(lastIterId, lastId, "iterator loop should see the same last row as the step loop");
             assert.equal(firstCodeValueIter, firstCodeValue, "iterator loop should find the first non-null code value as the step loop");
         });
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel2.withPreparedStatement("select ecinstanceid, codeValue from bis.element WHERE (ecinstanceid=?)", (stmt3) => {
             // Now try a statement with a placeholder
             const idToFind = Id64.fromJSON(lastId);
@@ -1148,6 +1163,7 @@ describe("iModel", () => {
             assert.equal(count, 1);
         });
         let firstCodeValueId;
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel2.withPreparedStatement("select ecinstanceid, codeValue from bis.element WHERE (codeValue = :codevalue)", (stmt4) => {
             // Try a named placeholder
             const codeValueToFind = firstCodeValue;
@@ -1166,8 +1182,10 @@ describe("iModel", () => {
         // make sure we can use parameterized values for queryEnityId (test on parameterized codevalue)
         const ids = imodel2.queryEntityIds({ from: "bis.element", where: "codevalue=:cv", bindings: { cv: firstCodeValue } });
         assert.equal(ids.values().next().value, firstCodeValueId);
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         imodel2.withPreparedStatement("select ecinstanceid as id, codevalue from bis.element", (stmt5) => {
             while (DbResult.BE_SQLITE_ROW === stmt5.step()) {
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
                 imodel2.withPreparedStatement("select codevalue from bis.element where ecinstanceid=?", (stmt6) => {
                     stmt6.bindId(1, stmt5.getRow().id);
                     while (DbResult.BE_SQLITE_ROW === stmt6.step()) {
@@ -1385,6 +1403,7 @@ describe("iModel", () => {
         DefinitionGroupGroupsDefinitions.insert(iModelDb, definitionGroupId, categoryId1);
         DefinitionGroupGroupsDefinitions.insert(iModelDb, definitionGroupId, categoryId2);
         DefinitionGroupGroupsDefinitions.insert(iModelDb, definitionGroupId, categoryId3);
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         const numMembers = iModelDb.withPreparedStatement(`SELECT COUNT(*) FROM ${DefinitionGroupGroupsDefinitions.classFullName}`, (statement) => {
             return statement.step() === DbResult.BE_SQLITE_ROW ? statement.getValue(0).getInteger() : 0;
         });
@@ -1973,6 +1992,7 @@ describe("iModel", () => {
             getCurrentChangeset: () => changeset,
             setIModelDb: () => { },
             closeFile: () => { },
+            clearECDbCache: () => { },
         };
         const errorLogStub = sinon.stub(Logger, "logError").callsFake(() => { });
         const infoLogStub = sinon.stub(Logger, "logInfo").callsFake(() => { });
@@ -2066,6 +2086,33 @@ 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");
@@ -2093,14 +2140,15 @@ describe("iModel", () => {
         standaloneDb1.close();
         assert.isUndefined(StandaloneDb.tryFindByKey(standaloneDb1.key));
     });
-    it("Snapshot iModel properties", () => {
+    it("Snapshot iModel properties", async () => {
         const snapshotRootSubjectName = "Snapshot";
         const snapshotFile1 = IModelTestUtils.prepareOutputFile("IModel", "Snapshot1.bim");
         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 });
         let snapshotDb2 = SnapshotDb.createFrom(snapshotDb1, snapshotFile2);
-        let snapshotDb3 = SnapshotDb.createFrom(imodel1, snapshotFile3, { createClassViews: true });
+        let snapshotDb3 = SnapshotDb.createFrom(imodel, snapshotFile3, { createClassViews: true });
         assert.isTrue(snapshotDb1.isSnapshotDb());
         assert.isTrue(snapshotDb2.isSnapshotDb());
         assert.isTrue(snapshotDb3.isSnapshotDb());
@@ -2113,7 +2161,7 @@ describe("iModel", () => {
         assert.equal(snapshotDb1.getBriefcaseId(), BriefcaseIdValue.Unassigned);
         assert.equal(snapshotDb2.getBriefcaseId(), BriefcaseIdValue.Unassigned);
         assert.equal(snapshotDb3.getBriefcaseId(), BriefcaseIdValue.Unassigned);
-        assert.equal(imodel1.getBriefcaseId(), BriefcaseIdValue.Unassigned);
+        assert.equal(imodel.getBriefcaseId(), BriefcaseIdValue.Unassigned);
         assert.equal(snapshotDb1.pathName, snapshotFile1);
         assert.equal(snapshotDb2.pathName, snapshotFile2);
         assert.equal(snapshotDb3.pathName, snapshotFile3);
@@ -2128,10 +2176,10 @@ describe("iModel", () => {
         const rootSubjectName1 = snapshotDb1.elements.getRootSubject().code.value;
         const rootSubjectName2 = snapshotDb2.elements.getRootSubject().code.value;
         const rootSubjectName3 = snapshotDb3.elements.getRootSubject().code.value;
-        const imodel1RootSubjectName = imodel1.elements.getRootSubject().code.value;
+        const imodelRootSubjectName = imodel.elements.getRootSubject().code.value;
         assert.equal(rootSubjectName1, snapshotRootSubjectName);
         assert.equal(rootSubjectName1, rootSubjectName2, "Expect a snapshot to maintain the root Subject name from its seed");
-        assert.equal(rootSubjectName3, imodel1RootSubjectName, "Expect a snapshot to maintain the root Subject name from its seed");
+        assert.equal(rootSubjectName3, imodelRootSubjectName, "Expect a snapshot to maintain the root Subject name from its seed");
         assert.isTrue(snapshotDb1.isOpen);
         assert.isTrue(snapshotDb2.isOpen);
         assert.isTrue(snapshotDb3.isOpen);
@@ -2166,6 +2214,7 @@ describe("iModel", () => {
         assert.isTrue(hasClassView(snapshotDb1, "bis.ElementRefersToElements"));
         assert.isFalse(hasClassView(snapshotDb2, "bis.Element"));
         assert.isTrue(hasClassView(snapshotDb3, "bis.Element"));
+        imodel.close();
         snapshotDb1.close();
         snapshotDb2.close();
         snapshotDb3.close();
@@ -2286,8 +2335,11 @@ describe("iModel", () => {
         try {
             const sql = `SELECT * FROM ${Element.classFullName} LIMIT 1`;
             const invalidSql = "SELECT * FROM InvalidSchemaName:InvalidClassName LIMIT 1";
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             assert.throws(() => imodel1.prepareStatement(invalidSql, false));
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             assert.isUndefined(imodel1.tryPrepareStatement(invalidSql));
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
             const statement = __addDisposableResource(env_2, imodel1.tryPrepareStatement(sql), false);
             assert.isDefined(statement);
             assert.isTrue(statement?.isPrepared);
@@ -2370,7 +2422,7 @@ describe("iModel", () => {
         expect(elProps.code.scope).equal(element.code.scope);
         expect(elProps.code.spec).equal(element.code.spec);
         expect(elProps.federationGuid).equal(element.federationGuid);
-        expect(elProps.isPrivate).undefined;
+        expect(elProps.isPrivate).to.be.oneOf([false, undefined]);
         expect(elProps.isInstanceOfEntity).undefined;
         // remove userlabel by setting it to the blank string
         element.userLabel = "";
@@ -2548,12 +2600,12 @@ describe("iModel", () => {
         expect(imodel.codeValueBehavior).to.equal("trim-unicode-whitespace");
         const code1 = getNumberedCodeValAndProps(1);
         const categ1Id = imodel.elements.insertElement(code1.props);
-        const categ1 = imodel.elements.getElementJson({ id: categ1Id });
+        const categ1 = imodel.elements.getElementProps({ id: categ1Id });
         expect(categ1.code.value).to.equal(code1.trimmedCodeVal);
         imodel.codeValueBehavior = "exact";
         const code2 = getNumberedCodeValAndProps(2);
         const categ2Id = imodel.elements.insertElement(code2.props);
-        const categ2 = imodel.elements.getElementJson({ id: categ2Id });
+        const categ2 = imodel.elements.getElementProps({ id: categ2Id });
         expect(categ2.code.value).to.equal(code2.untrimmedCodeVal);
         imodel.codeValueBehavior = "trim-unicode-whitespace";
         const code3 = getNumberedCodeValAndProps(3);