@itwin/core-backend 5.5.0-dev.1 → 5.5.0-dev.4

package/lib/esm/test/incrementalSchemaLocater/TestContext.d.ts

@@ -0,0 +1,27 @@
+import { Schema, SchemaContext, SchemaKey } from "@itwin/ecschema-metadata";
+import { IModelIncrementalSchemaLocater } from "../../IModelIncrementalSchemaLocater";
+import { IModelDb } from "../../IModelDb";
+interface Options {
+    readonly bimFile?: string;
+    readonly incrementalSchemaLoading?: "enabled" | "disabled" | undefined;
+}
+type SchemaLocaterType<TOptions> = TOptions extends {
+    incrementalSchemaLoading: "disabled";
+} ? never : IModelIncrementalSchemaLocater;
+export declare class TestContext<TLocater = never> implements AsyncDisposable {
+    private readonly _iModel;
+    private readonly _schemaLocater;
+    private readonly _assetContext;
+    private constructor();
+    get iModel(): IModelDb;
+    get schemaLocater(): TLocater;
+    get schemaContext(): SchemaContext;
+    static create<TOptions extends Options>(options?: TOptions): Promise<TestContext<SchemaLocaterType<TOptions>>>;
+    private static loadIModelFile;
+    private static createIModel;
+    getSchemaNames(): Promise<string[]>;
+    importAssetSchema(schemaKey: SchemaKey): Promise<Schema>;
+    [Symbol.asyncDispose](): Promise<void>;
+}
+export {};
+//# sourceMappingURL=TestContext.d.ts.map

package/lib/esm/test/incrementalSchemaLocater/TestContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestContext.d.ts","sourceRoot":"","sources":["../../../../src/test/incrementalSchemaLocater/TestContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAsC,SAAS,EAAmB,MAAM,0BAA0B,CAAC;AACjI,OAAO,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAe,QAAQ,EAAgB,MAAM,gBAAgB,CAAC;AAUrE,UAAU,OAAO;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,wBAAwB,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;CACxE;AAED,KAAK,iBAAiB,CAAC,QAAQ,IAAI,QAAQ,SAAS;IAAE,wBAAwB,EAAE,UAAU,CAAA;CAAE,GAAG,KAAK,GAAG,8BAA8B,CAAC;AAEtI,qBAAa,WAAW,CAAC,QAAQ,GAAG,KAAK,CAAE,YAAW,eAAe;IACnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAW;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAW;IAC1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAE9C,OAAO;IAoBP,IAAW,MAAM,IAAI,QAAQ,CAE5B;IAED,IAAW,aAAa,IAAI,QAAQ,CAEnC;IAED,IAAW,aAAa,IAAI,aAAa,CAExC;WAEmB,MAAM,CAAC,QAAQ,SAAS,OAAO,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;mBAqBtG,cAAc;mBASd,YAAY;IAuBpB,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAenC,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IA6BxD,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;CAGpD"}

package/lib/esm/test/incrementalSchemaLocater/TestContext.js

