@itwin/core-backend 5.15.0-dev.7 → 5.15.0

package/lib/esm/test/element/RelationshipBatchLookup.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RelationshipBatchLookup.test.d.ts.map

package/lib/esm/test/element/RelationshipBatchLookup.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipBatchLookup.test.d.ts","sourceRoot":"","sources":["../../../../src/test/element/RelationshipBatchLookup.test.ts"],"names":[],"mappings":""}

package/lib/esm/test/element/RelationshipBatchLookup.test.js

@@ -0,0 +1,202 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { expect } from "chai";
+import * as sinon from "sinon";
+import { Guid, Id64 } from "@itwin/core-bentley";
+import { Code, IModel } from "@itwin/core-common";
+import { withEditTxn } from "../../EditTxn";
+import { RepositoryLink } from "../../Element";
+import { SnapshotDb } from "../../IModelDb";
+import { ElementDrivesElement, ElementGroupsMembers, ElementRefersToElements } from "../../Relationship";
+import { IModelTestUtils } from "../IModelTestUtils";
+describe("Relationships batched lookup", () => {
+    const testSchema = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="BatchLookupTest" alias="blt" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+      <ECSchemaReference name="BisCore" version="01.00.00" alias="bis"/>
+      <ECStructClass typeName="TestStruct">
+        <ECProperty propertyName="label" typeName="string"/>
+        <ECProperty propertyName="origin" typeName="point2d"/>
+      </ECStructClass>
+      <ECRelationshipClass typeName="TestRefersToElements" strength="referencing" modifier="Sealed">
+        <BaseClass>bis:ElementRefersToElements</BaseClass>
+        <Source multiplicity="(0..*)" roleLabel="refers to" polymorphic="true">
+          <Class class="bis:Element"/>
+        </Source>
+        <Target multiplicity="(0..*)" roleLabel="is referenced by" polymorphic="true">
+          <Class class="bis:Element"/>
+        </Target>
+        <ECProperty propertyName="Location" typeName="point3d"/>
+        <ECStructProperty propertyName="Info" typeName="TestStruct"/>
+        <ECArrayProperty propertyName="Points" typeName="point3d" minOccurs="0" maxOccurs="unbounded"/>
+      </ECRelationshipClass>
+    </ECSchema>`;
+    const testRelClass = "BatchLookupTest:TestRefersToElements";
+    let imodel;
+    let elementIds;
+    let relIds;
+    before(async () => {
+        imodel = SnapshotDb.createEmpty(IModelTestUtils.prepareOutputFile("Relationship", "BatchLookup.bim"), { rootSubject: { name: "BatchLookup" } });
+        await imodel.importSchemaStrings([testSchema]);
+        withEditTxn(imodel, (txn) => {
+            elementIds = [];
+            for (let i = 0; i < 6; ++i) {
+                const props = {
+                    classFullName: RepositoryLink.classFullName,
+                    model: IModel.repositoryModelId,
+                    code: Code.createEmpty(),
+                    repositoryGuid: Guid.createValue(),
+                };
+                elementIds.push(txn.insertElement(props));
+            }
+            // Chain e0->e1->e2->e3->e4 with memberPriority equal to the source index.
+            relIds = [];
+            for (let i = 0; i < 4; ++i)
+                relIds.push(txn.insertRelationship(ElementGroupsMembers.create(imodel, elementIds[i], elementIds[i + 1], i).toJSON()));
+        });
+    });
+    after(() => imodel.close());
+    it("matches tryGetInstanceProps for ids and source/target pairs, preserving order", async () => {
+        const [e0, e1, e2, e3, e4, e5] = elementIds;
+        const criteria = [
+            relIds[2],
+            { sourceId: e0, targetId: e1 },
+            Id64.fromLocalAndBriefcaseIds(0x7fff, 0), // non-existent id
+            { sourceId: e3, targetId: e4 },
+            { sourceId: e0, targetId: e2 }, // both ends requested elsewhere, but not related as a pair
+            { sourceId: e4, targetId: e5 }, // unrelated
+            Id64.invalid,
+            relIds[2], // duplicate
+            { sourceId: e1, targetId: e2 },
+            relIds[0],
+        ];
+        const batch = await imodel.relationships.queryInstancesProps(ElementGroupsMembers.classFullName, criteria);
+        expect(batch.length).to.equal(criteria.length);
+        criteria.forEach((criterion, i) => {
+            expect(batch[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(ElementGroupsMembers.classFullName, criterion), `criterion ${i}`);
+        });
+        expect(batch[0]?.id).to.equal(relIds[2]);
+        expect(batch[0]?.classFullName).to.equal(ElementGroupsMembers.classFullName);
+        expect(batch[1].memberPriority).to.equal(0);
+        expect(batch[1]?.id).to.equal(relIds[0]);
+        expect(batch[2]).to.be.undefined;
+        expect(batch[3]?.id).to.equal(relIds[3]);
+        expect(batch[4]).to.be.undefined;
+        expect(batch[5]).to.be.undefined;
+        expect(batch[6]).to.be.undefined;
+        expect(batch[7]?.id).to.equal(relIds[2]);
+        expect(batch[8]?.id).to.equal(relIds[1]);
+        // The concurrent query connection sees the same saved data.
+        expect(await imodel.relationships.queryInstancesProps(ElementGroupsMembers.classFullName, criteria, { usePrimaryConn: false })).to.deep.equal(batch);
+    });
+    it("returns an empty array for empty criteria", async () => {
+        expect(await imodel.relationships.queryInstancesProps(ElementGroupsMembers.classFullName, [])).to.deep.equal([]);
+        expect(await imodel.relationships.queryInstances(ElementGroupsMembers.classFullName, [])).to.deep.equal([]);
+    });
+    it("queries polymorphically and respects the relationship class", async () => {
+        const criteria = [relIds[0], { sourceId: elementIds[1], targetId: elementIds[2] }];
+        const viaBase = await imodel.relationships.queryInstancesProps(ElementRefersToElements.classFullName, criteria);
+        expect(viaBase.map((p) => p?.classFullName)).to.deep.equal([ElementGroupsMembers.classFullName, ElementGroupsMembers.classFullName]);
+        criteria.forEach((criterion, i) => expect(viaBase[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(ElementRefersToElements.classFullName, criterion), `criterion ${i}`));
+        const viaOther = await imodel.relationships.queryInstancesProps(ElementDrivesElement.classFullName, criteria);
+        expect(viaOther).to.deep.equal([undefined, undefined]);
+    });
+    it("queryInstances constructs Relationship entities", async () => {
+        const criteria = [relIds[1], { sourceId: elementIds[3], targetId: elementIds[4] }, Id64.invalid];
+        const rels = await imodel.relationships.queryInstances(ElementGroupsMembers.classFullName, criteria);
+        expect(rels.length).to.equal(3);
+        expect(rels[0]).to.be.instanceOf(ElementGroupsMembers);
+        expect(rels[0]?.id).to.equal(relIds[1]);
+        expect(rels[0]?.memberPriority).to.equal(1);
+        expect(rels[1]).to.be.instanceOf(ElementGroupsMembers);
+        expect(rels[1]?.sourceId).to.equal(elementIds[3]);
+        expect(rels[1]?.targetId).to.equal(elementIds[4]);
+        expect(rels[2]).to.be.undefined;
+        criteria.forEach((criterion, i) => expect(rels[i]?.toJSON()).to.deep.equal(imodel.relationships.tryGetInstance(ElementGroupsMembers.classFullName, criterion)?.toJSON(), `criterion ${i}`));
+    });
+    it("sees unsaved changes by default", async () => {
+        const cls = ElementGroupsMembers.classFullName;
+        const pair = { sourceId: elementIds[4], targetId: elementIds[5] };
+        await withEditTxn(imodel, async (txn) => {
+            const id = txn.insertRelationship(ElementGroupsMembers.create(imodel, pair.sourceId, pair.targetId, 4).toJSON());
+            const found = await imodel.relationships.queryInstances(cls, [id, pair]);
+            expect(found.map((r) => r?.id)).to.deep.equal([id, id]);
+            txn.deleteRelationship(imodel.relationships.getInstanceProps(cls, id));
+        });
+    });
+    it("converts point, struct and array properties like tryGetInstanceProps", async () => {
+        const pair = { sourceId: elementIds[0], targetId: elementIds[5] };
+        await withEditTxn(imodel, async (txn) => {
+            const id = txn.insertRelationship({
+                classFullName: testRelClass,
+                ...pair,
+                location: { x: 1, y: 2, z: 3 },
+                info: { label: "a", origin: { x: 4, y: 5 } },
+                points: [{ x: 6, y: 7, z: 8 }, { x: 9, y: 10, z: 11 }],
+            });
+            const criteria = [id, pair];
+            const batch = await imodel.relationships.queryInstancesProps(testRelClass, criteria);
+            criteria.forEach((criterion, i) => expect(batch[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(testRelClass, criterion), `criterion ${i}`));
+            expect(batch[0]).to.include({ id, classFullName: testRelClass });
+            expect(batch[0]).to.deep.include({
+                location: { x: 1, y: 2, z: 3 },
+                info: { label: "a", origin: { x: 4, y: 5 } },
+                points: [{ x: 6, y: 7, z: 8 }, { x: 9, y: 10, z: 11 }],
+            });
+            txn.deleteRelationship(batch[0]);
+        });
+    });
+    it("reads only the requested pairs in a dense many-to-many graph", async () => {
+        const cls = ElementGroupsMembers.classFullName;
+        const n = 5;
+        await withEditTxn(imodel, async (txn) => {
+            const sources = [];
+            const targets = [];
+            for (let i = 0; i < 2 * n; ++i) {
+                const id = txn.insertElement({ classFullName: RepositoryLink.classFullName, model: IModel.repositoryModelId, code: Code.createEmpty(), repositoryGuid: Guid.createValue() });
+                (i < n ? sources : targets).push(id);
+            }
+            // Connect every source to every target, then request only the "diagonal" pairs.
+            for (const sourceId of sources)
+                for (const targetId of targets)
+                    txn.insertRelationship(ElementGroupsMembers.create(imodel, sourceId, targetId, 0).toJSON());
+            const pairs = sources.map((sourceId, i) => ({ sourceId, targetId: targets[i] }));
+            let rowsRead = 0;
+            const createQueryReader = imodel.createQueryReader.bind(imodel);
+            const stub = sinon.stub(imodel, "createQueryReader").callsFake((ecsql, params, config) => {
+                const reader = createQueryReader(ecsql, params, config);
+                const step = reader.step.bind(reader);
+                reader.step = async () => {
+                    const hasRow = await step();
+                    if (hasRow)
+                        ++rowsRead;
+                    return hasRow;
+                };
+                return reader;
+            });
+            try {
+                const found = await imodel.relationships.queryInstancesProps(cls, pairs);
+                expect(found.map((p) => p && { sourceId: p.sourceId, targetId: p.targetId })).to.deep.equal(pairs);
+            }
+            finally {
+                stub.restore();
+            }
+            expect(rowsRead).to.equal(n);
+        });
+    });
+    it("supports relationships stored as navigation properties and ids from any briefcase", async () => {
+        const cls = "BisCore:ModelContainsElements";
+        const highBriefcaseId = Id64.fromLocalAndBriefcaseIds(1, 0xfffffd);
+        const criteria = [
+            elementIds[0],
+            { sourceId: IModel.repositoryModelId, targetId: elementIds[1] },
+            highBriefcaseId,
+            { sourceId: highBriefcaseId, targetId: elementIds[1] },
+        ];
+        const batch = await imodel.relationships.queryInstancesProps(cls, criteria);
+        criteria.forEach((criterion, i) => expect(batch[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(cls, criterion), `criterion ${i}`));
+        expect(batch.map((p) => p?.targetId)).to.deep.equal([elementIds[0], elementIds[1], undefined, undefined]);
+    });
+});
+//# sourceMappingURL=RelationshipBatchLookup.test.js.map

package/lib/esm/test/element/RelationshipBatchLookup.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelationshipBatchLookup.test.js","sourceRoot":"","sources":["../../../../src/test/element/RelationshipBatchLookup.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,EAA2D,MAAM,oBAAoB,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,MAAM,UAAU,GAAG;;;;;;;;;;;;;;;;;;;gBAmBL,CAAC;IACf,MAAM,YAAY,GAAG,sCAAsC,CAAC;IAE5D,IAAI,MAAkB,CAAC;IACvB,IAAI,UAAwB,CAAC;IAC7B,IAAI,MAAoB,CAAC;IAEzB,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,EAAE,EAAE,WAAW,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC;QAChJ,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/C,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;YAC1B,UAAU,GAAG,EAAE,CAAC;YAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAwB;oBACjC,aAAa,EAAE,cAAc,CAAC,aAAa;oBAC3C,KAAK,EAAE,MAAM,CAAC,iBAAiB;oBAC/B,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE;oBACxB,cAAc,EAAE,IAAI,CAAC,WAAW,EAAE;iBACnC,CAAC;gBACF,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5C,CAAC;YAED,0EAA0E;YAC1E,MAAM,GAAG,EAAE,CAAC;YACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC3H,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAE5B,EAAE,CAAC,+EAA+E,EAAE,KAAK,IAAI,EAAE;QAC7F,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC;QAC5C,MAAM,QAAQ,GAAwC;YACpD,MAAM,CAAC,CAAC,CAAC;YACT,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC9B,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,kBAAkB;YAC5D,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC9B,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,2DAA2D;YAC3F,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,YAAY;YAC5C,IAAI,CAAC,OAAO;YACZ,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY;YACvB,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC9B,MAAM,CAAC,CAAC,CAAC;SACV,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAC3G,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/C,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;YAChC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;QAC5I,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAC7E,MAAM,CAAE,KAAK,CAAC,CAAC,CAAS,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QACjC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzC,4DAA4D;QAC5D,MAAM,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,aAAa,EAAE,QAAQ,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACvJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjH,MAAM,CAAC,MAAM,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,oBAAoB,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAEnF,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAChH,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC,aAAa,EAAE,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC;QACrI,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QAEnL,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAC9G,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjG,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,cAAc,CAAuB,oBAAoB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAC3H,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChC,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,oBAAoB,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9L,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,GAAG,GAAG,oBAAoB,CAAC,aAAa,CAAC;QAC/C,MAAM,IAAI,GAAG,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACtC,MAAM,EAAE,GAAG,GAAG,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;YACjH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;YACzE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YACxD,GAAG,CAAC,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,IAAI,GAAG,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACtC,MAAM,EAAE,GAAG,GAAG,CAAC,kBAAkB,CAAC;gBAChC,aAAa,EAAE,YAAY;gBAC3B,GAAG,IAAI;gBACP,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC5C,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;aAClC,CAAC,CAAC;YAExB,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YACrF,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;YACxJ,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC,CAAC;YACjE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;gBAC/B,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;gBAC5C,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;aACvD,CAAC,CAAC;YACH,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,GAAG,GAAG,oBAAoB,CAAC,aAAa,CAAC;QAC/C,MAAM,CAAC,GAAG,CAAC,CAAC;QACZ,MAAM,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACtC,MAAM,OAAO,GAAiB,EAAE,CAAC;YACjC,MAAM,OAAO,GAAiB,EAAE,CAAC;YACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;gBAC/B,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,cAAc,CAAC,aAAa,EAAE,KAAK,EAAE,MAAM,CAAC,iBAAiB,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,WAAW,EAAE,EAAyB,CAAC,CAAC;gBACpM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACvC,CAAC;YAED,gFAAgF;YAChF,KAAK,MAAM,QAAQ,IAAI,OAAO;gBAC5B,KAAK,MAAM,QAAQ,IAAI,OAAO;oBAC5B,GAAG,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;YAEhG,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACjF,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAChE,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;gBACvF,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;gBACxD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACtC,MAAM,CAAC,IAAI,GAAG,KAAK,IAAI,EAAE;oBACvB,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;oBAC5B,IAAI,MAAM;wBACR,EAAE,QAAQ,CAAC;oBACb,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC;gBACF,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACzE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrG,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,CAAC;YACD,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QACjG,MAAM,GAAG,GAAG,+BAA+B,CAAC;QAC5C,MAAM,eAAe,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QACnE,MAAM,QAAQ,GAAwC;YACpD,UAAU,CAAC,CAAC,CAAC;YACb,EAAE,QAAQ,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;YAC/D,eAAe;YACf,EAAE,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE;SACvD,CAAC;QACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC5E,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,mBAAmB,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/I,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { expect } from \"chai\";\r\nimport * as sinon from \"sinon\";\r\nimport { Guid, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Code, IModel, RelationshipProps, RepositoryLinkProps, SourceAndTarget } from \"@itwin/core-common\";\r\nimport { withEditTxn } from \"../../EditTxn\";\r\nimport { RepositoryLink } from \"../../Element\";\r\nimport { SnapshotDb } from \"../../IModelDb\";\r\nimport { ElementDrivesElement, ElementGroupsMembers, ElementRefersToElements } from \"../../Relationship\";\r\nimport { IModelTestUtils } from \"../IModelTestUtils\";\r\n\r\ndescribe(\"Relationships batched lookup\", () => {\r\n  const testSchema = `<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n    <ECSchema schemaName=\"BatchLookupTest\" alias=\"blt\" version=\"01.00.00\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.3.2\">\r\n      <ECSchemaReference name=\"BisCore\" version=\"01.00.00\" alias=\"bis\"/>\r\n      <ECStructClass typeName=\"TestStruct\">\r\n        <ECProperty propertyName=\"label\" typeName=\"string\"/>\r\n        <ECProperty propertyName=\"origin\" typeName=\"point2d\"/>\r\n      </ECStructClass>\r\n      <ECRelationshipClass typeName=\"TestRefersToElements\" strength=\"referencing\" modifier=\"Sealed\">\r\n        <BaseClass>bis:ElementRefersToElements</BaseClass>\r\n        <Source multiplicity=\"(0..*)\" roleLabel=\"refers to\" polymorphic=\"true\">\r\n          <Class class=\"bis:Element\"/>\r\n        </Source>\r\n        <Target multiplicity=\"(0..*)\" roleLabel=\"is referenced by\" polymorphic=\"true\">\r\n          <Class class=\"bis:Element\"/>\r\n        </Target>\r\n        <ECProperty propertyName=\"Location\" typeName=\"point3d\"/>\r\n        <ECStructProperty propertyName=\"Info\" typeName=\"TestStruct\"/>\r\n        <ECArrayProperty propertyName=\"Points\" typeName=\"point3d\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\r\n      </ECRelationshipClass>\r\n    </ECSchema>`;\r\n  const testRelClass = \"BatchLookupTest:TestRefersToElements\";\r\n\r\n  let imodel: SnapshotDb;\r\n  let elementIds: Id64String[];\r\n  let relIds: Id64String[];\r\n\r\n  before(async () => {\r\n    imodel = SnapshotDb.createEmpty(IModelTestUtils.prepareOutputFile(\"Relationship\", \"BatchLookup.bim\"), { rootSubject: { name: \"BatchLookup\" } });\r\n    await imodel.importSchemaStrings([testSchema]);\r\n    withEditTxn(imodel, (txn) => {\r\n      elementIds = [];\r\n      for (let i = 0; i < 6; ++i) {\r\n        const props: RepositoryLinkProps = {\r\n          classFullName: RepositoryLink.classFullName,\r\n          model: IModel.repositoryModelId,\r\n          code: Code.createEmpty(),\r\n          repositoryGuid: Guid.createValue(),\r\n        };\r\n        elementIds.push(txn.insertElement(props));\r\n      }\r\n\r\n      // Chain e0->e1->e2->e3->e4 with memberPriority equal to the source index.\r\n      relIds = [];\r\n      for (let i = 0; i < 4; ++i)\r\n        relIds.push(txn.insertRelationship(ElementGroupsMembers.create(imodel, elementIds[i], elementIds[i + 1], i).toJSON()));\r\n    });\r\n  });\r\n\r\n  after(() => imodel.close());\r\n\r\n  it(\"matches tryGetInstanceProps for ids and source/target pairs, preserving order\", async () => {\r\n    const [e0, e1, e2, e3, e4, e5] = elementIds;\r\n    const criteria: Array<Id64String | SourceAndTarget> = [\r\n      relIds[2],\r\n      { sourceId: e0, targetId: e1 },\r\n      Id64.fromLocalAndBriefcaseIds(0x7fff, 0), // non-existent id\r\n      { sourceId: e3, targetId: e4 },\r\n      { sourceId: e0, targetId: e2 }, // both ends requested elsewhere, but not related as a pair\r\n      { sourceId: e4, targetId: e5 }, // unrelated\r\n      Id64.invalid,\r\n      relIds[2], // duplicate\r\n      { sourceId: e1, targetId: e2 },\r\n      relIds[0],\r\n    ];\r\n\r\n    const batch = await imodel.relationships.queryInstancesProps(ElementGroupsMembers.classFullName, criteria);\r\n    expect(batch.length).to.equal(criteria.length);\r\n    criteria.forEach((criterion, i) => {\r\n      expect(batch[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(ElementGroupsMembers.classFullName, criterion), `criterion ${i}`);\r\n    });\r\n\r\n    expect(batch[0]?.id).to.equal(relIds[2]);\r\n    expect(batch[0]?.classFullName).to.equal(ElementGroupsMembers.classFullName);\r\n    expect((batch[1] as any).memberPriority).to.equal(0);\r\n    expect(batch[1]?.id).to.equal(relIds[0]);\r\n    expect(batch[2]).to.be.undefined;\r\n    expect(batch[3]?.id).to.equal(relIds[3]);\r\n    expect(batch[4]).to.be.undefined;\r\n    expect(batch[5]).to.be.undefined;\r\n    expect(batch[6]).to.be.undefined;\r\n    expect(batch[7]?.id).to.equal(relIds[2]);\r\n    expect(batch[8]?.id).to.equal(relIds[1]);\r\n\r\n    // The concurrent query connection sees the same saved data.\r\n    expect(await imodel.relationships.queryInstancesProps(ElementGroupsMembers.classFullName, criteria, { usePrimaryConn: false })).to.deep.equal(batch);\r\n  });\r\n\r\n  it(\"returns an empty array for empty criteria\", async () => {\r\n    expect(await imodel.relationships.queryInstancesProps(ElementGroupsMembers.classFullName, [])).to.deep.equal([]);\r\n    expect(await imodel.relationships.queryInstances(ElementGroupsMembers.classFullName, [])).to.deep.equal([]);\r\n  });\r\n\r\n  it(\"queries polymorphically and respects the relationship class\", async () => {\r\n    const criteria = [relIds[0], { sourceId: elementIds[1], targetId: elementIds[2] }];\r\n\r\n    const viaBase = await imodel.relationships.queryInstancesProps(ElementRefersToElements.classFullName, criteria);\r\n    expect(viaBase.map((p) => p?.classFullName)).to.deep.equal([ElementGroupsMembers.classFullName, ElementGroupsMembers.classFullName]);\r\n    criteria.forEach((criterion, i) => expect(viaBase[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(ElementRefersToElements.classFullName, criterion), `criterion ${i}`));\r\n\r\n    const viaOther = await imodel.relationships.queryInstancesProps(ElementDrivesElement.classFullName, criteria);\r\n    expect(viaOther).to.deep.equal([undefined, undefined]);\r\n  });\r\n\r\n  it(\"queryInstances constructs Relationship entities\", async () => {\r\n    const criteria = [relIds[1], { sourceId: elementIds[3], targetId: elementIds[4] }, Id64.invalid];\r\n    const rels = await imodel.relationships.queryInstances<ElementGroupsMembers>(ElementGroupsMembers.classFullName, criteria);\r\n    expect(rels.length).to.equal(3);\r\n    expect(rels[0]).to.be.instanceOf(ElementGroupsMembers);\r\n    expect(rels[0]?.id).to.equal(relIds[1]);\r\n    expect(rels[0]?.memberPriority).to.equal(1);\r\n    expect(rels[1]).to.be.instanceOf(ElementGroupsMembers);\r\n    expect(rels[1]?.sourceId).to.equal(elementIds[3]);\r\n    expect(rels[1]?.targetId).to.equal(elementIds[4]);\r\n    expect(rels[2]).to.be.undefined;\r\n    criteria.forEach((criterion, i) => expect(rels[i]?.toJSON()).to.deep.equal(imodel.relationships.tryGetInstance(ElementGroupsMembers.classFullName, criterion)?.toJSON(), `criterion ${i}`));\r\n  });\r\n\r\n  it(\"sees unsaved changes by default\", async () => {\r\n    const cls = ElementGroupsMembers.classFullName;\r\n    const pair = { sourceId: elementIds[4], targetId: elementIds[5] };\r\n    await withEditTxn(imodel, async (txn) => {\r\n      const id = txn.insertRelationship(ElementGroupsMembers.create(imodel, pair.sourceId, pair.targetId, 4).toJSON());\r\n      const found = await imodel.relationships.queryInstances(cls, [id, pair]);\r\n      expect(found.map((r) => r?.id)).to.deep.equal([id, id]);\r\n      txn.deleteRelationship(imodel.relationships.getInstanceProps(cls, id));\r\n    });\r\n  });\r\n\r\n  it(\"converts point, struct and array properties like tryGetInstanceProps\", async () => {\r\n    const pair = { sourceId: elementIds[0], targetId: elementIds[5] };\r\n    await withEditTxn(imodel, async (txn) => {\r\n      const id = txn.insertRelationship({\r\n        classFullName: testRelClass,\r\n        ...pair,\r\n        location: { x: 1, y: 2, z: 3 },\r\n        info: { label: \"a\", origin: { x: 4, y: 5 } },\r\n        points: [{ x: 6, y: 7, z: 8 }, { x: 9, y: 10, z: 11 }],\r\n      } as RelationshipProps);\r\n\r\n      const criteria = [id, pair];\r\n      const batch = await imodel.relationships.queryInstancesProps(testRelClass, criteria);\r\n      criteria.forEach((criterion, i) => expect(batch[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(testRelClass, criterion), `criterion ${i}`));\r\n      expect(batch[0]).to.include({ id, classFullName: testRelClass });\r\n      expect(batch[0]).to.deep.include({\r\n        location: { x: 1, y: 2, z: 3 },\r\n        info: { label: \"a\", origin: { x: 4, y: 5 } },\r\n        points: [{ x: 6, y: 7, z: 8 }, { x: 9, y: 10, z: 11 }],\r\n      });\r\n      txn.deleteRelationship(batch[0]!);\r\n    });\r\n  });\r\n\r\n  it(\"reads only the requested pairs in a dense many-to-many graph\", async () => {\r\n    const cls = ElementGroupsMembers.classFullName;\r\n    const n = 5;\r\n    await withEditTxn(imodel, async (txn) => {\r\n      const sources: Id64String[] = [];\r\n      const targets: Id64String[] = [];\r\n      for (let i = 0; i < 2 * n; ++i) {\r\n        const id = txn.insertElement({ classFullName: RepositoryLink.classFullName, model: IModel.repositoryModelId, code: Code.createEmpty(), repositoryGuid: Guid.createValue() } as RepositoryLinkProps);\r\n        (i < n ? sources : targets).push(id);\r\n      }\r\n\r\n      // Connect every source to every target, then request only the \"diagonal\" pairs.\r\n      for (const sourceId of sources)\r\n        for (const targetId of targets)\r\n          txn.insertRelationship(ElementGroupsMembers.create(imodel, sourceId, targetId, 0).toJSON());\r\n\r\n      const pairs = sources.map((sourceId, i) => ({ sourceId, targetId: targets[i] }));\r\n      let rowsRead = 0;\r\n      const createQueryReader = imodel.createQueryReader.bind(imodel);\r\n      const stub = sinon.stub(imodel, \"createQueryReader\").callsFake((ecsql, params, config) => {\r\n        const reader = createQueryReader(ecsql, params, config);\r\n        const step = reader.step.bind(reader);\r\n        reader.step = async () => {\r\n          const hasRow = await step();\r\n          if (hasRow)\r\n            ++rowsRead;\r\n          return hasRow;\r\n        };\r\n        return reader;\r\n      });\r\n      try {\r\n        const found = await imodel.relationships.queryInstancesProps(cls, pairs);\r\n        expect(found.map((p) => p && { sourceId: p.sourceId, targetId: p.targetId })).to.deep.equal(pairs);\r\n      } finally {\r\n        stub.restore();\r\n      }\r\n      expect(rowsRead).to.equal(n);\r\n    });\r\n  });\r\n\r\n  it(\"supports relationships stored as navigation properties and ids from any briefcase\", async () => {\r\n    const cls = \"BisCore:ModelContainsElements\";\r\n    const highBriefcaseId = Id64.fromLocalAndBriefcaseIds(1, 0xfffffd);\r\n    const criteria: Array<Id64String | SourceAndTarget> = [\r\n      elementIds[0],\r\n      { sourceId: IModel.repositoryModelId, targetId: elementIds[1] },\r\n      highBriefcaseId,\r\n      { sourceId: highBriefcaseId, targetId: elementIds[1] },\r\n    ];\r\n    const batch = await imodel.relationships.queryInstancesProps(cls, criteria);\r\n    criteria.forEach((criterion, i) => expect(batch[i]).to.deep.equal(imodel.relationships.tryGetInstanceProps(cls, criterion), `criterion ${i}`));\r\n    expect(batch.map((p) => p?.targetId)).to.deep.equal([elementIds[0], elementIds[1], undefined, undefined]);\r\n  });\r\n});\r\n"]}

