@itwin/core-backend 4.6.0-dev.17 → 4.6.0-dev.18

package/lib/cjs/IModelDb.js

@@ -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;
@@ -1810,9 +1814,9 @@ exports.IModelDb = IModelDb;
          */
         getAspects(elementId, aspectClassFullName, excludedClassFullNames) {
             if (aspectClassFullName === undefined) {
-                const allAspects = this.runInstanceQuery(`SELECT $ FROM (
-          SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId
-            UNION ALL
+                const allAspects = this.runInstanceQuery(`SELECT $ FROM (
+          SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId
+            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}`);
@@ -1830,7 +1834,7 @@ exports.IModelDb = IModelDb;
             let classIdList = IModelDb.Elements.classMap.get(aspectClassFullName);
             if (classIdList === undefined) {
                 const classIds = [];
-                this._iModel.withPreparedStatement(`select SourceECInstanceId from meta.ClassHasAllBaseClasses where TargetECInstanceId = (select ECInstanceId from meta.ECClassDef where Name='${fullClassName[1]}'
+                this._iModel.withPreparedStatement(`select SourceECInstanceId from meta.ClassHasAllBaseClasses where TargetECInstanceId = (select ECInstanceId from meta.ECClassDef where Name='${fullClassName[1]}'
         and Schema.Id = (select ECInstanceId from meta.ECSchemaDef where Name='${fullClassName[0]}')) and SourceECInstanceId != TargetECInstanceId`, (statement) => {
                     while (statement.step() === core_bentley_1.DbResult.BE_SQLITE_ROW)
                         classIds.push(statement.getValue(0).getId());
@@ -1845,10 +1849,10 @@ exports.IModelDb = IModelDb;
                 return [];
             }
             // Execute an instance query to retrieve all aspects from all the derived classes
-            const aspects = this.runInstanceQuery(`SELECT $ FROM (
-        SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
-          UNION ALL
-        SELECT ECInstanceId, ECClassId FROM Bis.ElementUniqueAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
+            const aspects = this.runInstanceQuery(`SELECT $ FROM (
+        SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
+          UNION ALL
+        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}`);
@@ -2208,7 +2212,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() });
@@ -2218,8 +2227,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) {
@@ -2452,14 +2460,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) {
@@ -2487,8 +2505,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);
     }