@itwin/imodel-transformer 2.0.0-dev.29 → 2.0.0-dev.30

package/lib/cjs/IModelTransformer.js

@@ -24,6 +24,7 @@ const EntityUnifier_1 = require("./EntityUnifier");
 const Algo_1 = require("./Algo");
 const SyncTypeResolver_1 = require("./SyncTypeResolver");
 const ProvenanceManager_1 = require("./ProvenanceManager");
+const ChangesetScanner_1 = require("./ChangesetScanner");
 const IModelTransformerError_1 = require("./IModelTransformerError");
 const loggerCategory = TransformerLoggerCategory_1.TransformerLoggerCategory.IModelTransformer;
 /**
@@ -1287,6 +1288,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
     _sourceChangeDataState = "uninited";
     /** length === 0 when _changeDataState = "no-change", length > 0 means "has-changes", otherwise undefined  */
     _csFileProps = undefined;
+    _deletionRecordsByChangeset;
     /**
      * Initialize prerequisites of processing, you must initialize with an [[InitOptions]] if you
      * are intending to process changes. Callers may wish to explicitly call initialize if they need to execute code after initialize but before [[process]] is called.
@@ -1300,12 +1302,33 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         await this.initScopeProvenance();
         await this._tryInitChangesetData(this._options.argsForProcessChanges);
         await this.context.initialize();
-        // need exporter initialized to do remapdeletedsourceentities.
-        await this.exporter.initialize(await this.getExportInitOpts(this._options.argsForProcessChanges ?? {}));
+        const exporterInitOptions = await this.getExportInitOpts(this._options.argsForProcessChanges ?? {});
+        await this.initializeChangesetScanAndExporter(exporterInitOptions);
         // Exporter must be initialized prior to processing changesets in order to properly handle entity recreations (an entity delete followed by an insert of that same entity).
         await this.processChangesets();
         this._initialized = true;
     }
+    async initializeChangesetScanAndExporter(exporterInitOptions) {
+        if (this._csFileProps !== undefined &&
+            this._csFileProps.length > 0 &&
+            this.sourceDb.isBriefcaseDb()) {
+            const changedInstanceIds = this.exporter.sourceDbChanges ??
+                ("changedInstanceIds" in exporterInitOptions
+                    ? exporterInitOptions.changedInstanceIds
+                    : new IModelExporter_1.ChangedInstanceIds(this.sourceDb));
+            this._deletionRecordsByChangeset = await ChangesetScanner_1.ChangesetScanner.scan(this.sourceDb, this._csFileProps, changedInstanceIds, {
+                populateChangedInstanceIds: this.exporter.sourceDbChanges === undefined &&
+                    !("changedInstanceIds" in exporterInitOptions),
+            });
+            await this.exporter.initialize({
+                changedInstanceIds,
+                skipPropagateChangesToRootElements: exporterInitOptions.skipPropagateChangesToRootElements,
+            });
+        }
+        else {
+            await this.exporter.initialize(exporterInitOptions);
+        }
+    }
     /**
      * Reads all the changeset files in the private member of the transformer: _csFileProps
      * and finds the corresponding target entity for any deleted source entities and remaps the sourceId to the targetId.
@@ -1318,7 +1341,8 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         });
         if (this.exporter.sourceDbChanges)
             await this.addCustomChanges(this.exporter.sourceDbChanges);
-        if (this._csFileProps === undefined || this._csFileProps.length === 0) {
+        const csFileProps = this._csFileProps;
+        if (csFileProps === undefined || csFileProps.length === 0) {
             if (this.exporter.sourceDbChanges === undefined ||
                 !this.exporter.sourceDbChanges.hasChanges)
                 return;
@@ -1326,6 +1350,9 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
             if (this._sourceChangeDataState === "no-changes")
                 this._sourceChangeDataState = "has-changes";
         }
+        const deletionRecordsByChangeset = this._deletionRecordsByChangeset;
+        if (deletionRecordsByChangeset === undefined)
+            return;
         const relationshipECClassIdsToSkip = new Set();
         for await (const row of this.sourceDb.createQueryReader("SELECT ECInstanceId FROM ECDbMeta.ECClassDef where ECInstanceId IS (BisCore.ElementDrivesElement)", undefined, { usePrimaryConn: true })) {
             relationshipECClassIdsToSkip.add(row.ECInstanceId);
@@ -1348,63 +1375,25 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
                 alreadyImportedModelInserts.add(targetModelId);
         });
         this._deletedSourceRelationshipData = new Map();
-        for (const csFile of this._csFileProps ?? []) {
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const csReader = core_backend_1.SqliteChangesetReader.openFile({
-                fileName: csFile.pathname,
-                db: this.sourceDb,
-                disableSchemaCheck: true,
-            });
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const csAdaptor = new core_backend_1.ChangesetECAdaptor(csReader);
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const ecChangeUnifier = new core_backend_1.PartialECChangeUnifier(this.sourceDb);
-            while (csAdaptor.step()) {
-                ecChangeUnifier.appendFrom(csAdaptor);
-            }
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const changes = [...ecChangeUnifier.instances];
+        for (const changes of deletionRecordsByChangeset) {
             /** a map of element ids to this transformation scope's ESA data for that element, in case the ESA is deleted in the target */
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
             const elemIdToScopeEsa = new Map();
             for (const change of changes) {
-                if (change.ECClassId !== undefined &&
-                    relationshipECClassIdsToSkip.has(change.ECClassId))
+                if (relationshipECClassIdsToSkip.has(change.ecClassId))
                     continue;
-                const changeType = change.$meta?.op;
-                if (changeType === "Deleted" &&
-                    change?.$meta?.classFullName === core_backend_1.ExternalSourceAspect.classFullName &&
-                    change.Scope.Id === this.targetScopeElementId &&
-                    change.Kind === core_backend_1.ExternalSourceAspect.Kind.Element) {
-                    elemIdToScopeEsa.set(change.Element.Id, change);
+                if (change.classFullName === core_backend_1.ExternalSourceAspect.classFullName &&
+                    change.scopeId === this.targetScopeElementId &&
+                    change.kind === core_backend_1.ExternalSourceAspect.Kind.Element &&
+                    change.elementId !== undefined) {
+                    elemIdToScopeEsa.set(change.elementId, change);
                 }
             }
             // Loop to process deletes.
             for (const change of changes) {
-                const changeType = change.$meta?.op;
-                const ecClassId = change.ECClassId ?? change.$meta?.fallbackClassId;
-                if (ecClassId === undefined)
-                    core_bentley_1.ITwinError.throwError({
-                        iTwinErrorId: {
-                            scope: IModelTransformerError_1.IModelTransformerErrorScope,
-                            key: IModelTransformerError_1.IModelTransformerError.ChangedInstanceMetadataMissing,
-                        },
-                        message: `ECClassId was not found for id: ${change.ECInstanceId}! Table is : ${change?.$meta?.tables}`,
-                    });
-                if (changeType === undefined)
-                    core_bentley_1.ITwinError.throwError({
-                        iTwinErrorId: {
-                            scope: IModelTransformerError_1.IModelTransformerErrorScope,
-                            key: IModelTransformerError_1.IModelTransformerError.ChangedInstanceMetadataMissing,
-                        },
-                        message: `ChangeType was undefined for id: ${change.ECInstanceId}.`,
-                    });
-                if (changeType !== "Deleted" ||
-                    relationshipECClassIdsToSkip.has(ecClassId))
+                if (relationshipECClassIdsToSkip.has(change.ecClassId))
                     continue;
-                await this.processDeletedOp(change, elemIdToScopeEsa, relationshipECClassIds.has(ecClassId ?? ""), alreadyImportedElementInserts, alreadyImportedModelInserts);
+                await this.processDeletedOp(change, elemIdToScopeEsa, relationshipECClassIds.has(change.ecClassId), alreadyImportedElementInserts, alreadyImportedModelInserts);
             }
-            csReader.close();
         }
         return;
     }
