@itwin/core-backend 5.0.0-dev.99 → 5.0.0

package/lib/esm/test/IModelTestUtils.js

@@ -10,7 +10,7 @@ import * as path from "path";
 import { BeEvent, DbResult, Guid, Id64, IModelStatus, omit } from "@itwin/core-bentley";
 import { Base64EncodedString, Code, CodeScopeSpec, ColorDef, Environment, FontType, GeometryParams, GeometryStreamBuilder, ImageSourceFormat, IModel, IModelError, IModelReadRpcInterface, IModelVersion, PlanProjectionSettings, RelatedElement, RpcConfiguration, RpcManager, RpcPendingResponse, SkyBoxImageType, SubCategoryAppearance, SubCategoryOverride, SyncMode, } from "@itwin/core-common";
 import { Box, Cone, LineString3d, Point2d, Point3d, Range2d, Range3d, StandardViewIndex, Vector3d, YawPitchRollAngles } from "@itwin/core-geometry";
-import { V2CheckpointManager } from "../CheckpointManager";
+import { CheckpointManager, V2CheckpointManager } from "../CheckpointManager";
 import { ClassRegistry } from "../ClassRegistry";
 import { _nativeDb, AuxCoordSystem2d, BriefcaseDb, BriefcaseLocalValue, BriefcaseManager, CategorySelector, ChannelControl, DisplayStyle2d, DisplayStyle3d, DrawingCategory, DrawingViewDefinition, Element, ElementOwnsChildElements, ElementOwnsMultiAspects, ElementOwnsUniqueAspect, ExternalSource, ExternalSourceIsInRepository, FunctionalModel, FunctionalSchema, GroupModel, IModelDb, IModelHost, IModelJsFs, InformationPartitionElement, Model, ModelSelector, OrthographicViewDefinition, PhysicalModel, PhysicalObject, PhysicalPartition, RenderMaterialElement, SnapshotDb, SpatialCategory, SubCategory, SubjectOwnsPartitionElements, Texture, ViewDefinition, } from "../core-backend";
 import { DefinitionPartition, Drawing, DrawingGraphic, GeometryPart, LinkElement, PhysicalElement, RepositoryLink, Subject } from "../Element";
@@ -18,9 +18,9 @@ import { DefinitionModel, DocumentListModel, DrawingModel, InformationRecordMode
 import { DrawingGraphicRepresentsElement, ElementDrivesElement } from "../Relationship";
 import { RpcBriefcaseUtility } from "../rpc-impl/RpcBriefcaseUtility";
 import { Schema, Schemas } from "../Schema";
-import { HubMock } from "../HubMock";
+import { HubMock } from "../internal/HubMock";
 import { KnownTestLocations } from "./KnownTestLocations";
-import { _getCheckpointDb, _hubAccess } from "../internal/Symbols";
+import { _hubAccess } from "../internal/Symbols";
 chai.use(chaiAsPromised);
 /* eslint-disable @typescript-eslint/explicit-member-accessibility */
 RpcConfiguration.developmentMode = true;
@@ -136,7 +136,7 @@ export class HubWrappers {
             }
         }
     }
-    /** Downloads and opens a checkpoint */
+    /** Downloads a checkpoint and opens it as a SnapShotDb */
     static async downloadAndOpenCheckpoint(args) {
         if (undefined === args.asOf)
             args.asOf = IModelVersion.latest().toJSON();
@@ -147,8 +147,17 @@ export class HubWrappers {
             changeset: (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken: args.accessToken, version: IModelVersion.fromJSON(args.asOf), iModelId: args.iModelId })),
         };
         const folder = path.join(V2CheckpointManager.getFolder(), checkpoint.iModelId);
-        const filename = path.join(folder, `${checkpoint.changeset.id ?? "first"}.bim`);
-        return V2CheckpointManager[_getCheckpointDb]({ checkpoint, localFile: filename });
+        const filename = path.join(folder, `${checkpoint.changeset.id === "" ? "first" : checkpoint.changeset.id}.bim`);
+        const request = { checkpoint, localFile: filename };
+        let db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(request.checkpoint));
+        if (undefined !== db)
+            return db;
+        db = IModelTestUtils.tryOpenLocalFile(request);
+        if (db)
+            return db;
+        await V2CheckpointManager.downloadCheckpoint(request);
+        await CheckpointManager.updateToRequestedVersion(request);
+        return IModelTestUtils.openCheckpoint(request.localFile, request.checkpoint);
     }
     /** Opens the specific Checkpoint iModel, `SyncMode.FixedVersion`, through the same workflow the IModelReadRpc.getConnectionProps method will use. Replicates the way a frontend would open the iModel. */
     static async openCheckpointUsingRpc(args) {
@@ -211,6 +220,18 @@ export class IModelTestUtils {
     static generateUniqueName(baseName) {
         return `${baseName} - ${Guid.createValue()}`;
     }
+    static openCheckpoint(fileName, checkpoint) {
+        const snapshot = SnapshotDb.openFile(fileName, { key: CheckpointManager.getKey(checkpoint) });
+        snapshot._iTwinId = checkpoint.iTwinId;
+        return snapshot;
+    }
+    /** try to open an existing local file to satisfy a download request */
+    static tryOpenLocalFile(request) {
+        const checkpoint = request.checkpoint;
+        if (CheckpointManager.verifyCheckpoint(checkpoint, request.localFile))
+            return this.openCheckpoint(request.localFile, checkpoint);
+        return undefined;
+    }
     /** Prepare for an output file by:
      * - Resolving the output file name under the known test output directory
      * - Making directories as necessary