@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/CheckpointManager.js

@@ -0,0 +1,375 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+// cspell:ignore BLOCKCACHE
+import * as path from "path";
+import { NativeLoggerCategory } from "@bentley/imodeljs-native";
+import { BeEvent, ChangeSetStatus, Guid, IModelStatus, Logger, LogLevel, OpenMode, StopWatch } from "@itwin/core-bentley";
+import { BriefcaseIdValue, IModelError, IModelVersion, } from "@itwin/core-common";
+import { BackendLoggerCategory } from "./BackendLoggerCategory";
+import { BriefcaseManager } from "./BriefcaseManager";
+import { CloudSqlite } from "./CloudSqlite";
+import { IModelHost } from "./IModelHost";
+import { IModelJsFs } from "./IModelJsFs";
+import { SnapshotDb } from "./IModelDb";
+import { IModelNative } from "./internal/NativePlatform";
+import { _hubAccess, _nativeDb } from "./internal/Symbols";
+const loggerCategory = BackendLoggerCategory.IModelDb;
+/** Return value from [[ProgressFunction]].
+ *  @public
+ */
+export var ProgressStatus;
+(function (ProgressStatus) {
+    /** Continue download. */
+    ProgressStatus[ProgressStatus["Continue"] = 0] = "Continue";
+    /** Abort download. */
+    ProgressStatus[ProgressStatus["Abort"] = 1] = "Abort";
+})(ProgressStatus || (ProgressStatus = {}));
+/** @internal */
+export class Downloads {
+    static _active = new Map();
+    static async process(job, fn) {
+        const jobName = job.request.localFile; // save this, it can change inside call to `fn`!
+        this._active.set(jobName, job);
+        try {
+            return await fn(job);
+        }
+        finally {
+            this._active.delete(jobName);
+        }
+    }
+    static isInProgress(pathName) {
+        return this._active.get(pathName);
+    }
+    static async download(request, downloadFn) {
+        const pathName = request.localFile;
+        let job = this.isInProgress(pathName);
+        if (undefined !== job)
+            return job.promise;
+        IModelJsFs.recursiveMkDirSync(path.dirname(pathName));
+        job = { request };
+        return job.promise = this.process(job, downloadFn);
+    }
+}
+/**
+ * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.
+ * @internal
+*/
+export class V2CheckpointManager {
+    static cloudCacheName = "Checkpoints";
+    static _cloudCache;
+    static containers = new Map();
+    static getFolder() {
+        const cloudCachePath = path.join(BriefcaseManager.cacheDir, V2CheckpointManager.cloudCacheName);
+        if (!(IModelJsFs.existsSync(cloudCachePath))) {
+            IModelJsFs.recursiveMkDirSync(cloudCachePath);
+        }
+        return cloudCachePath;
+    }
+    /* only used by tests that reset the state of the v2CheckpointManager. all dbs should be closed before calling this function. */
+    static cleanup() {
+        for (const [_, value] of this.containers.entries()) {
+            if (value.isConnected)
+                value.disconnect({ detach: true });
+        }
+        CloudSqlite.CloudCaches.dropCache(this.cloudCacheName)?.destroy();
+        this._cloudCache = undefined;
+        this.containers.clear();
+    }
+    static get cloudCache() {
+        if (!this._cloudCache) {
+            let cacheDir = process.env.CHECKPOINT_CACHE_DIR ?? this.getFolder();
+            // See if there is a daemon running, otherwise use profile directory for cloudCache
+            if (!(IModelJsFs.existsSync(path.join(cacheDir, "portnumber.bcv"))))
+                cacheDir = undefined; // no daemon running, use profile directory
+            this._cloudCache = CloudSqlite.CloudCaches.getCache({ cacheName: this.cloudCacheName, cacheDir, cacheSize: "50G" });
+        }
+        return this._cloudCache;
+    }
+    /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */
+    static toCloudContainerProps(from) {
+        return { ...from, baseUri: `https://${from.accountName}.blob.core.windows.net`, accessToken: from.sasToken, storageType: "azure" };
+    }
+    static getContainer(v2Props, checkpoint) {
+        let container = this.containers.get(v2Props.containerId);
+        if (undefined === container) {
+            let tokenFn;
+            let tokenRefreshSeconds = -1;
+            // from Rpc, the accessToken in the checkpoint request is from the current user. It is used to request the sasToken for the container and
+            // the sasToken is checked for refresh (before it expires) on every Rpc request using that user's accessToken. For Ipc, the
+            // accessToken in the checkpoint request is undefined, and the sasToken is requested by IModelHost.getAccessToken(). It is refreshed on a timer.
+            if (undefined === checkpoint.accessToken) {
+                tokenFn = async () => (await IModelHost[_hubAccess].queryV2Checkpoint(checkpoint))?.sasToken ?? "";
+                tokenRefreshSeconds = undefined;
+            }
+            container = CloudSqlite.createCloudContainer({ ...this.toCloudContainerProps(v2Props), tokenRefreshSeconds, logId: process.env.POD_NAME, tokenFn });
+            this.containers.set(v2Props.containerId, container);
+        }
+        return container;
+    }
+    static async attach(checkpoint) {
+        let v2props;
+        try {
+            v2props = await IModelHost[_hubAccess].queryV2Checkpoint(checkpoint);
+            if (!v2props)
+                throw new Error("no checkpoint");
+        }
+        catch (err) {
+            throw new IModelError(IModelStatus.NotFound, `V2 checkpoint not found: err: ${err.message}`);
+        }
+        try {
+            const container = this.getContainer(v2props, checkpoint);
+            const dbName = v2props.dbName;
+            // Use the new token from the recently queried v2 checkpoint just incase the one we currently have is expired.
+            container.accessToken = v2props.sasToken;
+            if (!container.isConnected)
+                container.connect(this.cloudCache);
+            container.checkForChanges();
+            const dbStats = container.queryDatabase(dbName);
+            if (IModelHost.appWorkspace.settings.getBoolean("Checkpoints/prefetch", false)) {
+                const getPrefetchConfig = (name, defaultVal) => IModelHost.appWorkspace.settings.getNumber(`Checkpoints/prefetch/${name}`, defaultVal);
+                const minRequests = getPrefetchConfig("minRequests", 3);
+                const maxRequests = getPrefetchConfig("maxRequests", 6);
+                const timeout = getPrefetchConfig("timeout", 100);
+                const maxBlocks = getPrefetchConfig("maxBlocks", 500); // default size of 2GB. Assumes a checkpoint block size of 4MB.
+                if (dbStats?.totalBlocks !== undefined && dbStats.totalBlocks <= maxBlocks && dbStats.nPrefetch === 0) {
+                    const logPrefetch = async (prefetch) => {
+                        const stopwatch = new StopWatch(`[${container.containerId}/${dbName}]`, true);
+                        Logger.logInfo(loggerCategory, `Starting prefetch of ${stopwatch.description}`, { minRequests, maxRequests, timeout });
+                        const done = await prefetch.promise;
+                        Logger.logInfo(loggerCategory, `Prefetch of ${stopwatch.description} complete=${done} (${stopwatch.elapsedSeconds} seconds)`, { minRequests, maxRequests, timeout });
+                    };
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                    logPrefetch(CloudSqlite.startCloudPrefetch(container, dbName, { minRequests, nRequests: maxRequests, timeout }));
+                }
+                else {
+                    Logger.logInfo(loggerCategory, `Skipping prefetch due to size limits or ongoing prefetch.`, { maxBlocks, numPrefetches: dbStats?.nPrefetch, totalBlocksInDb: dbStats?.totalBlocks, v2props });
+                }
+            }
+            return { dbName, container };
+        }
+        catch (e) {
+            const error = `Cloud cache connect failed: ${e.message}`;
+            if (checkpoint.expectV2)
+                Logger.logError(loggerCategory, error);
+            throw new IModelError(e.errorNumber, error);
+        }
+    }
+    static async performDownload(job) {
+        const request = job.request;
+        const v2props = await IModelHost[_hubAccess].queryV2Checkpoint({ ...request.checkpoint, allowPreceding: true });
+        if (!v2props)
+            throw new IModelError(IModelStatus.NotFound, "V2 checkpoint not found");
+        CheckpointManager.onDownloadV2.raiseEvent(job);
+        const container = CloudSqlite.createCloudContainer(this.toCloudContainerProps(v2props));
+        await CloudSqlite.transferDb("download", container, { dbName: v2props.dbName, localFileName: request.localFile, onProgress: request.onProgress });
+        return request.checkpoint.changeset.id;
+    }
+    /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.
+     * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will
+     * be the same as the requested changesetId or the most recent checkpoint before it.)
+     */
+    static async downloadCheckpoint(request) {
+        return Downloads.download(request, async (job) => this.performDownload(job));
+    }
+}
+/** Utility class to deal with downloading V1 checkpoints from iModelHub.
+ * @internal
+ */
+export class V1CheckpointManager {
+    static getFolder(iModelId) {
+        return path.join(BriefcaseManager.getIModelPath(iModelId), "checkpoints");
+    }
+    static getFileName(checkpoint) {
+        const changesetId = checkpoint.changeset.id || "first";
+        return path.join(this.getFolder(checkpoint.iModelId), `${changesetId}.bim`);
+    }
+    static async getCheckpointDb(request) {
+        const db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(request.checkpoint));
+        return (undefined !== db) ? db : Downloads.download(request, async (job) => this.downloadAndOpen(job));
+    }
+    /** Download a V1 checkpoint */
+    static async downloadCheckpoint(request) {
+        return Downloads.download(request, async (job) => this.performDownload(job));
+    }
+    static openCheckpointV1(fileName, checkpoint) {
+        const snapshot = SnapshotDb.openFile(fileName, { key: CheckpointManager.getKey(checkpoint) });
+        snapshot._iTwinId = checkpoint.iTwinId;
+        return snapshot;
+    }
+    static async downloadAndOpen(job) {
+        const db = CheckpointManager.tryOpenLocalFile(job.request);
+        if (db)
+            return db;
+        await this.performDownload(job);
+        await CheckpointManager.updateToRequestedVersion(job.request);
+        return this.openCheckpointV1(job.request.localFile, job.request.checkpoint);
+    }
+    static async performDownload(job) {
+        CheckpointManager.onDownloadV1.raiseEvent(job);
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        return (await IModelHost[_hubAccess].downloadV1Checkpoint(job.request)).id;
+    }
+}
+/** @internal  */
+export class CheckpointManager {
+    static onDownloadV1 = new BeEvent();
+    static onDownloadV2 = new BeEvent();
+    static getKey(checkpoint) { return `${checkpoint.iModelId}:${checkpoint.changeset.id}`; }
+    static async doDownload(request) {
+        try {
+            // first see if there's a V2 checkpoint available.
+            const stopwatch = new StopWatch(`[${request.checkpoint.changeset.id}]`, true);
+            Logger.logInfo(loggerCategory, `Starting download of V2 checkpoint with id ${stopwatch.description}`);
+            const changesetId = await V2CheckpointManager.downloadCheckpoint(request);
+            Logger.logInfo(loggerCategory, `Downloaded V2 checkpoint with id ${stopwatch.description} (${stopwatch.elapsedSeconds} seconds)`);
+            if (changesetId !== request.checkpoint.changeset.id)
+                Logger.logInfo(loggerCategory, `Downloaded previous v2 checkpoint because requested checkpoint not found.`, { requestedChangesetId: request.checkpoint.changeset.id, iModelId: request.checkpoint.iModelId, changesetId, iTwinId: request.checkpoint.iTwinId });
+            else
+                Logger.logInfo(loggerCategory, `Downloaded v2 checkpoint.`, { iModelId: request.checkpoint.iModelId, changesetId: request.checkpoint.changeset.id, iTwinId: request.checkpoint.iTwinId });
+            return changesetId;
+        }
+        catch (error) {
+            if (error.errorNumber === IModelStatus.NotFound) { // No V2 checkpoint available, try a v1 checkpoint
+                const changeset = await V1CheckpointManager.downloadCheckpoint(request);
+                Logger.logWarning(loggerCategory, `Got an error downloading v2 checkpoint, but downloaded v1 checkpoint successfully!`, { error, iModelId: request.checkpoint.iModelId, iTwinId: request.checkpoint.iTwinId, requestedChangesetId: request.checkpoint.changeset.id, changesetId: changeset });
+                return changeset;
+            }
+            throw error; // most likely, was aborted
+        }
+    }
+    static async updateToRequestedVersion(request) {
+        const checkpoint = request.checkpoint;
+        const targetFile = request.localFile;
+        const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId, changeset: checkpoint.changeset };
+        try {
+            // Open checkpoint for write
+            const prevLogLevel = Logger.getLevel(NativeLoggerCategory.SQLite) ?? LogLevel.Error; // Get log level before we set it to None.
+            Logger.setLevel(NativeLoggerCategory.SQLite, LogLevel.None); // Ignores noisy error messages when applying changesets.
+            const db = SnapshotDb.openForApplyChangesets(targetFile);
+            const nativeDb = db[_nativeDb];
+            try {
+                if (nativeDb.hasPendingTxns()) {
+                    Logger.logWarning(loggerCategory, "Checkpoint with Txns found - deleting them", () => traceInfo);
+                    nativeDb.deleteAllTxns();
+                }
+                if (nativeDb.getBriefcaseId() !== BriefcaseIdValue.Unassigned)
+                    nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned);
+                CheckpointManager.validateCheckpointGuids(checkpoint, db);
+                // Apply change sets if necessary
+                const currentChangeset = nativeDb.getCurrentChangeset();
+                if (currentChangeset.id !== checkpoint.changeset.id) {
+                    const accessToken = checkpoint.accessToken;
+                    const toIndex = checkpoint.changeset.index ??
+                        (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken, iModelId: checkpoint.iModelId, version: IModelVersion.asOfChangeSet(checkpoint.changeset.id) })).index;
+                    await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });
+                }
+                else {
+                    // make sure the parent changeset index is saved in the file - old versions didn't have it.
+                    currentChangeset.index = checkpoint.changeset.index; // eslint-disable-line @typescript-eslint/no-non-null-assertion
+                    nativeDb.saveLocalValue("parentChangeSet", JSON.stringify(currentChangeset));
+                }
+            }
+            finally {
+                Logger.setLevel(NativeLoggerCategory.SQLite, prevLogLevel); // Set logging to what it was before we started applying changesets.
+                db.saveChanges();
+                db.close();
+            }
+        }
+        catch (error) {
+            Logger.logError(loggerCategory, "Error downloading checkpoint - deleting it", () => traceInfo);
+            IModelJsFs.removeSync(targetFile);
+            if (error.errorNumber === ChangeSetStatus.CorruptedChangeStream || error.errorNumber === ChangeSetStatus.InvalidId || error.errorNumber === ChangeSetStatus.InvalidVersion) {
+                Logger.logError(loggerCategory, "Detected potential corruption of change sets. Deleting them to enable retries", () => traceInfo);
+                BriefcaseManager.deleteChangeSetsFromLocalDisk(checkpoint.iModelId);
+            }
+            throw error;
+        }
+    }
+    /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */
+    static async downloadCheckpoint(request) {
+        if (this.verifyCheckpoint(request.checkpoint, request.localFile))
+            return;
+        if (request.aliasFiles) {
+            for (const alias of request.aliasFiles) {
+                if (this.verifyCheckpoint(request.checkpoint, alias)) {
+                    request.localFile = alias;
+                    return;
+                }
+            }
+        }
+        await this.doDownload(request);
+        return this.updateToRequestedVersion(request);
+    }
+    /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */
+    static validateCheckpointGuids(checkpoint, snapshotDb) {
+        const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId };
+        const nativeDb = snapshotDb[_nativeDb];
+        const dbChangeset = nativeDb.getCurrentChangeset();
+        const iModelId = Guid.normalize(nativeDb.getIModelId());
+        if (iModelId !== Guid.normalize(checkpoint.iModelId)) {
+            if (nativeDb.isReadonly())
+                throw new IModelError(IModelStatus.ValidationFailed, "iModelId is not properly set up in the checkpoint");
+            Logger.logWarning(loggerCategory, "iModelId is not properly set up in the checkpoint. Updated checkpoint to the correct iModelId.", () => ({ ...traceInfo, dbGuid: iModelId }));
+            const iModelIdNormalized = Guid.normalize(checkpoint.iModelId);
+            nativeDb.setIModelId(iModelIdNormalized);
+            snapshotDb._iModelId = iModelIdNormalized;
+            // Required to reset the ChangeSetId because setDbGuid clears the value.
+            nativeDb.saveLocalValue("ParentChangeSetId", dbChangeset.id);
+            if (undefined !== dbChangeset.index)
+                nativeDb.saveLocalValue("parentChangeSet", JSON.stringify(dbChangeset));
+        }
+        const iTwinId = Guid.normalize(nativeDb.getITwinId());
+        if (iTwinId !== Guid.normalize(checkpoint.iTwinId))
+            throw new IModelError(IModelStatus.ValidationFailed, "iTwinId was not properly set up in the checkpoint");
+    }
+    /** @returns true if the file is the checkpoint requested */
+    static verifyCheckpoint(checkpoint, fileName) {
+        if (!IModelJsFs.existsSync(fileName))
+            return false;
+        const nativeDb = new IModelNative.platform.DgnDb();
+        try {
+            nativeDb.openIModel(fileName, OpenMode.Readonly);
+        }
+        catch {
+            return false;
+        }
+        const isValid = checkpoint.iModelId === nativeDb.getIModelId() && checkpoint.changeset.id === nativeDb.getCurrentChangeset().id;
+        nativeDb.closeFile();
+        if (!isValid)
+            IModelJsFs.removeSync(fileName);
+        return isValid;
+    }
+    /** try to open an existing local file to satisfy a download request */
+    static tryOpenLocalFile(request) {
+        const checkpoint = request.checkpoint;
+        if (this.verifyCheckpoint(checkpoint, request.localFile))
+            return V1CheckpointManager.openCheckpointV1(request.localFile, checkpoint);
+        // check a list of aliases for finding checkpoints downloaded to non-default locations (e.g. from older versions)
+        if (request.aliasFiles) {
+            for (const alias of request.aliasFiles) {
+                if (this.verifyCheckpoint(checkpoint, alias)) {
+                    request.localFile = alias;
+                    return V1CheckpointManager.openCheckpointV1(alias, checkpoint);
+                }
+            }
+        }
+        return undefined;
+    }
+    static async toCheckpointProps(args) {
+        const changeset = args.changeset ?? await IModelHost[_hubAccess].getLatestChangeset({ ...args, accessToken: await IModelHost.getAccessToken() });
+        return {
+            iModelId: args.iModelId,
+            iTwinId: args.iTwinId,
+            changeset: {
+                index: changeset.index,
+                id: changeset.id ?? (await IModelHost[_hubAccess].queryChangeset({ ...args, changeset, accessToken: await IModelHost.getAccessToken() })).id,
+            },
+        };
+    }
+}
+//# sourceMappingURL=CheckpointManager.js.map