package/lib/esm/test/hubaccess/BriefcaseManager.test.js

@@ -2,15 +2,19 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-import { assert } from "chai";
+import * as chai from "chai";
+import * as chaiAsPromised from "chai-as-promised";
 import { Guid } from "@itwin/core-bentley";
 import { BriefcaseIdValue } from "@itwin/core-common";
+import { Range3d } from "@itwin/core-geometry";
 import { HubWrappers, IModelTestUtils } from "../IModelTestUtils";
 import { KnownTestLocations } from "../KnownTestLocations";
 import { HubMock } from "../../internal/HubMock";
 import { TestChangeSetUtility } from "../TestChangeSetUtility";
 import { _nativeDb, ChannelControl, ProgressStatus } from "../../core-backend";
 import { withEditTxn } from "../../EditTxn";
+chai.use(chaiAsPromised);
+const assert = chai.assert;
 describe("BriefcaseManager", async () => {
     const testITwinId = Guid.createValue();
     const managerAccessToken = "manager mock token";
@@ -234,5 +238,187 @@ describe("BriefcaseManager", async () => {
             await testUtility.deleteTestIModel();
         });
     });
+    describe("TxnManager.onPrePushValidation", () => {
+        const user2 = "user2 mock token";
+        const user3 = "user3 mock token";
+        /** Creates an empty iModel and opens a briefcase with one local, unpushed change to the root subject's user label. */
+        async function setupBriefcaseWithLocalChange(testName) {
+            HubMock.startup(testName, KnownTestLocations.outputDir);
+            const iTwinId = HubMock.iTwinId;
+            const iModelId = await HubWrappers.recreateIModel({ accessToken: user2, iTwinId, iModelName: testName, noLocks: true });
+            const briefcase = await HubWrappers.downloadAndOpenBriefcase({ accessToken: user2, iTwinId, iModelId });
+            briefcase.channels.addAllowedChannel(ChannelControl.sharedChannelName);
+            const rootEl = briefcase.elements.getRootSubject();
+            rootEl.userLabel = "local change";
+            withEditTxn(briefcase, (txn) => txn.updateElement(rootEl.toJSON()));
+            assert.isTrue(briefcase.txns.hasPendingTxns);
+            return { iTwinId, iModelId, briefcase };
+        }
+        it("delays the push until the listener's promise resolves", async () => {
+            const { briefcase } = await setupBriefcaseWithLocalChange("prePushDelay");
+            const changesetBeforePush = briefcase.changeset.id;
+            const events = [];
+            let changesetWhenListenerFinished;
+            let releaseListener;
+            const gate = new Promise((resolve) => { releaseListener = resolve; });
+            let listenerStarted;
+            const started = new Promise((resolve) => { listenerStarted = resolve; });
+            const removeListener = briefcase.txns.onPrePushValidation.addListener(async () => {
+                events.push("listener started");
+                listenerStarted();
+                await gate;
+                changesetWhenListenerFinished = briefcase.changeset.id;
+                events.push("listener finished");
+            });
+            try {
+                const pushPromise = briefcase.pushChanges({ accessToken: user2, description: "delayed push" }).then(() => { events.push("push settled"); });
+                await started;
+                events.push("listener released");
+                releaseListener();
+                await pushPromise;
+                assert.deepEqual(events, ["listener started", "listener released", "listener finished", "push settled"]);
+                assert.strictEqual(changesetWhenListenerFinished, changesetBeforePush, "nothing should be pushed before the listener resolves");
+                assert.notStrictEqual(briefcase.changeset.id, changesetBeforePush, "push should complete once the listener resolves");
+                assert.isFalse(briefcase.txns.hasPendingTxns);
+            }
+            finally {
+                releaseListener();
+                removeListener();
+            }
+            await HubWrappers.closeAndDeleteBriefcaseDb(user2, briefcase);
+        });
+        it("includes a Txn written by the listener in the pushed changeset", async () => {
+            const { iTwinId, iModelId, briefcase } = await setupBriefcaseWithLocalChange("prePushWriteTxn");
+            const changesetBeforePush = briefcase.changeset.id;
+            const txnCountBeforePush = Array.from(briefcase.txns.queryTxns()).length;
+            let txnCountInListener = 0;
+            const removeListener = briefcase.txns.onPrePushValidation.addListener(async () => {
+                const rootEl = briefcase.elements.getRootSubject();
+                rootEl.description = "written during pre-push validation";
+                withEditTxn(briefcase, (txn) => txn.updateElement(rootEl.toJSON()));
+                txnCountInListener = Array.from(briefcase.txns.queryTxns()).length;
+            });
+            try {
+                await briefcase.pushChanges({ accessToken: user2, description: "push with pre-push txn" });
+            }
+            finally {
+                removeListener();
+            }
+            assert.isAbove(txnCountInListener, txnCountBeforePush, "listener should have written a new Txn");
+            assert.notStrictEqual(briefcase.changeset.id, changesetBeforePush);
+            assert.isFalse(briefcase.txns.hasPendingTxns, "the listener's Txn should have been pushed, not left pending");
+            // A fresh briefcase at the tip only sees the listener's change if it was part of the pushed changeset.
+            const verifier = await HubWrappers.downloadAndOpenBriefcase({ accessToken: user3, iTwinId, iModelId });
+            const pushedRoot = verifier.elements.getRootSubject();
+            assert.strictEqual(pushedRoot.userLabel, "local change");
+            assert.strictEqual(pushedRoot.description, "written during pre-push validation");
+            await HubWrappers.closeAndDeleteBriefcaseDb(user3, verifier);
+            await HubWrappers.closeAndDeleteBriefcaseDb(user2, briefcase);
+        });
+        it("aborts the push when the listener rejects", async () => {
+            const { briefcase } = await setupBriefcaseWithLocalChange("prePushReject");
+            const changesetBeforePush = briefcase.changeset.id;
+            const removeListener = briefcase.txns.onPrePushValidation.addListener(async () => {
+                throw new Error("validation failed");
+            });
+            try {
+                await assert.isRejected(briefcase.pushChanges({ accessToken: user2, description: "rejected push" }), "validation failed");
+            }
+            finally {
+                removeListener();
+            }
+            assert.strictEqual(briefcase.changeset.id, changesetBeforePush, "briefcase should not have advanced");
+            assert.isTrue(briefcase.txns.hasPendingTxns, "local changes should still be pending");
+            // With the listener removed, the same changes can still be pushed.
+            await briefcase.pushChanges({ accessToken: user2, description: "retry push" });
+            assert.notStrictEqual(briefcase.changeset.id, changesetBeforePush);
+            assert.isFalse(briefcase.txns.hasPendingTxns);
+            await HubWrappers.closeAndDeleteBriefcaseDb(user2, briefcase);
+        });
+        it("handles a listener that calls pushChanges, recursing asynchronously", async () => {
+            const { briefcase } = await setupBriefcaseWithLocalChange("prePushRecursion");
+            const changesetBeforePush = briefcase.changeset.id;
+            let listenerCalls = 0;
+            let changesetAfterNestedPush;
+            // addOnce removes the listener before invoking it, so the nested push does not re-enter it endlessly.
+            const removeListener = briefcase.txns.onPrePushValidation.addOnce(async () => {
+                ++listenerCalls;
+                await briefcase.pushChanges({ accessToken: user2, description: "nested push" });
+                changesetAfterNestedPush = briefcase.changeset.id;
+            });
+            try {
+                // The nested push consumes all pending Txns, so the outer push has nothing left to push and completes quietly.
+                await briefcase.pushChanges({ accessToken: user2, description: "outer push" });
+            }
+            finally {
+                removeListener();
+            }
+            assert.strictEqual(listenerCalls, 1, "listener should only run for the outer push");
+            assert.isDefined(changesetAfterNestedPush);
+            assert.notStrictEqual(changesetAfterNestedPush, changesetBeforePush, "nested push should have pushed the changes");
+            assert.strictEqual(briefcase.changeset.id, changesetAfterNestedPush);
+            assert.isFalse(briefcase.txns.hasPendingTxns);
+            await HubWrappers.closeAndDeleteBriefcaseDb(user2, briefcase);
+        });
+        describe("after pull/merge", () => {
+            const incomingExtents = new Range3d(-100, -200, -300, 400, 500, 600);
+            // Note: only project extents are covered. The native getIModelProps("pullMerge") does not reload geolocation (ECEF location, global origin) after a merge.
+            /** user2 has a local unpushed change; user3 then pushes new project extents that user2 has not yet pulled. */
+            async function setup(testName) {
+                HubMock.startup(testName, KnownTestLocations.outputDir);
+                const iTwinId = HubMock.iTwinId;
+                const iModelId = await HubWrappers.recreateIModel({ accessToken: user2, iTwinId, iModelName: testName, noLocks: true });
+                const local = await HubWrappers.downloadAndOpenBriefcase({ accessToken: user2, iTwinId, iModelId });
+                local.channels.addAllowedChannel(ChannelControl.sharedChannelName);
+                const rootEl = local.elements.getRootSubject();
+                rootEl.userLabel = "local change";
+                withEditTxn(local, (txn) => txn.updateElement(rootEl.toJSON()));
+                const remote = await HubWrappers.downloadAndOpenBriefcase({ accessToken: user3, iTwinId, iModelId });
+                remote.channels.addAllowedChannel(ChannelControl.sharedChannelName);
+                withEditTxn(remote, (txn) => txn.updateProjectExtents(incomingExtents));
+                await remote.pushChanges({ accessToken: user3, description: "project extents" });
+                return { iTwinId, iModelId, local, remote };
+            }
+            it("exposes the merged project extents to listeners", async () => {
+                const { local, remote } = await setup("prePushMergedProps");
+                let seenExtents;
+                const removeListener = local.txns.onPrePushValidation.addListener(async () => {
+                    seenExtents = local.projectExtents.clone();
+                });
+                try {
+                    await local.pushChanges({ accessToken: user2, description: "push after merge" });
+                }
+                finally {
+                    removeListener();
+                }
+                assert.isDefined(seenExtents);
+                assert.isTrue(seenExtents.isAlmostEqual(incomingExtents), "listener should see the merged project extents");
+                await HubWrappers.closeAndDeleteBriefcaseDb(user3, remote);
+                await HubWrappers.closeAndDeleteBriefcaseDb(user2, local);
+            });
+            it("lets a listener extend the merged project extents", async () => {
+                const { iTwinId, iModelId, local, remote } = await setup("prePushExtendExtents");
+                const extra = new Range3d(500, 600, 700, 800, 900, 1000);
+                const expected = incomingExtents.clone();
+                expected.extendRange(extra);
+                const removeListener = local.txns.onPrePushValidation.addListener(async () => {
+                    const extended = local.projectExtents.clone();
+                    extended.extendRange(extra);
+                    withEditTxn(local, (txn) => txn.updateProjectExtents(extended));
+                });
+                try {
+                    await local.pushChanges({ accessToken: user2, description: "push after merge" });
+                }
+                finally {
+                    removeListener();
+                }
+                const verifier = await HubWrappers.downloadAndOpenBriefcase({ accessToken: user3, iTwinId, iModelId, briefcaseId: BriefcaseIdValue.Unassigned });
+                assert.isTrue(verifier.projectExtents.isAlmostEqual(expected), "pushed extents should extend the merged extents, not the stale pre-merge extents");
+                await HubWrappers.closeAndDeleteBriefcaseDb(user3, verifier);
+                await HubWrappers.closeAndDeleteBriefcaseDb(user3, remote);
+                await HubWrappers.closeAndDeleteBriefcaseDb(user2, local);
+            });
+        });
+    });
 });
 //# sourceMappingURL=BriefcaseManager.test.js.map