@@ -1427,11 +1416,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
      * @param alreadyImportedModelInserts used to handle entity recreation and not delete already handled model inserts.
      * @returns void
      */
-    async processDeletedOp(
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    change, 
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    mapOfDeletedElemIdToScopeEsas, isRelationship, alreadyImportedElementInserts, alreadyImportedModelInserts) {
+    async processDeletedOp(change, mapOfDeletedElemIdToScopeEsas, isRelationship, alreadyImportedElementInserts, alreadyImportedModelInserts) {
         // we need a connected iModel with changes to remap elements with deletions
         const notConnectedModel = this.sourceDb.iTwinId === undefined;
         const noChanges = (await this.getSynchronizationVersion()).index ===
@@ -1441,7 +1426,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
         if (notConnectedModel || noChanges)
             return;
         /**
-         * if our ChangedECInstance is in the provenanceDb, then we can use the ids we find in the ChangedECInstance to query for ESAs.
+         * If the deleted source entity is in the provenanceDb, then we can use its ids to query for ESAs.
          * This is because the ESAs are stored on an element Id thats present in the provenanceDb.
          */
         const changeDataInProvenanceDb = this.sourceDb === (await this.getProvenanceDb());
@@ -1453,7 +1438,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
             }
             const fedGuid = isRelationship
                 ? element?.federationGuid
-                : change.FederationGuid;
+                : change.federationGuid;
             if (changeDataInProvenanceDb) {
                 // TODO: clarify what happens if there are multiple (e.g. elements were merged)
                 for await (const row of this.sourceDb.createQueryReader("SELECT esa.Identifier FROM bis.ExternalSourceAspect esa WHERE Scope.Id=:scopeId AND Kind=:kind AND Element.Id=:relatedElementId LIMIT 1", core_common_1.QueryBinder.from([
@@ -1464,7 +1449,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
                     identifierValue = row.Identifier;
                 }
                 identifierValue =
-                    identifierValue ?? mapOfDeletedElemIdToScopeEsas.get(id)?.Identifier;
+                    identifierValue ?? mapOfDeletedElemIdToScopeEsas.get(id)?.identifier;
             }
             // Check for targetId by an esa first
             if (changeDataInProvenanceDb && identifierValue) {
@@ -1478,11 +1463,21 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
             }
             return undefined;
         };
-        const changedInstanceId = change.ECInstanceId;
+        const changedInstanceId = change.ecInstanceId;
         if (isRelationship) {
-            const sourceIdOfRelationshipInSource = change.SourceECInstanceId;
-            const targetIdOfRelationshipInSource = change.TargetECInstanceId;
-            const classFullName = change.$meta?.classFullName;
+            const sourceIdOfRelationshipInSource = change.sourceECInstanceId;
+            const targetIdOfRelationshipInSource = change.targetECInstanceId;
+            const classFullName = change.classFullName;
+            if (sourceIdOfRelationshipInSource === undefined ||
+                targetIdOfRelationshipInSource === undefined) {
+                core_bentley_1.ITwinError.throwError({
+                    iTwinErrorId: {
+                        scope: IModelTransformerError_1.IModelTransformerErrorScope,
+                        key: IModelTransformerError_1.IModelTransformerError.ChangedInstanceMetadataMissing,
+                    },
+                    message: `Relationship deletion ${changedInstanceId} is missing an endpoint.`,
+                });
+            }
             const sourceIdOfRelationshipInTarget = await getTargetIdFromSourceId(sourceIdOfRelationshipInSource);
             const targetIdOfRelationshipInTarget = await getTargetIdFromSourceId(targetIdOfRelationshipInSource);
             if (sourceIdOfRelationshipInTarget && targetIdOfRelationshipInTarget) {
@@ -1711,6 +1706,12 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
     async getExportInitOpts(opts) {
         if (!this._options.argsForProcessChanges)
             return {};
+        if ("changedInstanceIds" in opts) {
+            return {
+                changedInstanceIds: opts.changedInstanceIds,
+                skipPropagateChangesToRootElements: this._options.skipPropagateChangesToRootElements,
+            };
+        }
         const startChangeset = "startChangeset" in opts ? opts.startChangeset : undefined;
         return {
             skipPropagateChangesToRootElements: this._options.skipPropagateChangesToRootElements,