@@ -0,0 +1,136 @@
+import { SchemaContext, SchemaGraphUtil, SchemaJsonLocater, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { IModelIncrementalSchemaLocater } from "../../IModelIncrementalSchemaLocater";
+import { BriefcaseDb, IModelDb, StandaloneDb } from "../../IModelDb";
+import { IModelHost } from "../../IModelHost";
+import { KnownTestLocations } from "../KnownTestLocations";
+import { OpenMode } from "@itwin/core-bentley";
+import { IModelJsFs } from "../../IModelJsFs";
+import { ProfileOptions } from "@itwin/core-common";
+import { SchemaXmlFileLocater } from "@itwin/ecschema-locaters";
+import { DOMParser, XMLSerializer } from "@xmldom/xmldom";
+import * as path from "path";
+export class TestContext {
+    _iModel;
+    _schemaLocater;
+    _assetContext;
+    constructor(iModel) {
+        this._iModel = iModel;
+        this._schemaLocater = this._iModel.schemaContext.locaters.find((locater) => {
+            return locater instanceof IModelIncrementalSchemaLocater;
+        });
+        // Ideally we should not need a seperate context here to locate and locate the bisschemas from the
+        // parent imodel context, but due to a bug in the incremental schema logic, we have to do this for now.
+        // TODO: remove this when issue #1763 is fixed.
+        this._assetContext = new SchemaContext();
+        this._assetContext.addLocater(new SchemaJsonLocater((schemaName) => {
+            return iModel.getSchemaProps(schemaName);
+        }));
+        const xmlAssetSchemaLocater = new SchemaXmlFileLocater();
+        xmlAssetSchemaLocater.addSchemaSearchPath(path.join(KnownTestLocations.assetsDir, "IncrementalSchemaLocater"));
+        this._assetContext.addLocater(xmlAssetSchemaLocater);
+        iModel.schemaContext.addLocater(this._assetContext);
+    }
+    get iModel() {
+        return this._iModel;
+    }
+    get schemaLocater() {
+        return this._schemaLocater;
+    }
+    get schemaContext() {
+        return this._iModel.schemaContext;
+    }
+    static async create(options) {
+        if (!IModelHost.isValid) {
+            await IModelHost.startup();
+        }
+        const iModel = options?.bimFile ?
+            await this.loadIModelFile(options.bimFile) :
+            await this.createIModel();
+        const configuration = IModelHost.configuration;
+        if (configuration) {
+            const previousSetting = configuration.incrementalSchemaLoading;
+            configuration.incrementalSchemaLoading = options ? options.incrementalSchemaLoading : "enabled";
+            iModel.onBeforeClose.addOnce(() => {
+                configuration.incrementalSchemaLoading = previousSetting;
+            });
+        }
+        return new TestContext(iModel);
+    }
+    static async loadIModelFile(bimFile) {
+        const pathToBriefCase = path.join(KnownTestLocations.assetsDir, bimFile);
+        return BriefcaseDb.open({
+            fileName: pathToBriefCase,
+            readonly: true,
+            key: "test-iModel",
+        });
+    }
+    static async createIModel() {
+        const testBimPath = path.join(KnownTestLocations.assetsDir, "IncrementalSchemaLocater", "test-bim.bim");
+        if (IModelJsFs.existsSync(testBimPath)) {
+            ~IModelJsFs.removeSync(testBimPath);
+        }
+        const localBim = StandaloneDb.createEmpty(testBimPath, {
+            allowEdit: "true",
+            rootSubject: {
+                name: "IncrementalSchemaTestingDb"
+            },
+        });
+        localBim.close();
+        const nativeDb = IModelDb.openDgnDb({ path: testBimPath }, OpenMode.ReadWrite, { profile: ProfileOptions.Upgrade });
+        nativeDb.saveChanges();
+        nativeDb.closeFile();
+        return StandaloneDb.openFile(testBimPath, OpenMode.ReadWrite);
+    }
+    async getSchemaNames() {
+        const result = new Array();
+        const sqlQuery = "SELECT Name, VersionMajor, VersionWrite, VersionMinor FROM meta.ECSchemaDef ORDER BY Name";
+        const reader = this._iModel.createQueryReader(sqlQuery);
+        while (await reader.step()) {
+            const name = reader.current[0];
+            const versionMajor = reader.current[1];
+            const versionWrite = reader.current[2];
+            const versionMinor = reader.current[3];
+            result.push(`${name}.${versionMajor}.${versionWrite}.${versionMinor}`);
+        }
+        return result;
+    }
+    async importAssetSchema(schemaKey) {
+        // If schema is already in the iModel, return it.
+        if (undefined !== this.iModel.querySchemaVersion(schemaKey.name))
+            return await this.schemaContext.getSchema(schemaKey);
+        // Locate the schema from the assets using the schema contexts asset locaters.
+        const testSchema = await this._assetContext.getSchema(schemaKey, SchemaMatchType.Exact);
+        if (undefined === testSchema)
+            throw new Error(`The schema '${schemaKey.name}' could not be found in the assets folder.`);
+        const schemaXml = await getOrderedSchemaStrings(testSchema);
+        await this._iModel.importSchemaStrings(schemaXml);
+        this._iModel.saveChanges();
+        if (this.iModel.isBriefcaseDb() && !this.iModel.isReadonly) {
+            await this.iModel.pushChanges({ description: "import test schema" });
+        }
+        const schema = await this.schemaContext.getSchema(schemaKey);
+        if (undefined === schema)
+            throw new Error(`The schema '${schemaKey.name}' could not be found after import.`);
+        if (schema.loadingController && !schema.loadingController.isComplete) {
+            await schema.loadingController.wait();
+        }
+        return schema;
+    }
+    async [Symbol.asyncDispose]() {
+        return this._iModel.close();
+    }
+}
+async function getOrderedSchemaStrings(insertSchema) {
+    const schemas = SchemaGraphUtil.buildDependencyOrderedSchemaList(insertSchema);
+    const schemaStrings = await Promise.all(schemas.map(async (schema) => getSchemaString(schema)));
+    return schemaStrings;
+}
+async function getSchemaString(schema) {
+    // Serialize schema to the document object
+    const xmlDocument = new DOMParser().parseFromString(`<?xml version="1.0" encoding="UTF-8"?>`, "application/xml");
+    await schema.toXml(xmlDocument);
+    const serializer = new XMLSerializer();
+    const xml = serializer.serializeToString(xmlDocument);
+    return xml;
+}
+//# sourceMappingURL=TestContext.js.map

package/lib/esm/test/incrementalSchemaLocater/TestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestContext.js","sourceRoot":"","sources":["../../../../src/test/incrementalSchemaLocater/TestContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,aAAa,EAAE,eAAe,EAAE,iBAAiB,EAAa,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACjI,OAAO,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAS7B,MAAM,OAAO,WAAW;IACL,OAAO,CAAW;IAClB,cAAc,CAAW;IACzB,aAAa,CAAgB;IAE9C,YAAoB,MAAgB;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;YACzE,OAAO,OAAO,YAAY,8BAA8B,CAAC;QAC3D,CAAC,CAAa,CAAC;QAEf,kGAAkG;QAClG,uGAAuG;QACvG,+CAA+C;QAC/C,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QACzC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,iBAAiB,CAAC,CAAC,UAAU,EAAE,EAAE;YACjE,OAAO,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC,CAAA;QACH,MAAM,qBAAqB,GAAG,IAAI,oBAAoB,EAAE,CAAC;QACzD,qBAAqB,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAC,CAAC;QAC/G,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;QAErD,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtD,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAA2B,OAAkB;QACrE,IAAG,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,UAAU,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC;QAED,MAAM,MAAM,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/B,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAC5C,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE5B,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC/C,IAAG,aAAa,EAAE,CAAC;YACjB,MAAM,eAAe,GAAG,aAAa,CAAC,wBAAwB,CAAC;YAC/D,aAAa,CAAC,wBAAwB,GAAG,OAAO,CAAC,CAAC,CAAA,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/F,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE;gBAChC,aAAa,CAAC,wBAAwB,GAAG,eAAe,CAAC;YAC3D,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,OAAe;QACjD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACzE,OAAO,WAAW,CAAC,IAAI,CAAC;YACtB,QAAQ,EAAE,eAAe;YACzB,QAAQ,EAAE,IAAI;YACd,GAAG,EAAE,aAAa;SACnB,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,YAAY;QAC/B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,0BAA0B,EAAE,cAAc,CAAC,CAAC;QAExG,IAAI,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAAA,CACvC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC,WAAW,EAAE;YACrD,SAAS,EAAE,MAAM;YACjB,WAAW,EAAE;gBACX,IAAI,EAAE,4BAA4B;aACnC;SACF,CAAC,CAAC;QAEH,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEjB,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;QACpH,QAAQ,CAAC,WAAW,EAAE,CAAC;QACvB,QAAQ,CAAC,SAAS,EAAE,CAAC;QAErB,OAAO,YAAY,CAAC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,MAAM,QAAQ,GAAG,2FAA2F,CAAC;QAC7G,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACxD,OAAO,MAAM,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC/B,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAEvC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,YAAY,IAAI,YAAY,IAAI,YAAY,EAAE,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,SAAoB;QACjD,iDAAiD;QACjD,IAAI,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,SAAS,CAAC,IAAI,CAAC;YAC9D,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAW,CAAC;QAEjE,8EAA8E;QAC9E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACxF,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,KAAK,CAAC,eAAe,SAAS,CAAC,IAAI,4CAA4C,CAAC,CAAC;QAE7F,MAAM,SAAS,GAAG,MAAM,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAE3B,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC3D,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,IAAI,KAAK,CAAC,eAAe,SAAS,CAAC,IAAI,oCAAoC,CAAC,CAAC;QAErF,IAAG,MAAM,CAAC,iBAAiB,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YACpE,MAAM,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;QACxC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;CACF;AAED,KAAK,UAAU,uBAAuB,CAAC,YAAoB;IACzD,MAAM,OAAO,GAAG,eAAe,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC;IAC/E,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAChG,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,MAAc;IAC3C,0CAA0C;IAC1C,MAAM,WAAW,GAAG,IAAI,SAAS,EAAE,CAAC,eAAe,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;IACjH,MAAM,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAEhC,MAAM,UAAU,GAAG,IAAI,aAAa,EAAE,CAAC;IACvC,MAAM,GAAG,GAAG,UAAU,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAEtD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import { Schema, SchemaContext, SchemaGraphUtil, SchemaJsonLocater, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { IModelIncrementalSchemaLocater } from \"../../IModelIncrementalSchemaLocater\";\r\nimport { BriefcaseDb, IModelDb, StandaloneDb } from \"../../IModelDb\";\r\nimport { IModelHost } from \"../../IModelHost\";\r\nimport { KnownTestLocations } from \"../KnownTestLocations\";\r\nimport { OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModelJsFs } from \"../../IModelJsFs\";\r\nimport { ProfileOptions } from \"@itwin/core-common\";\r\nimport { SchemaXmlFileLocater } from \"@itwin/ecschema-locaters\";\r\nimport { DOMParser, XMLSerializer } from \"@xmldom/xmldom\";\r\nimport * as path from \"path\";\r\n\r\ninterface Options {\r\n  readonly bimFile?: string;\r\n  readonly incrementalSchemaLoading?: \"enabled\" | \"disabled\" | undefined;\r\n}\r\n\r\ntype SchemaLocaterType<TOptions> = TOptions extends { incrementalSchemaLoading: \"disabled\" } ? never : IModelIncrementalSchemaLocater;\r\n\r\nexport class TestContext<TLocater = never> implements AsyncDisposable {\r\n  private readonly _iModel: IModelDb;\r\n  private readonly _schemaLocater: TLocater;\r\n  private readonly _assetContext: SchemaContext;\r\n\r\n  private constructor(iModel: IModelDb) {\r\n    this._iModel = iModel;\r\n    this._schemaLocater = this._iModel.schemaContext.locaters.find((locater) => {\r\n      return locater instanceof IModelIncrementalSchemaLocater;\r\n    }) as TLocater;\r\n\r\n    // Ideally we should not need a seperate context here to locate and locate the bisschemas from the\r\n    // parent imodel context, but due to a bug in the incremental schema logic, we have to do this for now.\r\n    // TODO: remove this when issue #1763 is fixed.\r\n    this._assetContext = new SchemaContext();\r\n    this._assetContext.addLocater(new SchemaJsonLocater((schemaName) => {\r\n      return iModel.getSchemaProps(schemaName);\r\n    }))\r\n    const xmlAssetSchemaLocater = new SchemaXmlFileLocater();\r\n    xmlAssetSchemaLocater.addSchemaSearchPath(path.join(KnownTestLocations.assetsDir, \"IncrementalSchemaLocater\"));\r\n    this._assetContext.addLocater(xmlAssetSchemaLocater);\r\n\r\n    iModel.schemaContext.addLocater(this._assetContext);\r\n  }\r\n\r\n  public get iModel(): IModelDb {\r\n    return this._iModel;\r\n  }\r\n\r\n  public get schemaLocater(): TLocater {\r\n    return this._schemaLocater;\r\n  }\r\n\r\n  public get schemaContext(): SchemaContext {\r\n    return this._iModel.schemaContext;\r\n  }\r\n\r\n  public static async create<TOptions extends Options>(options?: TOptions): Promise<TestContext<SchemaLocaterType<TOptions>>> {\r\n    if(!IModelHost.isValid) {\r\n      await IModelHost.startup()\r\n    }\r\n\r\n    const iModel = options?.bimFile ?\r\n      await this.loadIModelFile(options.bimFile) :\r\n      await this.createIModel();\r\n\r\n    const configuration = IModelHost.configuration;\r\n    if(configuration) {\r\n      const previousSetting = configuration.incrementalSchemaLoading;\r\n      configuration.incrementalSchemaLoading = options ?options.incrementalSchemaLoading : \"enabled\";\r\n      iModel.onBeforeClose.addOnce(() => {\r\n        configuration.incrementalSchemaLoading = previousSetting;\r\n      });\r\n    }\r\n\r\n    return new TestContext(iModel);\r\n  }\r\n\r\n  private static async loadIModelFile(bimFile: string): Promise<IModelDb> {\r\n    const pathToBriefCase = path.join(KnownTestLocations.assetsDir, bimFile);\r\n    return BriefcaseDb.open({\r\n      fileName: pathToBriefCase,\r\n      readonly: true,\r\n      key: \"test-iModel\",\r\n    });\r\n  }\r\n\r\n  private static async createIModel(): Promise<IModelDb> {\r\n    const testBimPath = path.join(KnownTestLocations.assetsDir, \"IncrementalSchemaLocater\", \"test-bim.bim\");\r\n\r\n    if (IModelJsFs.existsSync(testBimPath)) {~\r\n      IModelJsFs.removeSync(testBimPath);\r\n    }\r\n\r\n    const localBim = StandaloneDb.createEmpty(testBimPath, {\r\n      allowEdit: \"true\",\r\n      rootSubject: {\r\n        name: \"IncrementalSchemaTestingDb\"\r\n      },\r\n    });\r\n\r\n    localBim.close();\r\n\r\n    const nativeDb = IModelDb.openDgnDb({ path: testBimPath }, OpenMode.ReadWrite, { profile: ProfileOptions.Upgrade });\r\n    nativeDb.saveChanges();\r\n    nativeDb.closeFile();\r\n\r\n    return StandaloneDb.openFile(testBimPath, OpenMode.ReadWrite);\r\n  }\r\n\r\n  public async getSchemaNames(): Promise<string[]> {\r\n    const result = new Array<string>();\r\n    const sqlQuery = \"SELECT Name, VersionMajor, VersionWrite, VersionMinor FROM meta.ECSchemaDef ORDER BY Name\";\r\n    const reader = this._iModel.createQueryReader(sqlQuery);\r\n    while (await reader.step()) {\r\n      const name = reader.current[0];\r\n      const versionMajor = reader.current[1];\r\n      const versionWrite = reader.current[2];\r\n      const versionMinor = reader.current[3];\r\n\r\n      result.push(`${name}.${versionMajor}.${versionWrite}.${versionMinor}`);\r\n    }\r\n    return result;\r\n  }\r\n\r\n  public async importAssetSchema(schemaKey: SchemaKey): Promise<Schema> {\r\n    // If schema is already in the iModel, return it.\r\n    if (undefined !== this.iModel.querySchemaVersion(schemaKey.name))\r\n      return await this.schemaContext.getSchema(schemaKey) as Schema;\r\n\r\n    // Locate the schema from the assets using the schema contexts asset locaters.\r\n    const testSchema = await this._assetContext.getSchema(schemaKey, SchemaMatchType.Exact);\r\n    if (undefined === testSchema)\r\n      throw new Error(`The schema '${schemaKey.name}' could not be found in the assets folder.`);\r\n\r\n    const schemaXml = await getOrderedSchemaStrings(testSchema);\r\n    await this._iModel.importSchemaStrings(schemaXml);\r\n    this._iModel.saveChanges();\r\n\r\n    if (this.iModel.isBriefcaseDb() && !this.iModel.isReadonly) {\r\n      await this.iModel.pushChanges({ description: \"import test schema\" });\r\n    }\r\n\r\n    const schema = await this.schemaContext.getSchema(schemaKey);\r\n    if (undefined === schema)\r\n      throw new Error(`The schema '${schemaKey.name}' could not be found after import.`);\r\n\r\n    if(schema.loadingController && !schema.loadingController.isComplete) {\r\n      await schema.loadingController.wait();\r\n    }\r\n\r\n    return schema;\r\n  }\r\n\r\n  public async [Symbol.asyncDispose](): Promise<void> {\r\n    return this._iModel.close();\r\n  }\r\n}\r\n\r\nasync function getOrderedSchemaStrings(insertSchema: Schema): Promise<string[]> {\r\n  const schemas = SchemaGraphUtil.buildDependencyOrderedSchemaList(insertSchema);\r\n  const schemaStrings = await Promise.all(schemas.map(async (schema) => getSchemaString(schema)));\r\n  return schemaStrings;\r\n}\r\n\r\nasync function getSchemaString(schema: Schema): Promise<string> {\r\n  // Serialize schema to the document object\r\n  const xmlDocument = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\r\n  await schema.toXml(xmlDocument);\r\n\r\n  const serializer = new XMLSerializer();\r\n  const xml = serializer.serializeToString(xmlDocument);\r\n\r\n  return xml;\r\n}\r\n"]}

