@itwin/core-backend 5.10.0-dev.1 → 5.10.0-dev.10

package/lib/esm/BriefcaseManager.js

@@ -5,63 +5,11 @@
 /** @packageDocumentation
  * @module iModels
  */
-var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
-    if (value !== null && value !== void 0) {
-        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
-        var dispose, inner;
-        if (async) {
-            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
-            dispose = value[Symbol.asyncDispose];
-        }
-        if (dispose === void 0) {
-            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
-            dispose = value[Symbol.dispose];
-            if (async) inner = dispose;
-        }
-        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
-        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
-        env.stack.push({ value: value, dispose: dispose, async: async });
-    }
-    else if (async) {
-        env.stack.push({ async: true });
-    }
-    return value;
-};
-var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
-    return function (env) {
-        function fail(e) {
-            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
-            env.hasError = true;
-        }
-        var r, s = 0;
-        function next() {
-            while (r = env.stack.pop()) {
-                try {
-                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
-                    if (r.dispose) {
-                        var result = r.dispose.call(r.value);
-                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
-                    }
-                    else s |= 1;
-                }
-                catch (e) {
-                    fail(e);
-                }
-            }
-            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
-            if (env.hasError) throw env.error;
-        }
-        return next();
-    };
-})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-});
 // cspell:ignore cset csets ecchanges
 import * as path from "node:path";
 import * as os from "node:os";
 import { BeDuration, ChangeSetStatus, DbResult, IModelHubStatus, IModelStatus, Logger, OpenMode, StopWatch } from "@itwin/core-bentley";
-import { BriefcaseIdValue, ChangesetType, IModelError, IModelVersion, } from "@itwin/core-common";
+import { Base64EncodedString, BriefcaseIdValue, ChangesetType, IModelError, IModelVersion, } from "@itwin/core-common";
 import { BackendLoggerCategory } from "./BackendLoggerCategory";
 import { CheckpointManager } from "./CheckpointManager";
 import { BriefcaseDb, IModelDb } from "./IModelDb";
@@ -71,8 +19,6 @@ import { SchemaSync } from "./SchemaSync";
 import { _hubAccess, _nativeDb, _releaseAllLocks } from "./internal/Symbols";
 import { IModelNative } from "./internal/NativePlatform";
 import { StashManager } from "./StashManager";
