@itwin/core-backend 4.6.0-dev.9 → 4.7.0-dev.3

package/lib/cjs/IModelDb.js

@@ -61,7 +61,7 @@ var BriefcaseLocalValue;
 (function (BriefcaseLocalValue) {
     BriefcaseLocalValue["StandaloneEdit"] = "StandaloneEdit";
     BriefcaseLocalValue["NoLocking"] = "NoLocking";
-})(BriefcaseLocalValue = exports.BriefcaseLocalValue || (exports.BriefcaseLocalValue = {}));
+})(BriefcaseLocalValue || (exports.BriefcaseLocalValue = BriefcaseLocalValue = {}));
 // function to open an briefcaseDb, perform an operation, and then close it.
 const withBriefcaseDb = async (briefcase, fn) => {
     const db = await BriefcaseDb.open(briefcase);
@@ -187,7 +187,10 @@ class IModelDb extends core_common_1.IModel {
         /** Event called when the iModel is about to be closed. */
         this.onBeforeClose = new core_bentley_1.BeEvent();
         this.nativeDb = args.nativeDb;
-        // PR https://github.com/iTwin/imodel-native/pull/558 ill-advisedly renamed closeIModel to closeFile.
+        // it is illegal to create an IModelDb unless the nativeDb has been opened. Throw otherwise.
+        if (!this.isOpen)
+            throw new Error("cannot create an IModelDb unless it has already been opened");
+        // PR https://github.com/iTwin/imodel-native/pull/558 renamed closeIModel to closeFile because it changed its behavior.
         // Ideally, nobody outside of core-backend would be calling it, but somebody important is.
         // Make closeIModel available so their code doesn't break.
         this.nativeDb.closeIModel = () => {
@@ -718,7 +721,8 @@ class IModelDb extends core_common_1.IModel {
     */
     static findByFilename(fileName) {
         for (const entry of this._openDbs) {
-            if (entry[1].pathName === fileName)
+            // It shouldn't be possible for anything in _openDbs to not be open, but if so just skip them because `pathName` will throw an exception.
+            if (entry[1].isOpen && entry[1].pathName === fileName)
                 return entry[1];
         }
         return undefined;
@@ -884,6 +888,15 @@ class IModelDb extends core_common_1.IModel {
         }
         return metadata;
     }
+    /** Identical to [[getMetaData]], except it returns `undefined` instead of throwing an error if the metadata cannot be found nor loaded. */
+    tryGetMetaData(classFullName) {
+        try {
+            return this.getMetaData(classFullName);
+        }
+        catch (_) {
+            return undefined;
+        }
+    }
     /** Invoke a callback on each property of the specified class, optionally including superclass properties.
      * @param iModel  The IModel that contains the schema
      * @param classFullName The full class name to load the metadata, if necessary
@@ -1168,13 +1181,21 @@ class IModelDb extends core_common_1.IModel {
     set codeValueBehavior(newBehavior) {
         this.nativeDb.setCodeValueBehavior(newBehavior);
     }
+    /** @internal */
+    computeRangesForText(args) {
+        const props = this.nativeDb.computeRangesForText(args.chars, args.fontId, args.bold, args.italic, args.widthFactor, args.lineHeight);
+        return {
+            layout: core_geometry_1.Range2d.fromJSON(props.layout),
+            justification: core_geometry_1.Range2d.fromJSON(props.justification),
+        };
+    }
 }
+exports.IModelDb = IModelDb;
 /** Keep track of open imodels to support `tryFind` for RPC purposes */
 IModelDb._openDbs = new Map();
 IModelDb.defaultLimit = 1000; // default limit for batching queries
 IModelDb.maxLimit = 10000; // maximum limit for batching queries
 IModelDb._settingPropNamespace = "settings";
-exports.IModelDb = IModelDb;
 /** @public */
 (function (IModelDb) {
     /** The collection of models in an [[IModelDb]].
@@ -1257,7 +1278,7 @@ exports.IModelDb = IModelDb;
         getModelJson(modelIdArg) {
             const modelJson = this.tryGetModelJson(modelIdArg);
             if (undefined === modelJson) {
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `Model=${modelIdArg}`);
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `Model=(id: ${modelIdArg.id}, code: ${modelIdArg.code})`);
             }
             return modelJson;
         }
@@ -1414,7 +1435,7 @@ exports.IModelDb = IModelDb;
         getElementJson(elementId) {
             const elementProps = this.tryGetElementJson(elementId);
             if (undefined === elementProps)
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `reading element=${elementId}`);
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `reading element={id: ${elementId.id} federationGuid: ${elementId.federationGuid}, code: ${elementId.code}}`);
             return elementProps;
         }
         /** Read element data from the iModel as JSON
@@ -1472,8 +1493,12 @@ exports.IModelDb = IModelDb;
          */
         getElement(elementId, elementClass) {
             const element = this.tryGetElement(elementId, elementClass);
-            if (undefined === element)
-                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `Element=${elementId}`);
+            if (undefined === element) {
+                if (typeof elementId === "string" || elementId instanceof core_common_1.Code)
+                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `Element=${elementId}`);
+                else
+                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `Element={id: ${elementId.id} federationGuid: ${elementId.federationGuid}, code: ${elementId.code}}`);
+            }
             return element;
         }
         /** Get an element by Id, FederationGuid, or Code
@@ -1807,7 +1832,7 @@ exports.IModelDb = IModelDb;
             UNION ALL
           SELECT ECInstanceId, ECClassId FROM Bis.ElementUniqueAspect WHERE Element.Id = :elementId) OPTIONS USE_JS_PROP_NAMES DO_NOT_TRUNCATE_BLOB`, elementId, excludedClassFullNames);
                 if (allAspects.length === 0)
-                    core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.ECDb, `No aspects found for class ${aspectClassFullName} and element ${elementId}`);
+                    core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.BackendLoggerCategory.ECDb, `No aspects found for class ${aspectClassFullName} and element ${elementId}`);
                 return allAspects;
             }
             // Check if class is abstract
@@ -1843,7 +1868,7 @@ exports.IModelDb = IModelDb;
         SELECT ECInstanceId, ECClassId FROM Bis.ElementUniqueAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
         ) OPTIONS USE_JS_PROP_NAMES DO_NOT_TRUNCATE_BLOB`, elementId, excludedClassFullNames);
             if (aspects.length === 0)
-                core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.ECDb, `No aspects found for class ${aspectClassFullName} and element ${elementId}`);
+                core_bentley_1.Logger.logInfo(BackendLoggerCategory_1.BackendLoggerCategory.ECDb, `No aspects found for class ${aspectClassFullName} and element ${elementId}`);
             return aspects;
         }
         /** Insert a new ElementAspect into the iModel.
@@ -2170,8 +2195,7 @@ exports.IModelDb = IModelDb;
         }
     }
     IModelDb.Tiles = Tiles;
-})(IModelDb = exports.IModelDb || (exports.IModelDb = {}));
-exports.IModelDb = IModelDb;
+})(IModelDb || (exports.IModelDb = IModelDb = {}));
 /**
  * A local copy of an iModel from iModelHub that can pull and potentially push changesets.
  * BriefcaseDb raises a set of events to allow apps and subsystems to track its object life cycle, including [[onOpen]] and [[onOpened]].
@@ -2200,7 +2224,12 @@ class BriefcaseDb extends IModelDb {
      * - the "no locking" flag is not present. This is a property of an iModel, established when the iModel is created in IModelHub.
      */
     get useLockServer() {
-        return !this.isReadonly && (this.briefcaseId !== core_common_1.BriefcaseIdValue.Unassigned) && (undefined === this.nativeDb.queryLocalValue(BriefcaseLocalValue.NoLocking));
+        return !this.nativeDb.isReadonly() && (this.briefcaseId !== core_common_1.BriefcaseIdValue.Unassigned) && (undefined === this.nativeDb.queryLocalValue(BriefcaseLocalValue.NoLocking));
+    }
+    // if the iModel uses a lock server, create a ServerBasedLocks LockControl for this BriefcaseDb.
+    makeLockControl() {
+        if (this.useLockServer)
+            this._locks = new ServerBasedLocks_1.ServerBasedLocks(this);
     }
     constructor(args) {
         super({ ...args, changeset: args.nativeDb.getCurrentChangeset() });
@@ -2210,8 +2239,7 @@ class BriefcaseDb extends IModelDb {
         this.onClosed = new core_bentley_1.BeEvent();
         this._openMode = args.openMode;
         this.briefcaseId = args.briefcaseId;
-        if (this.useLockServer) // if the iModel uses a lock server, create a ServerBasedLocks LockControl for this BriefcaseDb.
-            this._locks = new ServerBasedLocks_1.ServerBasedLocks(this);
+        this.makeLockControl();
     }
     /** Upgrades the profile or domain schemas. File must be closed before this call and is always left closed. */
     static async doUpgrade(briefcase, upgradeOptions, description) {
@@ -2444,14 +2472,24 @@ class BriefcaseDb extends IModelDb {
      */
     async executeWritable(func) {
         const fileName = this.pathName;
+        const isReadonly = this.isReadonly;
+        let locks;
         try {
-            if (this.isReadonly)
+            if (isReadonly) {
                 this.closeAndReopen(core_bentley_1.OpenMode.ReadWrite, fileName);
+                locks = this.locks;
+                this.makeLockControl(); // create a ServerBasedLocks, if necessary
+            }
             await func();
         }
         finally {
-            if (this.isReadonly)
+            if (isReadonly) {
+                if (locks !== this._locks) { // did we have to create a ServerBasedLocks?
+                    this.locks.close(); // yes, close it and reset back to previous
+                    this._locks = locks;
+                }
                 this.closeAndReopen(core_bentley_1.OpenMode.Readonly, fileName);
+            }
         }
     }
     closeAndReopen(openMode, fileName) {
@@ -2479,8 +2517,11 @@ class BriefcaseDb extends IModelDb {
             throw new core_common_1.IModelError(core_bentley_1.ChangeSetStatus.HasUncommittedChanges, "Cannot push with unsaved changes");
         if (!this.nativeDb.hasPendingTxns())
             return; // nothing to push
-        await BriefcaseManager_1.BriefcaseManager.pullMergePush(this, arg);
-        this.initializeIModelDb();
+        // pushing changes requires a writeable briefcase
+        await this.executeWritable(async () => {
+            await BriefcaseManager_1.BriefcaseManager.pullMergePush(this, arg);
+            this.initializeIModelDb();
+        });
         const changeset = this.changeset;
         IpcHost_1.IpcHost.notifyTxns(this, "notifyPushedChanges", changeset);
     }
@@ -2489,6 +2530,7 @@ class BriefcaseDb extends IModelDb {
         this.onClosed.raiseEvent();
     }
 }
+exports.BriefcaseDb = BriefcaseDb;
 /**
  * Event raised just before a BriefcaseDb is opened. Supplies the arguments that will be used to open the BriefcaseDb.
  * Throw an exception to stop the open.
@@ -2510,7 +2552,6 @@ BriefcaseDb.onOpen = new core_bentley_1.BeEvent();
 BriefcaseDb.onOpened = new core_bentley_1.BeEvent();
 /** @alpha */
 BriefcaseDb.onCodeServiceCreated = new core_bentley_1.BeEvent();
-exports.BriefcaseDb = BriefcaseDb;
 /** Used to reattach Daemon from a user's accessToken for V2 checkpoints.
  * @note Reattach only happens if the previous access token either has expired or is about to expire within an application-supplied safety duration.
  */
@@ -2698,9 +2739,9 @@ class SnapshotDb extends IModelDb {
         }
     }
 }
+exports.SnapshotDb = SnapshotDb;
 SnapshotDb.onOpen = new core_bentley_1.BeEvent();
 SnapshotDb.onOpened = new core_bentley_1.BeEvent();
-exports.SnapshotDb = SnapshotDb;
 /**
  * Standalone iModels are read/write files that are not associated with an iTwin or managed by iModelHub.
  * They are relevant only for testing, or for small-scale single-user scenarios.