package/lib/esm/CheckpointManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheckpointManager.js","sourceRoot":"","sources":["../../src/CheckpointManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,2BAA2B;AAE3B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAe,OAAO,EAAE,eAAe,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAW,QAAQ,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC5J,OAAO,EACL,gBAAgB,EAA0D,WAAW,EAAE,aAAa,GACrG,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAY,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,cAAc,GAAG,qBAAqB,CAAC,QAAQ,CAAC;AAyBtD;;GAEG;AACH,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,yBAAyB;IACzB,2DAAY,CAAA;IACZ,sBAAsB;IACtB,qDAAS,CAAA;AACX,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AAmCD,gBAAgB;AAChB,MAAM,OAAO,SAAS;IACZ,MAAM,CAAC,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;IAEhD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAI,GAAgB,EAAE,EAAoC;QACpF,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,gDAAgD;QACvF,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAuB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAI,OAAwB,EAAE,UAA4C;QACpG,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,SAAS,KAAK,GAAG;YACnB,OAAO,GAAG,CAAC,OAAO,CAAC;QAErB,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtD,GAAG,GAAG,EAAE,OAAO,EAAE,CAAC;QAClB,OAAO,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;;AAGH;;;EAGE;AACF,MAAM,OAAO,mBAAmB;IACvB,MAAM,CAAU,cAAc,GAAG,aAAa,CAAC;IAC9C,MAAM,CAAC,WAAW,CAA0B;IAC5C,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,EAAsC,CAAC;IAEnE,MAAM,CAAC,SAAS;QACrB,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAChG,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;YAC7C,UAAU,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,gIAAgI;IACzH,MAAM,CAAC,OAAO;QACnB,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YACnD,IAAI,KAAK,CAAC,WAAW;gBACnB,KAAK,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;QAED,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC;QAClE,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IAEO,MAAM,KAAK,UAAU;QAC3B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,QAAQ,GAAuB,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACxF,mFAAmF;YACnF,IAAI,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC;gBACjE,QAAQ,GAAG,SAAS,CAAC,CAAC,2CAA2C;YAEnE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACtH,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,qKAAqK;IAC7J,MAAM,CAAC,qBAAqB,CAAC,IAA6B;QAChE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,WAAW,IAAI,CAAC,WAAW,wBAAwB,EAAE,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;IACrI,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,OAAgC,EAAE,UAA2B;QACvF,IAAI,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACzD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,OAAmF,CAAC;YACxF,IAAI,mBAAmB,GAAuB,CAAC,CAAC,CAAC;YACjD,yIAAyI;YACzI,2HAA2H;YAC3H,gJAAgJ;YAChJ,IAAI,SAAS,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC;gBACzC,OAAO,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,EAAE,QAAQ,IAAI,EAAE,CAAC;gBACnG,mBAAmB,GAAG,SAAS,CAAC;YAClC,CAAC;YACD,SAAS,GAAG,WAAW,CAAC,oBAAoB,CAAC,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,mBAAmB,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YACpJ,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAA2B;QACpD,IAAI,OAA4C,CAAC;QACjD,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YACrE,IAAI,CAAC,OAAO;gBACV,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,iCAAiC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/F,CAAC;QAED,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,8GAA8G;YAC9G,SAAS,CAAC,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;YACzC,IAAI,CAAC,SAAS,CAAC,WAAW;gBACxB,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACrC,SAAS,CAAC,eAAe,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YAChD,IAAI,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/E,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,UAAkB,EAAE,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,wBAAwB,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;gBACvJ,MAAM,WAAW,GAAG,iBAAiB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;gBACxD,MAAM,WAAW,GAAG,iBAAiB,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;gBACxD,MAAM,OAAO,GAAG,iBAAiB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;gBAClD,MAAM,SAAS,GAAG,iBAAiB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,+DAA+D;gBACtH,IAAI,OAAO,EAAE,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,WAAW,IAAI,SAAS,IAAI,OAAO,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;oBACtG,MAAM,WAAW,GAAG,KAAK,EAAE,QAAmC,EAAE,EAAE;wBAChE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,SAAS,CAAC,WAAW,IAAI,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC;wBAC9E,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,wBAAwB,SAAS,CAAC,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;wBACvH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;wBACpC,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,eAAe,SAAS,CAAC,WAAW,aAAa,IAAI,KAAK,SAAS,CAAC,cAAc,WAAW,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;oBACvK,CAAC,CAAC;oBACF,mEAAmE;oBACnE,WAAW,CAAC,WAAW,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;gBACnH,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,2DAA2D,EAAE,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;gBAChM,CAAC;YACH,CAAC;YACD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,+BAA+B,CAAC,CAAC,OAAO,EAAE,CAAC;YACzD,IAAI,UAAU,CAAC,QAAQ;gBACrB,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YAEzC,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,MAAM,OAAO,GAAwC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,iBAAiB,CAAC,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;QACrJ,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;QAE1E,iBAAiB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,SAAS,GAAG,WAAW,CAAC,oBAAoB,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;QACxF,MAAM,WAAW,CAAC,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAClJ,OAAO,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB;QAC7D,OAAO,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,GAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,mBAAmB;IACvB,MAAM,CAAC,SAAS,CAAC,QAAoB;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAA2B;QACnD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,OAAO,CAAC;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,GAAG,WAAW,MAAM,CAAC,CAAC;IAC9E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAwB;QAC1D,MAAM,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QACjF,OAAO,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,GAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IACtH,CAAC;IAED,+BAA+B;IACxB,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB;QAC7D,OAAO,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,GAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,QAAuB,EAAE,UAA2B;QACjF,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC7F,QAAgB,CAAC,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC;QAChD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,MAAM,EAAE,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC3D,IAAI,EAAE;YACJ,OAAO,EAAE,CAAC;QACZ,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,iBAAiB,CAAC,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAgB;QACnD,iBAAiB,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC/C,4DAA4D;QAC5D,OAAO,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7E,CAAC;CACF;AAED,iBAAiB;AACjB,MAAM,OAAO,iBAAiB;IACrB,MAAM,CAAU,YAAY,GAAG,IAAI,OAAO,EAA8B,CAAC;IACzE,MAAM,CAAU,YAAY,GAAG,IAAI,OAAO,EAA8B,CAAC;IACzE,MAAM,CAAC,MAAM,CAAC,UAA2B,IAAI,OAAO,GAAG,UAAU,CAAC,QAAQ,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAEzG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAwB;QACtD,IAAI,CAAC;YACH,kDAAkD;YAClD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YAC9E,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,8CAA8C,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;YACtG,MAAM,WAAW,GAAG,MAAM,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC1E,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,oCAAoC,SAAS,CAAC,WAAW,KAAK,SAAS,CAAC,cAAc,WAAW,CAAC,CAAC;YAClI,IAAI,WAAW,KAAK,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBACjD,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,2EAA2E,EAAE,EAAE,oBAAoB,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;;gBAEhQ,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,2BAA2B,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YAC5L,OAAO,WAAW,CAAC;QACrB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,CAAC,WAAW,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,kDAAkD;gBACnG,MAAM,SAAS,GAAG,MAAM,mBAAmB,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;gBACxE,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,oFAAoF,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;gBAC9R,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,KAAK,CAAC,CAAC,2BAA2B;QAC1C,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,OAAwB;QACnE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,CAAC;QAClH,IAAI,CAAC;YACH,4BAA4B;YAC5B,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,0CAA0C;YAC/H,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,yDAAyD;YACtH,MAAM,EAAE,GAAG,UAAU,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;YACzD,MAAM,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC;gBAEH,IAAI,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC;oBAC9B,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,4CAA4C,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;oBACjG,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC3B,CAAC;gBAED,IAAI,QAAQ,CAAC,cAAc,EAAE,KAAK,gBAAgB,CAAC,UAAU;oBAC3D,QAAQ,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAEzD,iBAAiB,CAAC,uBAAuB,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;gBAC1D,iCAAiC;gBACjC,MAAM,gBAAgB,GAAiC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;gBACtF,IAAI,gBAAgB,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;oBACpD,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;oBAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK;wBACxC,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,OAAO,EAAE,aAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;oBAC9K,MAAM,gBAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC9E,CAAC;qBAAM,CAAC;oBACN,2FAA2F;oBAC3F,gBAAgB,CAAC,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,KAAM,CAAC,CAAC,+DAA+D;oBACrH,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,oEAAoE;gBAChI,EAAE,CAAC,WAAW,EAAE,CAAC;gBACjB,EAAE,CAAC,KAAK,EAAE,CAAC;YACb,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAEpB,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4CAA4C,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/F,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YAElC,IAAI,KAAK,CAAC,WAAW,KAAK,eAAe,CAAC,qBAAqB,IAAI,KAAK,CAAC,WAAW,KAAK,eAAe,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,KAAK,eAAe,CAAC,cAAc,EAAE,CAAC;gBAC3K,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,+EAA+E,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBAClI,gBAAgB,CAAC,6BAA6B,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACtE,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,uGAAuG;IAChG,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,OAAwB;QAC7D,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC;YAC9D,OAAO;QAET,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;oBACrD,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC;oBAC1B,OAAO;gBACT,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,6FAA6F;IACtF,MAAM,CAAC,uBAAuB,CAAC,UAA2B,EAAE,UAAsB;QACvF,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC;QAEjF,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,QAAQ,CAAC,mBAAmB,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;QACxD,IAAI,QAAQ,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrD,IAAI,QAAQ,CAAC,UAAU,EAAE;gBACvB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;YAE5G,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,gGAAgG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;YAChL,MAAM,kBAAkB,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC/D,QAAQ,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;YACxC,UAAkB,CAAC,SAAS,GAAG,kBAAkB,CAAC;YACnD,wEAAwE;YACxE,QAAQ,CAAC,cAAc,CAAC,mBAAmB,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;YAC7D,IAAI,SAAS,KAAK,WAAW,CAAC,KAAK;gBACjC,QAAQ,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACtD,IAAI,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;IAC9G,CAAC;IAED,4DAA4D;IACrD,MAAM,CAAC,gBAAgB,CAAC,UAA2B,EAAE,QAAuB;QACjF,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC;YAClC,OAAO,KAAK,CAAC;QAEf,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnD,IAAI,CAAC;YACH,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,KAAK,QAAQ,CAAC,WAAW,EAAE,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,KAAK,QAAQ,CAAC,mBAAmB,EAAE,CAAC,EAAE,CAAC;QAChI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO;YACV,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,gBAAgB,CAAC,OAAwB;QACrD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC;YACtD,OAAO,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAE7E,iHAAiH;QACjH,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvC,IAAI,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC7C,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC;oBAC1B,OAAO,mBAAmB,CAAC,gBAAgB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAwB;QAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAEjJ,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE;gBACT,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,EAAE,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7I;SACF,CAAC;IACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\n// cspell:ignore BLOCKCACHE\n\nimport * as path from \"path\";\nimport { NativeLoggerCategory } from \"@bentley/imodeljs-native\";\nimport { AccessToken, BeEvent, ChangeSetStatus, Guid, GuidString, IModelStatus, Logger, LogLevel, Mutable, OpenMode, StopWatch } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseIdValue, ChangesetId, ChangesetIdWithIndex, ChangesetIndexAndId, IModelError, IModelVersion, LocalDirName, LocalFileName, OpenCheckpointArgs,\n} from \"@itwin/core-common\";\nimport { V2CheckpointAccessProps } from \"./BackendHubAccess\";\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\nimport { BriefcaseManager } from \"./BriefcaseManager\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelHost } from \"./IModelHost\";\nimport { IModelJsFs } from \"./IModelJsFs\";\nimport { SnapshotDb, TokenArg } from \"./IModelDb\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _hubAccess, _nativeDb } from \"./internal/Symbols\";\n\nconst loggerCategory = BackendLoggerCategory.IModelDb;\n\n/**\n * Properties of a checkpoint\n * @public\n */\nexport interface CheckpointProps extends TokenArg {\n  readonly expectV2?: boolean;\n\n  /** iTwin that the iModel belongs to */\n  readonly iTwinId: GuidString;\n\n  /** Id of the iModel */\n  readonly iModelId: GuidString;\n\n  /** changeset for the checkpoint */\n  readonly changeset: ChangesetIdWithIndex;\n\n  /** If true, then the latest successful v2 checkpoint at or before the provided changeset will be returned when calling queryV2Checkpoint.  */\n  readonly allowPreceding?: boolean;\n\n  /** The number of seconds before the current token expires to attempt to reacquire a new token. Default is 1 hour. */\n  readonly reattachSafetySeconds?: number;\n}\n\n/** Return value from [[ProgressFunction]].\n *  @public\n */\nexport enum ProgressStatus {\n  /** Continue download. */\n  Continue = 0,\n  /** Abort download. */\n  Abort = 1,\n}\n\n/** Called to show progress during a download. If this function returns non-zero, the download is aborted.\n *  @public\n */\nexport type ProgressFunction = (loaded: number, total: number) => ProgressStatus;\n\n/** The parameters that specify a request to download a checkpoint file from iModelHub.\n * @internal\n */\nexport interface DownloadRequest {\n  /** name of local file to hold the downloaded data. */\n  localFile: LocalFileName;\n\n  /** A list of full fileName paths to test before downloading. If a valid file exists by one of these names,\n   * no download is performed and `localFile` is updated to reflect the fact that the file exists with that name.\n   * This can be used, for example, to look for checkpoints from previous versions if the naming strategy changes.\n   */\n  readonly aliasFiles?: ReadonlyArray<string>;\n\n  /** Properties of the checkpoint to be downloaded */\n  readonly checkpoint: CheckpointProps;\n\n  /** If present, this function will be called to indicate progress as the briefcase is downloaded. If this\n   * function returns a non-zero value, the download is aborted.\n   */\n  readonly onProgress?: ProgressFunction;\n}\n\n/** @internal */\nexport interface DownloadJob {\n  request: DownloadRequest;\n  promise?: Promise<any>;\n}\n\n/** @internal */\nexport class Downloads {\n  private static _active = new Map<string, DownloadJob>();\n\n  private static async process<T>(job: DownloadJob, fn: (job: DownloadJob) => Promise<T>) {\n    const jobName = job.request.localFile; // save this, it can change inside call to `fn`!\n    this._active.set(jobName, job);\n    try {\n      return await fn(job);\n    } finally {\n      this._active.delete(jobName);\n    }\n  }\n\n  public static isInProgress(pathName: LocalFileName): DownloadJob | undefined {\n    return this._active.get(pathName);\n  }\n\n  public static async download<T>(request: DownloadRequest, downloadFn: (job: DownloadJob) => Promise<T>) {\n    const pathName = request.localFile;\n    let job = this.isInProgress(pathName);\n    if (undefined !== job)\n      return job.promise;\n\n    IModelJsFs.recursiveMkDirSync(path.dirname(pathName));\n    job = { request };\n    return job.promise = this.process(job, downloadFn);\n  }\n}\n\n/**\n * Utility class for opening V2 checkpoints from cloud containers, and also for downloading them.\n * @internal\n*/\nexport class V2CheckpointManager {\n  public static readonly cloudCacheName = \"Checkpoints\";\n  private static _cloudCache?: CloudSqlite.CloudCache;\n  private static containers = new Map<string, CloudSqlite.CloudContainer>();\n\n  public static getFolder(): LocalDirName {\n    const cloudCachePath = path.join(BriefcaseManager.cacheDir, V2CheckpointManager.cloudCacheName);\n    if (!(IModelJsFs.existsSync(cloudCachePath))) {\n      IModelJsFs.recursiveMkDirSync(cloudCachePath);\n    }\n    return cloudCachePath;\n  }\n\n  /* only used by tests that reset the state of the v2CheckpointManager. all dbs should be closed before calling this function. */\n  public static cleanup(): void {\n    for (const [_, value] of this.containers.entries()) {\n      if (value.isConnected)\n        value.disconnect({ detach: true });\n    }\n\n    CloudSqlite.CloudCaches.dropCache(this.cloudCacheName)?.destroy();\n    this._cloudCache = undefined;\n    this.containers.clear();\n  }\n\n  private static get cloudCache(): CloudSqlite.CloudCache {\n    if (!this._cloudCache) {\n      let cacheDir: string | undefined = process.env.CHECKPOINT_CACHE_DIR ?? this.getFolder();\n      // See if there is a daemon running, otherwise use profile directory for cloudCache\n      if (!(IModelJsFs.existsSync(path.join(cacheDir, \"portnumber.bcv\"))))\n        cacheDir = undefined; // no daemon running, use profile directory\n\n      this._cloudCache = CloudSqlite.CloudCaches.getCache({ cacheName: this.cloudCacheName, cacheDir, cacheSize: \"50G\" });\n    }\n    return this._cloudCache;\n  }\n\n  /** Member names differ slightly between the V2Checkpoint api and the CloudSqlite api. Add aliases `accessName` for `accountName` and `accessToken` for `sasToken` */\n  private static toCloudContainerProps(from: V2CheckpointAccessProps): CloudSqlite.ContainerAccessProps {\n    return { ...from, baseUri: `https://${from.accountName}.blob.core.windows.net`, accessToken: from.sasToken, storageType: \"azure\" };\n  }\n\n  private static getContainer(v2Props: V2CheckpointAccessProps, checkpoint: CheckpointProps) {\n    let container = this.containers.get(v2Props.containerId);\n    if (undefined === container) {\n      let tokenFn: ((args: CloudSqlite.RequestTokenArgs) => Promise<AccessToken>) | undefined;\n      let tokenRefreshSeconds: number | undefined = -1;\n      // from Rpc, the accessToken in the checkpoint request is from the current user. It is used to request the sasToken for the container and\n      // the sasToken is checked for refresh (before it expires) on every Rpc request using that user's accessToken. For Ipc, the\n      // accessToken in the checkpoint request is undefined, and the sasToken is requested by IModelHost.getAccessToken(). It is refreshed on a timer.\n      if (undefined === checkpoint.accessToken) {\n        tokenFn = async () => (await IModelHost[_hubAccess].queryV2Checkpoint(checkpoint))?.sasToken ?? \"\";\n        tokenRefreshSeconds = undefined;\n      }\n      container = CloudSqlite.createCloudContainer({ ...this.toCloudContainerProps(v2Props), tokenRefreshSeconds, logId: process.env.POD_NAME, tokenFn });\n      this.containers.set(v2Props.containerId, container);\n    }\n    return container;\n  }\n\n  public static async attach(checkpoint: CheckpointProps): Promise<{ dbName: string, container: CloudSqlite.CloudContainer }> {\n    let v2props: V2CheckpointAccessProps | undefined;\n    try {\n      v2props = await IModelHost[_hubAccess].queryV2Checkpoint(checkpoint);\n      if (!v2props)\n        throw new Error(\"no checkpoint\");\n    } catch (err: any) {\n      throw new IModelError(IModelStatus.NotFound, `V2 checkpoint not found: err: ${err.message}`);\n    }\n\n    try {\n      const container = this.getContainer(v2props, checkpoint);\n      const dbName = v2props.dbName;\n      // Use the new token from the recently queried v2 checkpoint just incase the one we currently have is expired.\n      container.accessToken = v2props.sasToken;\n      if (!container.isConnected)\n        container.connect(this.cloudCache);\n      container.checkForChanges();\n      const dbStats = container.queryDatabase(dbName);\n      if (IModelHost.appWorkspace.settings.getBoolean(\"Checkpoints/prefetch\", false)) {\n        const getPrefetchConfig = (name: string, defaultVal: number) => IModelHost.appWorkspace.settings.getNumber(`Checkpoints/prefetch/${name}`, defaultVal);\n        const minRequests = getPrefetchConfig(\"minRequests\", 3);\n        const maxRequests = getPrefetchConfig(\"maxRequests\", 6);\n        const timeout = getPrefetchConfig(\"timeout\", 100);\n        const maxBlocks = getPrefetchConfig(\"maxBlocks\", 500); // default size of 2GB. Assumes a checkpoint block size of 4MB.\n        if (dbStats?.totalBlocks !== undefined && dbStats.totalBlocks <= maxBlocks && dbStats.nPrefetch === 0) {\n          const logPrefetch = async (prefetch: CloudSqlite.CloudPrefetch) => {\n            const stopwatch = new StopWatch(`[${container.containerId}/${dbName}]`, true);\n            Logger.logInfo(loggerCategory, `Starting prefetch of ${stopwatch.description}`, { minRequests, maxRequests, timeout });\n            const done = await prefetch.promise;\n            Logger.logInfo(loggerCategory, `Prefetch of ${stopwatch.description} complete=${done} (${stopwatch.elapsedSeconds} seconds)`, { minRequests, maxRequests, timeout });\n          };\n          // eslint-disable-next-line @typescript-eslint/no-floating-promises\n          logPrefetch(CloudSqlite.startCloudPrefetch(container, dbName, { minRequests, nRequests: maxRequests, timeout }));\n        } else {\n          Logger.logInfo(loggerCategory, `Skipping prefetch due to size limits or ongoing prefetch.`, { maxBlocks, numPrefetches: dbStats?.nPrefetch, totalBlocksInDb: dbStats?.totalBlocks, v2props });\n        }\n      }\n      return { dbName, container };\n    } catch (e: any) {\n      const error = `Cloud cache connect failed: ${e.message}`;\n      if (checkpoint.expectV2)\n        Logger.logError(loggerCategory, error);\n\n      throw new IModelError(e.errorNumber, error);\n    }\n  }\n\n  private static async performDownload(job: DownloadJob): Promise<ChangesetId> {\n    const request = job.request;\n    const v2props: V2CheckpointAccessProps | undefined = await IModelHost[_hubAccess].queryV2Checkpoint({ ...request.checkpoint, allowPreceding: true });\n    if (!v2props)\n      throw new IModelError(IModelStatus.NotFound, \"V2 checkpoint not found\");\n\n    CheckpointManager.onDownloadV2.raiseEvent(job);\n    const container = CloudSqlite.createCloudContainer(this.toCloudContainerProps(v2props));\n    await CloudSqlite.transferDb(\"download\", container, { dbName: v2props.dbName, localFileName: request.localFile, onProgress: request.onProgress });\n    return request.checkpoint.changeset.id;\n  }\n\n  /** Fully download a V2 checkpoint to a local file that can be used to create a briefcase or to work offline.\n   * @returns a Promise that is resolved when the download completes with the changesetId of the downloaded checkpoint (which will\n   * be the same as the requested changesetId or the most recent checkpoint before it.)\n   */\n  public static async downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId> {\n    return Downloads.download(request, async (job: DownloadJob) => this.performDownload(job));\n  }\n}\n\n/** Utility class to deal with downloading V1 checkpoints from iModelHub.\n * @internal\n */\nexport class V1CheckpointManager {\n  public static getFolder(iModelId: GuidString): LocalDirName {\n    return path.join(BriefcaseManager.getIModelPath(iModelId), \"checkpoints\");\n  }\n\n  public static getFileName(checkpoint: CheckpointProps): LocalFileName {\n    const changesetId = checkpoint.changeset.id || \"first\";\n    return path.join(this.getFolder(checkpoint.iModelId), `${changesetId}.bim`);\n  }\n\n  public static async getCheckpointDb(request: DownloadRequest): Promise<SnapshotDb> {\n    const db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(request.checkpoint));\n    return (undefined !== db) ? db : Downloads.download(request, async (job: DownloadJob) => this.downloadAndOpen(job));\n  }\n\n  /** Download a V1 checkpoint */\n  public static async downloadCheckpoint(request: DownloadRequest): Promise<ChangesetId> {\n    return Downloads.download(request, async (job: DownloadJob) => this.performDownload(job));\n  }\n\n  public static openCheckpointV1(fileName: LocalFileName, checkpoint: CheckpointProps) {\n    const snapshot = SnapshotDb.openFile(fileName, { key: CheckpointManager.getKey(checkpoint) });\n    (snapshot as any)._iTwinId = checkpoint.iTwinId;\n    return snapshot;\n  }\n\n  private static async downloadAndOpen(job: DownloadJob) {\n    const db = CheckpointManager.tryOpenLocalFile(job.request);\n    if (db)\n      return db;\n    await this.performDownload(job);\n    await CheckpointManager.updateToRequestedVersion(job.request);\n    return this.openCheckpointV1(job.request.localFile, job.request.checkpoint);\n  }\n\n  private static async performDownload(job: DownloadJob): Promise<ChangesetId> {\n    CheckpointManager.onDownloadV1.raiseEvent(job);\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return (await IModelHost[_hubAccess].downloadV1Checkpoint(job.request)).id;\n  }\n}\n\n/** @internal  */\nexport class CheckpointManager {\n  public static readonly onDownloadV1 = new BeEvent<(job: DownloadJob) => void>();\n  public static readonly onDownloadV2 = new BeEvent<(job: DownloadJob) => void>();\n  public static getKey(checkpoint: CheckpointProps) { return `${checkpoint.iModelId}:${checkpoint.changeset.id}`; }\n\n  private static async doDownload(request: DownloadRequest): Promise<ChangesetId> {\n    try {\n      // first see if there's a V2 checkpoint available.\n      const stopwatch = new StopWatch(`[${request.checkpoint.changeset.id}]`, true);\n      Logger.logInfo(loggerCategory, `Starting download of V2 checkpoint with id ${stopwatch.description}`);\n      const changesetId = await V2CheckpointManager.downloadCheckpoint(request);\n      Logger.logInfo(loggerCategory, `Downloaded V2 checkpoint with id ${stopwatch.description} (${stopwatch.elapsedSeconds} seconds)`);\n      if (changesetId !== request.checkpoint.changeset.id)\n        Logger.logInfo(loggerCategory, `Downloaded previous v2 checkpoint because requested checkpoint not found.`, { requestedChangesetId: request.checkpoint.changeset.id, iModelId: request.checkpoint.iModelId, changesetId, iTwinId: request.checkpoint.iTwinId });\n      else\n        Logger.logInfo(loggerCategory, `Downloaded v2 checkpoint.`, { iModelId: request.checkpoint.iModelId, changesetId: request.checkpoint.changeset.id, iTwinId: request.checkpoint.iTwinId });\n      return changesetId;\n    } catch (error: any) {\n      if (error.errorNumber === IModelStatus.NotFound) { // No V2 checkpoint available, try a v1 checkpoint\n        const changeset = await V1CheckpointManager.downloadCheckpoint(request);\n        Logger.logWarning(loggerCategory, `Got an error downloading v2 checkpoint, but downloaded v1 checkpoint successfully!`, { error, iModelId: request.checkpoint.iModelId, iTwinId: request.checkpoint.iTwinId, requestedChangesetId: request.checkpoint.changeset.id, changesetId: changeset });\n        return changeset;\n      }\n      throw error; // most likely, was aborted\n    }\n  }\n\n  public static async updateToRequestedVersion(request: DownloadRequest) {\n    const checkpoint = request.checkpoint;\n    const targetFile = request.localFile;\n    const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId, changeset: checkpoint.changeset };\n    try {\n      // Open checkpoint for write\n      const prevLogLevel = Logger.getLevel(NativeLoggerCategory.SQLite) ?? LogLevel.Error; // Get log level before we set it to None.\n      Logger.setLevel(NativeLoggerCategory.SQLite, LogLevel.None); // Ignores noisy error messages when applying changesets.\n      const db = SnapshotDb.openForApplyChangesets(targetFile);\n      const nativeDb = db[_nativeDb];\n      try {\n\n        if (nativeDb.hasPendingTxns()) {\n          Logger.logWarning(loggerCategory, \"Checkpoint with Txns found - deleting them\", () => traceInfo);\n          nativeDb.deleteAllTxns();\n        }\n\n        if (nativeDb.getBriefcaseId() !== BriefcaseIdValue.Unassigned)\n          nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned);\n\n        CheckpointManager.validateCheckpointGuids(checkpoint, db);\n        // Apply change sets if necessary\n        const currentChangeset: Mutable<ChangesetIndexAndId> = nativeDb.getCurrentChangeset();\n        if (currentChangeset.id !== checkpoint.changeset.id) {\n          const accessToken = checkpoint.accessToken;\n          const toIndex = checkpoint.changeset.index ??\n            (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken, iModelId: checkpoint.iModelId, version: IModelVersion.asOfChangeSet(checkpoint.changeset.id) })).index;\n          await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\n        } else {\n          // make sure the parent changeset index is saved in the file - old versions didn't have it.\n          currentChangeset.index = checkpoint.changeset.index!; // eslint-disable-line @typescript-eslint/no-non-null-assertion\n          nativeDb.saveLocalValue(\"parentChangeSet\", JSON.stringify(currentChangeset));\n        }\n      } finally {\n        Logger.setLevel(NativeLoggerCategory.SQLite, prevLogLevel); // Set logging to what it was before we started applying changesets.\n        db.saveChanges();\n        db.close();\n      }\n    } catch (error: any) {\n\n      Logger.logError(loggerCategory, \"Error downloading checkpoint - deleting it\", () => traceInfo);\n      IModelJsFs.removeSync(targetFile);\n\n      if (error.errorNumber === ChangeSetStatus.CorruptedChangeStream || error.errorNumber === ChangeSetStatus.InvalidId || error.errorNumber === ChangeSetStatus.InvalidVersion) {\n        Logger.logError(loggerCategory, \"Detected potential corruption of change sets. Deleting them to enable retries\", () => traceInfo);\n        BriefcaseManager.deleteChangeSetsFromLocalDisk(checkpoint.iModelId);\n      }\n      throw error;\n    }\n  }\n\n  /** Download a checkpoint file from iModelHub into a local file specified in the request parameters. */\n  public static async downloadCheckpoint(request: DownloadRequest): Promise<void> {\n    if (this.verifyCheckpoint(request.checkpoint, request.localFile))\n      return;\n\n    if (request.aliasFiles) {\n      for (const alias of request.aliasFiles) {\n        if (this.verifyCheckpoint(request.checkpoint, alias)) {\n          request.localFile = alias;\n          return;\n        }\n      }\n    }\n\n    await this.doDownload(request);\n    return this.updateToRequestedVersion(request);\n  }\n\n  /** checks a file's dbGuid & iTwinId for consistency, and updates the dbGuid when possible */\n  public static validateCheckpointGuids(checkpoint: CheckpointProps, snapshotDb: SnapshotDb) {\n    const traceInfo = { iTwinId: checkpoint.iTwinId, iModelId: checkpoint.iModelId };\n\n    const nativeDb = snapshotDb[_nativeDb];\n    const dbChangeset = nativeDb.getCurrentChangeset();\n    const iModelId = Guid.normalize(nativeDb.getIModelId());\n    if (iModelId !== Guid.normalize(checkpoint.iModelId)) {\n      if (nativeDb.isReadonly())\n        throw new IModelError(IModelStatus.ValidationFailed, \"iModelId is not properly set up in the checkpoint\");\n\n      Logger.logWarning(loggerCategory, \"iModelId is not properly set up in the checkpoint. Updated checkpoint to the correct iModelId.\", () => ({ ...traceInfo, dbGuid: iModelId }));\n      const iModelIdNormalized = Guid.normalize(checkpoint.iModelId);\n      nativeDb.setIModelId(iModelIdNormalized);\n      (snapshotDb as any)._iModelId = iModelIdNormalized;\n      // Required to reset the ChangeSetId because setDbGuid clears the value.\n      nativeDb.saveLocalValue(\"ParentChangeSetId\", dbChangeset.id);\n      if (undefined !== dbChangeset.index)\n        nativeDb.saveLocalValue(\"parentChangeSet\", JSON.stringify(dbChangeset));\n    }\n\n    const iTwinId = Guid.normalize(nativeDb.getITwinId());\n    if (iTwinId !== Guid.normalize(checkpoint.iTwinId))\n      throw new IModelError(IModelStatus.ValidationFailed, \"iTwinId was not properly set up in the checkpoint\");\n  }\n\n  /** @returns true if the file is the checkpoint requested */\n  public static verifyCheckpoint(checkpoint: CheckpointProps, fileName: LocalFileName): boolean {\n    if (!IModelJsFs.existsSync(fileName))\n      return false;\n\n    const nativeDb = new IModelNative.platform.DgnDb();\n    try {\n      nativeDb.openIModel(fileName, OpenMode.Readonly);\n    } catch {\n      return false;\n    }\n\n    const isValid = checkpoint.iModelId === nativeDb.getIModelId() && checkpoint.changeset.id === nativeDb.getCurrentChangeset().id;\n    nativeDb.closeFile();\n    if (!isValid)\n      IModelJsFs.removeSync(fileName);\n\n    return isValid;\n  }\n\n  /** try to open an existing local file to satisfy a download request */\n  public static tryOpenLocalFile(request: DownloadRequest): SnapshotDb | undefined {\n    const checkpoint = request.checkpoint;\n    if (this.verifyCheckpoint(checkpoint, request.localFile))\n      return V1CheckpointManager.openCheckpointV1(request.localFile, checkpoint);\n\n    // check a list of aliases for finding checkpoints downloaded to non-default locations (e.g. from older versions)\n    if (request.aliasFiles) {\n      for (const alias of request.aliasFiles) {\n        if (this.verifyCheckpoint(checkpoint, alias)) {\n          request.localFile = alias;\n          return V1CheckpointManager.openCheckpointV1(alias, checkpoint);\n        }\n      }\n    }\n    return undefined;\n  }\n\n  public static async toCheckpointProps(args: OpenCheckpointArgs): Promise<CheckpointProps> {\n    const changeset = args.changeset ?? await IModelHost[_hubAccess].getLatestChangeset({ ...args, accessToken: await IModelHost.getAccessToken() });\n\n    return {\n      iModelId: args.iModelId,\n      iTwinId: args.iTwinId,\n      changeset: {\n        index: changeset.index,\n        id: changeset.id ?? (await IModelHost[_hubAccess].queryChangeset({ ...args, changeset, accessToken: await IModelHost.getAccessToken() })).id,\n      },\n    };\n  }\n}\n"]}