package/lib/esm/test/standalone/ChangesetReader.test.js

@@ -55,18 +55,19 @@ var __disposeResources = (this && this.__disposeResources) || (function (Suppres
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 import { DbResult, Id64 } from "@itwin/core-bentley";
-import { Code, ColorDef, IModel, SubCategoryAppearance } from "@itwin/core-common";
+import { Code, ColorDef, IModel, QueryBinder, SubCategoryAppearance } from "@itwin/core-common";
 import { Arc3d, IModelJson, Point3d } from "@itwin/core-geometry";
+import * as chai from "chai";
 import { assert, expect } from "chai";
 import * as path from "node:path";
 import { DrawingCategory } from "../../Category";
 import { ChangesetECAdaptor, ChangesetECAdaptor as ECChangesetAdaptor, ECChangeUnifierCache, PartialECChangeUnifier } from "../../ChangesetECAdaptor";
+import { _nativeDb, ChannelControl, GraphicalElement2d } from "../../core-backend";
+import { BriefcaseDb, SnapshotDb } from "../../IModelDb";
 import { HubMock } from "../../internal/HubMock";
-import { SnapshotDb } from "../../IModelDb";
 import { SqliteChangesetReader } from "../../SqliteChangesetReader";
 import { HubWrappers, IModelTestUtils } from "../IModelTestUtils";
 import { KnownTestLocations } from "../KnownTestLocations";
-import { _nativeDb, ChannelControl } from "../../core-backend";
 describe("Changeset Reader API", async () => {
     let iTwinId;
     before(() => {
@@ -1434,5 +1435,223 @@ describe("Changeset Reader API", async () => {
         }
         await rwIModel.pushChanges({ description: "insert element", accessToken: adminToken });
     });
+    it("Instance update to a different class (bug)", async () => {
+        /**
+         * Test scenario: Verifies changeset reader behavior when an instance ID is reused with a different class.
+         *
+         * Steps:
+         * 1. Import schema with two classes (T1 and T2) that inherit from GraphicalElement2d.
+         *    - T1 has property 'p' of type string
+         *    - T2 has property 'p' of type long
+         * 2. Insert an element of type T1 with id=elId and property p="wwww"
+         * 3. Push changeset #1: "insert element"
+         * 4. Delete the T1 element
+         * 5. Manipulate the element ID sequence to force reuse of the same ID
+         * 6. Insert a new element of type T2 with the same id=elId but property p=1111
+         * 7. Push changeset #2: "buggy changeset"
+         *
+         * Verification:
+         * - Changeset #2 should show an "Updated" operation (not Delete+Insert)
+         * - In bis_Element table: ECClassId changes from T1 to T2
+         * - In bis_GeometricElement2d table: ECClassId changes from T1 to T2
+         * - Property 'p' changes from string "wwww" to integer 1111
+         *
+         * This tests the changeset reader's ability to handle instance class changes,
+         * which can occur in edge cases where IDs are reused with different types.
+         */
+        const adminToken = "super manager token";
+        const iModelName = "test";
+        const modelId = await HubMock.createNewIModel({ iTwinId, iModelName, description: "TestSubject", accessToken: adminToken });
+        assert.isNotEmpty(modelId);
+        let b1 = await HubWrappers.downloadAndOpenBriefcase({ iTwinId, iModelId: modelId, accessToken: adminToken });
+        // 1. Import schema with classes that span overflow table.
+        const schema = `<?xml version="1.0" encoding="UTF-8"?>
+    <ECSchema schemaName="TestDomain" alias="ts" version="01.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
+        <ECSchemaReference name="BisCore" version="01.00" alias="bis"/>
+        <ECEntityClass typeName="T1">
+            <BaseClass>bis:GraphicalElement2d</BaseClass>
+              <ECProperty propertyName="p" typeName="string"/>
+        </ECEntityClass>
+        <ECEntityClass typeName="T2">
+            <BaseClass>bis:GraphicalElement2d</BaseClass>
+              <ECProperty propertyName="p" typeName="long"/>
+        </ECEntityClass>
+    </ECSchema>`;
+        await b1.importSchemaStrings([schema]);
+        b1.channels.addAllowedChannel(ChannelControl.sharedChannelName);
+        // Create drawing model and category
+        await b1.locks.acquireLocks({ shared: IModel.dictionaryId });
+        const codeProps = Code.createEmpty();
+        codeProps.value = "DrawingModel";
+        const [, drawingModelId] = IModelTestUtils.createAndInsertDrawingPartitionAndModel(b1, codeProps, true);
+        let drawingCategoryId = DrawingCategory.queryCategoryIdByName(b1, IModel.dictionaryId, "MyDrawingCategory");
+        if (undefined === drawingCategoryId)
+            drawingCategoryId = DrawingCategory.insert(b1, IModel.dictionaryId, "MyDrawingCategory", new SubCategoryAppearance({ color: ColorDef.fromString("rgb(255,0,0)").toJSON() }));
+        const geomArray = [
+            Arc3d.createXY(Point3d.create(0, 0), 5),
+            Arc3d.createXY(Point3d.create(5, 5), 2),
+            Arc3d.createXY(Point3d.create(-5, -5), 20),
+        ];
+        const geometryStream = [];
+        for (const geom of geomArray) {
+            const arcData = IModelJson.Writer.toIModelJson(geom);
+            geometryStream.push(arcData);
+        }
+        const geomElementT1 = {
+            classFullName: `TestDomain:T1`,
+            model: drawingModelId,
+            category: drawingCategoryId,
+            code: Code.createEmpty(),
+            geom: geometryStream,
+            p: "wwww",
+        };
+        const elId = b1.elements.insertElement(geomElementT1);
+        assert.isTrue(Id64.isValidId64(elId), "insert worked");
+        b1.saveChanges();
+        await b1.pushChanges({ description: "insert element" });
+        await b1.locks.acquireLocks({ shared: drawingModelId, exclusive: elId });
+        await b1.locks.acquireLocks({ shared: IModel.dictionaryId });
+        b1.elements.deleteElement(elId);
+        b1.saveChanges();
+        // Force id set to reproduce same instance with different classid
+        const bid = BigInt(elId) - 1n;
+        b1[_nativeDb].saveLocalValue("bis_elementidsequence", bid.toString());
+        b1.saveChanges();
+        const fileName = b1[_nativeDb].getFilePath();
+        b1.close();
+        b1 = await BriefcaseDb.open({ fileName });
+        b1.channels.addAllowedChannel(ChannelControl.sharedChannelName);
+        const geomElementT2 = {
+            classFullName: `TestDomain:T2`,
+            model: drawingModelId,
+            category: drawingCategoryId,
+            code: Code.createEmpty(),
+            geom: geometryStream,
+            p: 1111,
+        };
+        const elId2 = b1.elements.insertElement(geomElementT2);
+        chai.expect(elId).equals(elId2);
+        b1.saveChanges();
+        await b1.pushChanges({ description: "buggy changeset" });
+        const getChanges = async () => {
+            return HubMock.downloadChangesets({ iModelId: modelId, targetDir: path.join(KnownTestLocations.outputDir, modelId, "changesets") });
+        };
+        const changesets = await getChanges();
+        chai.expect(changesets.length).equals(2);
+        chai.expect(changesets[0].description).equals("insert element");
+        chai.expect(changesets[1].description).equals("buggy changeset");
+        const getClassId = async (name) => {
+            const r = b1.createQueryReader("SELECT FORMAT('0x%x', ec_classid(?))", QueryBinder.from([name]));
+            if (await r.step()) {
+                return r.current[0];
+            }
+        };
+        const t1ClassId = await getClassId("TestDomain:T1");
+        const t2ClassId = await getClassId("TestDomain:T2");
+        const reader = SqliteChangesetReader.openFile({ fileName: changesets[1].pathname, disableSchemaCheck: true, db: b1 });
+        let bisElementAsserted = false;
+        let bisGeometricElement2dAsserted = false;
+        while (reader.step()) {
+            if (reader.tableName === "bis_Element" && reader.op === "Updated") {
+                bisElementAsserted = true;
+                chai.expect(reader.getColumnNames(reader.tableName)).deep.equals([
+                    "Id",
+                    "ECClassId",
+                    "ModelId",
+                    "LastMod",
+                    "CodeSpecId",
+                    "CodeScopeId",
+                    "CodeValue",
+                    "UserLabel",
+                    "ParentId",
+                    "ParentRelECClassId",
+                    "FederationGuid",
+                    "JsonProperties",
+                ]);
+                const oldId = reader.getChangeValueId(0, "Old");
+                const newId = reader.getChangeValueId(0, "New");
+                chai.expect(oldId).equals(elId);
+                chai.expect(newId).to.be.undefined;
+                const oldClassId = reader.getChangeValueId(1, "Old");
+                const newClassId = reader.getChangeValueId(1, "New");
+                chai.expect(oldClassId).equals(t1ClassId);
+                chai.expect(newClassId).equals(t2ClassId);
+                chai.expect(oldClassId).is.not.equal(newClassId);
+            }
+            if (reader.tableName === "bis_GeometricElement2d" && reader.op === "Updated") {
+                bisGeometricElement2dAsserted = true;
+                chai.expect(reader.getColumnNames(reader.tableName)).deep.equals([
+                    "ElementId",
+                    "ECClassId",
+                    "CategoryId",
+                    "Origin_X",
+                    "Origin_Y",
+                    "Rotation",
+                    "BBoxLow_X",
+                    "BBoxLow_Y",
+                    "BBoxHigh_X",
+                    "BBoxHigh_Y",
+                    "GeometryStream",
+                    "TypeDefinitionId",
+                    "TypeDefinitionRelECClassId",
+                    "js1",
+                    "js2",
+                ]);
+                // ECInstanceId
+                const oldId = reader.getChangeValueId(0, "Old");
+                const newId = reader.getChangeValueId(0, "New");
+                chai.expect(oldId).equals(elId);
+                chai.expect(newId).to.be.undefined;
+                // ECClassId (changed)
+                const oldClassId = reader.getChangeValueId(1, "Old");
+                const newClassId = reader.getChangeValueId(1, "New");
+                chai.expect(oldClassId).equals(t1ClassId);
+                chai.expect(newClassId).equals(t2ClassId);
+                chai.expect(oldClassId).is.not.equal(newClassId);
+                // Property 'p' changed type and value.
+                const oldP = reader.getChangeValueText(13, "Old");
+                const newP = reader.getChangeValueInteger(13, "New");
+                chai.expect(oldP).equals("wwww");
+                chai.expect(newP).equals(1111);
+            }
+        }
+        chai.expect(bisElementAsserted).to.be.true;
+        chai.expect(bisGeometricElement2dAsserted).to.be.true;
+        reader.close();
+        // ChangesetECAdaptor works incorrectly as it does not expect ECClassId to change in an update.
+        const adaptor = new ChangesetECAdaptor(SqliteChangesetReader.openFile({ fileName: changesets[1].pathname, disableSchemaCheck: true, db: b1 }));
+        adaptor.acceptClass(GraphicalElement2d.classFullName);
+        adaptor.acceptOp("Updated");
+        let ecChangeForElementAsserted = false;
+        let ecChangeForGeometricElement2dAsserted = false;
+        while (adaptor.step()) {
+            if (adaptor.reader.tableName === "bis_Element") {
+                ecChangeForElementAsserted = true;
+                chai.expect(adaptor.inserted?.$meta?.classFullName).equals("TestDomain:T1"); // WRONG should be TestDomain:T2
+                chai.expect(adaptor.deleted?.$meta?.classFullName).equals("TestDomain:T1"); // WRONG should be TestDomain:T2
+            }
+            if (adaptor.reader.tableName === "bis_GeometricElement2d") {
+                ecChangeForGeometricElement2dAsserted = true;
+                chai.expect(adaptor.inserted?.$meta?.classFullName).equals("TestDomain:T1"); // WRONG should be TestDomain:T2
+                chai.expect(adaptor.deleted?.$meta?.classFullName).equals("TestDomain:T1"); // WRONG should be TestDomain:T2
+                chai.expect(adaptor.inserted?.p).equals("0x457"); // CORRECT p in T2 is integer
+                chai.expect(adaptor.deleted?.p).equals("wwww"); // CORRECT p in T1 is string
+            }
+        }
+        chai.expect(ecChangeForElementAsserted).to.be.true;
+        chai.expect(ecChangeForGeometricElement2dAsserted).to.be.true;
+        adaptor.close();
+        // PartialECChangeUnifier fail to combine changes correctly when ECClassId is updated.
+        const adaptor2 = new ChangesetECAdaptor(SqliteChangesetReader.openFile({ fileName: changesets[1].pathname, disableSchemaCheck: true, db: b1 }));
+        const unifier = new PartialECChangeUnifier(b1);
+        adaptor2.acceptClass(GraphicalElement2d.classFullName);
+        adaptor2.acceptOp("Updated");
+        while (adaptor2.step()) {
+            unifier.appendFrom(adaptor2);
+        }
+        chai.expect(unifier.getInstanceCount()).to.be.equals(2); // WRONG should be 1
+        b1.saveChanges();
+        b1.close();
+    });
 });
 //# sourceMappingURL=ChangesetReader.test.js.map