@itwin/imodel-transformer 2.0.0-dev.68 → 2.0.0-dev.69

package/lib/cjs/IModelExporter.js

@@ -18,6 +18,7 @@ const ElementAspectExportProcessor_1 = require("./ElementAspectExportProcessor")
 const ElementAspectExportCoordinator_1 = require("./ElementAspectExportCoordinator");
 const IModelTransformerError_1 = require("./IModelTransformerError");
 const ChangesetScanner_1 = require("./ChangesetScanner");
+const SourceClassKinds_1 = require("./SourceClassKinds");
 const ChangedElementForest_1 = require("./ChangedElementForest");
 const loggerCategory = TransformerLoggerCategory_1.TransformerLoggerCategory.IModelExporter;
 /** Handles the events generated by IModelExporter.
@@ -1387,12 +1388,7 @@ class ChangedInstanceIds {
     aspect = new ChangedInstanceOps();
     relationship = new ChangedInstanceOps();
     font = new ChangedInstanceOps();
-    _codeSpecSubclassIds;
-    _modelSubclassIds;
-    _elementSubclassIds;
-    _aspectSubclassIds;
-    _relationshipSubclassIds;
-    _relationshipSubclassIdsToSkip;
+    _classKinds;
     _aspectOwnerElementIds = new Set();
     /** Element IDs that own the aspects represented by `aspect` changes.
      * @internal
@@ -1404,52 +1400,6 @@ class ChangedInstanceIds {
     constructor(db) {
         this._db = db;
     }
-    async setupECClassIds() {
-        this._codeSpecSubclassIds = new Set();
-        this._modelSubclassIds = new Set();
-        this._elementSubclassIds = new Set();
-        this._aspectSubclassIds = new Set();
-        this._relationshipSubclassIds = new Set();
-        this._relationshipSubclassIdsToSkip = new Set();
-        const addECClassIdsToSet = async (setToModify, baseClass) => {
-            for await (const row of this._db.createQueryReader(`SELECT ECInstanceId FROM ECDbMeta.ECClassDef where ECInstanceId IS (${baseClass})`, undefined, { usePrimaryConn: true })) {
-                setToModify.add(row.ECInstanceId);
-            }
-        };
-        const promises = [
-            addECClassIdsToSet(this._codeSpecSubclassIds, "BisCore.CodeSpec"),
-            addECClassIdsToSet(this._modelSubclassIds, "BisCore.Model"),
-            addECClassIdsToSet(this._elementSubclassIds, "BisCore.Element"),
-            addECClassIdsToSet(this._aspectSubclassIds, "BisCore.ElementUniqueAspect"),
-            addECClassIdsToSet(this._aspectSubclassIds, "BisCore.ElementMultiAspect"),
-            addECClassIdsToSet(this._relationshipSubclassIds, "BisCore.ElementRefersToElements"),
-            addECClassIdsToSet(this._relationshipSubclassIdsToSkip, "BisCore.ElementDrivesElement"),
-        ];
-        await Promise.all(promises);
-    }
-    get _ecClassIdsInitialized() {
-        return (this._codeSpecSubclassIds &&
-            this._modelSubclassIds &&
-            this._elementSubclassIds &&
-            this._aspectSubclassIds &&
-            this._relationshipSubclassIds &&
-            this._relationshipSubclassIdsToSkip);
-    }
-    isRelationship(ecClassId) {
-        return this._relationshipSubclassIds?.has(ecClassId);
-    }
-    isCodeSpec(ecClassId) {
-        return this._codeSpecSubclassIds?.has(ecClassId);
-    }
-    isAspect(ecClassId) {
-        return this._aspectSubclassIds?.has(ecClassId);
-    }
-    isModel(ecClassId) {
-        return this._modelSubclassIds?.has(ecClassId);
-    }
-    isElement(ecClassId) {
-        return this._elementSubclassIds?.has(ecClassId);
-    }
     /** Checks if there are any changes.
      * @returns true if there are any changes in the ChangedInstanceIds object.
      */