-import { ChangesetECAdaptor, ECChangeUnifierCache, PartialECChangeUnifier } from "./ChangesetECAdaptor";
-import { SqliteChangesetReader } from "./SqliteChangesetReader";
 const loggerCategory = BackendLoggerCategory.IModelDb;
 /** Manages downloading Briefcases and downloading and uploading changesets.
  * @public
@@ -528,11 +474,8 @@ export class BriefcaseManager {
         }
         if (!reverse) {
             if (briefcaseDb) {
-                if (useSemanticRebase) {
-                    this.capturePatchInstances(briefcaseDb);
-                }
                 briefcaseDb.txns.rebaser.notifyReverseLocalChangesBegin();
-                const reversedTxns = nativeDb.pullMergeReverseLocalChanges();
+                const reversedTxns = nativeDb.pullMergeReverseLocalChanges(useSemanticRebase);
                 if (useSemanticRebase) {
                     nativeDb.clearECDbCache(); // Clear the ECDb cache after reversing local changes to ensure consistency during semantic rebase with schema changes.
                 }
@@ -757,101 +700,11 @@ export class BriefcaseManager {
     static SCHEMAS_FOLDER = "schemas";
     static DATA_FOLDER = "data";
     static DATA_FILE_NAME = "data.json";
-    /**
-     * Captures the changed instances as patch instances from each data txn in the briefcase db for semantic rebase
-     * @param db The {@link BriefcaseDb} instance for which to capture the changed instances as patch instances for all data txns
-     * @internal
-     */
-    static capturePatchInstances(db) {
-        const txns = Array.from(db.txns.queryTxns());
-        txns.forEach((txn) => {
-            if (txn.type !== "Data")
-                return;
-            // already captured(This actually shows that first rebase operation is already done but during that while reinstating this txns,
-            // some error happened so the folder still exists so we don't want to capture again)
-            if (this.semanticRebaseDataFolderExists(db, txn.id))
-                return;
-            const changedInstances = this.captureChangedInstancesAsJSON(db, txn.id);
-            const instancePatches = this.constructPatchInstances(db, changedInstances);
-            this.storeChangedInstancesForSemanticRebase(db, txn.id, instancePatches);
-        });
-    }
-    /**
-     * Captures changed instances from a txn as JSON
-     * @param txnId The txn id for which to capture changed instances
-     * @param db The {@link BriefcaseDb} instance from which to capture changed instances as json
-     * @returns changed instances for semantic rebase
-     * @internal
-     */
-    static captureChangedInstancesAsJSON(db, txnId) {
-        const env_1 = { stack: [], error: void 0, hasError: false };
-        try {
-            const reader = SqliteChangesetReader.openTxn({
-                txnId, db, disableSchemaCheck: true
-            });
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const adaptor = new ChangesetECAdaptor(reader);
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const indirectUnifier = __addDisposableResource(env_1, new PartialECChangeUnifier(reader.db, ECChangeUnifierCache.createInMemoryCache()), false);
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            const directUnifier = __addDisposableResource(env_1, new PartialECChangeUnifier(reader.db, ECChangeUnifierCache.createInMemoryCache()), false);
-            while (adaptor.step()) {
-                if (adaptor.reader.isIndirect)
-                    indirectUnifier.appendFrom(adaptor); // eslint-disable-line @typescript-eslint/no-deprecated
-                else
-                    directUnifier.appendFrom(adaptor); // eslint-disable-line @typescript-eslint/no-deprecated
-            }
-            return [...Array.from(directUnifier.instances).map((instance) => ({ isIndirect: false, instance })), ...Array.from(indirectUnifier.instances).map((instance) => ({ isIndirect: true, instance }))]; // eslint-disable-line @typescript-eslint/no-deprecated
-        }
-        catch (e_1) {
-            env_1.error = e_1;
-            env_1.hasError = true;
-        }
-        finally {
-            __disposeResources(env_1);
-        }
-    }
-    /**
-     * Constructs patch instances from changed instances
-     * @param changedInstances The changed instances from which to construct the patch instances
-     * @param db The {@link BriefcaseDb} instance for which to construct the patch instances
-     * @returns  The {@link InstancePatch} instance patches for semantic rebase
-     * @internal
-     */
-    static constructPatchInstances(db, changedInstances) {
-        return changedInstances
-            .filter((changedInstance) => !(changedInstance.instance.$meta?.op === "Updated" && changedInstance.instance.$meta.stage === "Old")) // we will not take the old stage of updated instances
-            .map((changedInstance) => this.constructPatchInstance(db, changedInstance));
-    }
-    /**
-     * Constructs a single patch instance from changed instance
-     * @param changedInstance The changed instance from which to construct the patch instance
-     * @param db The {@link BriefcaseDb} instance for which to construct the single patch instance
-     * @returns a single instance patch {@link InstancePatch}
-     * @throws IModelError If cannot determine classId or unknown operation encountered
-     */
-    static constructPatchInstance(db, changedInstance) {
-        const className = (changedInstance.instance.ECClassId && db.getClassNameFromId(changedInstance.instance.ECClassId))
-            ?? changedInstance.instance.$meta?.classFullName
-            ?? (changedInstance.instance.$meta?.fallbackClassId && db.getClassNameFromId(changedInstance.instance.$meta.fallbackClassId));
-        if (!className)
-            throw new IModelError(IModelStatus.BadArg, "Cannot determine classId of changed instance");
-        const instanceKey = { id: changedInstance.instance.ECInstanceId, classFullName: className };
-        const op = changedInstance.instance.$meta?.op;
-        if (op !== "Inserted" && op !== "Updated" && op !== "Deleted")
-            throw new IModelError(IModelStatus.BadArg, `Unknown operation: ${op}`);
-        return {
-            key: instanceKey,
-            op,
-            isIndirect: changedInstance.isIndirect,
-            props: op !== "Deleted" ? db[_nativeDb].readInstance(instanceKey, { useJsNames: true }) : undefined,
-        };
-    }
     /**
      * Stores changed instances for semantic rebase locally in appropriate json file in a folder structure
-     * @param db The {@link BriefcaseDb} instance for storing the changed instances against a txn
+     * @param db The [BriefcaseDb]($backend) instance for storing the changed instances against a txn
      * @param txnId The txn id for which we are storing the changed instances
-     * @param instancePatches The {@link InstancePatch} instance patches to be stored
+     * @param instancePatches The [ChangeInstance]($backend) IterableIterator instance patches to be stored
      * @internal
      */
     static storeChangedInstancesForSemanticRebase(db, txnId, instancePatches) {
@@ -861,7 +714,33 @@ export class BriefcaseManager {
         if (IModelJsFs.existsSync(targetDir))
             IModelJsFs.removeSync(targetDir);
         IModelJsFs.recursiveMkDirSync(targetDir);
-        IModelJsFs.writeFileSync(filePath, JSON.stringify(instancePatches, undefined, 2));
+        const BATCH_SIZE = 100;
+        let isFirst = true;
+        let batchParts = [];
+        const flushBatch = () => {
+            if (batchParts.length === 0)
+                return;
+            IModelJsFs.appendFileSync(filePath, batchParts.join(""));
+            batchParts = [];
+        };
+        IModelJsFs.writeFileSync(filePath, "[");
+        for (const instancePatch of instancePatches) {
+            // we will not take the old stage of updated instances for now, because we still don't have conflict resolution on instance level while using semantic rebase.
+            // Once we have conflict resolution on instance level, we can consider taking old stage of updated instances as well.
+            if (instancePatch.$meta.op === "Updated" && instancePatch.$meta.stage === "Old")
+                continue;
+            const { $meta, ...rest } = instancePatch;
+            const transformedInstance = {
+                ...rest,
+                $meta: { op: $meta.op, stage: $meta.stage, isIndirectChange: $meta.isIndirectChange },
+            };
+            batchParts.push(`${isFirst ? "" : ","}\n${JSON.stringify(transformedInstance, Base64EncodedString.replacer)}`);
+            isFirst = false;
+            if (batchParts.length >= BATCH_SIZE)
+                flushBatch();
+        }
+        flushBatch();
+        IModelJsFs.appendFileSync(filePath, "\n]");
     }
     /**
      * Gets the base path for semantic rebase local files
@@ -874,7 +753,7 @@ export class BriefcaseManager {
     }
     /**
      * Stores schemas for semantic rebase locally in appropriate folder structure
-     * @param db The {@link BriefcaseDb} instance for storing the schemas against a txn
+     * @param db The [BriefcaseDb]($backend) instance for storing the schemas against a txn
      * @param txnId The txn id for which we are storing the schemas
      * @param schemaFileNames The schema file paths or schema xml strings to be stored
      * @internal
@@ -900,7 +779,7 @@ export class BriefcaseManager {
     }
     /**
      * Gets schemas for semantic rebase for a txn
-     * @param db The {@link BriefcaseDb} instance for getting the locally stored schemas against a txn
+     * @param db The [BriefcaseDb]($backend) instance for getting the locally stored schemas against a txn
      * @param txnId The txn id for which we are getting the schemas
      * @returns the schema file paths
      * @internal
@@ -912,21 +791,25 @@ export class BriefcaseManager {
     }
     /**
      * Get the changed instances data for semantic rebase for a txn
-     * @param db - The {@link BriefcaseDb} instance for getting the locally stored changed instances against a txn
+     * @param db - The [BriefcaseDb]($backend) instance for getting the locally stored changed instances against a txn
      * @param txnId - The txn id for which we are getting the changed instances
      * @returns Instance patches
      * @internal
      */
-    static getChangedInstancesDataForTxn(db, txnId) {
+    static async *getChangedInstancesDataForTxn(db, txnId) {
         const basePath = BriefcaseManager.getBasePathForSemanticRebaseLocalFiles(db);
         const folderPath = path.join(basePath, txnId, BriefcaseManager.DATA_FOLDER);
         const filePath = path.join(folderPath, BriefcaseManager.DATA_FILE_NAME);
-        const fileContents = IModelJsFs.readFileWithEncodingSync(filePath, "utf-8");
-        return JSON.parse(fileContents);
+        for await (const line of IModelJsFs.readLines(filePath)) {
+            if (line === "[" || line === "]" || line === "")
+                continue;
+            const trimmedLine = line.trim().endsWith(",") ? line.trim().slice(0, -1) : line.trim(); // remove trailing comma if exists
+            yield JSON.parse(trimmedLine, Base64EncodedString.reviver);
+        }
     }
     /**
      * Checks if schema folder exists for semantic rebase for a txn
-     * @param db - The {@link BriefcaseDb} instance for which TO check the schema folder
+     * @param db - The [BriefcaseDb]($backend) instance for which TO check the schema folder
      * @param txnId - The txn id for which we are check the schema folder
      * @returns true if exists, false otherwise
      * @internal
@@ -938,7 +821,7 @@ export class BriefcaseManager {
     }
     /**
      * Checks if data folder exists for semantic rebase for a txn
-     * @param db The {@link BriefcaseDb} instance for which to check the data folder.
+     * @param db The [BriefcaseDb]($backend) instance for which to check the data folder.
      * @param txnId The txn id for which to check the data folder
      * @returns true if exists, false otherwise
      * @internal
@@ -950,7 +833,7 @@ export class BriefcaseManager {
     }
     /**
      * Deletes the schema folder for semantic rebase for a txn
-     * @param db The {@link BriefcaseDb} instance for which to delete the schema folder.
+     * @param db The [BriefcaseDb]($backend) instance for which to delete the schema folder.
      * @param txnId The txn id for which to delete the schema folder
      * @internal
      */
@@ -966,7 +849,7 @@ export class BriefcaseManager {
     }
     /**
     * Deletes the data folder for semantic rebase for a txn
-    * @param db The {@link BriefcaseDb} instance for which to delete the data folder.
+    * @param db The [BriefcaseDb]($backend) instance for which to delete the data folder.
     * @param txnId The txn id for which to delete the data folder
     * @internal
     */
@@ -982,7 +865,7 @@ export class BriefcaseManager {
     }
     /**
      * Deletes rebase folders for semantic rebase
-     * @param db The {@link BriefcaseDb} instance for which to delete the rebase folders.
+     * @param db The [BriefcaseDb]($backend) instance for which to delete the rebase folders.
      * @param checkIfEmpty If true, only deletes the base folder if it is empty, default is false
      * @internal
      */