@itwin/imodel-transformer 2.0.0-dev.3 → 2.0.0-dev.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/BranchProvenanceInitializer.d.ts.map +1 -1
- package/lib/cjs/BranchProvenanceInitializer.js +24 -18
- package/lib/cjs/BranchProvenanceInitializer.js.map +1 -1
- package/lib/cjs/ChangesetScanner.d.ts +60 -0
- package/lib/cjs/ChangesetScanner.d.ts.map +1 -0
- package/lib/cjs/ChangesetScanner.js +101 -0
- package/lib/cjs/ChangesetScanner.js.map +1 -0
- package/lib/cjs/DetachedExportElementAspectsStrategy.d.ts.map +1 -1
- package/lib/cjs/DetachedExportElementAspectsStrategy.js +8 -6
- package/lib/cjs/DetachedExportElementAspectsStrategy.js.map +1 -1
- package/lib/cjs/ECReferenceTypesCache.d.ts.map +1 -1
- package/lib/cjs/ECReferenceTypesCache.js +60 -38
- package/lib/cjs/ECReferenceTypesCache.js.map +1 -1
- package/lib/cjs/ElementCascadingDeleter.d.ts +3 -3
- package/lib/cjs/ElementCascadingDeleter.d.ts.map +1 -1
- package/lib/cjs/ElementCascadingDeleter.js +12 -12
- package/lib/cjs/ElementCascadingDeleter.js.map +1 -1
- package/lib/cjs/EntityUnifier.d.ts +4 -8
- package/lib/cjs/EntityUnifier.d.ts.map +1 -1
- package/lib/cjs/EntityUnifier.js +6 -24
- package/lib/cjs/EntityUnifier.js.map +1 -1
- package/lib/cjs/ExportElementAspectsStrategy.d.ts +4 -4
- package/lib/cjs/ExportElementAspectsStrategy.d.ts.map +1 -1
- package/lib/cjs/ExportElementAspectsStrategy.js +1 -1
- package/lib/cjs/ExportElementAspectsStrategy.js.map +1 -1
- package/lib/cjs/ExportElementAspectsWithElementsStrategy.d.ts.map +1 -1
- package/lib/cjs/ExportElementAspectsWithElementsStrategy.js +17 -16
- package/lib/cjs/ExportElementAspectsWithElementsStrategy.js.map +1 -1
- package/lib/cjs/IModelCloneContext.d.ts +3 -3
- package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
- package/lib/cjs/IModelCloneContext.js +70 -54
- package/lib/cjs/IModelCloneContext.js.map +1 -1
- package/lib/cjs/IModelExporter.d.ts +33 -23
- package/lib/cjs/IModelExporter.d.ts.map +1 -1
- package/lib/cjs/IModelExporter.js +200 -152
- package/lib/cjs/IModelExporter.js.map +1 -1
- package/lib/cjs/IModelImporter.d.ts +32 -24
- package/lib/cjs/IModelImporter.d.ts.map +1 -1
- package/lib/cjs/IModelImporter.js +199 -127
- package/lib/cjs/IModelImporter.js.map +1 -1
- package/lib/cjs/IModelTransformer.d.ts +94 -186
- package/lib/cjs/IModelTransformer.d.ts.map +1 -1
- package/lib/cjs/IModelTransformer.js +502 -1075
- package/lib/cjs/IModelTransformer.js.map +1 -1
- package/lib/cjs/IModelTransformerError.d.ts +74 -0
- package/lib/cjs/IModelTransformerError.d.ts.map +1 -0
- package/lib/cjs/IModelTransformerError.js +83 -0
- package/lib/cjs/IModelTransformerError.js.map +1 -0
- package/lib/cjs/ProvenanceManager.d.ts +165 -0
- package/lib/cjs/ProvenanceManager.d.ts.map +1 -0
- package/lib/cjs/ProvenanceManager.js +735 -0
- package/lib/cjs/ProvenanceManager.js.map +1 -0
- package/lib/cjs/SyncTypeResolver.d.ts +34 -0
- package/lib/cjs/SyncTypeResolver.d.ts.map +1 -0
- package/lib/cjs/SyncTypeResolver.js +96 -0
- package/lib/cjs/SyncTypeResolver.js.map +1 -0
- package/lib/cjs/TransformerLoggerCategory.d.ts +2 -1
- package/lib/cjs/TransformerLoggerCategory.d.ts.map +1 -1
- package/lib/cjs/TransformerLoggerCategory.js +1 -0
- package/lib/cjs/TransformerLoggerCategory.js.map +1 -1
- package/lib/cjs/imodel-transformer.d.ts +5 -0
- package/lib/cjs/imodel-transformer.d.ts.map +1 -1
- package/lib/cjs/imodel-transformer.js +26 -7
- package/lib/cjs/imodel-transformer.js.map +1 -1
- package/package.json +22 -17
|
@@ -12,6 +12,7 @@ const path = require("path");
|
|
|
12
12
|
const Semver = require("semver");
|
|
13
13
|
const nodeAssert = require("assert");
|
|
14
14
|
const core_bentley_1 = require("@itwin/core-bentley");
|
|
15
|
+
const ECSchemaMetaData = require("@itwin/ecschema-metadata");
|
|
15
16
|
const core_geometry_1 = require("@itwin/core-geometry");
|
|
16
17
|
const core_backend_1 = require("@itwin/core-backend");
|
|
17
18
|
const core_common_1 = require("@itwin/core-common");
|
|
@@ -21,13 +22,11 @@ const TransformerLoggerCategory_1 = require("./TransformerLoggerCategory");
|
|
|
21
22
|
const IModelCloneContext_1 = require("./IModelCloneContext");
|
|
22
23
|
const EntityUnifier_1 = require("./EntityUnifier");
|
|
23
24
|
const Algo_1 = require("./Algo");
|
|
25
|
+
const SyncTypeResolver_1 = require("./SyncTypeResolver");
|
|
26
|
+
const ProvenanceManager_1 = require("./ProvenanceManager");
|
|
27
|
+
const ChangesetScanner_1 = require("./ChangesetScanner");
|
|
28
|
+
const IModelTransformerError_1 = require("./IModelTransformerError");
|
|
24
29
|
const loggerCategory = TransformerLoggerCategory_1.TransformerLoggerCategory.IModelTransformer;
|
|
25
|
-
const nullLastProvenanceEntityInfo = {
|
|
26
|
-
entityId: core_bentley_1.Id64.invalid,
|
|
27
|
-
aspectId: core_bentley_1.Id64.invalid,
|
|
28
|
-
aspectVersion: "",
|
|
29
|
-
aspectKind: core_backend_1.ExternalSourceAspect.Kind.Element,
|
|
30
|
-
};
|
|
31
30
|
/**
|
|
32
31
|
* Apply a function to each Id64 in a supported container type of Id64s.
|
|
33
32
|
* Currently only supports raw Id64String or RelatedElement-like objects containing an `id` property that is a Id64String,
|
|
@@ -53,10 +52,16 @@ function mapId64(idContainer, func) {
|
|
|
53
52
|
results.push(func(idContainer.id));
|
|
54
53
|
}
|
|
55
54
|
else {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
55
|
+
core_bentley_1.ITwinError.throwError({
|
|
56
|
+
iTwinErrorId: {
|
|
57
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
58
|
+
key: IModelTransformerError_1.IModelTransformerError.InvalidEntityReference,
|
|
59
|
+
},
|
|
60
|
+
message: [
|
|
61
|
+
`Id64 container '${JSON.stringify(idContainer)}' is unsupported.`,
|
|
62
|
+
"Currently only singular Id64 strings or prop-like objects containing an 'id' property are supported.",
|
|
63
|
+
].join("\n"),
|
|
64
|
+
});
|
|
60
65
|
}
|
|
61
66
|
return results;
|
|
62
67
|
}
|
|
@@ -86,7 +91,17 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
86
91
|
* @beta
|
|
87
92
|
*/
|
|
88
93
|
_linearSpatialTransform;
|
|
89
|
-
|
|
94
|
+
/** The [[EditTxn]] used for write operations on the target iModel.
|
|
95
|
+
* The caller is responsible for starting, committing or abandoning this transaction.
|
|
96
|
+
* @beta
|
|
97
|
+
*/
|
|
98
|
+
_targetEditTxn;
|
|
99
|
+
/** The optional [[EditTxn]] used for write operations on the source iModel during reverse synchronization.
|
|
100
|
+
* @beta
|
|
101
|
+
*/
|
|
102
|
+
_sourceEditTxn;
|
|
103
|
+
_syncTypeResolver;
|
|
104
|
+
_provenanceManager;
|
|
90
105
|
/** The Id of the Element in the **target** iModel that represents the **source** repository as a whole and scopes its [ExternalSourceAspect]($backend) instances. */
|
|
91
106
|
get targetScopeElementId() {
|
|
92
107
|
return this._options.targetScopeElementId;
|
|
@@ -95,118 +110,21 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
95
110
|
_elementsWithExplicitlyTrackedProvenance = new Set();
|
|
96
111
|
_partiallyCommittedElementIds = new Set();
|
|
97
112
|
_partiallyCommittedAspectIds = new Set();
|
|
98
|
-
/** the options that were used to initialize this transformer */
|
|
99
|
-
_options;
|
|
100
113
|
/**
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
114
|
+
* Tracks target element IDs that were remapped by Code during the current
|
|
115
|
+
* transformation pass. Used to prevent deletion of target elements that have been remapped
|
|
116
|
+
* to a new source element in the same pass (e.g., when a source element is deleted and a
|
|
117
|
+
* new one with the same properties is added, causing a remap to the same target).
|
|
105
118
|
*/
|
|
106
|
-
|
|
107
|
-
static noEsaSyncDirectionErrorMessage = "Couldn't find an external source aspect to determine sync direction. This often means that the master->branch relationship has not been established. Consider running the transformer with wasSourceIModelCopiedToTarget set to true.";
|
|
119
|
+
_targetElementIdsRemappedByCode = new Set();
|
|
108
120
|
/**
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
121
|
+
* Tracks target model IDs that were imported (inserted or updated) during the current
|
|
122
|
+
* transformation pass. Used to prevent deletion of target models that have been recreated
|
|
123
|
+
* in the same pass (e.g. when a partition element is recreated with a new model).
|
|
112
124
|
*/
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
FROM ${core_backend_1.ExternalSourceAspect.classFullName}
|
|
117
|
-
WHERE Element.Id=:elementId
|
|
118
|
-
AND Scope.Id=:scopeId
|
|
119
|
-
AND Kind=:kind
|
|
120
|
-
AND Identifier=:identifier
|
|
121
|
-
LIMIT 1
|
|
122
|
-
`;
|
|
123
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
124
|
-
return dbToQuery.withPreparedStatement(sql, (statement) => {
|
|
125
|
-
statement.bindId("elementId", aspectProps.element.id);
|
|
126
|
-
if (aspectProps.scope === undefined)
|
|
127
|
-
return undefined; // return instead of binding an invalid id
|
|
128
|
-
statement.bindId("scopeId", aspectProps.scope.id);
|
|
129
|
-
statement.bindString("kind", aspectProps.kind);
|
|
130
|
-
statement.bindString("identifier", aspectProps.identifier);
|
|
131
|
-
if (core_bentley_1.DbResult.BE_SQLITE_ROW !== statement.step())
|
|
132
|
-
return undefined;
|
|
133
|
-
const aspectId = statement.getValue(0).getId();
|
|
134
|
-
const versionValue = statement.getValue(1);
|
|
135
|
-
const version = versionValue.isNull
|
|
136
|
-
? undefined
|
|
137
|
-
: versionValue.getString();
|
|
138
|
-
const jsonPropsValue = statement.getValue(2);
|
|
139
|
-
const jsonProperties = jsonPropsValue.isNull
|
|
140
|
-
? undefined
|
|
141
|
-
: jsonPropsValue.getString();
|
|
142
|
-
return { aspectId, version, jsonProperties };
|
|
143
|
-
});
|
|
144
|
-
}
|
|
145
|
-
/**
|
|
146
|
-
* Determines the sync direction "forward" or "reverse" of a given sourceDb and targetDb by looking for the scoping ESA.
|
|
147
|
-
* If the sourceDb's iModelId is found as the identifier of the expected scoping ESA in the targetDb, then it is a forward synchronization.
|
|
148
|
-
* If the targetDb's iModelId is found as the identifier of the expected scoping ESA in the sourceDb, then it is a reverse synchronization.
|
|
149
|
-
* @throws if no scoping ESA can be found in either the sourceDb or targetDb which describes a master branch relationship between the two databases.
|
|
150
|
-
* @returns "forward" or "reverse"
|
|
151
|
-
*/
|
|
152
|
-
static determineSyncType(sourceDb, targetDb,
|
|
153
|
-
/** @see [[IModelTransformOptions.targetScopeElementId]] */
|
|
154
|
-
targetScopeElementId) {
|
|
155
|
-
const aspectProps = {
|
|
156
|
-
id: undefined,
|
|
157
|
-
version: undefined,
|
|
158
|
-
classFullName: core_backend_1.ExternalSourceAspect.classFullName,
|
|
159
|
-
element: {
|
|
160
|
-
id: targetScopeElementId,
|
|
161
|
-
relClassName: core_backend_1.ElementOwnsExternalSourceAspects.classFullName,
|
|
162
|
-
},
|
|
163
|
-
scope: { id: core_common_1.IModel.rootSubjectId }, // the root Subject scopes scope elements
|
|
164
|
-
identifier: sourceDb.iModelId,
|
|
165
|
-
kind: core_backend_1.ExternalSourceAspect.Kind.Scope,
|
|
166
|
-
jsonProperties: undefined,
|
|
167
|
-
};
|
|
168
|
-
/** First check if the targetDb is the branch (branch is the @see provenanceDb) */
|
|
169
|
-
const esaPropsFromTargetDb = this.queryScopeExternalSourceAspect(targetDb, aspectProps);
|
|
170
|
-
if (esaPropsFromTargetDb !== undefined) {
|
|
171
|
-
return "forward"; // we found an esa assuming targetDb is the provenanceDb/branch so this is a forward sync.
|
|
172
|
-
}
|
|
173
|
-
// Now check if the sourceDb is the branch
|
|
174
|
-
aspectProps.identifier = targetDb.iModelId;
|
|
175
|
-
const esaPropsFromSourceDb = this.queryScopeExternalSourceAspect(sourceDb, aspectProps);
|
|
176
|
-
if (esaPropsFromSourceDb !== undefined) {
|
|
177
|
-
return "reverse"; // we found an esa assuming sourceDb is the provenanceDb/branch so this is a reverse sync.
|
|
178
|
-
}
|
|
179
|
-
throw new Error(this.noEsaSyncDirectionErrorMessage);
|
|
180
|
-
}
|
|
181
|
-
determineSyncType() {
|
|
182
|
-
if (this._isProvenanceInitTransform) {
|
|
183
|
-
return "forward";
|
|
184
|
-
}
|
|
185
|
-
if (!this._options.argsForProcessChanges) {
|
|
186
|
-
return "not-sync";
|
|
187
|
-
}
|
|
188
|
-
try {
|
|
189
|
-
return IModelTransformer.determineSyncType(this.sourceDb, this.targetDb, this.targetScopeElementId);
|
|
190
|
-
}
|
|
191
|
-
catch (err) {
|
|
192
|
-
if (err instanceof Error &&
|
|
193
|
-
err.message === IModelTransformer.noEsaSyncDirectionErrorMessage &&
|
|
194
|
-
this._allowNoScopingESA) {
|
|
195
|
-
return "forward";
|
|
196
|
-
}
|
|
197
|
-
throw err;
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
get isReverseSynchronization() {
|
|
201
|
-
if (this._syncType === undefined)
|
|
202
|
-
this._syncType = this.determineSyncType();
|
|
203
|
-
return this._syncType === "reverse";
|
|
204
|
-
}
|
|
205
|
-
get isForwardSynchronization() {
|
|
206
|
-
if (this._syncType === undefined)
|
|
207
|
-
this._syncType = this.determineSyncType();
|
|
208
|
-
return this._syncType === "forward";
|
|
209
|
-
}
|
|
125
|
+
_targetModelsImportedInCurrentTransform = new Set();
|
|
126
|
+
/** the options that were used to initialize this transformer */
|
|
127
|
+
_options;
|
|
210
128
|
_changesetRanges = undefined;
|
|
211
129
|
/**
|
|
212
130
|
* Set if the transformer is being used to perform the provenance initialization step of a fork initialization.
|
|
@@ -215,31 +133,25 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
215
133
|
_isProvenanceInitTransform;
|
|
216
134
|
/** The element classes that are considered to define provenance in the iModel */
|
|
217
135
|
static get provenanceElementClasses() {
|
|
218
|
-
return
|
|
219
|
-
core_backend_1.FolderLink,
|
|
220
|
-
core_backend_1.SynchronizationConfigLink,
|
|
221
|
-
core_backend_1.ExternalSource,
|
|
222
|
-
core_backend_1.ExternalSourceAttachment,
|
|
223
|
-
];
|
|
136
|
+
return ProvenanceManager_1.ProvenanceManager.provenanceElementClasses;
|
|
224
137
|
}
|
|
225
138
|
/** The element aspect classes that are considered to define provenance in the iModel */
|
|
226
139
|
static get provenanceElementAspectClasses() {
|
|
227
|
-
return
|
|
140
|
+
return ProvenanceManager_1.ProvenanceManager.provenanceElementAspectClasses;
|
|
228
141
|
}
|
|
229
142
|
/** Construct a new IModelTransformer
|
|
230
|
-
* @param
|
|
231
|
-
* @param target Specifies the target IModelImporter or the target IModelDb that will be used to construct the target IModelImporter.
|
|
143
|
+
* @param args The required arguments including source and target.
|
|
232
144
|
* @param options The options that specify how the transformation should be done.
|
|
233
145
|
*/
|
|
234
|
-
constructor(
|
|
146
|
+
constructor(args, options) {
|
|
235
147
|
super();
|
|
148
|
+
const { source, target } = args;
|
|
236
149
|
// initialize IModelTransformOptions
|
|
237
150
|
this._options = {
|
|
238
151
|
...options,
|
|
239
152
|
// non-falsy defaults
|
|
240
153
|
cloneUsingBinaryGeometry: options?.cloneUsingBinaryGeometry ?? true,
|
|
241
154
|
targetScopeElementId: options?.targetScopeElementId ?? core_common_1.IModel.rootSubjectId,
|
|
242
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
243
155
|
danglingReferencesBehavior: options?.danglingReferencesBehavior ?? "reject",
|
|
244
156
|
branchRelationshipDataBehavior: options?.branchRelationshipDataBehavior ?? "reject",
|
|
245
157
|
skipPropagateChangesToRootElements: options?.skipPropagateChangesToRootElements ?? true,
|
|
@@ -271,7 +183,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
271
183
|
this.exporter.excludeElementAspectClass(core_backend_1.ChannelRootAspect.classFullName); // Channel boundaries within the source iModel are not relevant to the target iModel
|
|
272
184
|
this.exporter.excludeElementAspectClass("BisCore:TextAnnotationData"); // This ElementAspect is auto-created by the BisCore:TextAnnotation2d/3d element handlers
|
|
273
185
|
// initialize importer and targetDb
|
|
274
|
-
if (target instanceof core_backend_1.
|
|
186
|
+
if (target instanceof core_backend_1.EditTxn) {
|
|
275
187
|
this.importer = new IModelImporter_1.IModelImporter(target, {
|
|
276
188
|
preserveElementIdsForFiltering: this._options.preserveElementIdsForFiltering,
|
|
277
189
|
skipPropagateChangesToRootElements: this._options.skipPropagateChangesToRootElements,
|
|
@@ -282,16 +194,10 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
282
194
|
this.validateSharedOptionsMatch();
|
|
283
195
|
}
|
|
284
196
|
this.targetDb = this.importer.targetDb;
|
|
197
|
+
this._targetEditTxn = this.importer.editTxn;
|
|
198
|
+
this._sourceEditTxn = options?.sourceEditTxn;
|
|
285
199
|
// create the IModelCloneContext, it must be initialized later
|
|
286
200
|
this.context = new IModelCloneContext_1.IModelCloneContext(this.sourceDb, this.targetDb);
|
|
287
|
-
if (this.sourceDb.isBriefcase && this.targetDb.isBriefcase) {
|
|
288
|
-
nodeAssert(this.sourceDb.changeset.index !== undefined &&
|
|
289
|
-
this.targetDb.changeset.index !== undefined, "database has no changeset index");
|
|
290
|
-
this._startingChangesetIndices = {
|
|
291
|
-
target: this.targetDb.changeset.index,
|
|
292
|
-
source: this.sourceDb.changeset.index,
|
|
293
|
-
};
|
|
294
|
-
}
|
|
295
201
|
// this internal is guaranteed stable for just transformer usage
|
|
296
202
|
/* eslint-disable @itwin/no-internal */
|
|
297
203
|
if (("codeValueBehavior" in this.sourceDb)) {
|
|
@@ -299,6 +205,8 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
299
205
|
this.targetDb.codeValueBehavior = "exact";
|
|
300
206
|
}
|
|
301
207
|
/* eslint-enable @itwin/no-internal */
|
|
208
|
+
this._syncTypeResolver = new SyncTypeResolver_1.SyncTypeResolver(this.context, this._options.targetScopeElementId, !!this._isProvenanceInitTransform, !!this._options.argsForProcessChanges);
|
|
209
|
+
this._provenanceManager = new ProvenanceManager_1.ProvenanceManager(this._options.targetScopeElementId, this._options, this._syncTypeResolver, this._targetEditTxn, this._sourceEditTxn);
|
|
302
210
|
if (this._options.tryAlignGeolocation) {
|
|
303
211
|
if (this.sourceDb.geographicCoordinateSystem ||
|
|
304
212
|
this.targetDb.geographicCoordinateSystem) {
|
|
@@ -320,19 +228,29 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
320
228
|
validateSharedOptionsMatch() {
|
|
321
229
|
if (Boolean(this._options.preserveElementIdsForFiltering) !==
|
|
322
230
|
this.importer.options.preserveElementIdsForFiltering) {
|
|
323
|
-
|
|
324
|
-
|
|
231
|
+
core_bentley_1.ITwinError.throwError({
|
|
232
|
+
iTwinErrorId: {
|
|
233
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
234
|
+
key: IModelTransformerError_1.IModelTransformerError.ImporterOptionMismatch,
|
|
235
|
+
},
|
|
236
|
+
message: "A custom importer was passed as a target but its 'preserveElementIdsForFiltering' option is out of sync with the transformer's option.",
|
|
237
|
+
});
|
|
325
238
|
}
|
|
326
239
|
if (Boolean(this._options.skipPropagateChangesToRootElements) !==
|
|
327
240
|
this.importer.options.skipPropagateChangesToRootElements) {
|
|
328
|
-
|
|
329
|
-
|
|
241
|
+
core_bentley_1.ITwinError.throwError({
|
|
242
|
+
iTwinErrorId: {
|
|
243
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
244
|
+
key: IModelTransformerError_1.IModelTransformerError.ImporterOptionMismatch,
|
|
245
|
+
},
|
|
246
|
+
message: "A custom importer was passed as a target but its 'skipPropagateChangesToRootElements' option is out of sync with the transformer's option.",
|
|
247
|
+
});
|
|
330
248
|
}
|
|
331
249
|
}
|
|
332
250
|
/** Dispose any native resources associated with this IModelTransformer. */
|
|
333
251
|
dispose() {
|
|
334
252
|
core_bentley_1.Logger.logTrace(loggerCategory, "dispose()");
|
|
335
|
-
this.context.dispose();
|
|
253
|
+
this.context[Symbol.dispose]();
|
|
336
254
|
}
|
|
337
255
|
/** Log current settings that affect IModelTransformer's behavior. */
|
|
338
256
|
logSettings() {
|
|
@@ -349,74 +267,6 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
349
267
|
core_bentley_1.Logger.logInfo(TransformerLoggerCategory_1.TransformerLoggerCategory.IModelImporter, `this.importer.autoExtendProjectExtents=${JSON.stringify(this.importer.options.autoExtendProjectExtents)}`);
|
|
350
268
|
core_bentley_1.Logger.logInfo(TransformerLoggerCategory_1.TransformerLoggerCategory.IModelImporter, `this.importer.simplifyElementGeometry=${this.importer.options.simplifyElementGeometry}`);
|
|
351
269
|
}
|
|
352
|
-
/** Return the IModelDb where IModelTransformer will store its provenance.
|
|
353
|
-
* @note This will be [[targetDb]] except when it is a reverse synchronization. In that case it be [[sourceDb]].
|
|
354
|
-
*/
|
|
355
|
-
get provenanceDb() {
|
|
356
|
-
return this.isReverseSynchronization ? this.sourceDb : this.targetDb;
|
|
357
|
-
}
|
|
358
|
-
/** Return the IModelDb where IModelTransformer looks for entities referred to by stored provenance.
|
|
359
|
-
* @note This will be [[sourceDb]] except when it is a reverse synchronization. In that case it be [[targetDb]].
|
|
360
|
-
*/
|
|
361
|
-
get provenanceSourceDb() {
|
|
362
|
-
return this.isReverseSynchronization ? this.targetDb : this.sourceDb;
|
|
363
|
-
}
|
|
364
|
-
/** Create an ExternalSourceAspectProps in a standard way for an Element in an iModel --> iModel transformation. */
|
|
365
|
-
static initElementProvenanceOptions(sourceElementId, targetElementId, args) {
|
|
366
|
-
const elementId = args.isReverseSynchronization
|
|
367
|
-
? sourceElementId
|
|
368
|
-
: targetElementId;
|
|
369
|
-
const version = args.isReverseSynchronization
|
|
370
|
-
? args.targetDb.elements.queryLastModifiedTime(targetElementId)
|
|
371
|
-
: args.sourceDb.elements.queryLastModifiedTime(sourceElementId);
|
|
372
|
-
const aspectIdentifier = args.isReverseSynchronization
|
|
373
|
-
? targetElementId
|
|
374
|
-
: sourceElementId;
|
|
375
|
-
const aspectProps = {
|
|
376
|
-
classFullName: core_backend_1.ExternalSourceAspect.classFullName,
|
|
377
|
-
element: {
|
|
378
|
-
id: elementId,
|
|
379
|
-
relClassName: core_backend_1.ElementOwnsExternalSourceAspects.classFullName,
|
|
380
|
-
},
|
|
381
|
-
scope: { id: args.targetScopeElementId },
|
|
382
|
-
identifier: aspectIdentifier,
|
|
383
|
-
kind: core_backend_1.ExternalSourceAspect.Kind.Element,
|
|
384
|
-
version,
|
|
385
|
-
};
|
|
386
|
-
return aspectProps;
|
|
387
|
-
}
|
|
388
|
-
static initRelationshipProvenanceOptions(sourceRelInstanceId, targetRelInstanceId, args) {
|
|
389
|
-
const provenanceDb = args.isReverseSynchronization
|
|
390
|
-
? args.sourceDb
|
|
391
|
-
: args.targetDb;
|
|
392
|
-
const aspectIdentifier = args.isReverseSynchronization
|
|
393
|
-
? targetRelInstanceId
|
|
394
|
-
: sourceRelInstanceId;
|
|
395
|
-
const provenanceRelInstanceId = args.isReverseSynchronization
|
|
396
|
-
? sourceRelInstanceId
|
|
397
|
-
: targetRelInstanceId;
|
|
398
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
399
|
-
const elementId = provenanceDb.withPreparedStatement("SELECT SourceECInstanceId FROM bis.ElementRefersToElements WHERE ECInstanceId=?", (stmt) => {
|
|
400
|
-
stmt.bindId(1, provenanceRelInstanceId);
|
|
401
|
-
nodeAssert(stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW);
|
|
402
|
-
return stmt.getValue(0).getId();
|
|
403
|
-
});
|
|
404
|
-
const jsonProperties = args.forceOldRelationshipProvenanceMethod
|
|
405
|
-
? { targetRelInstanceId }
|
|
406
|
-
: { provenanceRelInstanceId };
|
|
407
|
-
const aspectProps = {
|
|
408
|
-
classFullName: core_backend_1.ExternalSourceAspect.classFullName,
|
|
409
|
-
element: {
|
|
410
|
-
id: elementId,
|
|
411
|
-
relClassName: core_backend_1.ElementOwnsExternalSourceAspects.classFullName,
|
|
412
|
-
},
|
|
413
|
-
scope: { id: args.targetScopeElementId },
|
|
414
|
-
identifier: aspectIdentifier,
|
|
415
|
-
kind: core_backend_1.ExternalSourceAspect.Kind.Relationship,
|
|
416
|
-
jsonProperties: JSON.stringify(jsonProperties),
|
|
417
|
-
};
|
|
418
|
-
return aspectProps;
|
|
419
|
-
}
|
|
420
270
|
/**
|
|
421
271
|
* Previously the transformer would insert provenance always pointing to the "target" relationship.
|
|
422
272
|
* It should (and now by default does) instead insert provenance pointing to the provenanceSource
|
|
@@ -425,43 +275,8 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
425
275
|
*/
|
|
426
276
|
_forceOldRelationshipProvenanceMethod = false;
|
|
427
277
|
/** Create an ExternalSourceAspectProps in a standard way for an Element in an iModel --> iModel transformation. */
|
|
428
|
-
initElementProvenance(sourceElementId, targetElementId) {
|
|
429
|
-
return
|
|
430
|
-
isReverseSynchronization: this.isReverseSynchronization,
|
|
431
|
-
targetScopeElementId: this.targetScopeElementId,
|
|
432
|
-
sourceDb: this.sourceDb,
|
|
433
|
-
targetDb: this.targetDb,
|
|
434
|
-
});
|
|
435
|
-
}
|
|
436
|
-
/** Create an ExternalSourceAspectProps in a standard way for a Relationship in an iModel --> iModel transformations.
|
|
437
|
-
* The ExternalSourceAspect is meant to be owned by the Element in the target iModel that is the `sourceId` of transformed relationship.
|
|
438
|
-
* The `identifier` property of the ExternalSourceAspect will be the ECInstanceId of the relationship in the master iModel.
|
|
439
|
-
* The ECInstanceId of the relationship in the branch iModel will be stored in the JsonProperties of the ExternalSourceAspect.
|
|
440
|
-
*/
|
|
441
|
-
initRelationshipProvenance(sourceRelationship, targetRelInstanceId) {
|
|
442
|
-
return IModelTransformer.initRelationshipProvenanceOptions(sourceRelationship.id, targetRelInstanceId, {
|
|
443
|
-
sourceDb: this.sourceDb,
|
|
444
|
-
targetDb: this.targetDb,
|
|
445
|
-
isReverseSynchronization: this.isReverseSynchronization,
|
|
446
|
-
targetScopeElementId: this.targetScopeElementId,
|
|
447
|
-
forceOldRelationshipProvenanceMethod: this._forceOldRelationshipProvenanceMethod,
|
|
448
|
-
});
|
|
449
|
-
}
|
|
450
|
-
/** NOTE: the json properties must be converted to string before insertion */
|
|
451
|
-
_targetScopeProvenanceProps = undefined;
|
|
452
|
-
/**
|
|
453
|
-
* Index of the changeset that the transformer was at when the transformation begins (was constructed).
|
|
454
|
-
* Used to determine at the end which changesets were part of a synchronization.
|
|
455
|
-
*/
|
|
456
|
-
_startingChangesetIndices = undefined;
|
|
457
|
-
_cachedSynchronizationVersion = undefined;
|
|
458
|
-
/**
|
|
459
|
-
* We cache the synchronization version to avoid querying the target scoping ESA multiple times.
|
|
460
|
-
* If the target scoping ESA is ever updated we need to clear any potentially cached sync version otherwise we will get stale values.
|
|
461
|
-
* Sets this._cachedSynchronizationVersion to undefined.
|
|
462
|
-
*/
|
|
463
|
-
clearCachedSynchronizationVersion() {
|
|
464
|
-
this._cachedSynchronizationVersion = undefined;
|
|
278
|
+
async initElementProvenance(sourceElementId, targetElementId) {
|
|
279
|
+
return this._provenanceManager.initElementProvenance(sourceElementId, targetElementId);
|
|
465
280
|
}
|
|
466
281
|
/** the changeset in the scoping element's source version found for this transformation
|
|
467
282
|
* @note the version depends on whether this is a reverse synchronization or not, as
|
|
@@ -470,448 +285,59 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
470
285
|
* @note empty string and -1 for changeset and index if it was transformed before federation guid update (pre 1.x) and @see [[IModelTransformOptions.branchRelationshipDataBehavior]] === "unsafe-migrate".
|
|
471
286
|
* @throws if the version is not found in a preexisting scope aspect and @see [[IModelTransformOptions.branchRelationshipDataBehavior]] !== "unsafe-migrate"
|
|
472
287
|
*/
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
const provenanceScopeAspect = this.tryGetProvenanceScopeAspect();
|
|
476
|
-
if (!provenanceScopeAspect) {
|
|
477
|
-
return { index: -1, id: "" }; // first synchronization.
|
|
478
|
-
}
|
|
479
|
-
const version = this.isReverseSynchronization
|
|
480
|
-
? JSON.parse(provenanceScopeAspect.jsonProperties ?? "{}").reverseSyncVersion
|
|
481
|
-
: provenanceScopeAspect.version;
|
|
482
|
-
if (!version &&
|
|
483
|
-
this._options.branchRelationshipDataBehavior === "unsafe-migrate") {
|
|
484
|
-
return { index: -1, id: "" }; // previous synchronization was done before fed guid update.
|
|
485
|
-
}
|
|
486
|
-
if (version === undefined) {
|
|
487
|
-
throw new Error(`Could not find synchronization version in scope aspect. This may be due to the last successful run of the transformer being done with an older version.
|
|
488
|
-
Consider running the transformer with branchRelationshipDataBehavior set to 'unsafe-migrate'`);
|
|
489
|
-
}
|
|
490
|
-
const [id, index] = version === "" ? ["", -1] : version.split(";");
|
|
491
|
-
if (Number.isNaN(Number(index)))
|
|
492
|
-
throw new Error("Could not parse version data from scope aspect");
|
|
493
|
-
this._cachedSynchronizationVersion = { index: Number(index), id }; // synchronization version found and cached.
|
|
494
|
-
}
|
|
495
|
-
return this._cachedSynchronizationVersion;
|
|
288
|
+
async getSynchronizationVersion() {
|
|
289
|
+
return this._provenanceManager.getSynchronizationVersion();
|
|
496
290
|
}
|
|
497
291
|
/**
|
|
498
292
|
* @returns provenance scope aspect if it exists in the provenanceDb.
|
|
499
293
|
* Provenance scope aspect is created and inserted into provenanceDb when [[initScopeProvenance]] is invoked.
|
|
500
294
|
*/
|
|
501
|
-
tryGetProvenanceScopeAspect() {
|
|
502
|
-
|
|
503
|
-
id: undefined,
|
|
504
|
-
classFullName: core_backend_1.ExternalSourceAspect.classFullName,
|
|
505
|
-
scope: { id: core_common_1.IModel.rootSubjectId },
|
|
506
|
-
kind: core_backend_1.ExternalSourceAspect.Kind.Scope,
|
|
507
|
-
element: { id: this.targetScopeElementId ?? core_common_1.IModel.rootSubjectId },
|
|
508
|
-
identifier: this.provenanceSourceDb.iModelId,
|
|
509
|
-
});
|
|
510
|
-
return scopeProvenanceAspectProps !== undefined
|
|
511
|
-
? this.provenanceDb.elements.getAspect(scopeProvenanceAspectProps.aspectId)
|
|
512
|
-
: undefined;
|
|
295
|
+
async tryGetProvenanceScopeAspect() {
|
|
296
|
+
return this._provenanceManager.tryGetProvenanceScopeAspect();
|
|
513
297
|
}
|
|
514
298
|
/**
|
|
515
299
|
* Make sure there are no conflicting other scope-type external source aspects on the *target scope element*,
|
|
516
300
|
* If there are none at all, insert one, then this must be a first synchronization.
|
|
517
|
-
* @returns the last synced version (changesetId) on the target scope's external source aspect,
|
|
518
|
-
* if this was a [BriefcaseDb]($backend)
|
|
519
301
|
*/
|
|
520
|
-
initScopeProvenance() {
|
|
521
|
-
|
|
522
|
-
id: undefined,
|
|
523
|
-
version: undefined,
|
|
524
|
-
classFullName: core_backend_1.ExternalSourceAspect.classFullName,
|
|
525
|
-
element: {
|
|
526
|
-
id: this.targetScopeElementId,
|
|
527
|
-
relClassName: core_backend_1.ElementOwnsExternalSourceAspects.classFullName,
|
|
528
|
-
},
|
|
529
|
-
scope: { id: core_common_1.IModel.rootSubjectId }, // the root Subject scopes scope elements
|
|
530
|
-
identifier: this.provenanceSourceDb.iModelId,
|
|
531
|
-
kind: core_backend_1.ExternalSourceAspect.Kind.Scope,
|
|
532
|
-
jsonProperties: undefined,
|
|
533
|
-
};
|
|
534
|
-
const foundEsaProps = IModelTransformer.queryScopeExternalSourceAspect(this.provenanceDb, aspectProps); // this query includes "identifier"
|
|
535
|
-
if (foundEsaProps === undefined) {
|
|
536
|
-
aspectProps.version = ""; // empty since never before transformed. Will be updated in [[finalizeTransformation]]
|
|
537
|
-
aspectProps.jsonProperties = {
|
|
538
|
-
pendingReverseSyncChangesetIndices: [],
|
|
539
|
-
pendingSyncChangesetIndices: [],
|
|
540
|
-
reverseSyncVersion: "", // empty since never before transformed. Will be updated in first reverse sync
|
|
541
|
-
};
|
|
542
|
-
// this query does not include "identifier" to find possible conflicts
|
|
543
|
-
const sql = `
|
|
544
|
-
SELECT ECInstanceId
|
|
545
|
-
FROM ${core_backend_1.ExternalSourceAspect.classFullName}
|
|
546
|
-
WHERE Element.Id=:elementId
|
|
547
|
-
AND Scope.Id=:scopeId
|
|
548
|
-
AND Kind=:kind
|
|
549
|
-
LIMIT 1
|
|
550
|
-
`;
|
|
551
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
552
|
-
const hasConflictingScope = this.provenanceDb.withPreparedStatement(sql,
|
|
553
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
554
|
-
(statement) => {
|
|
555
|
-
statement.bindId("elementId", aspectProps.element.id);
|
|
556
|
-
statement.bindId("scopeId", aspectProps.scope.id); // this scope.id can never be invalid, we create it above
|
|
557
|
-
statement.bindString("kind", aspectProps.kind);
|
|
558
|
-
return core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step();
|
|
559
|
-
});
|
|
560
|
-
if (hasConflictingScope) {
|
|
561
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.InvalidId, "Provenance scope conflict");
|
|
562
|
-
}
|
|
563
|
-
if (!this._options.noProvenance) {
|
|
564
|
-
const id = this.provenanceDb.elements.insertAspect({
|
|
565
|
-
...aspectProps,
|
|
566
|
-
jsonProperties: JSON.stringify(aspectProps.jsonProperties),
|
|
567
|
-
});
|
|
568
|
-
aspectProps.id = id;
|
|
569
|
-
// Busting a potential cached version
|
|
570
|
-
this.clearCachedSynchronizationVersion();
|
|
571
|
-
}
|
|
572
|
-
}
|
|
573
|
-
else {
|
|
574
|
-
// foundEsaProps is defined.
|
|
575
|
-
aspectProps.id = foundEsaProps.aspectId;
|
|
576
|
-
aspectProps.version = foundEsaProps.version;
|
|
577
|
-
aspectProps.jsonProperties = foundEsaProps.jsonProperties
|
|
578
|
-
? JSON.parse(foundEsaProps.jsonProperties)
|
|
579
|
-
: undefined;
|
|
580
|
-
// Clone oldProps incase they're changed for logging purposes
|
|
581
|
-
const oldProps = JSON.parse(JSON.stringify(aspectProps));
|
|
582
|
-
if (this.handleUnsafeMigrate(aspectProps)) {
|
|
583
|
-
core_bentley_1.Logger.logInfo(loggerCategory, "Unsafe migrate made a change to the target scope's external source aspect. Updating aspect in database.", { oldProps, newProps: aspectProps });
|
|
584
|
-
this.provenanceDb.elements.updateAspect({
|
|
585
|
-
...aspectProps,
|
|
586
|
-
jsonProperties: JSON.stringify(aspectProps.jsonProperties),
|
|
587
|
-
});
|
|
588
|
-
// Busting a potential cached version
|
|
589
|
-
this.clearCachedSynchronizationVersion();
|
|
590
|
-
}
|
|
591
|
-
}
|
|
592
|
-
this._targetScopeProvenanceProps =
|
|
593
|
-
aspectProps;
|
|
594
|
-
}
|
|
595
|
-
/** Returns true if a change was made to the aspectProps. */
|
|
596
|
-
handleUnsafeMigrate(aspectProps) {
|
|
597
|
-
let madeChange = false;
|
|
598
|
-
if (this._options.branchRelationshipDataBehavior !== "unsafe-migrate")
|
|
599
|
-
return madeChange;
|
|
600
|
-
const fallbackSyncVersionToUse = this._options.argsForProcessChanges?.unsafeFallbackSyncVersion ?? "";
|
|
601
|
-
const fallbackReverseSyncVersionToUse = this._options.argsForProcessChanges?.unsafeFallbackReverseSyncVersion ??
|
|
602
|
-
"";
|
|
603
|
-
if (aspectProps.version === undefined ||
|
|
604
|
-
(aspectProps.version === "" &&
|
|
605
|
-
aspectProps.version !== fallbackSyncVersionToUse)) {
|
|
606
|
-
aspectProps.version = fallbackSyncVersionToUse;
|
|
607
|
-
madeChange = true;
|
|
608
|
-
}
|
|
609
|
-
if (aspectProps.jsonProperties === undefined) {
|
|
610
|
-
aspectProps.jsonProperties = {
|
|
611
|
-
pendingReverseSyncChangesetIndices: [],
|
|
612
|
-
pendingSyncChangesetIndices: [],
|
|
613
|
-
reverseSyncVersion: fallbackReverseSyncVersionToUse,
|
|
614
|
-
};
|
|
615
|
-
madeChange = true;
|
|
616
|
-
}
|
|
617
|
-
else if (aspectProps.jsonProperties.reverseSyncVersion === undefined ||
|
|
618
|
-
(aspectProps.jsonProperties.reverseSyncVersion === "" &&
|
|
619
|
-
aspectProps.jsonProperties.reverseSyncVersion !==
|
|
620
|
-
fallbackReverseSyncVersionToUse)) {
|
|
621
|
-
aspectProps.jsonProperties.reverseSyncVersion =
|
|
622
|
-
fallbackReverseSyncVersionToUse;
|
|
623
|
-
madeChange = true;
|
|
624
|
-
}
|
|
625
|
-
/**
|
|
626
|
-
* This case will only be hit when:
|
|
627
|
-
* - first transformation was performed on pre-fedguid transformer.
|
|
628
|
-
* - a second processAll transformation was performed on the same target-source iModels post-fedguid transformer.
|
|
629
|
-
* - change processing was invoked on for the second 'initial' transformation.
|
|
630
|
-
* NOTE: This case likely does not exist anymore, but we will keep it just to be sure.
|
|
631
|
-
*/
|
|
632
|
-
if (aspectProps.jsonProperties.pendingReverseSyncChangesetIndices ===
|
|
633
|
-
undefined) {
|
|
634
|
-
core_bentley_1.Logger.logWarning(loggerCategory, "Property pendingReverseSyncChangesetIndices missing on the jsonProperties of the scoping ESA. Setting to [].");
|
|
635
|
-
aspectProps.jsonProperties.pendingReverseSyncChangesetIndices = [];
|
|
636
|
-
madeChange = true;
|
|
637
|
-
}
|
|
638
|
-
if (aspectProps.jsonProperties.pendingSyncChangesetIndices === undefined) {
|
|
639
|
-
core_bentley_1.Logger.logWarning(loggerCategory, "Property pendingSyncChangesetIndices missing on the jsonProperties of the scoping ESA. Setting to [].");
|
|
640
|
-
aspectProps.jsonProperties.pendingSyncChangesetIndices = [];
|
|
641
|
-
madeChange = true;
|
|
642
|
-
}
|
|
643
|
-
return madeChange;
|
|
302
|
+
async initScopeProvenance() {
|
|
303
|
+
return this._provenanceManager.initScopeProvenance();
|
|
644
304
|
}
|
|
645
305
|
/**
|
|
646
|
-
*
|
|
647
|
-
*
|
|
648
|
-
* @note provenance is done by federation guids where possible
|
|
649
|
-
* @note this may execute on each element more than once! Only use in cases where that is handled
|
|
306
|
+
* Get the IModelDb where provenance (ExternalSourceAspects) is stored.
|
|
307
|
+
* This will be targetDb except when it is a reverse synchronization, in which case it will be sourceDb.
|
|
650
308
|
*/
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadSchema, "The BisCore schema version of the target database is too old");
|
|
656
|
-
}
|
|
657
|
-
const sourceDb = args.isReverseSynchronization
|
|
658
|
-
? args.provenanceDb
|
|
659
|
-
: args.provenanceSourceDb;
|
|
660
|
-
const targetDb = args.isReverseSynchronization
|
|
661
|
-
? args.provenanceSourceDb
|
|
662
|
-
: args.provenanceDb;
|
|
663
|
-
// query for provenanceDb
|
|
664
|
-
const elementIdByFedGuidQuery = `
|
|
665
|
-
SELECT e.ECInstanceId, FederationGuid
|
|
666
|
-
FROM bis.Element e
|
|
667
|
-
${args.skipPropagateChangesToRootElements
|
|
668
|
-
? "WHERE e.ECInstanceId NOT IN (0x1, 0xe, 0x10) -- special static elements"
|
|
669
|
-
: ""}
|
|
670
|
-
ORDER BY FederationGuid
|
|
671
|
-
`;
|
|
672
|
-
// iterate through sorted list of fed guids from both dbs to get the intersection
|
|
673
|
-
// NOTE: if we exposed the native attach database support,
|
|
674
|
-
// we could get the intersection of fed guids in one query, not sure if it would be faster
|
|
675
|
-
// OR we could do a raw sqlite query...
|
|
676
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
677
|
-
sourceDb.withStatement(elementIdByFedGuidQuery, (sourceStmt) =>
|
|
678
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
679
|
-
targetDb.withStatement(elementIdByFedGuidQuery, (targetStmt) => {
|
|
680
|
-
if (sourceStmt.step() !== core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
681
|
-
return;
|
|
682
|
-
let sourceRow = sourceStmt.getRow();
|
|
683
|
-
if (targetStmt.step() !== core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
684
|
-
return;
|
|
685
|
-
let targetRow = targetStmt.getRow();
|
|
686
|
-
// NOTE: these comparisons rely upon the lowercase of the guid,
|
|
687
|
-
// and the fact that '0' < '9' < a' < 'f' in ascii/utf8
|
|
688
|
-
while (true) {
|
|
689
|
-
const currSourceRow = sourceRow, currTargetRow = targetRow;
|
|
690
|
-
if (currSourceRow.federationGuid !== undefined &&
|
|
691
|
-
currTargetRow.federationGuid !== undefined &&
|
|
692
|
-
currSourceRow.federationGuid === currTargetRow.federationGuid) {
|
|
693
|
-
// data flow direction is always sourceDb -> targetDb and it does not depend on where the explicit element provenance is stored
|
|
694
|
-
args.fn(sourceRow.id, targetRow.id);
|
|
695
|
-
}
|
|
696
|
-
if (currTargetRow.federationGuid === undefined ||
|
|
697
|
-
(currSourceRow.federationGuid !== undefined &&
|
|
698
|
-
currSourceRow.federationGuid >= currTargetRow.federationGuid)) {
|
|
699
|
-
if (targetStmt.step() !== core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
700
|
-
return;
|
|
701
|
-
targetRow = targetStmt.getRow();
|
|
702
|
-
}
|
|
703
|
-
if (currSourceRow.federationGuid === undefined ||
|
|
704
|
-
(currTargetRow.federationGuid !== undefined &&
|
|
705
|
-
currSourceRow.federationGuid <= currTargetRow.federationGuid)) {
|
|
706
|
-
if (sourceStmt.step() !== core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
707
|
-
return;
|
|
708
|
-
sourceRow = sourceStmt.getRow();
|
|
709
|
-
}
|
|
710
|
-
}
|
|
711
|
-
}));
|
|
712
|
-
// query for provenanceDb
|
|
713
|
-
const provenanceAspectsQuery = `
|
|
714
|
-
SELECT esa.Identifier, Element.Id
|
|
715
|
-
FROM bis.ExternalSourceAspect esa
|
|
716
|
-
WHERE Scope.Id=:scopeId
|
|
717
|
-
AND Kind=:kind
|
|
718
|
-
`;
|
|
719
|
-
// Technically this will a second time call the function (as documented) on
|
|
720
|
-
// victims of the old provenance method that have both fedguids and an inserted aspect.
|
|
721
|
-
// But this is a private function with one known caller where that doesn't matter
|
|
722
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
723
|
-
args.provenanceDb.withPreparedStatement(provenanceAspectsQuery, (stmt) => {
|
|
724
|
-
const runFnInDataFlowDirection = (sourceId, targetId) => args.isReverseSynchronization
|
|
725
|
-
? args.fn(sourceId, targetId)
|
|
726
|
-
: args.fn(targetId, sourceId);
|
|
727
|
-
stmt.bindId("scopeId", args.targetScopeElementId);
|
|
728
|
-
stmt.bindString("kind", core_backend_1.ExternalSourceAspect.Kind.Element);
|
|
729
|
-
while (core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step()) {
|
|
730
|
-
// ExternalSourceAspect.Identifier is of type string
|
|
731
|
-
const aspectIdentifier = stmt.getValue(0).getString();
|
|
732
|
-
const elementId = stmt.getValue(1).getId();
|
|
733
|
-
runFnInDataFlowDirection(elementId, aspectIdentifier);
|
|
734
|
-
}
|
|
735
|
-
});
|
|
736
|
-
}
|
|
737
|
-
forEachTrackedElement(fn) {
|
|
738
|
-
return IModelTransformer.forEachTrackedElement({
|
|
739
|
-
provenanceSourceDb: this.provenanceSourceDb,
|
|
740
|
-
provenanceDb: this.provenanceDb,
|
|
741
|
-
targetScopeElementId: this.targetScopeElementId,
|
|
742
|
-
isReverseSynchronization: this.isReverseSynchronization,
|
|
743
|
-
fn,
|
|
744
|
-
skipPropagateChangesToRootElements: this._options.skipPropagateChangesToRootElements ?? true,
|
|
745
|
-
});
|
|
309
|
+
async getProvenanceDb() {
|
|
310
|
+
return (await this.getIsReverseSynchronization())
|
|
311
|
+
? this.sourceDb
|
|
312
|
+
: this.targetDb;
|
|
746
313
|
}
|
|
747
314
|
/**
|
|
748
|
-
*
|
|
749
|
-
* The identifier on the ESA is the id of the element in the [[IModelTransformer.provenanceSourceDb]]
|
|
750
|
-
* Therefore it only makes sense to call this function when you have an id in the provenanceSourceDb.
|
|
751
|
-
* @param entityInProvenanceSourceId
|
|
752
|
-
* @returns the elementId that the ESA is stored on, esa.Element.Id
|
|
315
|
+
* Get whether this is a reverse synchronization.
|
|
753
316
|
*/
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
return this.provenanceDb.withPreparedStatement(`
|
|
757
|
-
SELECT esa.Element.Id
|
|
758
|
-
FROM Bis.ExternalSourceAspect esa
|
|
759
|
-
WHERE esa.Kind=?
|
|
760
|
-
AND esa.Scope.Id=?
|
|
761
|
-
AND esa.Identifier=?
|
|
762
|
-
`, (stmt) => {
|
|
763
|
-
stmt.bindString(1, core_backend_1.ExternalSourceAspect.Kind.Element);
|
|
764
|
-
stmt.bindId(2, this.targetScopeElementId);
|
|
765
|
-
stmt.bindString(3, entityInProvenanceSourceId);
|
|
766
|
-
if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
767
|
-
return stmt.getValue(0).getId();
|
|
768
|
-
else
|
|
769
|
-
return undefined;
|
|
770
|
-
});
|
|
317
|
+
async getIsReverseSynchronization() {
|
|
318
|
+
return (await this._syncTypeResolver.getSyncType()) === "reverse";
|
|
771
319
|
}
|
|
772
320
|
/**
|
|
773
|
-
*
|
|
774
|
-
* The identifier on the ESA is the id of the relationship in the [[IModelTransformer.provenanceSourceDb]]
|
|
775
|
-
* Therefore it only makes sense to call this function when you have an id in the provenanceSourceDb.
|
|
776
|
-
* @param entityInProvenanceSourceId
|
|
777
|
-
* @returns
|
|
321
|
+
* Get whether this is a forward synchronization.
|
|
778
322
|
*/
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
return this.provenanceDb.withPreparedStatement(`
|
|
782
|
-
SELECT
|
|
783
|
-
ECInstanceId,
|
|
784
|
-
JSON_EXTRACT(JsonProperties, '$.targetRelInstanceId'),
|
|
785
|
-
JSON_EXTRACT(JsonProperties, '$.provenanceRelInstanceId')
|
|
786
|
-
FROM Bis.ExternalSourceAspect
|
|
787
|
-
WHERE Kind=?
|
|
788
|
-
AND Scope.Id=?
|
|
789
|
-
AND Identifier=?
|
|
790
|
-
`, (stmt) => {
|
|
791
|
-
stmt.bindString(1, core_backend_1.ExternalSourceAspect.Kind.Relationship);
|
|
792
|
-
stmt.bindId(2, this.targetScopeElementId);
|
|
793
|
-
stmt.bindString(3, entityInProvenanceSourceId);
|
|
794
|
-
if (stmt.step() !== core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
795
|
-
return undefined;
|
|
796
|
-
const aspectId = stmt.getValue(0).getId();
|
|
797
|
-
const provenanceRelInstIdVal = stmt.getValue(2);
|
|
798
|
-
const provenanceRelInstanceId = !provenanceRelInstIdVal.isNull
|
|
799
|
-
? provenanceRelInstIdVal.getString()
|
|
800
|
-
: this._queryTargetRelId(sourceRelInfo);
|
|
801
|
-
return {
|
|
802
|
-
aspectId,
|
|
803
|
-
relationshipId: provenanceRelInstanceId,
|
|
804
|
-
};
|
|
805
|
-
});
|
|
323
|
+
async getIsForwardSynchronization() {
|
|
324
|
+
return (await this._syncTypeResolver.getSyncType()) === "forward";
|
|
806
325
|
}
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
return undefined; // couldn't find an element, rel is invalid or deleted
|
|
815
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
816
|
-
return this.targetDb.withPreparedStatement(`
|
|
817
|
-
SELECT ECInstanceId
|
|
818
|
-
FROM bis.ElementRefersToElements
|
|
819
|
-
WHERE SourceECInstanceId=?
|
|
820
|
-
AND TargetECInstanceId=?
|
|
821
|
-
AND ECClassId=?
|
|
822
|
-
`, (stmt) => {
|
|
823
|
-
stmt.bindId(1, targetRelInfo.sourceId);
|
|
824
|
-
stmt.bindId(2, targetRelInfo.targetId);
|
|
825
|
-
stmt.bindId(3, this._targetClassNameToClassId(sourceRelInfo.classFullName));
|
|
826
|
-
if (stmt.step() !== core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
827
|
-
return undefined;
|
|
828
|
-
return stmt.getValue(0).getId();
|
|
829
|
-
});
|
|
830
|
-
}
|
|
831
|
-
_targetClassNameToClassIdCache = new Map();
|
|
832
|
-
_targetClassNameToClassId(classFullName) {
|
|
833
|
-
let classId = this._targetClassNameToClassIdCache.get(classFullName);
|
|
834
|
-
if (classId === undefined) {
|
|
835
|
-
classId = this._getRelClassId(this.targetDb, classFullName);
|
|
836
|
-
this._targetClassNameToClassIdCache.set(classFullName, classId);
|
|
837
|
-
}
|
|
838
|
-
return classId;
|
|
839
|
-
}
|
|
840
|
-
// NOTE: this doesn't handle remapped element classes,
|
|
841
|
-
// but is only used for relationships rn
|
|
842
|
-
_getRelClassId(db, classFullName) {
|
|
843
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
844
|
-
return db.withPreparedStatement(`
|
|
845
|
-
SELECT c.ECInstanceId
|
|
846
|
-
FROM ECDbMeta.ECClassDef c
|
|
847
|
-
JOIN ECDbMeta.ECSchemaDef s ON c.Schema.Id=s.ECInstanceId
|
|
848
|
-
WHERE s.Name=? AND c.Name=?
|
|
849
|
-
`, (stmt) => {
|
|
850
|
-
const [schemaName, className] = classFullName.indexOf(".") !== -1
|
|
851
|
-
? classFullName.split(".")
|
|
852
|
-
: classFullName.split(":");
|
|
853
|
-
stmt.bindString(1, schemaName);
|
|
854
|
-
stmt.bindString(2, className);
|
|
855
|
-
if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
856
|
-
return stmt.getValue(0).getId();
|
|
857
|
-
(0, core_bentley_1.assert)(false, "relationship was not found");
|
|
858
|
-
});
|
|
859
|
-
}
|
|
860
|
-
_queryElemIdByFedGuid(db, fedGuid) {
|
|
861
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
862
|
-
return db.withPreparedStatement("SELECT ECInstanceId FROM Bis.Element WHERE FederationGuid=?", (stmt) => {
|
|
863
|
-
stmt.bindGuid(1, fedGuid);
|
|
864
|
-
if (stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
|
|
865
|
-
return stmt.getValue(0).getId();
|
|
866
|
-
else
|
|
867
|
-
return undefined;
|
|
326
|
+
/**
|
|
327
|
+
* Updates the synchronization version on the scope ESA.
|
|
328
|
+
*/
|
|
329
|
+
async updateSynchronizationVersion({ initializeReverseSyncVersion = false, } = {}) {
|
|
330
|
+
return this._provenanceManager.updateSynchronizationVersion({
|
|
331
|
+
initializeReverseSyncVersion,
|
|
332
|
+
sourceChangeDataState: this._sourceChangeDataState,
|
|
868
333
|
});
|
|
869
334
|
}
|
|
870
335
|
/** Returns `true` if *brute force* delete detections should be run.
|
|
871
336
|
* @note This is only called if [[IModelTransformOptions.forceExternalSourceAspectProvenance]] option is true
|
|
872
337
|
* @note Not relevant for [[process]] when [[IModelTransformOptions.argsForProcessChanges]] are provided and change history is known.
|
|
873
338
|
*/
|
|
874
|
-
shouldDetectDeletes() {
|
|
875
|
-
|
|
876
|
-
return this._syncType === "not-sync";
|
|
877
|
-
}
|
|
878
|
-
/**
|
|
879
|
-
* Detect Element deletes using ExternalSourceAspects in the target iModel and a *brute force* comparison against Elements
|
|
880
|
-
* in the source iModel.
|
|
881
|
-
* @deprecated in 1.x. Do not use this. // FIXME<MIKE>: how to better explain this?
|
|
882
|
-
* This method is only called during [[process]] when [[IModelTransformOptions.argsForProcessChanges]] is undefined and the option
|
|
883
|
-
* [[IModelTransformOptions.forceExternalSourceAspectProvenance]] is enabled. It is not
|
|
884
|
-
* necessary when calling [[process]] with [[IModelTransformOptions.argsForProcessChanges]] defined, since changeset information is sufficient.
|
|
885
|
-
* @note you do not need to call this directly unless processing a subset of an iModel.
|
|
886
|
-
* @throws [[IModelError]] If the required provenance information is not available to detect deletes.
|
|
887
|
-
*/
|
|
888
|
-
async detectElementDeletes() {
|
|
889
|
-
const sql = `
|
|
890
|
-
SELECT Identifier, Element.Id
|
|
891
|
-
FROM BisCore.ExternalSourceAspect
|
|
892
|
-
WHERE Scope.Id=:scopeId
|
|
893
|
-
AND Kind=:kind
|
|
894
|
-
`;
|
|
895
|
-
nodeAssert(!this.isReverseSynchronization, "synchronizations with processChanges already detect element deletes, don't call detectElementDeletes");
|
|
896
|
-
// Reported issue: https://github.com/iTwin/itwinjs-core/issues/7989
|
|
897
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
898
|
-
this.provenanceDb.withPreparedStatement(sql, (stmt) => {
|
|
899
|
-
stmt.bindId("scopeId", this.targetScopeElementId);
|
|
900
|
-
stmt.bindString("kind", core_backend_1.ExternalSourceAspect.Kind.Element);
|
|
901
|
-
while (core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step()) {
|
|
902
|
-
// ExternalSourceAspect.Identifier is of type string
|
|
903
|
-
const aspectIdentifier = stmt.getValue(0).getString();
|
|
904
|
-
if (!core_bentley_1.Id64.isValidId64(aspectIdentifier)) {
|
|
905
|
-
continue;
|
|
906
|
-
}
|
|
907
|
-
const targetElemId = stmt.getValue(1).getId();
|
|
908
|
-
const wasDeletedInSource = !EntityUnifier_1.EntityUnifier.exists(this.sourceDb, {
|
|
909
|
-
entityReference: `e${aspectIdentifier}`,
|
|
910
|
-
});
|
|
911
|
-
if (wasDeletedInSource)
|
|
912
|
-
this.importer.deleteElement(targetElemId);
|
|
913
|
-
}
|
|
914
|
-
});
|
|
339
|
+
async shouldDetectDeletes() {
|
|
340
|
+
return (await this._syncTypeResolver.getSyncType()) === "not-sync";
|
|
915
341
|
}
|
|
916
342
|
/** Transform the specified sourceElement into ElementProps for the target iModel.
|
|
917
343
|
* @param sourceElement The Element from the source iModel to transform.
|
|
@@ -919,9 +345,9 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
919
345
|
* @note A subclass can override this method to provide custom transform behavior.
|
|
920
346
|
* @note This can be called more than once for an element in arbitrary order, so it should not have side-effects.
|
|
921
347
|
*/
|
|
922
|
-
onTransformElement(sourceElement) {
|
|
348
|
+
async onTransformElement(sourceElement) {
|
|
923
349
|
core_bentley_1.Logger.logTrace(loggerCategory, `onTransformElement(${sourceElement.id}) "${sourceElement.getDisplayLabel()}"`);
|
|
924
|
-
const targetElementProps = this.context.cloneElement(sourceElement, { binaryGeometry: this._options.cloneUsingBinaryGeometry });
|
|
350
|
+
const targetElementProps = await this.context.cloneElement(sourceElement, { binaryGeometry: this._options.cloneUsingBinaryGeometry });
|
|
925
351
|
// Special case: source element is the root subject
|
|
926
352
|
if (sourceElement.id === core_common_1.IModel.rootSubjectId) {
|
|
927
353
|
const targetElementId = this.context.findTargetElementId(sourceElement.id);
|
|
@@ -964,7 +390,13 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
964
390
|
const srcEcefLoc = this.sourceDb.ecefLocation;
|
|
965
391
|
const targetEcefLoc = this.targetDb.ecefLocation;
|
|
966
392
|
if (srcEcefLoc === undefined || targetEcefLoc === undefined) {
|
|
967
|
-
|
|
393
|
+
core_bentley_1.ITwinError.throwError({
|
|
394
|
+
iTwinErrorId: {
|
|
395
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
396
|
+
key: IModelTransformerError_1.IModelTransformerError.GeolocationUnavailable,
|
|
397
|
+
},
|
|
398
|
+
message: "Both source and target ECEF locations must be defined to calculate the transform.",
|
|
399
|
+
});
|
|
968
400
|
}
|
|
969
401
|
if (srcEcefLoc.getTransform().isAlmostEqual(targetEcefLoc.getTransform())) {
|
|
970
402
|
core_bentley_1.Logger.logTrace(loggerCategory, "ECEF data is already aligned. No spatial transforms needed.");
|
|
@@ -973,7 +405,13 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
973
405
|
const srcSpatialToECEF = srcEcefLoc.getTransform(); // converts relative to ECEF in relation to source
|
|
974
406
|
const targetECEFToSpatial = targetEcefLoc.getTransform().inverse(); // converts ECEF to relative in relation to target
|
|
975
407
|
if (!targetECEFToSpatial) {
|
|
976
|
-
|
|
408
|
+
core_bentley_1.ITwinError.throwError({
|
|
409
|
+
iTwinErrorId: {
|
|
410
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
411
|
+
key: IModelTransformerError_1.IModelTransformerError.GeolocationUnavailable,
|
|
412
|
+
},
|
|
413
|
+
message: "Failed to invert target ECEF transform.",
|
|
414
|
+
});
|
|
977
415
|
}
|
|
978
416
|
const ecefTransform = targetECEFToSpatial.multiplyTransformTransform(srcSpatialToECEF); // chain both transforms
|
|
979
417
|
return ecefTransform;
|
|
@@ -991,15 +429,33 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
991
429
|
calculateTransformFromHelmertTransforms() {
|
|
992
430
|
if (this.sourceDb.geographicCoordinateSystem?.horizontalCRS === undefined ||
|
|
993
431
|
this.sourceDb.geographicCoordinateSystem?.verticalCRS === undefined) {
|
|
994
|
-
|
|
432
|
+
core_bentley_1.ITwinError.throwError({
|
|
433
|
+
iTwinErrorId: {
|
|
434
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
435
|
+
key: IModelTransformerError_1.IModelTransformerError.GeographicCoordinateSystemUnavailable,
|
|
436
|
+
},
|
|
437
|
+
message: "Source iModel does not have a geographic coordinate system defined.",
|
|
438
|
+
});
|
|
995
439
|
}
|
|
996
440
|
if (this.targetDb.geographicCoordinateSystem?.horizontalCRS === undefined ||
|
|
997
441
|
this.targetDb.geographicCoordinateSystem.verticalCRS === undefined) {
|
|
998
|
-
|
|
442
|
+
core_bentley_1.ITwinError.throwError({
|
|
443
|
+
iTwinErrorId: {
|
|
444
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
445
|
+
key: IModelTransformerError_1.IModelTransformerError.GeographicCoordinateSystemUnavailable,
|
|
446
|
+
},
|
|
447
|
+
message: "Target iModel does not have a geographic coordinate system defined.",
|
|
448
|
+
});
|
|
999
449
|
}
|
|
1000
450
|
if (!this.sourceDb.geographicCoordinateSystem.horizontalCRS.equals(this.targetDb.geographicCoordinateSystem.horizontalCRS) ||
|
|
1001
451
|
!this.sourceDb.geographicCoordinateSystem.verticalCRS.equals(this.targetDb.geographicCoordinateSystem.verticalCRS)) {
|
|
1002
|
-
|
|
452
|
+
core_bentley_1.ITwinError.throwError({
|
|
453
|
+
iTwinErrorId: {
|
|
454
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
455
|
+
key: IModelTransformerError_1.IModelTransformerError.GeographicCoordinateSystemMismatch,
|
|
456
|
+
},
|
|
457
|
+
message: "Source and target geographic coordinate systems must match to calculate the spatial transform.",
|
|
458
|
+
});
|
|
1003
459
|
}
|
|
1004
460
|
if (this.sourceDb.geographicCoordinateSystem.additionalTransform ===
|
|
1005
461
|
this.targetDb.geographicCoordinateSystem.additionalTransform) {
|
|
@@ -1011,14 +467,26 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1011
467
|
const targetScale = this.targetDb.geographicCoordinateSystem.additionalTransform
|
|
1012
468
|
?.helmert2DWithZOffset?.scale ?? 1;
|
|
1013
469
|
if (srcScale !== targetScale) {
|
|
1014
|
-
|
|
470
|
+
core_bentley_1.ITwinError.throwError({
|
|
471
|
+
iTwinErrorId: {
|
|
472
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
473
|
+
key: IModelTransformerError_1.IModelTransformerError.GeographicCoordinateSystemMismatch,
|
|
474
|
+
},
|
|
475
|
+
message: "Spatial transform is non rigid. Source and target Helmert transforms must have the same scale to calculate a rigid spatial transform.",
|
|
476
|
+
});
|
|
1015
477
|
}
|
|
1016
478
|
const srcTransform = IModelTransformer.convertHelmertToTransform(this.sourceDb.geographicCoordinateSystem.additionalTransform
|
|
1017
479
|
?.helmert2DWithZOffset); // moves elements to where src helmert transform would move them at render time
|
|
1018
480
|
const targetTransformInv = IModelTransformer.convertHelmertToTransform(this.targetDb.geographicCoordinateSystem.additionalTransform
|
|
1019
481
|
?.helmert2DWithZOffset).inverse(); // negates target helmert transform that is applied at render time
|
|
1020
482
|
if (!targetTransformInv) {
|
|
1021
|
-
|
|
483
|
+
core_bentley_1.ITwinError.throwError({
|
|
484
|
+
iTwinErrorId: {
|
|
485
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
486
|
+
key: IModelTransformerError_1.IModelTransformerError.GeolocationUnavailable,
|
|
487
|
+
},
|
|
488
|
+
message: "Failed to invert target Helmert transform.",
|
|
489
|
+
});
|
|
1022
490
|
}
|
|
1023
491
|
const combinedTransform = targetTransformInv.multiplyTransformTransform(srcTransform);
|
|
1024
492
|
return combinedTransform;
|
|
@@ -1028,6 +496,9 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1028
496
|
/** Returns true if a change within sourceElement is detected.
|
|
1029
497
|
* @param sourceElement The Element from the source iModel
|
|
1030
498
|
* @note A subclass can override this method to provide custom change detection behavior.
|
|
499
|
+
* @note During change processing, elements not present in the changeset are short-circuited
|
|
500
|
+
* in the exporter before reaching this method. To add elements to the changeset programmatically,
|
|
501
|
+
* use [[addCustomChanges]] rather than overriding this method to expand processing.
|
|
1031
502
|
*/
|
|
1032
503
|
hasElementChanged(sourceElement) {
|
|
1033
504
|
const sourceDbChanges = this.exporter.sourceDbChanges;
|
|
@@ -1035,7 +506,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1035
506
|
sourceDbChanges.element.insertIds.has(sourceElement.id) ||
|
|
1036
507
|
sourceDbChanges.element.updateIds.has(sourceElement.id));
|
|
1037
508
|
}
|
|
1038
|
-
completePartiallyCommittedElements() {
|
|
509
|
+
async completePartiallyCommittedElements() {
|
|
1039
510
|
for (const sourceElementId of this._partiallyCommittedElementIds) {
|
|
1040
511
|
const sourceElement = this.sourceDb.elements.getElement({
|
|
1041
512
|
id: sourceElementId,
|
|
@@ -1046,25 +517,25 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1046
517
|
if (core_bentley_1.Id64.isInvalid(targetId)) {
|
|
1047
518
|
throw new Error(`source-target element mapping not found for element "${sourceElementId}" when completing partially committed elements. This is a bug.`);
|
|
1048
519
|
}
|
|
1049
|
-
const targetProps = this.onTransformElement(sourceElement);
|
|
1050
|
-
this.
|
|
520
|
+
const targetProps = await this.onTransformElement(sourceElement);
|
|
521
|
+
this._targetEditTxn.updateElement({ ...targetProps, id: targetId });
|
|
1051
522
|
}
|
|
1052
523
|
}
|
|
1053
|
-
completePartiallyCommittedAspects() {
|
|
524
|
+
async completePartiallyCommittedAspects() {
|
|
1054
525
|
for (const sourceAspectId of this._partiallyCommittedAspectIds) {
|
|
1055
526
|
const sourceAspect = this.sourceDb.elements.getAspect(sourceAspectId);
|
|
1056
527
|
const targetAspectId = this.context.findTargetAspectId(sourceAspectId);
|
|
1057
528
|
if (core_bentley_1.Id64.isInvalid(targetAspectId)) {
|
|
1058
529
|
throw new Error(`source-target aspect mapping not found for aspect "${sourceAspectId}" when completing partially committed aspects. This is a bug.`);
|
|
1059
530
|
}
|
|
1060
|
-
const targetAspectProps = this.onTransformElementAspect(sourceAspect);
|
|
1061
|
-
this.
|
|
531
|
+
const targetAspectProps = await this.onTransformElementAspect(sourceAspect);
|
|
532
|
+
this._targetEditTxn.updateAspect({
|
|
1062
533
|
...targetAspectProps,
|
|
1063
534
|
id: targetAspectId,
|
|
1064
535
|
});
|
|
1065
536
|
}
|
|
1066
537
|
}
|
|
1067
|
-
doAllReferencesExistInTarget(entity) {
|
|
538
|
+
async doAllReferencesExistInTarget(entity) {
|
|
1068
539
|
let allReferencesExist = true;
|
|
1069
540
|
for (const referenceId of entity.getReferenceIds()) {
|
|
1070
541
|
const referencedEntityId = core_backend_1.EntityReferences.toId64(referenceId);
|
|
@@ -1074,7 +545,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1074
545
|
continue;
|
|
1075
546
|
}
|
|
1076
547
|
if (allReferencesExist &&
|
|
1077
|
-
!core_backend_1.EntityReferences.isValid(this.context.findTargetEntityId(referenceId))) {
|
|
548
|
+
!core_backend_1.EntityReferences.isValid(await this.context.findTargetEntityId(referenceId))) {
|
|
1078
549
|
// if we care about references existing then we cannot return early and must check all other references.
|
|
1079
550
|
if (this._options.danglingReferencesBehavior === "ignore") {
|
|
1080
551
|
return false;
|
|
@@ -1082,22 +553,28 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1082
553
|
allReferencesExist = false;
|
|
1083
554
|
}
|
|
1084
555
|
if (this._options.danglingReferencesBehavior === "reject") {
|
|
1085
|
-
this.assertReferenceExistsInSource(referenceId, entity);
|
|
556
|
+
await this.assertReferenceExistsInSource(referenceId, entity);
|
|
1086
557
|
}
|
|
1087
558
|
}
|
|
1088
559
|
return allReferencesExist;
|
|
1089
560
|
}
|
|
1090
|
-
assertReferenceExistsInSource(referenceId, entity) {
|
|
1091
|
-
const referencedExistsInSource = EntityUnifier_1.EntityUnifier.exists(this.sourceDb, {
|
|
561
|
+
async assertReferenceExistsInSource(referenceId, entity) {
|
|
562
|
+
const referencedExistsInSource = await EntityUnifier_1.EntityUnifier.exists(this.sourceDb, {
|
|
1092
563
|
entityReference: referenceId,
|
|
1093
564
|
});
|
|
1094
565
|
if (!referencedExistsInSource) {
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
566
|
+
core_bentley_1.ITwinError.throwError({
|
|
567
|
+
iTwinErrorId: {
|
|
568
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
569
|
+
key: IModelTransformerError_1.IModelTransformerError.DanglingReference,
|
|
570
|
+
},
|
|
571
|
+
message: [
|
|
572
|
+
`Found a reference to an element "${referenceId}" that doesn't exist while looking for references of "${entity.id}".`,
|
|
573
|
+
"This must have been caused by an upstream application that changed the iModel.",
|
|
574
|
+
"You can set the IModelTransformOptions.danglingReferencesBehavior option to 'ignore' to ignore this,",
|
|
575
|
+
`and the referenceId found on "${entity.id}" will not be carried over to corresponding target element.`,
|
|
576
|
+
].join("\n"),
|
|
577
|
+
});
|
|
1101
578
|
}
|
|
1102
579
|
}
|
|
1103
580
|
/** Cause the specified Element and its child Elements (if applicable) to be exported from the source iModel and imported into the target iModel.
|
|
@@ -1107,7 +584,13 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1107
584
|
async processElement(sourceElementId) {
|
|
1108
585
|
await this.initialize();
|
|
1109
586
|
if (sourceElementId === core_common_1.IModel.rootSubjectId) {
|
|
1110
|
-
|
|
587
|
+
core_bentley_1.ITwinError.throwError({
|
|
588
|
+
iTwinErrorId: {
|
|
589
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
590
|
+
key: IModelTransformerError_1.IModelTransformerError.RootSubjectNotProcessable,
|
|
591
|
+
},
|
|
592
|
+
message: "The root Subject should not be directly imported",
|
|
593
|
+
});
|
|
1111
594
|
}
|
|
1112
595
|
return this.exporter.exportElement(sourceElementId);
|
|
1113
596
|
}
|
|
@@ -1122,7 +605,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1122
605
|
/** Override of [IModelExportHandler.shouldExportElement]($transformer) that is called to determine if an element should be exported from the source iModel.
|
|
1123
606
|
* @note Reaching this point means that the element has passed the standard exclusion checks in IModelExporter.
|
|
1124
607
|
*/
|
|
1125
|
-
shouldExportElement(_sourceElement) {
|
|
608
|
+
async shouldExportElement(_sourceElement) {
|
|
1126
609
|
return true;
|
|
1127
610
|
}
|
|
1128
611
|
/**
|
|
@@ -1130,6 +613,10 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1130
613
|
* @internal do not call, override or implement this, it will be removed
|
|
1131
614
|
*/
|
|
1132
615
|
async preExportElement(sourceElement) {
|
|
616
|
+
if (!this.hasElementChanged(sourceElement)) {
|
|
617
|
+
core_bentley_1.Logger.logTrace(loggerCategory, `Skipping unchanged element (${sourceElement.id}, ${sourceElement.getDisplayLabel()}).`);
|
|
618
|
+
return;
|
|
619
|
+
}
|
|
1133
620
|
const elemClass = sourceElement.constructor;
|
|
1134
621
|
const unresolvedReferences = elemClass.requiredReferenceKeys
|
|
1135
622
|
.map((referenceKey) => {
|
|
@@ -1164,7 +651,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1164
651
|
.flat();
|
|
1165
652
|
if (unresolvedReferences.length > 0) {
|
|
1166
653
|
for (const reference of unresolvedReferences) {
|
|
1167
|
-
const processState = this.getElemTransformState(reference);
|
|
654
|
+
const processState = await this.getElemTransformState(reference);
|
|
1168
655
|
// must export element first
|
|
1169
656
|
if (processState.needsElemImport)
|
|
1170
657
|
await this.exporter.exportElement(reference);
|
|
@@ -1173,23 +660,55 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1173
660
|
}
|
|
1174
661
|
}
|
|
1175
662
|
}
|
|
1176
|
-
getElemTransformState(elementId) {
|
|
1177
|
-
const dbHasModel = (db, id) => {
|
|
663
|
+
async getElemTransformState(elementId) {
|
|
664
|
+
const dbHasModel = async (db, id) => {
|
|
1178
665
|
const maybeModelId = core_backend_1.EntityReferences.fromEntityType(id, core_common_1.ConcreteEntityTypes.Model);
|
|
1179
666
|
return EntityUnifier_1.EntityUnifier.exists(db, { entityReference: maybeModelId });
|
|
1180
667
|
};
|
|
1181
|
-
const isSubModeled = dbHasModel(this.sourceDb, elementId);
|
|
668
|
+
const isSubModeled = await dbHasModel(this.sourceDb, elementId);
|
|
1182
669
|
const idOfElemInTarget = this.context.findTargetElementId(elementId);
|
|
1183
670
|
const isElemInTarget = core_bentley_1.Id64.invalid !== idOfElemInTarget;
|
|
1184
671
|
const needsModelImport = isSubModeled &&
|
|
1185
|
-
(!isElemInTarget || !dbHasModel(this.targetDb, idOfElemInTarget));
|
|
672
|
+
(!isElemInTarget || !(await dbHasModel(this.targetDb, idOfElemInTarget)));
|
|
1186
673
|
return { needsElemImport: !isElemInTarget, needsModelImport };
|
|
1187
674
|
}
|
|
675
|
+
// In iTwin js 5.x Elements.queryElementIdByCode() uses Code class to query id:
|
|
676
|
+
// https://github.com/iTwin/itwinjs-core/blob/master/core/backend/src/IModelDb.ts#L2779
|
|
677
|
+
// Code class constructor trims white spaces from code value.
|
|
678
|
+
// Custom implementation of queryElementIdByCode() was added to support querying elements with code values that have trailing whitespaces.
|
|
679
|
+
// It mimicks 4.x implementation: https://github.com/iTwin/itwinjs-core/blob/9c8b394ec3878a39764be81f928fd8b0b9115d31/core/backend/src/IModelDb.ts#L1882
|
|
680
|
+
async queryElementIdByCode(iModel, code) {
|
|
681
|
+
if (core_bentley_1.Id64.isInvalid(code.spec))
|
|
682
|
+
core_bentley_1.ITwinError.throwError({
|
|
683
|
+
iTwinErrorId: {
|
|
684
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
685
|
+
key: IModelTransformerError_1.IModelTransformerError.InvalidCode,
|
|
686
|
+
},
|
|
687
|
+
message: "Invalid CodeSpec",
|
|
688
|
+
});
|
|
689
|
+
if (code.value === undefined)
|
|
690
|
+
core_bentley_1.ITwinError.throwError({
|
|
691
|
+
iTwinErrorId: {
|
|
692
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
693
|
+
key: IModelTransformerError_1.IModelTransformerError.InvalidCode,
|
|
694
|
+
},
|
|
695
|
+
message: "Invalid Code",
|
|
696
|
+
});
|
|
697
|
+
const query = "SELECT ECInstanceId FROM BisCore:Element WHERE CodeSpec.Id=? AND CodeScope.Id=? AND CodeValue=?";
|
|
698
|
+
const queryBinder = new core_common_1.QueryBinder()
|
|
699
|
+
.bindId(1, code.spec)
|
|
700
|
+
.bindId(2, core_bentley_1.Id64.fromString(code.scope))
|
|
701
|
+
.bindString(3, code.value);
|
|
702
|
+
const queryReader = iModel.createQueryReader(query, queryBinder, {
|
|
703
|
+
usePrimaryConn: true,
|
|
704
|
+
});
|
|
705
|
+
return (await queryReader.step()) ? queryReader.current[0] : undefined;
|
|
706
|
+
}
|
|
1188
707
|
/** Override of [IModelExportHandler.onExportElement]($transformer) that imports an element into the target iModel when it is exported from the source iModel.
|
|
1189
708
|
* This override calls [[onTransformElement]] and then [IModelImporter.importElement]($transformer) to update the target iModel.
|
|
1190
709
|
*/
|
|
1191
|
-
onExportElement(sourceElement) {
|
|
1192
|
-
let targetElementId;
|
|
710
|
+
async onExportElement(sourceElement) {
|
|
711
|
+
let targetElementId = core_bentley_1.Id64.invalid;
|
|
1193
712
|
let targetElementProps;
|
|
1194
713
|
if (this._options.wasSourceIModelCopiedToTarget) {
|
|
1195
714
|
targetElementId = sourceElement.id;
|
|
@@ -1198,14 +717,14 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1198
717
|
}
|
|
1199
718
|
else {
|
|
1200
719
|
targetElementId = this.context.findTargetElementId(sourceElement.id);
|
|
1201
|
-
targetElementProps = this.onTransformElement(sourceElement);
|
|
720
|
+
targetElementProps = await this.onTransformElement(sourceElement);
|
|
1202
721
|
}
|
|
1203
722
|
// if an existing remapping was not yet found, check by FederationGuid
|
|
1204
723
|
if (this.context.isBetweenIModels &&
|
|
1205
724
|
!core_bentley_1.Id64.isValid(targetElementId) &&
|
|
1206
725
|
sourceElement.federationGuid !== undefined) {
|
|
1207
726
|
targetElementId =
|
|
1208
|
-
this.
|
|
727
|
+
this.targetDb.elements.getIdFromFederationGuid(sourceElement.federationGuid) ?? core_bentley_1.Id64.invalid;
|
|
1209
728
|
if (core_bentley_1.Id64.isValid(targetElementId))
|
|
1210
729
|
this.context.remapElement(sourceElement.id, targetElementId); // record that the targetElement was found
|
|
1211
730
|
}
|
|
@@ -1215,13 +734,14 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1215
734
|
// respond the same way to undefined code value as the @see Code class, but don't use that class because it trims
|
|
1216
735
|
// whitespace from the value, and there are iModels out there with untrimmed whitespace that we ought not to trim
|
|
1217
736
|
targetElementProps.code.value = targetElementProps.code.value ?? "";
|
|
1218
|
-
const maybeTargetElementId = this.
|
|
737
|
+
const maybeTargetElementId = await this.queryElementIdByCode(this.targetDb, targetElementProps.code);
|
|
1219
738
|
if (undefined !== maybeTargetElementId) {
|
|
1220
739
|
const maybeTargetElem = this.targetDb.elements.getElement(maybeTargetElementId);
|
|
1221
740
|
if (maybeTargetElem.classFullName === targetElementProps.classFullName) {
|
|
1222
741
|
// ensure code remapping doesn't change the target class
|
|
1223
742
|
targetElementId = maybeTargetElementId;
|
|
1224
743
|
this.context.remapElement(sourceElement.id, targetElementId); // record that the targetElement was found by Code
|
|
744
|
+
this._targetElementIdsRemappedByCode.add(targetElementId);
|
|
1225
745
|
}
|
|
1226
746
|
else {
|
|
1227
747
|
targetElementProps.code = core_common_1.Code.createEmpty(); // clear out invalid code
|
|
@@ -1232,7 +752,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1232
752
|
core_bentley_1.Logger.logTrace(loggerCategory, `Skipping unchanged element (${sourceElement.id}, ${sourceElement.getDisplayLabel()}).`);
|
|
1233
753
|
return;
|
|
1234
754
|
}
|
|
1235
|
-
if (!this.doAllReferencesExistInTarget(sourceElement)) {
|
|
755
|
+
if (!(await this.doAllReferencesExistInTarget(sourceElement))) {
|
|
1236
756
|
this._partiallyCommittedElementIds.add(sourceElement.id);
|
|
1237
757
|
}
|
|
1238
758
|
// targetElementId will be valid (indicating update) or undefined (indicating insert)
|
|
@@ -1243,7 +763,13 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1243
763
|
const isValid = core_bentley_1.Id64.isValid(targetElementId);
|
|
1244
764
|
if (isValid && targetElementId !== sourceElement.id) {
|
|
1245
765
|
// Element found with different id
|
|
1246
|
-
|
|
766
|
+
core_bentley_1.ITwinError.throwError({
|
|
767
|
+
iTwinErrorId: {
|
|
768
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
769
|
+
key: IModelTransformerError_1.IModelTransformerError.ElementIdNotPreservable,
|
|
770
|
+
},
|
|
771
|
+
message: `Element id(${sourceElement.id}) cannot be preserved. Found a different mapping(${targetElementId}) from source element`,
|
|
772
|
+
});
|
|
1247
773
|
}
|
|
1248
774
|
else if (isValid && targetElementId === sourceElement.id) {
|
|
1249
775
|
// targetElementId is valid (indicating update)
|
|
@@ -1254,7 +780,13 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1254
780
|
// if we don't find mapping for source element in target(invalid) but another element with source id exists in target
|
|
1255
781
|
if (sourceInTargetElemProps) {
|
|
1256
782
|
// Element id is already taken by another element
|
|
1257
|
-
|
|
783
|
+
core_bentley_1.ITwinError.throwError({
|
|
784
|
+
iTwinErrorId: {
|
|
785
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
786
|
+
key: IModelTransformerError_1.IModelTransformerError.ElementIdNotPreservable,
|
|
787
|
+
},
|
|
788
|
+
message: `Element id(${sourceElement.id}) cannot be preserved. An unrelated element in the target already uses id: ${sourceElement.id}`,
|
|
789
|
+
});
|
|
1258
790
|
}
|
|
1259
791
|
else {
|
|
1260
792
|
// Element id in target is available to be remapped
|
|
@@ -1263,10 +795,10 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1263
795
|
}
|
|
1264
796
|
}
|
|
1265
797
|
if (!this._options.wasSourceIModelCopiedToTarget) {
|
|
1266
|
-
this.importer.importElement(targetElementProps); // don't need to import if iModel was copied
|
|
798
|
+
await this.importer.importElement(targetElementProps); // don't need to import if iModel was copied
|
|
1267
799
|
}
|
|
1268
800
|
if (targetElementProps.id === undefined) {
|
|
1269
|
-
throw new
|
|
801
|
+
throw new Error("targetElementProps.id should be assigned by importElement");
|
|
1270
802
|
}
|
|
1271
803
|
this.context.remapElement(sourceElement.id, targetElementProps.id);
|
|
1272
804
|
// the transformer does not currently 'split' or 'join' any elements, therefore, it does not
|
|
@@ -1276,39 +808,43 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1276
808
|
// physical consolidation is an example of a 'joining' transform
|
|
1277
809
|
// FIXME: verify at finalization time that we don't lose provenance on new elements
|
|
1278
810
|
// FIXME: make public and improve `initElementProvenance` API for usage by consolidators
|
|
811
|
+
const provenanceDb = await this.getProvenanceDb();
|
|
812
|
+
const provenanceEditTxn = await this._provenanceManager.getProvenanceEditTxn();
|
|
1279
813
|
if (!this._options.noProvenance) {
|
|
1280
|
-
|
|
814
|
+
const provenance = this._options.forceExternalSourceAspectProvenance ||
|
|
1281
815
|
this._elementsWithExplicitlyTrackedProvenance.has(sourceElement.id)
|
|
1282
816
|
? undefined
|
|
1283
817
|
: sourceElement.federationGuid;
|
|
1284
818
|
if (!provenance) {
|
|
1285
|
-
const aspectProps = this.initElementProvenance(sourceElement.id, targetElementProps.id);
|
|
1286
|
-
const foundEsaProps =
|
|
819
|
+
const aspectProps = await this.initElementProvenance(sourceElement.id, targetElementProps.id);
|
|
820
|
+
const foundEsaProps = await ProvenanceManager_1.ProvenanceManager.queryScopeExternalSourceAspect(provenanceDb, aspectProps);
|
|
1287
821
|
if (foundEsaProps === undefined)
|
|
1288
|
-
aspectProps.id =
|
|
822
|
+
aspectProps.id = provenanceEditTxn.insertAspect(aspectProps);
|
|
1289
823
|
else {
|
|
1290
824
|
// Since initElementProvenance sets a property 'version' on the aspectProps that we wish to persist in the provenanceDb, only grab the id from the foundEsaProps.
|
|
1291
825
|
aspectProps.id = foundEsaProps.aspectId;
|
|
1292
|
-
|
|
826
|
+
provenanceEditTxn.updateAspect(aspectProps);
|
|
1293
827
|
}
|
|
1294
|
-
provenance = aspectProps;
|
|
1295
828
|
}
|
|
1296
|
-
this.markLastProvenance(provenance, { isRelationship: false });
|
|
1297
829
|
}
|
|
1298
830
|
}
|
|
1299
831
|
/** Override of [IModelExportHandler.onDeleteElement]($transformer) that is called when [IModelExporter]($transformer) detects that an Element has been deleted from the source iModel.
|
|
1300
832
|
* This override propagates the delete to the target iModel via [IModelImporter.deleteElement]($transformer).
|
|
1301
833
|
*/
|
|
1302
|
-
onDeleteElement(sourceElementId) {
|
|
834
|
+
async onDeleteElement(sourceElementId) {
|
|
1303
835
|
const targetElementId = this.context.findTargetElementId(sourceElementId);
|
|
1304
836
|
if (core_bentley_1.Id64.isValidId64(targetElementId)) {
|
|
1305
|
-
|
|
837
|
+
// Skip deletion if new / updated source element was remapped to it by Code during
|
|
838
|
+
// this transformation pass.
|
|
839
|
+
if (!this._targetElementIdsRemappedByCode.has(targetElementId)) {
|
|
840
|
+
await this.importer.deleteElement(targetElementId);
|
|
841
|
+
}
|
|
1306
842
|
}
|
|
1307
843
|
}
|
|
1308
844
|
/** Override of [IModelExportHandler.onExportModel]($transformer) that is called when a Model should be exported from the source iModel.
|
|
1309
845
|
* This override calls [[onTransformModel]] and then [IModelImporter.importModel]($transformer) to update the target iModel.
|
|
1310
846
|
*/
|
|
1311
|
-
onExportModel(sourceModel) {
|
|
847
|
+
async onExportModel(sourceModel) {
|
|
1312
848
|
if (this._options.skipPropagateChangesToRootElements &&
|
|
1313
849
|
core_common_1.IModel.repositoryModelId === sourceModel.id)
|
|
1314
850
|
return; // The RepositoryModel should not be directly imported
|
|
@@ -1319,16 +855,27 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1319
855
|
if (isRemappedRootSubject)
|
|
1320
856
|
return;
|
|
1321
857
|
const targetModelProps = this.onTransformModel(sourceModel, targetModeledElementId);
|
|
1322
|
-
this.importer.importModel(targetModelProps);
|
|
858
|
+
await this.importer.importModel(targetModelProps);
|
|
859
|
+
if (targetModelProps.id === undefined) {
|
|
860
|
+
throw new Error("targetModelProps.id should be assigned by now");
|
|
861
|
+
}
|
|
862
|
+
this._targetModelsImportedInCurrentTransform.add(targetModelProps.id);
|
|
1323
863
|
}
|
|
1324
864
|
/** Override of [IModelExportHandler.onDeleteModel]($transformer) that is called when [IModelExporter]($transformer) detects that a [Model]($backend) has been deleted from the source iModel. */
|
|
1325
|
-
onDeleteModel(sourceModelId) {
|
|
865
|
+
async onDeleteModel(sourceModelId) {
|
|
1326
866
|
// It is possible and apparently occasionally sensical to delete a model without deleting its underlying element.
|
|
1327
867
|
// - If only the model is deleted, [[initFromExternalSourceAspects]] will have already remapped the underlying element since it still exists.
|
|
1328
868
|
// - If both were deleted, [[remapDeletedSourceEntities]] will find and remap the deleted element making this operation valid
|
|
1329
869
|
const targetModelId = this.context.findTargetElementId(sourceModelId);
|
|
1330
870
|
if (!core_bentley_1.Id64.isValidId64(targetModelId))
|
|
1331
871
|
return;
|
|
872
|
+
// This handles cases where model with a partition element was remapped to
|
|
873
|
+
// new element by code value after recreation.
|
|
874
|
+
if (this._targetElementIdsRemappedByCode.has(targetModelId) &&
|
|
875
|
+
this._targetModelsImportedInCurrentTransform.has(targetModelId)) {
|
|
876
|
+
core_bentley_1.Logger.logTrace(loggerCategory, `Skipping delete operation for model (source id: ${sourceModelId}) because the target model (id: ${targetModelId}) was remapped by Code and re-imported during this transformation pass.`);
|
|
877
|
+
return;
|
|
878
|
+
}
|
|
1332
879
|
const sql = `
|
|
1333
880
|
SELECT 1
|
|
1334
881
|
FROM bis.DefinitionPartition
|
|
@@ -1339,19 +886,11 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1339
886
|
WHERE ECInstanceId=:targetModelId
|
|
1340
887
|
`;
|
|
1341
888
|
if (this.exporter.sourceDbChanges?.element.deleteIds.has(sourceModelId)) {
|
|
1342
|
-
|
|
1343
|
-
const
|
|
1344
|
-
|
|
1345
|
-
const val = stmt.step();
|
|
1346
|
-
switch (val) {
|
|
1347
|
-
case core_bentley_1.DbResult.BE_SQLITE_ROW:
|
|
1348
|
-
return true;
|
|
1349
|
-
case core_bentley_1.DbResult.BE_SQLITE_DONE:
|
|
1350
|
-
return false;
|
|
1351
|
-
default:
|
|
1352
|
-
(0, core_bentley_1.assert)(false, `unexpected db result: '${JSON.stringify(stmt)}'`);
|
|
1353
|
-
}
|
|
889
|
+
const params = new core_common_1.QueryBinder().bindId("targetModelId", targetModelId);
|
|
890
|
+
const reader = this.targetDb.createQueryReader(sql, params, {
|
|
891
|
+
usePrimaryConn: true,
|
|
1354
892
|
});
|
|
893
|
+
const isDefinitionPartition = await reader.step();
|
|
1355
894
|
if (isDefinitionPartition) {
|
|
1356
895
|
// Skipping model deletion because model's partition will also be deleted.
|
|
1357
896
|
// It expects that model will be present and will fail if it's missing.
|
|
@@ -1360,7 +899,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1360
899
|
}
|
|
1361
900
|
}
|
|
1362
901
|
try {
|
|
1363
|
-
this.importer.deleteModel(targetModelId);
|
|
902
|
+
await this.importer.deleteModel(targetModelId);
|
|
1364
903
|
}
|
|
1365
904
|
catch (error) {
|
|
1366
905
|
const isDeletionProhibitedErr = error instanceof core_common_1.IModelError &&
|
|
@@ -1407,41 +946,24 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1407
946
|
await this.initialize();
|
|
1408
947
|
// import DefinitionModels first
|
|
1409
948
|
const childDefinitionPartitionSql = `SELECT ECInstanceId FROM ${core_backend_1.DefinitionPartition.classFullName} WHERE Parent.Id=:subjectId`;
|
|
1410
|
-
|
|
1411
|
-
await this.sourceDb.
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
statement.bindId("subjectId", sourceSubjectId);
|
|
1415
|
-
while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
|
|
1416
|
-
await this.processModel(statement.getValue(0).getId());
|
|
1417
|
-
}
|
|
1418
|
-
});
|
|
949
|
+
const params = new core_common_1.QueryBinder().bindId("subjectId", sourceSubjectId);
|
|
950
|
+
for await (const row of this.sourceDb.createQueryReader(childDefinitionPartitionSql, params, { usePrimaryConn: true })) {
|
|
951
|
+
await this.processModel(row.id);
|
|
952
|
+
}
|
|
1419
953
|
// import other partitions next
|
|
1420
954
|
const childPartitionSql = `SELECT ECInstanceId FROM ${core_backend_1.InformationPartitionElement.classFullName} WHERE Parent.Id=:subjectId`;
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
|
|
1427
|
-
const modelId = statement.getValue(0).getId();
|
|
1428
|
-
const model = this.sourceDb.models.getModel(modelId);
|
|
1429
|
-
if (!(model instanceof core_backend_1.DefinitionModel)) {
|
|
1430
|
-
await this.processModel(modelId);
|
|
1431
|
-
}
|
|
955
|
+
for await (const row of this.sourceDb.createQueryReader(childPartitionSql, params, { usePrimaryConn: true })) {
|
|
956
|
+
const modelId = row.id;
|
|
957
|
+
const model = this.sourceDb.models.getModel(modelId);
|
|
958
|
+
if (!(model instanceof core_backend_1.DefinitionModel)) {
|
|
959
|
+
await this.processModel(modelId);
|
|
1432
960
|
}
|
|
1433
|
-
}
|
|
961
|
+
}
|
|
1434
962
|
// recurse into child Subjects
|
|
1435
963
|
const childSubjectSql = `SELECT ECInstanceId FROM ${core_backend_1.Subject.classFullName} WHERE Parent.Id=:subjectId`;
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
async (statement) => {
|
|
1440
|
-
statement.bindId("subjectId", sourceSubjectId);
|
|
1441
|
-
while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
|
|
1442
|
-
await this.processSubjectSubModels(statement.getValue(0).getId());
|
|
1443
|
-
}
|
|
1444
|
-
});
|
|
964
|
+
for await (const row of this.sourceDb.createQueryReader(childSubjectSql, params, { usePrimaryConn: true })) {
|
|
965
|
+
await this.processSubjectSubModels(row.id);
|
|
966
|
+
}
|
|
1445
967
|
}
|
|
1446
968
|
/** Transform the specified sourceModel into ModelProps for the target iModel.
|
|
1447
969
|
* @param sourceModel The Model from the source iModel to be transformed.
|
|
@@ -1458,104 +980,21 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1458
980
|
};
|
|
1459
981
|
targetModelProps.id = targetModeledElementId;
|
|
1460
982
|
if (targetModelProps.parentModel === undefined) {
|
|
1461
|
-
|
|
983
|
+
core_bentley_1.ITwinError.throwError({
|
|
984
|
+
iTwinErrorId: {
|
|
985
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
986
|
+
key: IModelTransformerError_1.IModelTransformerError.ParentModelRequired,
|
|
987
|
+
},
|
|
988
|
+
message: "targetElementProps must have a defined parentModel",
|
|
989
|
+
});
|
|
1462
990
|
}
|
|
1463
991
|
targetModelProps.parentModel = this.context.findTargetElementId(targetModelProps.parentModel);
|
|
1464
992
|
return targetModelProps;
|
|
1465
993
|
}
|
|
1466
|
-
/**
|
|
1467
|
-
* Called at the end of a transformation,
|
|
1468
|
-
* updates the target scope element to say that transformation up through the
|
|
1469
|
-
* source's changeset has been performed. Also stores all changesets that occurred
|
|
1470
|
-
* during the transformation as "pending synchronization changeset indices" @see TargetScopeProvenanceJsonProps
|
|
1471
|
-
*
|
|
1472
|
-
* You generally should not call this function yourself and use [[process]] with [[IModelTransformOptions.argsForProcessChanges]] provided instead.
|
|
1473
|
-
* It is public for unsupported use cases of custom synchronization transforms.
|
|
1474
|
-
* @note If [[IModelTransformOptions.argsForProcessChanges]] is not defined in this transformation, this function will return early without updating the sync version,
|
|
1475
|
-
* unless the `initializeReverseSyncVersion` option is set to `true`
|
|
1476
|
-
*
|
|
1477
|
-
* The `initializeReverseSyncVersion` is added to set the reverse synchronization version during a forward synchronization.
|
|
1478
|
-
* When set to `true`, it saves the reverse sync version as the current changeset of the targetDb. This is typically used for the first transformation between a master and branch iModel.
|
|
1479
|
-
* Setting `initializeReverseSyncVersion` to `true` has the effect of making it so any changesets in the branch iModel at the time of the first transformation will be ignored during any future reverse synchronizations from the branch to the master iModel.
|
|
1480
|
-
*
|
|
1481
|
-
* Note that typically, the reverseSyncVersion is saved as the last changeset merged from the branch into master.
|
|
1482
|
-
* Setting initializeReverseSyncVersion to true during a forward transformation could overwrite this correct reverseSyncVersion and should only be done during the first transformation between a master and branch iModel.
|
|
1483
|
-
*/
|
|
1484
|
-
updateSynchronizationVersion({ initializeReverseSyncVersion = false, } = {}) {
|
|
1485
|
-
const shouldSkipSyncVersionUpdate = !initializeReverseSyncVersion &&
|
|
1486
|
-
this._sourceChangeDataState !== "has-changes";
|
|
1487
|
-
if (shouldSkipSyncVersionUpdate)
|
|
1488
|
-
return;
|
|
1489
|
-
nodeAssert(this._targetScopeProvenanceProps);
|
|
1490
|
-
const sourceVersion = `${this.sourceDb.changeset.id};${this.sourceDb.changeset.index}`;
|
|
1491
|
-
const targetVersion = `${this.targetDb.changeset.id};${this.targetDb.changeset.index}`;
|
|
1492
|
-
if (this.isReverseSynchronization) {
|
|
1493
|
-
const oldVersion = this._targetScopeProvenanceProps.jsonProperties.reverseSyncVersion;
|
|
1494
|
-
core_bentley_1.Logger.logInfo(loggerCategory, `updating reverse version from ${oldVersion} to ${sourceVersion}`);
|
|
1495
|
-
this._targetScopeProvenanceProps.jsonProperties.reverseSyncVersion =
|
|
1496
|
-
sourceVersion;
|
|
1497
|
-
}
|
|
1498
|
-
else {
|
|
1499
|
-
core_bentley_1.Logger.logInfo(loggerCategory, `updating sync version from ${this._targetScopeProvenanceProps.version} to ${sourceVersion}`);
|
|
1500
|
-
this._targetScopeProvenanceProps.version = sourceVersion;
|
|
1501
|
-
// save reverse sync version
|
|
1502
|
-
if (initializeReverseSyncVersion) {
|
|
1503
|
-
core_bentley_1.Logger.logInfo(loggerCategory, `updating reverse sync version from ${this._targetScopeProvenanceProps.jsonProperties.reverseSyncVersion} to ${targetVersion}`);
|
|
1504
|
-
this._targetScopeProvenanceProps.jsonProperties.reverseSyncVersion =
|
|
1505
|
-
targetVersion;
|
|
1506
|
-
}
|
|
1507
|
-
}
|
|
1508
|
-
if (this._options.argsForProcessChanges ||
|
|
1509
|
-
(this._startingChangesetIndices && initializeReverseSyncVersion)) {
|
|
1510
|
-
nodeAssert(this.targetDb.changeset.index !== undefined &&
|
|
1511
|
-
this._startingChangesetIndices !== undefined, "updateSynchronizationVersion was called without change history");
|
|
1512
|
-
// Store in a local variable, so typescript knows it's defined (due to the assert above)
|
|
1513
|
-
const startingChangesetIndices = this._startingChangesetIndices;
|
|
1514
|
-
const jsonProps = this._targetScopeProvenanceProps.jsonProperties;
|
|
1515
|
-
core_bentley_1.Logger.logTrace(loggerCategory, `previous pendingReverseSyncChanges: ${jsonProps.pendingReverseSyncChangesetIndices}`);
|
|
1516
|
-
core_bentley_1.Logger.logTrace(loggerCategory, `previous pendingSyncChanges: ${jsonProps.pendingSyncChangesetIndices}`);
|
|
1517
|
-
const pendingSyncChangesetIndicesKey = "pendingSyncChangesetIndices";
|
|
1518
|
-
const pendingReverseSyncChangesetIndicesKey = "pendingReverseSyncChangesetIndices";
|
|
1519
|
-
// Determine which keys to clear and update based on the synchronization direction
|
|
1520
|
-
let syncChangesetsToClearKey;
|
|
1521
|
-
let syncChangesetsToUpdateKey;
|
|
1522
|
-
if (this.isReverseSynchronization) {
|
|
1523
|
-
syncChangesetsToClearKey = pendingReverseSyncChangesetIndicesKey;
|
|
1524
|
-
syncChangesetsToUpdateKey = pendingSyncChangesetIndicesKey;
|
|
1525
|
-
}
|
|
1526
|
-
else {
|
|
1527
|
-
syncChangesetsToClearKey = pendingSyncChangesetIndicesKey;
|
|
1528
|
-
syncChangesetsToUpdateKey = pendingReverseSyncChangesetIndicesKey;
|
|
1529
|
-
}
|
|
1530
|
-
// NOTE that as documented in [[processChanges]], this assumes that right after
|
|
1531
|
-
// transformation finalization, the work will be saved immediately, otherwise we've
|
|
1532
|
-
// just marked this changeset as a synchronization to ignore, and the user can add other
|
|
1533
|
-
// stuff to it which would break future synchronizations
|
|
1534
|
-
for (let i = startingChangesetIndices.target + 1; i <= this.targetDb.changeset.index + 1; i++)
|
|
1535
|
-
jsonProps[syncChangesetsToUpdateKey].push(i);
|
|
1536
|
-
// Only keep the changeset indices which are greater than the source, this means they haven't been processed yet.
|
|
1537
|
-
jsonProps[syncChangesetsToClearKey] = jsonProps[syncChangesetsToClearKey].filter((csIndex) => {
|
|
1538
|
-
return csIndex > startingChangesetIndices.source;
|
|
1539
|
-
});
|
|
1540
|
-
// if reverse sync then we may have received provenance changes which should be marked as sync changes
|
|
1541
|
-
if (this.isReverseSynchronization) {
|
|
1542
|
-
nodeAssert(this.sourceDb.changeset.index !== undefined, "changeset didn't exist");
|
|
1543
|
-
for (let i = startingChangesetIndices.source + 1; i <= this.sourceDb.changeset.index + 1; i++)
|
|
1544
|
-
jsonProps.pendingReverseSyncChangesetIndices.push(i);
|
|
1545
|
-
}
|
|
1546
|
-
core_bentley_1.Logger.logTrace(loggerCategory, `new pendingReverseSyncChanges: ${jsonProps.pendingReverseSyncChangesetIndices}`);
|
|
1547
|
-
core_bentley_1.Logger.logTrace(loggerCategory, `new pendingSyncChanges: ${jsonProps.pendingSyncChangesetIndices}`);
|
|
1548
|
-
}
|
|
1549
|
-
this.provenanceDb.elements.updateAspect({
|
|
1550
|
-
...this._targetScopeProvenanceProps,
|
|
1551
|
-
jsonProperties: JSON.stringify(this._targetScopeProvenanceProps.jsonProperties),
|
|
1552
|
-
});
|
|
1553
|
-
this.clearCachedSynchronizationVersion();
|
|
1554
|
-
}
|
|
1555
994
|
// FIXME<MIKE>: is this necessary when manually using low level transform APIs? (document if so)
|
|
1556
|
-
finalizeTransformation() {
|
|
995
|
+
async finalizeTransformation() {
|
|
1557
996
|
this.importer.finalize();
|
|
1558
|
-
this.updateSynchronizationVersion({
|
|
997
|
+
await this.updateSynchronizationVersion({
|
|
1559
998
|
initializeReverseSyncVersion: this._isProvenanceInitTransform,
|
|
1560
999
|
});
|
|
1561
1000
|
// TODO: ignore if we remove change cache usage
|
|
@@ -1582,38 +1021,39 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1582
1021
|
/** Override of [IModelExportHandler.shouldExportRelationship]($transformer) that is called to determine if a [Relationship]($backend) should be exported.
|
|
1583
1022
|
* @note Reaching this point means that the relationship has passed the standard exclusion checks in [IModelExporter]($transformer).
|
|
1584
1023
|
*/
|
|
1585
|
-
shouldExportRelationship(_sourceRelationship) {
|
|
1024
|
+
async shouldExportRelationship(_sourceRelationship) {
|
|
1586
1025
|
return true;
|
|
1587
1026
|
}
|
|
1588
1027
|
/** Override of [IModelExportHandler.onExportRelationship]($transformer) that imports a relationship into the target iModel when it is exported from the source iModel.
|
|
1589
1028
|
* This override calls [[onTransformRelationship]] and then [IModelImporter.importRelationship]($transformer) to update the target iModel.
|
|
1590
1029
|
*/
|
|
1591
|
-
onExportRelationship(sourceRelationship) {
|
|
1592
|
-
const sourceFedGuid =
|
|
1593
|
-
const targetFedGuid =
|
|
1030
|
+
async onExportRelationship(sourceRelationship) {
|
|
1031
|
+
const sourceFedGuid = this.sourceDb.elements.getFederationGuidFromId(sourceRelationship.sourceId);
|
|
1032
|
+
const targetFedGuid = this.sourceDb.elements.getFederationGuidFromId(sourceRelationship.targetId);
|
|
1594
1033
|
const targetRelationshipProps = this.onTransformRelationship(sourceRelationship);
|
|
1595
|
-
const targetRelationshipInstanceId = this.importer.importRelationship(targetRelationshipProps);
|
|
1034
|
+
const targetRelationshipInstanceId = await this.importer.importRelationship(targetRelationshipProps);
|
|
1035
|
+
const provenanceDb = await this.getProvenanceDb();
|
|
1036
|
+
const provenanceEditTxn = await this._provenanceManager.getProvenanceEditTxn();
|
|
1596
1037
|
if (!this._options.noProvenance &&
|
|
1597
1038
|
core_bentley_1.Id64.isValid(targetRelationshipInstanceId)) {
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
const
|
|
1039
|
+
const needsEsaProvenance = !this._options
|
|
1040
|
+
.forceExternalSourceAspectProvenance
|
|
1041
|
+
? !(sourceFedGuid && targetFedGuid)
|
|
1042
|
+
: true;
|
|
1043
|
+
if (needsEsaProvenance) {
|
|
1044
|
+
const aspectProps = await this._provenanceManager.initRelationshipProvenance(sourceRelationship.id, targetRelationshipInstanceId, this._forceOldRelationshipProvenanceMethod);
|
|
1045
|
+
const foundEsaProps = await ProvenanceManager_1.ProvenanceManager.queryScopeExternalSourceAspect(provenanceDb, aspectProps);
|
|
1604
1046
|
// onExportRelationship doesn't need to call updateAspect if esaProps were found, because relationship provenance doesn't have the same concept of a version as element provenance (which uses last mod time on the elements).
|
|
1605
1047
|
if (undefined === foundEsaProps) {
|
|
1606
|
-
aspectProps.id =
|
|
1048
|
+
aspectProps.id = provenanceEditTxn.insertAspect(aspectProps);
|
|
1607
1049
|
}
|
|
1608
|
-
provenance = aspectProps;
|
|
1609
1050
|
}
|
|
1610
|
-
this.markLastProvenance(provenance, { isRelationship: true });
|
|
1611
1051
|
}
|
|
1612
1052
|
}
|
|
1613
1053
|
/** Override of [IModelExportHandler.onDeleteRelationship]($transformer) that is called when [IModelExporter]($transformer) detects that a [Relationship]($backend) has been deleted from the source iModel.
|
|
1614
1054
|
* This override propagates the delete to the target iModel via [IModelImporter.deleteRelationship]($transformer).
|
|
1615
1055
|
*/
|
|
1616
|
-
onDeleteRelationship(sourceRelInstanceId) {
|
|
1056
|
+
async onDeleteRelationship(sourceRelInstanceId) {
|
|
1617
1057
|
nodeAssert(this._deletedSourceRelationshipData, "should be defined at initialization by now");
|
|
1618
1058
|
const deletedRelData = this._deletedSourceRelationshipData.get(sourceRelInstanceId);
|
|
1619
1059
|
if (!deletedRelData) {
|
|
@@ -1627,14 +1067,14 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1627
1067
|
targetId: deletedRelData.targetIdInTarget,
|
|
1628
1068
|
})?.id;
|
|
1629
1069
|
if (id) {
|
|
1630
|
-
this.importer.deleteRelationship({
|
|
1070
|
+
await this.importer.deleteRelationship({
|
|
1631
1071
|
id,
|
|
1632
1072
|
classFullName: deletedRelData.classFullName,
|
|
1633
1073
|
});
|
|
1634
1074
|
}
|
|
1635
1075
|
if (deletedRelData.provenanceAspectId) {
|
|
1636
1076
|
try {
|
|
1637
|
-
this.
|
|
1077
|
+
(await this._provenanceManager.getProvenanceEditTxn()).deleteAspect(deletedRelData.provenanceAspectId);
|
|
1638
1078
|
}
|
|
1639
1079
|
catch (error) {
|
|
1640
1080
|
// This aspect may no longer exist if it was deleted at some other point during the transformation. This is fine.
|
|
@@ -1645,51 +1085,6 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1645
1085
|
}
|
|
1646
1086
|
}
|
|
1647
1087
|
_yieldManager = new core_bentley_1.YieldManager();
|
|
1648
|
-
/** Detect Relationship deletes using ExternalSourceAspects in the target iModel and a *brute force* comparison against relationships in the source iModel.
|
|
1649
|
-
* @deprecated in 1.x. Don't use this anymore
|
|
1650
|
-
* @see [[process]] with [[IModelTransformOptions.argsForProcessChanges]] provided.
|
|
1651
|
-
* @note This method is called from [[process]] when [[IModelTransformOptions.argsForProcessChanges]] are undefined, so it only needs to be called directly when processing a subset of an iModel.
|
|
1652
|
-
* @throws [[IModelError]] If the required provenance information is not available to detect deletes.
|
|
1653
|
-
*/
|
|
1654
|
-
async detectRelationshipDeletes() {
|
|
1655
|
-
if (this.isReverseSynchronization) {
|
|
1656
|
-
throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "Cannot detect deletes when isReverseSynchronization=true");
|
|
1657
|
-
}
|
|
1658
|
-
const aspectDeleteIds = [];
|
|
1659
|
-
const sql = `
|
|
1660
|
-
SELECT ECInstanceId, Identifier, JsonProperties
|
|
1661
|
-
FROM ${core_backend_1.ExternalSourceAspect.classFullName} aspect
|
|
1662
|
-
WHERE aspect.Scope.Id=:scopeId
|
|
1663
|
-
AND aspect.Kind=:kind
|
|
1664
|
-
`;
|
|
1665
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
1666
|
-
await this.targetDb.withPreparedStatement(sql,
|
|
1667
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
1668
|
-
async (statement) => {
|
|
1669
|
-
statement.bindId("scopeId", this.targetScopeElementId);
|
|
1670
|
-
statement.bindString("kind", core_backend_1.ExternalSourceAspect.Kind.Relationship);
|
|
1671
|
-
while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
|
|
1672
|
-
const sourceRelInstanceId = core_bentley_1.Id64.fromJSON(statement.getValue(1).getString());
|
|
1673
|
-
if (undefined ===
|
|
1674
|
-
this.sourceDb.relationships.tryGetInstanceProps(core_backend_1.ElementRefersToElements.classFullName, sourceRelInstanceId)) {
|
|
1675
|
-
// this function exists only to support some in-imodel transformations, which must
|
|
1676
|
-
// use the old (external source aspect) provenance method anyway so we don't need to support
|
|
1677
|
-
// new provenance
|
|
1678
|
-
const json = JSON.parse(statement.getValue(2).getString());
|
|
1679
|
-
const targetRelInstanceId = json.targetRelInstanceId ?? json.provenanceRelInstanceId;
|
|
1680
|
-
if (targetRelInstanceId) {
|
|
1681
|
-
this.importer.deleteRelationship({
|
|
1682
|
-
id: targetRelInstanceId,
|
|
1683
|
-
classFullName: core_backend_1.ElementRefersToElements.classFullName,
|
|
1684
|
-
});
|
|
1685
|
-
}
|
|
1686
|
-
aspectDeleteIds.push(statement.getValue(0).getId());
|
|
1687
|
-
}
|
|
1688
|
-
await this._yieldManager.allowYield();
|
|
1689
|
-
}
|
|
1690
|
-
});
|
|
1691
|
-
this.targetDb.elements.deleteAspect(aspectDeleteIds);
|
|
1692
|
-
}
|
|
1693
1088
|
/** Transform the specified sourceRelationship into RelationshipProps for the target iModel.
|
|
1694
1089
|
* @param sourceRelationship The Relationship from the source iModel to be transformed.
|
|
1695
1090
|
* @returns RelationshipProps for the target iModel.
|
|
@@ -1700,16 +1095,18 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1700
1095
|
targetRelationshipProps.sourceId = this.context.findTargetElementId(sourceRelationship.sourceId);
|
|
1701
1096
|
targetRelationshipProps.targetId = this.context.findTargetElementId(sourceRelationship.targetId);
|
|
1702
1097
|
// TODO: move to cloneRelationship in IModelCloneContext
|
|
1703
|
-
sourceRelationship.
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1098
|
+
const relationshipClass = sourceRelationship.iModel.schemaContext.getSchemaItemSync(sourceRelationship.schemaItemKey, ECSchemaMetaData.RelationshipClass);
|
|
1099
|
+
(0, core_bentley_1.assert)(relationshipClass !== undefined, `Cannot get metadata for ${sourceRelationship.classFullName}.`);
|
|
1100
|
+
for (const property of relationshipClass.getPropertiesSync()) {
|
|
1101
|
+
const propertyName = property.name;
|
|
1102
|
+
if (property.isPrimitive() && "Id" === property.extendedTypeName) {
|
|
1103
|
+
targetRelationshipProps[core_common_1.ECJsNames.toJsName(propertyName)] =
|
|
1104
|
+
this.context.findTargetElementId(sourceRelationship.asAny[core_common_1.ECJsNames.toJsName(propertyName)]);
|
|
1708
1105
|
}
|
|
1709
|
-
}
|
|
1106
|
+
}
|
|
1710
1107
|
return targetRelationshipProps;
|
|
1711
1108
|
}
|
|
1712
|
-
shouldExportElementAspect(aspect) {
|
|
1109
|
+
async shouldExportElementAspect(aspect) {
|
|
1713
1110
|
// This override is needed to ensure that aspects are not exported if their element is not exported.
|
|
1714
1111
|
// This is needed in case DetachedExportElementAspectsStrategy is used.
|
|
1715
1112
|
return this.context.findTargetElementId(aspect.element.id) !== core_bentley_1.Id64.invalid;
|
|
@@ -1717,28 +1114,28 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1717
1114
|
/** Override of [IModelExportHandler.onExportElementUniqueAspect]($transformer) that imports an ElementUniqueAspect into the target iModel when it is exported from the source iModel.
|
|
1718
1115
|
* This override calls [[onTransformElementAspect]] and then [IModelImporter.importElementUniqueAspect]($transformer) to update the target iModel.
|
|
1719
1116
|
*/
|
|
1720
|
-
onExportElementUniqueAspect(sourceAspect) {
|
|
1721
|
-
const targetAspectProps = this.onTransformElementAspect(sourceAspect);
|
|
1722
|
-
if (!this.doAllReferencesExistInTarget(sourceAspect)) {
|
|
1117
|
+
async onExportElementUniqueAspect(sourceAspect) {
|
|
1118
|
+
const targetAspectProps = await this.onTransformElementAspect(sourceAspect);
|
|
1119
|
+
if (!(await this.doAllReferencesExistInTarget(sourceAspect))) {
|
|
1723
1120
|
this._partiallyCommittedAspectIds.add(sourceAspect.id);
|
|
1724
1121
|
}
|
|
1725
|
-
const targetId = this.importer.importElementUniqueAspect(targetAspectProps);
|
|
1122
|
+
const targetId = await this.importer.importElementUniqueAspect(targetAspectProps);
|
|
1726
1123
|
this.context.remapElementAspect(sourceAspect.id, targetId);
|
|
1727
1124
|
}
|
|
1728
1125
|
/** Override of [IModelExportHandler.onExportElementMultiAspects]($transformer) that imports ElementMultiAspects into the target iModel when they are exported from the source iModel.
|
|
1729
1126
|
* This override calls [[onTransformElementAspect]] for each ElementMultiAspect and then [IModelImporter.importElementMultiAspects]($transformer) to update the target iModel.
|
|
1730
1127
|
* @note ElementMultiAspects are handled as a group to make it easier to differentiate between insert, update, and delete.
|
|
1731
1128
|
*/
|
|
1732
|
-
onExportElementMultiAspects(sourceAspects) {
|
|
1129
|
+
async onExportElementMultiAspects(sourceAspects) {
|
|
1733
1130
|
// Transform source ElementMultiAspects into target ElementAspectProps
|
|
1734
|
-
const targetAspectPropsArray = sourceAspects.map((srcA) => this.onTransformElementAspect(srcA));
|
|
1735
|
-
|
|
1736
|
-
if (!this.doAllReferencesExistInTarget(a)) {
|
|
1131
|
+
const targetAspectPropsArray = sourceAspects.map(async (srcA) => this.onTransformElementAspect(srcA));
|
|
1132
|
+
for (const a of sourceAspects) {
|
|
1133
|
+
if (!(await this.doAllReferencesExistInTarget(a))) {
|
|
1737
1134
|
this._partiallyCommittedAspectIds.add(a.id);
|
|
1738
1135
|
}
|
|
1739
|
-
}
|
|
1136
|
+
}
|
|
1740
1137
|
// const targetAspectsToImport = targetAspectPropsArray.filter((targetAspect, i) => hasEntityChanged(sourceAspects[i], targetAspect));
|
|
1741
|
-
const targetIds = this.importer.importElementMultiAspects(targetAspectPropsArray, (a) => {
|
|
1138
|
+
const targetIds = await this.importer.importElementMultiAspects(await Promise.all(targetAspectPropsArray), (a) => {
|
|
1742
1139
|
const isExternalSourceAspectFromTransformer = a instanceof core_backend_1.ExternalSourceAspect &&
|
|
1743
1140
|
a.scope?.id === this.targetScopeElementId;
|
|
1744
1141
|
return (!this._options.includeSourceProvenance ||
|
|
@@ -1753,8 +1150,8 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1753
1150
|
* @returns ElementAspectProps for the target iModel.
|
|
1754
1151
|
* @note A subclass can override this method to provide custom transform behavior.
|
|
1755
1152
|
*/
|
|
1756
|
-
onTransformElementAspect(sourceElementAspect) {
|
|
1757
|
-
const targetElementAspectProps = this.context.cloneElementAspect(sourceElementAspect);
|
|
1153
|
+
async onTransformElementAspect(sourceElementAspect) {
|
|
1154
|
+
const targetElementAspectProps = await this.context.cloneElementAspect(sourceElementAspect);
|
|
1758
1155
|
return targetElementAspectProps;
|
|
1759
1156
|
}
|
|
1760
1157
|
/** The directory where schemas will be exported, a random temporary directory */
|
|
@@ -1762,7 +1159,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1762
1159
|
/** Override of [IModelExportHandler.shouldExportSchema]($transformer) that is called to determine if a schema should be exported
|
|
1763
1160
|
* @note the default behavior doesn't import schemas older than those already in the target
|
|
1764
1161
|
*/
|
|
1765
|
-
shouldExportSchema(schemaKey) {
|
|
1162
|
+
async shouldExportSchema(schemaKey) {
|
|
1766
1163
|
const versionInTarget = this.targetDb.querySchemaVersion(schemaKey.name);
|
|
1767
1164
|
if (versionInTarget === undefined)
|
|
1768
1165
|
return true;
|
|
@@ -1796,7 +1193,6 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1796
1193
|
nodeAssert(schemaFileName.length <= systemMaxPathSegmentSize, "Schema name was still long. This is a bug.");
|
|
1797
1194
|
this._longNamedSchemasMap.set(schema.name, schemaFileName);
|
|
1798
1195
|
}
|
|
1799
|
-
/* eslint-disable-next-line @typescript-eslint/no-deprecated */
|
|
1800
1196
|
this.sourceDb.exportSchema({
|
|
1801
1197
|
schemaName: schema.name,
|
|
1802
1198
|
outputDirectory: this._schemaExportDir,
|
|
@@ -1849,7 +1245,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1849
1245
|
return this.exporter.exportFonts();
|
|
1850
1246
|
}
|
|
1851
1247
|
/** Override of [IModelExportHandler.onExportFont]($transformer) that imports a font into the target iModel when it is exported from the source iModel. */
|
|
1852
|
-
onExportFont(font, _isUpdate) {
|
|
1248
|
+
async onExportFont(font, _isUpdate) {
|
|
1853
1249
|
this.context.importFont(font.id);
|
|
1854
1250
|
}
|
|
1855
1251
|
/** Cause all CodeSpecs to be exported from the source iModel and imported into the target iModel.
|
|
@@ -1869,11 +1265,11 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1869
1265
|
/** Override of [IModelExportHandler.shouldExportCodeSpec]($transformer) that is called to determine if a CodeSpec should be exported from the source iModel.
|
|
1870
1266
|
* @note Reaching this point means that the CodeSpec has passed the standard exclusion checks in [IModelExporter]($transformer).
|
|
1871
1267
|
*/
|
|
1872
|
-
shouldExportCodeSpec(_sourceCodeSpec) {
|
|
1268
|
+
async shouldExportCodeSpec(_sourceCodeSpec) {
|
|
1873
1269
|
return true;
|
|
1874
1270
|
}
|
|
1875
1271
|
/** Override of [IModelExportHandler.onExportCodeSpec]($transformer) that imports a CodeSpec into the target iModel when it is exported from the source iModel. */
|
|
1876
|
-
onExportCodeSpec(sourceCodeSpec) {
|
|
1272
|
+
async onExportCodeSpec(sourceCodeSpec) {
|
|
1877
1273
|
this.context.importCodeSpec(sourceCodeSpec.id);
|
|
1878
1274
|
}
|
|
1879
1275
|
/** Recursively import all Elements and sub-Models that descend from the specified Subject */
|
|
@@ -1884,14 +1280,15 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1884
1280
|
this.context.remapElement(sourceSubjectId, targetSubjectId);
|
|
1885
1281
|
await this.processChildElements(sourceSubjectId);
|
|
1886
1282
|
await this.processSubjectSubModels(sourceSubjectId);
|
|
1887
|
-
this.completePartiallyCommittedElements();
|
|
1888
|
-
this.completePartiallyCommittedAspects();
|
|
1283
|
+
await this.completePartiallyCommittedElements();
|
|
1284
|
+
await this.completePartiallyCommittedAspects();
|
|
1889
1285
|
}
|
|
1890
1286
|
/** state to prevent reinitialization, @see [[initialize]] */
|
|
1891
1287
|
_initialized = false;
|
|
1892
1288
|
_sourceChangeDataState = "uninited";
|
|
1893
1289
|
/** length === 0 when _changeDataState = "no-change", length > 0 means "has-changes", otherwise undefined */
|
|
1894
1290
|
_csFileProps = undefined;
|
|
1291
|
+
_deletionRecordsByChangeset;
|
|
1895
1292
|
/**
|
|
1896
1293
|
* Initialize prerequisites of processing, you must initialize with an [[InitOptions]] if you
|
|
1897
1294
|
* 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.
|
|
@@ -1901,15 +1298,37 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1901
1298
|
async initialize() {
|
|
1902
1299
|
if (this._initialized)
|
|
1903
1300
|
return;
|
|
1904
|
-
this.
|
|
1301
|
+
this.assertEditTxnActive();
|
|
1302
|
+
await this.initScopeProvenance();
|
|
1905
1303
|
await this._tryInitChangesetData(this._options.argsForProcessChanges);
|
|
1906
1304
|
await this.context.initialize();
|
|
1907
|
-
|
|
1908
|
-
await this.
|
|
1305
|
+
const exporterInitOptions = await this.getExportInitOpts(this._options.argsForProcessChanges ?? {});
|
|
1306
|
+
await this.initializeChangesetScanAndExporter(exporterInitOptions);
|
|
1909
1307
|
// 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).
|
|
1910
1308
|
await this.processChangesets();
|
|
1911
1309
|
this._initialized = true;
|
|
1912
1310
|
}
|
|
1311
|
+
async initializeChangesetScanAndExporter(exporterInitOptions) {
|
|
1312
|
+
if (this._csFileProps !== undefined &&
|
|
1313
|
+
this._csFileProps.length > 0 &&
|
|
1314
|
+
this.sourceDb.isBriefcaseDb()) {
|
|
1315
|
+
const changedInstanceIds = this.exporter.sourceDbChanges ??
|
|
1316
|
+
("changedInstanceIds" in exporterInitOptions
|
|
1317
|
+
? exporterInitOptions.changedInstanceIds
|
|
1318
|
+
: new IModelExporter_1.ChangedInstanceIds(this.sourceDb));
|
|
1319
|
+
this._deletionRecordsByChangeset = await ChangesetScanner_1.ChangesetScanner.scan(this.sourceDb, this._csFileProps, changedInstanceIds, {
|
|
1320
|
+
populateChangedInstanceIds: this.exporter.sourceDbChanges === undefined &&
|
|
1321
|
+
!("changedInstanceIds" in exporterInitOptions),
|
|
1322
|
+
});
|
|
1323
|
+
await this.exporter.initialize({
|
|
1324
|
+
changedInstanceIds,
|
|
1325
|
+
skipPropagateChangesToRootElements: exporterInitOptions.skipPropagateChangesToRootElements,
|
|
1326
|
+
});
|
|
1327
|
+
}
|
|
1328
|
+
else {
|
|
1329
|
+
await this.exporter.initialize(exporterInitOptions);
|
|
1330
|
+
}
|
|
1331
|
+
}
|
|
1913
1332
|
/**
|
|
1914
1333
|
* Reads all the changeset files in the private member of the transformer: _csFileProps
|
|
1915
1334
|
* and finds the corresponding target entity for any deleted source entities and remaps the sourceId to the targetId.
|
|
@@ -1917,12 +1336,13 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1917
1336
|
* @returns void
|
|
1918
1337
|
*/
|
|
1919
1338
|
async processChangesets() {
|
|
1920
|
-
this.forEachTrackedElement((sourceElementId, targetElementId) => {
|
|
1339
|
+
await this._provenanceManager.forEachTrackedElement((sourceElementId, targetElementId) => {
|
|
1921
1340
|
this.context.remapElement(sourceElementId, targetElementId);
|
|
1922
1341
|
});
|
|
1923
1342
|
if (this.exporter.sourceDbChanges)
|
|
1924
1343
|
await this.addCustomChanges(this.exporter.sourceDbChanges);
|
|
1925
|
-
|
|
1344
|
+
const csFileProps = this._csFileProps;
|
|
1345
|
+
if (csFileProps === undefined || csFileProps.length === 0) {
|
|
1926
1346
|
if (this.exporter.sourceDbChanges === undefined ||
|
|
1927
1347
|
!this.exporter.sourceDbChanges.hasChanges)
|
|
1928
1348
|
return;
|
|
@@ -1930,12 +1350,15 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1930
1350
|
if (this._sourceChangeDataState === "no-changes")
|
|
1931
1351
|
this._sourceChangeDataState = "has-changes";
|
|
1932
1352
|
}
|
|
1353
|
+
const deletionRecordsByChangeset = this._deletionRecordsByChangeset;
|
|
1354
|
+
if (deletionRecordsByChangeset === undefined)
|
|
1355
|
+
return;
|
|
1933
1356
|
const relationshipECClassIdsToSkip = new Set();
|
|
1934
|
-
for await (const row of this.sourceDb.createQueryReader("SELECT ECInstanceId FROM ECDbMeta.ECClassDef where ECInstanceId IS (BisCore.ElementDrivesElement)")) {
|
|
1357
|
+
for await (const row of this.sourceDb.createQueryReader("SELECT ECInstanceId FROM ECDbMeta.ECClassDef where ECInstanceId IS (BisCore.ElementDrivesElement)", undefined, { usePrimaryConn: true })) {
|
|
1935
1358
|
relationshipECClassIdsToSkip.add(row.ECInstanceId);
|
|
1936
1359
|
}
|
|
1937
1360
|
const relationshipECClassIds = new Set();
|
|
1938
|
-
for await (const row of this.sourceDb.createQueryReader("SELECT ECInstanceId FROM ECDbMeta.ECClassDef where ECInstanceId IS (BisCore.ElementRefersToElements)")) {
|
|
1361
|
+
for await (const row of this.sourceDb.createQueryReader("SELECT ECInstanceId FROM ECDbMeta.ECClassDef where ECInstanceId IS (BisCore.ElementRefersToElements)", undefined, { usePrimaryConn: true })) {
|
|
1939
1362
|
relationshipECClassIds.add(row.ECInstanceId);
|
|
1940
1363
|
}
|
|
1941
1364
|
// For later use when processing deletes.
|
|
@@ -1952,46 +1375,25 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
1952
1375
|
alreadyImportedModelInserts.add(targetModelId);
|
|
1953
1376
|
});
|
|
1954
1377
|
this._deletedSourceRelationshipData = new Map();
|
|
1955
|
-
for (const
|
|
1956
|
-
const csReader = core_backend_1.SqliteChangesetReader.openFile({
|
|
1957
|
-
fileName: csFile.pathname,
|
|
1958
|
-
db: this.sourceDb,
|
|
1959
|
-
disableSchemaCheck: true,
|
|
1960
|
-
});
|
|
1961
|
-
const csAdaptor = new core_backend_1.ChangesetECAdaptor(csReader);
|
|
1962
|
-
const ecChangeUnifier = new core_backend_1.PartialECChangeUnifier(this.sourceDb);
|
|
1963
|
-
while (csAdaptor.step()) {
|
|
1964
|
-
ecChangeUnifier.appendFrom(csAdaptor);
|
|
1965
|
-
}
|
|
1966
|
-
const changes = [...ecChangeUnifier.instances];
|
|
1378
|
+
for (const changes of deletionRecordsByChangeset) {
|
|
1967
1379
|
/** a map of element ids to this transformation scope's ESA data for that element, in case the ESA is deleted in the target */
|
|
1968
1380
|
const elemIdToScopeEsa = new Map();
|
|
1969
1381
|
for (const change of changes) {
|
|
1970
|
-
if (change.
|
|
1971
|
-
relationshipECClassIdsToSkip.has(change.ECClassId))
|
|
1382
|
+
if (relationshipECClassIdsToSkip.has(change.ecClassId))
|
|
1972
1383
|
continue;
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
change
|
|
1976
|
-
change.
|
|
1977
|
-
change.
|
|
1978
|
-
elemIdToScopeEsa.set(change.Element.Id, change);
|
|
1384
|
+
if (change.classFullName === core_backend_1.ExternalSourceAspect.classFullName &&
|
|
1385
|
+
change.scopeId === this.targetScopeElementId &&
|
|
1386
|
+
change.kind === core_backend_1.ExternalSourceAspect.Kind.Element &&
|
|
1387
|
+
change.elementId !== undefined) {
|
|
1388
|
+
elemIdToScopeEsa.set(change.elementId, change);
|
|
1979
1389
|
}
|
|
1980
1390
|
}
|
|
1981
1391
|
// Loop to process deletes.
|
|
1982
1392
|
for (const change of changes) {
|
|
1983
|
-
|
|
1984
|
-
const ecClassId = change.ECClassId ?? change.$meta?.fallbackClassId;
|
|
1985
|
-
if (ecClassId === undefined)
|
|
1986
|
-
throw new Error(`ECClassId was not found for id: ${change.ECInstanceId}! Table is : ${change?.$meta?.tables}`);
|
|
1987
|
-
if (changeType === undefined)
|
|
1988
|
-
throw new Error(`ChangeType was undefined for id: ${change.ECInstanceId}.`);
|
|
1989
|
-
if (changeType !== "Deleted" ||
|
|
1990
|
-
relationshipECClassIdsToSkip.has(ecClassId))
|
|
1393
|
+
if (relationshipECClassIdsToSkip.has(change.ecClassId))
|
|
1991
1394
|
continue;
|
|
1992
|
-
await this.processDeletedOp(change, elemIdToScopeEsa, relationshipECClassIds.has(ecClassId
|
|
1395
|
+
await this.processDeletedOp(change, elemIdToScopeEsa, relationshipECClassIds.has(change.ecClassId), alreadyImportedElementInserts, alreadyImportedModelInserts);
|
|
1993
1396
|
}
|
|
1994
|
-
csReader.close();
|
|
1995
1397
|
}
|
|
1996
1398
|
return;
|
|
1997
1399
|
}
|
|
@@ -2017,16 +1419,17 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2017
1419
|
async processDeletedOp(change, mapOfDeletedElemIdToScopeEsas, isRelationship, alreadyImportedElementInserts, alreadyImportedModelInserts) {
|
|
2018
1420
|
// we need a connected iModel with changes to remap elements with deletions
|
|
2019
1421
|
const notConnectedModel = this.sourceDb.iTwinId === undefined;
|
|
2020
|
-
const noChanges = this.
|
|
1422
|
+
const noChanges = (await this.getSynchronizationVersion()).index ===
|
|
1423
|
+
this.sourceDb.changeset.index &&
|
|
2021
1424
|
(this.exporter.sourceDbChanges === undefined ||
|
|
2022
1425
|
!this.exporter.sourceDbChanges.hasChanges);
|
|
2023
1426
|
if (notConnectedModel || noChanges)
|
|
2024
1427
|
return;
|
|
2025
1428
|
/**
|
|
2026
|
-
*
|
|
1429
|
+
* If the deleted source entity is in the provenanceDb, then we can use its ids to query for ESAs.
|
|
2027
1430
|
* This is because the ESAs are stored on an element Id thats present in the provenanceDb.
|
|
2028
1431
|
*/
|
|
2029
|
-
const changeDataInProvenanceDb = this.sourceDb === this.
|
|
1432
|
+
const changeDataInProvenanceDb = this.sourceDb === (await this.getProvenanceDb());
|
|
2030
1433
|
const getTargetIdFromSourceId = async (id) => {
|
|
2031
1434
|
let identifierValue;
|
|
2032
1435
|
let element;
|
|
@@ -2035,18 +1438,18 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2035
1438
|
}
|
|
2036
1439
|
const fedGuid = isRelationship
|
|
2037
1440
|
? element?.federationGuid
|
|
2038
|
-
: change.
|
|
1441
|
+
: change.federationGuid;
|
|
2039
1442
|
if (changeDataInProvenanceDb) {
|
|
2040
1443
|
// TODO: clarify what happens if there are multiple (e.g. elements were merged)
|
|
2041
1444
|
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([
|
|
2042
1445
|
this.targetScopeElementId,
|
|
2043
1446
|
core_backend_1.ExternalSourceAspect.Kind.Element,
|
|
2044
1447
|
id,
|
|
2045
|
-
]))) {
|
|
1448
|
+
]), { usePrimaryConn: true })) {
|
|
2046
1449
|
identifierValue = row.Identifier;
|
|
2047
1450
|
}
|
|
2048
1451
|
identifierValue =
|
|
2049
|
-
identifierValue ?? mapOfDeletedElemIdToScopeEsas.get(id)?.
|
|
1452
|
+
identifierValue ?? mapOfDeletedElemIdToScopeEsas.get(id)?.identifier;
|
|
2050
1453
|
}
|
|
2051
1454
|
// Check for targetId by an esa first
|
|
2052
1455
|
if (changeDataInProvenanceDb && identifierValue) {
|
|
@@ -2055,16 +1458,26 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2055
1458
|
}
|
|
2056
1459
|
// Check for targetId using sourceId's fedguid if we didn't find an esa.
|
|
2057
1460
|
if (fedGuid) {
|
|
2058
|
-
const targetId = this.
|
|
1461
|
+
const targetId = this.targetDb.elements.getIdFromFederationGuid(fedGuid);
|
|
2059
1462
|
return targetId;
|
|
2060
1463
|
}
|
|
2061
1464
|
return undefined;
|
|
2062
1465
|
};
|
|
2063
|
-
const changedInstanceId = change.
|
|
1466
|
+
const changedInstanceId = change.ecInstanceId;
|
|
2064
1467
|
if (isRelationship) {
|
|
2065
|
-
const sourceIdOfRelationshipInSource = change.
|
|
2066
|
-
const targetIdOfRelationshipInSource = change.
|
|
2067
|
-
const classFullName = change
|
|
1468
|
+
const sourceIdOfRelationshipInSource = change.sourceECInstanceId;
|
|
1469
|
+
const targetIdOfRelationshipInSource = change.targetECInstanceId;
|
|
1470
|
+
const classFullName = change.classFullName;
|
|
1471
|
+
if (sourceIdOfRelationshipInSource === undefined ||
|
|
1472
|
+
targetIdOfRelationshipInSource === undefined) {
|
|
1473
|
+
core_bentley_1.ITwinError.throwError({
|
|
1474
|
+
iTwinErrorId: {
|
|
1475
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
1476
|
+
key: IModelTransformerError_1.IModelTransformerError.ChangedInstanceMetadataMissing,
|
|
1477
|
+
},
|
|
1478
|
+
message: `Relationship deletion ${changedInstanceId} is missing an endpoint.`,
|
|
1479
|
+
});
|
|
1480
|
+
}
|
|
2068
1481
|
const sourceIdOfRelationshipInTarget = await getTargetIdFromSourceId(sourceIdOfRelationshipInSource);
|
|
2069
1482
|
const targetIdOfRelationshipInTarget = await getTargetIdFromSourceId(targetIdOfRelationshipInSource);
|
|
2070
1483
|
if (sourceIdOfRelationshipInTarget && targetIdOfRelationshipInTarget) {
|
|
@@ -2074,8 +1487,9 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2074
1487
|
targetIdInTarget: targetIdOfRelationshipInTarget,
|
|
2075
1488
|
});
|
|
2076
1489
|
}
|
|
2077
|
-
else if (this.sourceDb ===
|
|
2078
|
-
|
|
1490
|
+
else if (this.sourceDb ===
|
|
1491
|
+
(await this._provenanceManager.getProvenanceSourceDb())) {
|
|
1492
|
+
const relProvenance = await this._provenanceManager.queryProvenanceForRelationship(changedInstanceId, {
|
|
2079
1493
|
classFullName: classFullName ?? "",
|
|
2080
1494
|
sourceId: sourceIdOfRelationshipInSource,
|
|
2081
1495
|
targetId: targetIdOfRelationshipInSource,
|
|
@@ -2090,8 +1504,11 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2090
1504
|
}
|
|
2091
1505
|
else {
|
|
2092
1506
|
let targetId = await getTargetIdFromSourceId(changedInstanceId);
|
|
2093
|
-
if (targetId === undefined &&
|
|
2094
|
-
|
|
1507
|
+
if (targetId === undefined &&
|
|
1508
|
+
this.sourceDb ===
|
|
1509
|
+
(await this._provenanceManager.getProvenanceSourceDb())) {
|
|
1510
|
+
targetId =
|
|
1511
|
+
await this._provenanceManager.queryProvenanceForElement(changedInstanceId);
|
|
2095
1512
|
}
|
|
2096
1513
|
// since we are processing one changeset at a time, we can see local source deletes
|
|
2097
1514
|
// of entities that were never synced and can be safely ignored
|
|
@@ -2099,7 +1516,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2099
1516
|
if (deletionNotInTarget)
|
|
2100
1517
|
return;
|
|
2101
1518
|
if (targetId === undefined) {
|
|
2102
|
-
throw new
|
|
1519
|
+
throw new Error("targetId should be acquired from source id or element provenance");
|
|
2103
1520
|
}
|
|
2104
1521
|
this.context.remapElement(changedInstanceId, targetId);
|
|
2105
1522
|
// If an entity insert and an entity delete both point to the same entity in target iModel, that means that entity was recreated.
|
|
@@ -2119,7 +1536,8 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2119
1536
|
this._sourceChangeDataState = "unconnected";
|
|
2120
1537
|
return;
|
|
2121
1538
|
}
|
|
2122
|
-
const
|
|
1539
|
+
const syncVersion = await this.getSynchronizationVersion();
|
|
1540
|
+
const noChanges = syncVersion.index === this.sourceDb.changeset.index;
|
|
2123
1541
|
if (noChanges) {
|
|
2124
1542
|
this._sourceChangeDataState = "no-changes";
|
|
2125
1543
|
this._csFileProps = [];
|
|
@@ -2128,36 +1546,34 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2128
1546
|
const startChangeset = "startChangeset" in args ? args.startChangeset : undefined;
|
|
2129
1547
|
// NOTE: that we do NOT download the changesummary for the last transformed version, we want
|
|
2130
1548
|
// to ignore those already processed changes
|
|
2131
|
-
const startChangesetIndexOrId = startChangeset?.index ??
|
|
2132
|
-
startChangeset?.id ??
|
|
2133
|
-
this.synchronizationVersion.index + 1;
|
|
1549
|
+
const startChangesetIndexOrId = startChangeset?.index ?? startChangeset?.id ?? syncVersion.index + 1;
|
|
2134
1550
|
const endChangesetId = this.sourceDb.changeset.id;
|
|
2135
1551
|
const [startChangesetIndex, endChangesetIndex] = await Promise.all([startChangesetIndexOrId, endChangesetId].map(async (indexOrId) => typeof indexOrId === "number"
|
|
2136
1552
|
? indexOrId
|
|
2137
1553
|
: core_backend_1.BriefcaseManager.queryChangeset({
|
|
2138
1554
|
iModelId: this.sourceDb.iModelId,
|
|
2139
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
2140
1555
|
changeset: { id: indexOrId },
|
|
2141
1556
|
}).then((changeset) => changeset.index)));
|
|
2142
|
-
const missingChangesets = startChangesetIndex >
|
|
1557
|
+
const missingChangesets = startChangesetIndex > syncVersion.index + 1;
|
|
2143
1558
|
if (!this._options.argsForProcessChanges
|
|
2144
1559
|
?.ignoreMissingChangesetsInSynchronizations &&
|
|
2145
|
-
startChangesetIndex !==
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
`
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
1560
|
+
startChangesetIndex !== syncVersion.index + 1 &&
|
|
1561
|
+
syncVersion.index !== -1) {
|
|
1562
|
+
core_bentley_1.ITwinError.throwError({
|
|
1563
|
+
iTwinErrorId: {
|
|
1564
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
1565
|
+
key: IModelTransformerError_1.IModelTransformerError.SynchronizationRangeInvalid,
|
|
1566
|
+
},
|
|
1567
|
+
message: `synchronization is ${missingChangesets ? "missing changesets" : ""},` +
|
|
1568
|
+
" startChangesetId should be" +
|
|
1569
|
+
" exactly the first changeset *after* the previous synchronization to not miss data." +
|
|
1570
|
+
` You specified '${startChangesetIndexOrId}' which is changeset #${startChangesetIndex}` +
|
|
1571
|
+
` but the previous synchronization for this targetScopeElem ${syncVersion.id}'` +
|
|
1572
|
+
` which is changeset #${syncVersion.index}. The transformer expected` +
|
|
1573
|
+
` #${syncVersion.index + 1}.`,
|
|
1574
|
+
});
|
|
1575
|
+
}
|
|
1576
|
+
const changesetsToSkip = await this._provenanceManager.getChangesetsToSkip();
|
|
2161
1577
|
core_bentley_1.Logger.logTrace(loggerCategory, `changesets to skip: ${changesetsToSkip}`);
|
|
2162
1578
|
this._changesetRanges = (0, Algo_1.rangesFromRangeAndSkipped)(startChangesetIndex, endChangesetIndex, changesetsToSkip);
|
|
2163
1579
|
core_bentley_1.Logger.logTrace(loggerCategory, `ranges: ${this._changesetRanges}`);
|
|
@@ -2176,6 +1592,27 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2176
1592
|
this._sourceChangeDataState =
|
|
2177
1593
|
this._csFileProps.length === 0 ? "no-changes" : "has-changes";
|
|
2178
1594
|
}
|
|
1595
|
+
/** Asserts that the EditTxn is active before any write operations. */
|
|
1596
|
+
assertEditTxnActive() {
|
|
1597
|
+
if (!this._targetEditTxn.isActive) {
|
|
1598
|
+
core_bentley_1.ITwinError.throwError({
|
|
1599
|
+
iTwinErrorId: {
|
|
1600
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
1601
|
+
key: IModelTransformerError_1.IModelTransformerError.EditTxnNotActive,
|
|
1602
|
+
},
|
|
1603
|
+
message: "The target EditTxn must be started before calling process(). Call targetEditTxn.start() before invoking the transformer.",
|
|
1604
|
+
});
|
|
1605
|
+
}
|
|
1606
|
+
if (this._sourceEditTxn && !this._sourceEditTxn.isActive) {
|
|
1607
|
+
core_bentley_1.ITwinError.throwError({
|
|
1608
|
+
iTwinErrorId: {
|
|
1609
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
1610
|
+
key: IModelTransformerError_1.IModelTransformerError.EditTxnNotActive,
|
|
1611
|
+
},
|
|
1612
|
+
message: "The source EditTxn was provided but is not active. Call sourceEditTxn.start() before invoking the transformer.",
|
|
1613
|
+
});
|
|
1614
|
+
}
|
|
1615
|
+
}
|
|
2179
1616
|
/**
|
|
2180
1617
|
* The behavior of process is influenced by [[IModelTransformOptions.argsForProcessChanges]] being defined or not defined during construction passed of the IModelTransformer.
|
|
2181
1618
|
* @section When argsForProcessChanges are defined:
|
|
@@ -2210,6 +1647,10 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2210
1647
|
* @note [[processSchemas]] is not called automatically since the target iModel may want a different collection of schemas.
|
|
2211
1648
|
*/
|
|
2212
1649
|
async processAll() {
|
|
1650
|
+
this._targetElementIdsRemappedByCode.clear();
|
|
1651
|
+
this._targetModelsImportedInCurrentTransform.clear();
|
|
1652
|
+
// processAll always has changes to process, so mark it as such for version tracking
|
|
1653
|
+
this._sourceChangeDataState = "has-changes";
|
|
2213
1654
|
await this.exporter.exportCodeSpecs();
|
|
2214
1655
|
await this.exporter.exportFonts();
|
|
2215
1656
|
if (this._options.skipPropagateChangesToRootElements) {
|
|
@@ -2221,36 +1662,18 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2221
1662
|
else {
|
|
2222
1663
|
await this.exporter.exportModel(core_common_1.IModel.repositoryModelId);
|
|
2223
1664
|
}
|
|
2224
|
-
this.completePartiallyCommittedElements();
|
|
1665
|
+
await this.completePartiallyCommittedElements();
|
|
2225
1666
|
await this.exporter["exportAllAspects"](); // eslint-disable-line @typescript-eslint/dot-notation
|
|
2226
|
-
this.completePartiallyCommittedAspects();
|
|
1667
|
+
await this.completePartiallyCommittedAspects();
|
|
2227
1668
|
await this.exporter.exportRelationships(core_backend_1.ElementRefersToElements.classFullName);
|
|
2228
1669
|
if (this._options.forceExternalSourceAspectProvenance &&
|
|
2229
|
-
this.shouldDetectDeletes()) {
|
|
2230
|
-
|
|
2231
|
-
await this.detectElementDeletes();
|
|
2232
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
|
2233
|
-
await this.detectRelationshipDeletes();
|
|
1670
|
+
(await this.shouldDetectDeletes())) {
|
|
1671
|
+
core_bentley_1.Logger.logWarning(loggerCategory, "This workflows was deprecated in v1 and is no longer supported");
|
|
2234
1672
|
}
|
|
2235
1673
|
if (this._options.optimizeGeometry)
|
|
2236
1674
|
this.importer.optimizeGeometry(this._options.optimizeGeometry);
|
|
2237
1675
|
this.importer.computeProjectExtents();
|
|
2238
|
-
this.finalizeTransformation();
|
|
2239
|
-
}
|
|
2240
|
-
/** previous provenance, either a federation guid, a `${sourceFedGuid}/${targetFedGuid}` pair, or required aspect props */
|
|
2241
|
-
_lastProvenanceEntityInfo = nullLastProvenanceEntityInfo;
|
|
2242
|
-
markLastProvenance(sourceAspect, { isRelationship = false }) {
|
|
2243
|
-
this._lastProvenanceEntityInfo =
|
|
2244
|
-
typeof sourceAspect === "string"
|
|
2245
|
-
? sourceAspect
|
|
2246
|
-
: {
|
|
2247
|
-
entityId: sourceAspect.element.id,
|
|
2248
|
-
aspectId: sourceAspect.id,
|
|
2249
|
-
aspectVersion: sourceAspect.version ?? "",
|
|
2250
|
-
aspectKind: isRelationship
|
|
2251
|
-
? core_backend_1.ExternalSourceAspect.Kind.Relationship
|
|
2252
|
-
: core_backend_1.ExternalSourceAspect.Kind.Element,
|
|
2253
|
-
};
|
|
1676
|
+
await this.finalizeTransformation();
|
|
2254
1677
|
}
|
|
2255
1678
|
/** Export changes from the source iModel and import the transformed entities into the target iModel.
|
|
2256
1679
|
* Inserts, updates, and deletes are determined by inspecting the changeset(s).
|
|
@@ -2262,25 +1685,33 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2262
1685
|
* @note To form a range of versions to process, set `startChangesetId` for the start (inclusive) of the desired range and open the source iModel as of the end (inclusive) of the desired range.
|
|
2263
1686
|
*/
|
|
2264
1687
|
async processChanges(options) {
|
|
1688
|
+
this._targetElementIdsRemappedByCode.clear();
|
|
1689
|
+
this._targetModelsImportedInCurrentTransform.clear();
|
|
2265
1690
|
// must wait for initialization of synchronization provenance data
|
|
2266
|
-
await this.exporter.exportChanges(this.getExportInitOpts(options));
|
|
2267
|
-
this.completePartiallyCommittedElements();
|
|
2268
|
-
this.completePartiallyCommittedAspects();
|
|
1691
|
+
await this.exporter.exportChanges(await this.getExportInitOpts(options));
|
|
1692
|
+
await this.completePartiallyCommittedElements();
|
|
1693
|
+
await this.completePartiallyCommittedAspects();
|
|
2269
1694
|
if (this._options.optimizeGeometry)
|
|
2270
1695
|
this.importer.optimizeGeometry(this._options.optimizeGeometry);
|
|
2271
1696
|
this.importer.computeProjectExtents();
|
|
2272
|
-
this.finalizeTransformation();
|
|
1697
|
+
await this.finalizeTransformation();
|
|
2273
1698
|
const defaultSaveTargetChanges = () => {
|
|
2274
|
-
this.
|
|
1699
|
+
this._targetEditTxn.saveChanges();
|
|
2275
1700
|
};
|
|
2276
1701
|
await (options.saveTargetChanges ?? defaultSaveTargetChanges)(this);
|
|
2277
1702
|
}
|
|
2278
1703
|
/** Changeset data must be initialized in order to build correct changeOptions.
|
|
2279
1704
|
* Call [[IModelTransformer.initialize]] for initialization of synchronization provenance data
|
|
2280
1705
|
*/
|
|
2281
|
-
getExportInitOpts(opts) {
|
|
1706
|
+
async getExportInitOpts(opts) {
|
|
2282
1707
|
if (!this._options.argsForProcessChanges)
|
|
2283
1708
|
return {};
|
|
1709
|
+
if ("changedInstanceIds" in opts) {
|
|
1710
|
+
return {
|
|
1711
|
+
changedInstanceIds: opts.changedInstanceIds,
|
|
1712
|
+
skipPropagateChangesToRootElements: this._options.skipPropagateChangesToRootElements,
|
|
1713
|
+
};
|
|
1714
|
+
}
|
|
2284
1715
|
const startChangeset = "startChangeset" in opts ? opts.startChangeset : undefined;
|
|
2285
1716
|
return {
|
|
2286
1717
|
skipPropagateChangesToRootElements: this._options.skipPropagateChangesToRootElements,
|
|
@@ -2292,7 +1723,7 @@ class IModelTransformer extends IModelExporter_1.IModelExportHandler {
|
|
|
2292
1723
|
? { startChangeset }
|
|
2293
1724
|
: {
|
|
2294
1725
|
startChangeset: {
|
|
2295
|
-
index: this.
|
|
1726
|
+
index: (await this.getSynchronizationVersion()).index + 1,
|
|
2296
1727
|
},
|
|
2297
1728
|
}),
|
|
2298
1729
|
};
|
|
@@ -2319,16 +1750,14 @@ class TemplateModelCloner extends IModelTransformer {
|
|
|
2319
1750
|
/** Accumulates the mapping of sourceElementIds to targetElementIds from the elements in the template model that were cloned. */
|
|
2320
1751
|
_sourceIdToTargetIdMap;
|
|
2321
1752
|
/** Construct a new TemplateModelCloner
|
|
2322
|
-
* @param
|
|
2323
|
-
* @param targetDb Optionally specify the target IModelDb where the cloned template will be inserted.
|
|
2324
|
-
* Typically this is left unspecified, and the default is to use the sourceDb as the target
|
|
1753
|
+
* @param editTxn The [[EditTxn]] to use for all read and write operations. The source and target db are both derived from `editTxn.iModel`. Must be started before constructing.
|
|
2325
1754
|
* @note The expectation is that the template definitions are within the same iModel where instances will be placed.
|
|
2326
1755
|
*/
|
|
2327
|
-
constructor(
|
|
2328
|
-
const target = new IModelImporter_1.IModelImporter(
|
|
1756
|
+
constructor(editTxn) {
|
|
1757
|
+
const target = new IModelImporter_1.IModelImporter(editTxn, {
|
|
2329
1758
|
autoExtendProjectExtents: false, // autoExtendProjectExtents is intended for transformation service use cases, not template --> instance cloning
|
|
2330
1759
|
});
|
|
2331
|
-
super(
|
|
1760
|
+
super({ source: editTxn.iModel, target }, { noProvenance: true }); // WIP: need to decide the proper way to handle provenance
|
|
2332
1761
|
}
|
|
2333
1762
|
/** Place a template from the sourceDb at the specified placement in the target model within the targetDb.
|
|
2334
1763
|
* @param sourceTemplateModelId The Id of the template model in the sourceDb
|
|
@@ -2373,13 +1802,19 @@ class TemplateModelCloner extends IModelTransformer {
|
|
|
2373
1802
|
return this._sourceIdToTargetIdMap; // return the sourceElementId -> targetElementId Map in case further post-processing is required.
|
|
2374
1803
|
}
|
|
2375
1804
|
/** Cloning from a template requires this override of onTransformElement. */
|
|
2376
|
-
onTransformElement(sourceElement) {
|
|
1805
|
+
async onTransformElement(sourceElement) {
|
|
2377
1806
|
const referenceIds = sourceElement.getReferenceIds();
|
|
2378
|
-
|
|
1807
|
+
for (const referenceId of referenceIds) {
|
|
2379
1808
|
// TODO: consider going through all definition elements at once and remapping them to themselves
|
|
2380
|
-
if (!core_backend_1.EntityReferences.isValid(this.context.findTargetEntityId(referenceId))) {
|
|
1809
|
+
if (!core_backend_1.EntityReferences.isValid(await this.context.findTargetEntityId(referenceId))) {
|
|
2381
1810
|
if (this.context.isBetweenIModels) {
|
|
2382
|
-
|
|
1811
|
+
core_bentley_1.ITwinError.throwError({
|
|
1812
|
+
iTwinErrorId: {
|
|
1813
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
1814
|
+
key: IModelTransformerError_1.IModelTransformerError.DependencyMappingMissing,
|
|
1815
|
+
},
|
|
1816
|
+
message: `Remapping for source dependency ${referenceId} not found for target iModel`,
|
|
1817
|
+
});
|
|
2383
1818
|
}
|
|
2384
1819
|
else {
|
|
2385
1820
|
const definitionElement = this.sourceDb.elements.tryGetElement(referenceId, core_backend_1.DefinitionElement);
|
|
@@ -2388,12 +1823,18 @@ class TemplateModelCloner extends IModelTransformer {
|
|
|
2388
1823
|
this.context.remapElement(referenceId, referenceId); // when in the same iModel, can use existing DefinitionElements without remapping
|
|
2389
1824
|
}
|
|
2390
1825
|
else {
|
|
2391
|
-
|
|
1826
|
+
core_bentley_1.ITwinError.throwError({
|
|
1827
|
+
iTwinErrorId: {
|
|
1828
|
+
scope: IModelTransformerError_1.IModelTransformerErrorScope,
|
|
1829
|
+
key: IModelTransformerError_1.IModelTransformerError.DependencyMappingMissing,
|
|
1830
|
+
},
|
|
1831
|
+
message: `Remapping for dependency ${referenceId} not found`,
|
|
1832
|
+
});
|
|
2392
1833
|
}
|
|
2393
1834
|
}
|
|
2394
1835
|
}
|
|
2395
|
-
}
|
|
2396
|
-
const targetElementProps = super.onTransformElement(sourceElement);
|
|
1836
|
+
}
|
|
1837
|
+
const targetElementProps = await super.onTransformElement(sourceElement);
|
|
2397
1838
|
targetElementProps.federationGuid = core_bentley_1.Guid.createValue(); // clone from template should create a new federationGuid
|
|
2398
1839
|
targetElementProps.code = core_common_1.Code.createEmpty(); // clone from template should not maintain codes
|
|
2399
1840
|
if (sourceElement instanceof core_backend_1.GeometricElement) {
|
|
@@ -2411,18 +1852,4 @@ class TemplateModelCloner extends IModelTransformer {
|
|
|
2411
1852
|
}
|
|
2412
1853
|
}
|
|
2413
1854
|
exports.TemplateModelCloner = TemplateModelCloner;
|
|
2414
|
-
function queryElemFedGuid(db, elemId) {
|
|
2415
|
-
// eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
|
|
2416
|
-
return db.withPreparedStatement(`
|
|
2417
|
-
SELECT FederationGuid
|
|
2418
|
-
FROM bis.Element
|
|
2419
|
-
WHERE ECInstanceId=?
|
|
2420
|
-
`, (stmt) => {
|
|
2421
|
-
stmt.bindId(1, elemId);
|
|
2422
|
-
(0, core_bentley_1.assert)(stmt.step() === core_bentley_1.DbResult.BE_SQLITE_ROW);
|
|
2423
|
-
const result = stmt.getValue(0).getGuid();
|
|
2424
|
-
(0, core_bentley_1.assert)(stmt.step() === core_bentley_1.DbResult.BE_SQLITE_DONE);
|
|
2425
|
-
return result;
|
|
2426
|
-
});
|
|
2427
|
-
}
|
|
2428
1855
|
//# sourceMappingURL=IModelTransformer.js.map
|