@@ -1470,9 +1420,30 @@ class ChangedInstanceIds {
     async addChange(change) {
         return this.recordChange(change, undefined);
     }
+    /**
+     * Adds a change read from somewhere other than a changeset, such as a precomputed cache, like [[addChange]]
+     * does for a changeset reader's [ChangeInstance]($backend). Add changes in the order they were made, so that,
+     * for example, an insert followed by a delete of the same instance cancels out.
+     * @throws [ITwinError]($bentley) with key `AspectOwnerRequired` if a deleted aspect has no `aspectOwnerElementId`.
+     * @beta
+     */
+    async addChangeRecord(change) {
+        if (change.op === "Deleted" && change.aspectOwnerElementId === undefined) {
+            this._classKinds ??= await SourceClassKinds_1.SourceClassKinds.query(this._db);
+            const kind = this._classKinds.kindOf(change.ecClassId);
+            // The source no longer has the aspect, so without its owner the target aspect would silently stay.
+            if (kind === "aspect" || kind === "externalSourceAspect")
+                core_bentley_1.ITwinError.throwError({
+                    iTwinErrorId: {
+                        scope: IModelTransformerError_1.IModelTransformerErrorScope,
+                        key: IModelTransformerError_1.IModelTransformerError.AspectOwnerRequired,
+                    },
+                    message: `Deleted ElementAspect change ${change.id} requires the owning element ID.`,
+                });
+        }
+        return this.applyChangeRecord(change, undefined);
+    }
     async recordChange(change, unresolvedAspectIds) {
-        if (!this._ecClassIdsInitialized)
-            await this.setupECClassIds();
         const ecClassId = change.ECClassId;
         if (ecClassId === undefined)
             core_bentley_1.ITwinError.throwError({
@@ -1491,29 +1462,43 @@ class ChangedInstanceIds {
                 },
                 message: `ChangeType was undefined for id: ${change.ECInstanceId}.`,
             });
-        if (this._relationshipSubclassIdsToSkip?.has(ecClassId))
-            return;
-        if (this.isRelationship(ecClassId))
-            this.handleChange(this.relationship, changeType, change.ECInstanceId);
-        else if (this.isCodeSpec(ecClassId))
-            this.handleChange(this.codeSpec, changeType, change.ECInstanceId);
-        else if (this.isAspect(ecClassId)) {
-            let ownerElementId = change.Element?.Id;
-            if (ownerElementId === undefined) {
-                if (unresolvedAspectIds !== undefined)
-                    unresolvedAspectIds.add(change.ECInstanceId);
-                else
-                    ownerElementId = this.tryGetAspectOwnerElementId(change.ECInstanceId);
-            }
-            if (ownerElementId !== undefined) {
-                this._aspectOwnerElementIds.add(ownerElementId);
+        return this.applyChangeRecord({
+            id: change.ECInstanceId,
+            ecClassId,
+            op: changeType,
+            aspectOwnerElementId: change.Element?.Id,
+        }, unresolvedAspectIds);
+    }
+    async applyChangeRecord(change, unresolvedAspectIds) {
+        // Await only the first time, so later changes are classified without yielding.
+        this._classKinds ??= await SourceClassKinds_1.SourceClassKinds.query(this._db);
+        const { id, ecClassId, op } = change;
+        switch (this._classKinds.kindOf(ecClassId)) {
+            case "relationship":
+                return this.handleChange(this.relationship, op, id);
+            case "codeSpec":
+                return this.handleChange(this.codeSpec, op, id);
+            case "aspect":
+            case "externalSourceAspect": {
+                let ownerElementId = change.aspectOwnerElementId;
+                if (ownerElementId === undefined) {
+                    if (unresolvedAspectIds !== undefined)
+                        unresolvedAspectIds.add(id);
+                    else
+                        ownerElementId = this.tryGetAspectOwnerElementId(id);
+                }
+                if (ownerElementId !== undefined)
+                    this._aspectOwnerElementIds.add(ownerElementId);
+                return this.handleChange(this.aspect, op, id);
             }
-            this.handleChange(this.aspect, changeType, change.ECInstanceId);
+            case "model":
+                return this.handleChange(this.model, op, id);
+            case "element":
+                return this.handleChange(this.element, op, id);
+            case "skippedRelationship":
+            case undefined:
+                return;
         }
-        else if (this.isModel(ecClassId))
-            this.handleChange(this.model, changeType, change.ECInstanceId);
-        else if (this.isElement(ecClassId))
-            this.handleChange(this.element, changeType, change.ECInstanceId);
     }
     tryGetAspectOwnerElementId(aspectId) {
         try {
@@ -1751,18 +1736,17 @@ class ChangedInstanceIds {
                 ? opts.changesetRanges
                 : undefined;
         const csFileProps = changesetRanges !== undefined
-            ? (await Promise.all(changesetRanges.map(async ([first, end]) => core_backend_1.BriefcaseManager.downloadChangesets({
-                iModelId,
-                range: { first, end },
-                targetDir: core_backend_1.BriefcaseManager.getChangeSetsPath(iModelId),
-            })))).flat()
+            ? (await ChangesetScanner_1.ChangesetScanner.download(opts.iModel, changesetRanges)).flat()
             : "csFileProps" in opts
                 ? opts.csFileProps
                 : undefined;
         if (csFileProps === undefined)
             return undefined;
         const changedInstanceIds = new ChangedInstanceIds(opts.iModel);
-        await ChangesetScanner_1.ChangesetScanner.scan(opts.iModel, csFileProps, changedInstanceIds);
+        await ChangesetScanner_1.ChangesetScanner.scan(opts.iModel, [csFileProps], {
+            changedInstanceIds,
+            collectDeletionRecords: false,
+        });
         return changedInstanceIds;
     }
     /** Record an ordered batch, then resolve missing aspect owners against current source state.