package/lib/esm/ClassRegistry.d.ts

@@ -0,0 +1,134 @@
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { EntityMetaData, IModelError } from "@itwin/core-common";
+import { Entity } from "./Entity";
+import { IModelDb } from "./IModelDb";
+import { Schema } from "./Schema";
+/** Maintains the mapping between the name of a BIS [ECClass]($ecschema-metadata) (in "schema:class" format) and the JavaScript [[Entity]] class that implements it.
+ * @public
+ */
+export declare class EntityJsClassMap {
+    private readonly _classMap;
+    /** @internal */
+    has(classFullName: string): boolean;
+    /** @internal */
+    get(classFullName: string): typeof Entity | undefined;
+    /** @internal */
+    set(classFullName: string, entityClass: typeof Entity): void;
+    /** @internal */
+    delete(classFullName: string): boolean;
+    /** @internal */
+    clear(): void;
+    /** @internal */
+    [Symbol.iterator](): IterableIterator<[string, typeof Entity]>;
+    /**
+     * Registers a single `entityClass` defined in the specified `schema`.
+     * This method registers the class globally. To register a class for a specific iModel, use [[IModelDb.jsClassMap]].
+     *
+     * @param entityClass - The JavaScript class that implements the BIS [ECClass](@itwin/core-common) to be registered.
+     * @param schema - The schema that contains the `entityClass`.
+     *
+     * @throws Error if the class is already registered.
+     *
+     * @public
+     */
+    register(entityClass: typeof Entity, schema: typeof Schema): void;
+}
+/** Maintains the mapping between the name of a BIS [ECClass]($ecschema-metadata) (in "schema:class" format) and the JavaScript [[Entity]] class that implements it.
+ * Applications or modules that supply their own Entity subclasses should use [[registerModule]] or [[register]] at startup
+ * to establish their mappings.
+ * @public
+ */
+export declare class ClassRegistry {
+    private static readonly _globalClassMap;
+    /** @internal */
+    static isNotFoundError(err: any): boolean;
+    /** @internal */
+    static makeMetaDataNotFoundError(className: string): IModelError;
+    /** Register a single `entityClass` defined in the specified `schema`.
+     * @see [[registerModule]] to register multiple classes.
+     * @public
+     */
+    static register(entityClass: typeof Entity, schema: typeof Schema): void;
+    /** Generate a proxy Schema for a domain that has not been registered. */
+    private static generateProxySchema;
+    /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).
+     * Then, gets its metadata and returns that.
+     * @param iModel - iModel containing the metadata for this type
+     * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of
+     * @returns the qualified full name of an ECEntityClass
+     * @internal public for testing only
+     */
+    static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string;
+    /** Generate a JavaScript class from Entity metadata.
+     * @param entityMetaData The Entity metadata that defines the class
+     */
+    private static generateClassForEntity;
+    /** Register all of the classes found in the given module that derive from [[Entity]].
+     * [[register]] will be invoked for each subclass of `Entity` exported by `moduleObj`.
+     * @param moduleObj The module to search for subclasses of Entity
+     * @param schema The schema that contains all of the [ECClass]($ecschema-metadata)es exported by `moduleObj`.
+     */
+    static registerModule(moduleObj: any, schema: typeof Schema): void;
+    /**
+     * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated
+     * class. This function also ensures that all of the base classes of the Entity exist and are registered.
+     */
+    private static generateClass;
+    /** Find a registered class by classFullName.
+     * @param classFullName class to find
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class or undefined
+     */
+    static findRegisteredClass(classFullName: string): typeof Entity | undefined;
+    /** Get the Entity class for the specified Entity className.
+     * @param classFullName The full BIS class name of the Entity
+     * @param iModel The IModel that contains the class definitions
+     * @returns The Entity class
+     */
+    static getClass(classFullName: string, iModel: IModelDb): typeof Entity;
+    /** Unregister a class, by name, if one is already registered.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.
+     * @param classFullName Name of the class to unregister
+     * @return true if the class was unregistered
+     * @internal
+     */
+    static unregisterClass(classFullName: string): boolean;
+    /** Unregister all classes from a schema.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
+     * @param schema Name of the schema to unregister
+     * @internal
+     */
+    static unregisterClassesFrom(schema: typeof Schema): void;
+}
+/**
+ * A cache that records the mapping between class names and class metadata.
+ * @see [[IModelDb.classMetaDataRegistry]] to access the registry for a specific iModel.
+ * @internal
+ * @deprecated in 5.0. Please use `schemaContext` from the `iModel` instead.
+ *
+ * @example
+ * @
+ * Current Usage:
+ * ```ts
+ * const metaData: EntityMetaData | undefined = iModel.classMetaDataRegistry.find("SchemaName:ClassName");
+ * ```
+ *
+ * Replacement:
+ * ```ts
+ * const entityMetaData: EntityClass | undefined = iModel.schemaContext.getSchemaItemSync("SchemaName.ClassName", EntityClass);
+ * const relationshipMetaData: RelationshipClass | undefined = iModel.schemaContext.getSchemaItemSync("SchemaName", "ClassName", RelationshipClass);
+ * ```
+ */
+export declare class MetaDataRegistry {
+    private _registry;
+    private _classIdToName;
+    /** Get the specified Entity metadata */
+    find(classFullName: string): EntityMetaData | undefined;
+    findByClassId(classId: Id64String): EntityMetaData | undefined;
+    /** Add metadata to the cache */
+    add(classFullName: string, metaData: EntityMetaData): void;
+}
+//# sourceMappingURL=ClassRegistry.d.ts.map

package/lib/esm/ClassRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClassRegistry.d.ts","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,UAAU,EAAwB,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAsB,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAW,MAAM,UAAU,CAAC;AAO3C;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoC;IAE9D,gBAAgB;IACT,GAAG,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO;IAI1C,gBAAgB;IACT,GAAG,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAI5D,gBAAgB;IACT,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,MAAM,GAAG,IAAI;IAInE,gBAAgB;IACT,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO;IAI7C,gBAAgB;IACT,KAAK,IAAI,IAAI;IAIpB,gBAAgB;IACT,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,OAAO,MAAM,CAAC,CAAC;IAIrE;;;;;;;;;;OAUG;IACI,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM,GAAG,IAAI;CAUzE;AAED;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAA0B;IACjE,gBAAgB;WACF,eAAe,CAAC,GAAG,EAAE,GAAG;IACtC,gBAAgB;WACF,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IACvE;;;OAGG;WACW,QAAQ,CAAC,WAAW,EAAE,OAAO,MAAM,EAAE,MAAM,EAAE,OAAO,MAAM;IAIxE,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAqBlC;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM;IAkB9E;;OAEG;IAEH,OAAO,CAAC,MAAM,CAAC,sBAAsB;IA2GrC;;;;OAIG;WACW,cAAc,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,MAAM;IAQlE;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAc5B;;;;OAIG;WACW,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,MAAM,GAAG,SAAS;IAInF;;;;OAIG;WACW,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,MAAM;IAK9E;;;;;OAKG;WACW,eAAe,CAAC,aAAa,EAAE,MAAM;IAEnD;;;;OAIG;WACW,qBAAqB,CAAC,MAAM,EAAE,OAAO,MAAM;CAM1D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,SAAS,CAAqC;IACtD,OAAO,CAAC,cAAc,CAAiC;IAEvD,wCAAwC;IAEjC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAKvD,aAAa,CAAC,OAAO,EAAE,UAAU,GAAG,cAAc,GAAG,SAAS;IAKrE,gCAAgC;IAEzB,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,IAAI;CAKlE"}