@itwin/core-backend 3.0.0-dev.146 → 3.0.0-dev.151

package/lib/cjs/ServerBasedLocks.d.ts

@@ -42,16 +42,10 @@ export declare class ServerBasedLocks implements LockControl {
     private addOwnerSharedLocks;
     /** attempt to acquire all necessary locks for a set of elements */
     private acquireAllLocks;
-    /**
-     * Acquire the exclusive lock on one or more elements. This also attempts to acquire a shared lock on all of the element's owners, recursively.
-     * If *any* lock cannot be obtained, no locks are acquired.
-     */
-    acquireExclusiveLock(ids: Id64Arg): Promise<void>;
-    /**
-     * Acquire a shared lock on one or more elements. This also attempts to acquire a shared lock on all of the element's owners, recursively.
-     * If *any* lock cannot be obtained, no locks are acquired.
-     */
-    acquireSharedLock(ids: Id64Arg): Promise<void>;
+    acquireLocks(arg: {
+        shared?: Id64Arg;
+        exclusive?: Id64Arg;
+    }): Promise<void>;
     /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */
     elementWasCreated(id: Id64String): void;
     /** locks are not necessary during change propagation. */

package/lib/cjs/ServerBasedLocks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ServerBasedLocks.d.ts","sourceRoot":"","sources":["../../src/ServerBasedLocks.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAkB,OAAO,EAAE,UAAU,EAA0B,MAAM,qBAAqB,CAAC;AAElG,OAAO,EAAW,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,CAAC;CAC3C;AASD,gBAAgB;AAChB,qBAAa,gBAAiB,YAAW,WAAW;IAClD,IAAW,aAAa,YAAmB;IAC3C,SAAS,CAAC,QAAQ,CAAC,MAAM,WAAkB;IAC3C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;gBAEvB,MAAM,EAAE,WAAW;IAY/B,KAAK;IAKZ,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,aAAa;IAKrB,qBAAqB;IACd,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM;IAQhC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAK7C,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,uBAAuB;IAgB/B,mGAAmG;IAC5F,kBAAkB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAK3C,eAAe,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAM/C,sIAAsI;IACtI,OAAO,CAAC,aAAa;IAUrB,sGAAsG;IACtG,OAAO,CAAC,mBAAmB;IAM3B,mEAAmE;YACrD,eAAe;IAmB7B;;;OAGG;IACU,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9D;;;OAGG;IACU,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAS3D,wGAAwG;IACjG,iBAAiB,CAAC,EAAE,EAAE,UAAU;IAKvC,yDAAyD;IACzD,OAAO,KAAK,iBAAiB,GAAqD;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAKzE,kGAAkG;IAC3F,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAKvE"}
+{"version":3,"file":"ServerBasedLocks.d.ts","sourceRoot":"","sources":["../../src/ServerBasedLocks.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAkB,OAAO,EAAE,UAAU,EAA0B,MAAM,qBAAqB,CAAC;AAElG,OAAO,EAAW,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,CAAC;CAC3C;AASD,gBAAgB;AAChB,qBAAa,gBAAiB,YAAW,WAAW;IAClD,IAAW,aAAa,YAAmB;IAC3C,SAAS,CAAC,QAAQ,CAAC,MAAM,WAAkB;IAC3C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;gBAEvB,MAAM,EAAE,WAAW;IAY/B,KAAK;IAKZ,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,aAAa;IAKrB,qBAAqB;IACd,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM;IAQhC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAK7C,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,uBAAuB;IAgB/B,mGAAmG;IAC5F,kBAAkB,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAK3C,eAAe,CAAC,EAAE,EAAE,UAAU,GAAG,OAAO;IAM/C,sIAAsI;IACtI,OAAO,CAAC,aAAa;IAUrB,sGAAsG;IACtG,OAAO,CAAC,mBAAmB;IAM3B,mEAAmE;YACrD,eAAe;IAmBhB,YAAY,CAAC,GAAG,EAAE;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBxF,wGAAwG;IACjG,iBAAiB,CAAC,EAAE,EAAE,UAAU;IAKvC,yDAAyD;IACzD,OAAO,KAAK,iBAAiB,GAAqD;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAKzE,kGAAkG;IAC3F,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAKvE"}

package/lib/cjs/ServerBasedLocks.js

@@ -131,27 +131,19 @@ class ServerBasedLocks {
             this.insertLock(lock[0], lock[1], 0 /* Acquired */);
         this.lockDb.saveChanges();
     }
-    /**
-     * Acquire the exclusive lock on one or more elements. This also attempts to acquire a shared lock on all of the element's owners, recursively.
-     * If *any* lock cannot be obtained, no locks are acquired.
-     */
-    async acquireExclusiveLock(ids) {
+    async acquireLocks(arg) {
         const locks = new Map();
-        for (const id of core_bentley_1.Id64.iterable(ids)) {
-            if (!this.holdsExclusiveLock(id))
-                locks.set(id, BackendHubAccess_1.LockState.Exclusive);
+        if (arg.shared) {
+            for (const id of core_bentley_1.Id64.iterable(arg.shared)) {
+                if (!this.holdsSharedLock(id))
+                    locks.set(id, BackendHubAccess_1.LockState.Shared);
+            }
         }
-        return this.acquireAllLocks(locks);
-    }
-    /**
-     * Acquire a shared lock on one or more elements. This also attempts to acquire a shared lock on all of the element's owners, recursively.
-     * If *any* lock cannot be obtained, no locks are acquired.
-     */
-    async acquireSharedLock(ids) {
-        const locks = new Map();
-        for (const id of core_bentley_1.Id64.iterable(ids)) {
-            if (!this.holdsSharedLock(id))
-                locks.set(id, BackendHubAccess_1.LockState.Shared);
+        if (arg.exclusive) {
+            for (const id of core_bentley_1.Id64.iterable(arg.exclusive)) {
+                if (!this.holdsExclusiveLock(id))
+                    locks.set(id, BackendHubAccess_1.LockState.Exclusive);
+            }
         }
         return this.acquireAllLocks(locks);
     }

package/lib/cjs/ServerBasedLocks.js.map

@@ -1 +1 @@
-{"version":3,"file":"ServerBasedLocks.js","sourceRoot":"","sources":["../../src/ServerBasedLocks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAAkG;AAClG,oDAAyD;AACzD,yDAAwD;AAExD,6CAA0C;AAC1C,yCAAsC;AAoBtC,gBAAgB;AAChB,MAAa,gBAAgB;IAK3B,YAAmB,MAAmB;QAHnB,WAAM,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAIzC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QAChE,IAAI;YACF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;SAChD;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,2FAA2F,CAAC,CAAC;YACpH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;SAC3B;IACH,CAAC;IAdD,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgBpC,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,EAAc;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YAChH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,aAAa,KAAK,EAAE;gBAC/B,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YAEvD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,EAAe;QAClC,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClJ,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,OAAO,CAAC,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,qBAAqB;IACd,YAAY,CAAC,KAAgB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1F,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB;QACrF,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,UAAU,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QACrE,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,6HAA6H,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9K,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,iCAAiC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,EAA0B;QACxD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,oBAAM,CAAC,aAAa;YACjD,OAAO,KAAK,CAAC,CAAC,gBAAgB;QAEhC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,4BAAS,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,4BAAS,CAAC,SAAS;YAC3G,OAAO,IAAI,CAAC;QAEd,wIAAwI;QACxI,IAAI,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,4BAAS,CAAC,SAAS,qBAAwB,CAAC;QAE9E,yIAAyI;QACzI,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAS,EAAE,4BAAS,CAAC,SAAS,qBAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,+DAA+D;IACjM,CAAC;IAED,mGAAmG;IAC5F,kBAAkB,CAAC,EAAc;QACtC,2GAA2G;QAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,4BAAS,CAAC,SAAS,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,eAAe,CAAC,EAAc;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACpC,gKAAgK;QAChK,OAAO,CAAC,KAAK,KAAK,4BAAS,CAAC,MAAM,IAAI,KAAK,KAAK,4BAAS,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,sIAAsI;IAC9H,aAAa,CAAC,EAA0B,EAAE,KAAsB;QACtE,gHAAgH;QAChH,0GAA0G;QAC1G,IAAI,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACpF,OAAO;QAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC;QACnD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,iCAAiC;IACxE,CAAC;IAED,sGAAsG;IAC9F,mBAAmB,CAAC,EAAc,EAAE,KAAsB;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gCAAgC;QACxE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB;IAC3D,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,eAAe,CAAC,KAAc;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,yBAAyB;YAC7C,OAAO;QAET,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE;YAChC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,8CAA8C;gBACpE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,4BAAS,CAAC,MAAM,CAAC,CAAC;SACvC;QAED,MAAM,uBAAU,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;QACzF,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,mBAAsB,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,GAAY;QAC5C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,4BAAS,CAAC,SAAS,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,GAAY;QACzC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;gBAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,4BAAS,CAAC,MAAM,CAAC,CAAC;SACnC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,wGAAwG;IACjG,iBAAiB,CAAC,EAAc;QACrC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,4BAAS,CAAC,SAAS,qBAAwB,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,yDAAyD;IACzD,IAAY,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACvE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,8BAA8B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACtH,CAAC;IAED,kGAAkG;IAC3F,eAAe,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACpE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,2BAA2B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnH,CAAC;CAEF;AA3LD,4CA2LC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { DbResult, Id64, Id64Arg, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModel, IModelError } from \"@itwin/core-common\";\r\nimport { LockMap, LockState } from \"./BackendHubAccess\";\r\nimport { BriefcaseDb, LockControl } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\r\n\r\n/**\r\n * Both the Model and Parent of an element are considered \"owners\" of their member elements. That means:\r\n * 1) they must hold at least a shared lock before an exclusive lock can be acquired for their members\r\n * 2) if they hold an exclusive lock, then all of their members are exclusively locked implicitly.\r\n * @internal\r\n */\r\nexport interface ElementOwners {\r\n  readonly modelId: Id64String;\r\n  readonly parentId: Id64String | undefined;\r\n}\r\n\r\n// eslint-disable-next-line no-restricted-syntax\r\nconst enum LockOrigin {\r\n  Acquired = 0,\r\n  NewElement = 1,\r\n  Discovered = 2,\r\n}\r\n\r\n/** @internal */\r\nexport class ServerBasedLocks implements LockControl {\r\n  public get isServerBased() { return true; }\r\n  protected readonly lockDb = new SQLiteDb();\r\n  protected readonly briefcase: BriefcaseDb;\r\n\r\n  public constructor(iModel: BriefcaseDb) {\r\n    this.briefcase = iModel;\r\n    const dbName = `${iModel.nativeDb.getTempFileBaseName()}-locks`;\r\n    try {\r\n      this.lockDb.openDb(dbName, OpenMode.ReadWrite);\r\n    } catch (_e) {\r\n      this.lockDb.createDb(dbName);\r\n      this.lockDb.executeSQL(\"CREATE TABLE locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)\");\r\n      this.lockDb.saveChanges();\r\n    }\r\n  }\r\n\r\n  public close() {\r\n    if (this.lockDb.isOpen)\r\n      this.lockDb.closeDb();\r\n  }\r\n\r\n  private getOwners(id: Id64String): ElementOwners {\r\n    return this.briefcase.withPreparedSqliteStatement(\"SELECT ModelId,ParentId FROM bis_Element WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_ROW !== rc)\r\n        throw new IModelError(rc, `element ${id} not found`);\r\n\r\n      return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };\r\n    });\r\n  }\r\n\r\n  private getLockState(id?: Id64String): LockState | undefined {\r\n    return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement(\"SELECT state FROM locks WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;\r\n    });\r\n  }\r\n\r\n  /** Clear the cache of locally held locks.\r\n   * Note: does *not* release locks from server.\r\n   */\r\n  private clearAllLocks() {\r\n    this.lockDb.executeSQL(\"DELETE FROM locks\");\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** only for tests */\r\n  public getLockCount(state: LockState): number {\r\n    return this.lockDb.withSqliteStatement(\"SELECT count(*) FROM locks WHERE state=?\", (stmt) => {\r\n      stmt.bindInteger(1, state);\r\n      stmt.step();\r\n      return stmt.getValueInteger(0);\r\n    });\r\n  }\r\n\r\n  public async releaseAllLocks(): Promise<void> {\r\n    await IModelHost.hubAccess.releaseAllLocks(this.briefcase); // throws if unsuccessful\r\n    this.clearAllLocks();\r\n  }\r\n\r\n  private insertLock(id: Id64String, state: LockState, origin: LockOrigin): true {\r\n    this.lockDb.withPreparedSqliteStatement(\"INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      stmt.bindInteger(2, state);\r\n      stmt.bindInteger(3, origin);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_DONE !== rc)\r\n        throw new IModelError(rc, \"can't insert lock into database\");\r\n    });\r\n    return true;\r\n  }\r\n\r\n  private ownerHoldsExclusiveLock(id: Id64String | undefined): boolean {\r\n    if (id === undefined || id === IModel.rootSubjectId)\r\n      return false; // has no owners\r\n\r\n    const { modelId, parentId } = this.getOwners(id);\r\n    if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)\r\n      return true;\r\n\r\n    // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.\r\n    if (this.ownerHoldsExclusiveLock(modelId))\r\n      return this.insertLock(modelId, LockState.Exclusive, LockOrigin.Discovered);\r\n\r\n    // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.\r\n    return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId!, LockState.Exclusive, LockOrigin.Discovered) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */\r\n  public holdsExclusiveLock(id: Id64String): boolean {\r\n    // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)\r\n    return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  public holdsSharedLock(id: Id64String): boolean {\r\n    const state = this.getLockState(id);\r\n    // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.\r\n    return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */\r\n  private addSharedLock(id: Id64String | undefined, locks: Set<Id64String>) {\r\n    // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done\r\n    // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.\r\n    if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))\r\n      return;\r\n\r\n    locks.add(id); // add to set of needed shared locks\r\n    this.addOwnerSharedLocks(id, locks); // check parent models and groups\r\n  }\r\n\r\n  /** add owners (recursively) of an element to a list of required shared locks, if not already held. */\r\n  private addOwnerSharedLocks(id: Id64String, locks: Set<Id64String>) {\r\n    const el = this.getOwners(id);\r\n    this.addSharedLock(el.parentId, locks); // if this element is in a group\r\n    this.addSharedLock(el.modelId, locks); // check its model\r\n  }\r\n\r\n  /** attempt to acquire all necessary locks for a set of elements */\r\n  private async acquireAllLocks(locks: LockMap) {\r\n    if (locks.size === 0) // no locks are required.\r\n      return;\r\n\r\n    const sharedLocks = new Set<Id64String>();\r\n    for (const lock of locks)\r\n      this.addOwnerSharedLocks(lock[0], sharedLocks);\r\n\r\n    for (const shared of sharedLocks) {\r\n      if (!locks.has(shared)) // we may already be asking for exclusive lock\r\n        locks.set(shared, LockState.Shared);\r\n    }\r\n\r\n    await IModelHost.hubAccess.acquireLocks(this.briefcase, locks); // throws if unsuccessful\r\n    for (const lock of locks)\r\n      this.insertLock(lock[0], lock[1], LockOrigin.Acquired);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /**\r\n   * Acquire the exclusive lock on one or more elements. This also attempts to acquire a shared lock on all of the element's owners, recursively.\r\n   * If *any* lock cannot be obtained, no locks are acquired.\r\n   */\r\n  public async acquireExclusiveLock(ids: Id64Arg): Promise<void> {\r\n    const locks = new Map<Id64String, LockState>();\r\n    for (const id of Id64.iterable(ids)) {\r\n      if (!this.holdsExclusiveLock(id))\r\n        locks.set(id, LockState.Exclusive);\r\n    }\r\n    return this.acquireAllLocks(locks);\r\n  }\r\n\r\n  /**\r\n   * Acquire a shared lock on one or more elements. This also attempts to acquire a shared lock on all of the element's owners, recursively.\r\n   * If *any* lock cannot be obtained, no locks are acquired.\r\n   */\r\n  public async acquireSharedLock(ids: Id64Arg): Promise<void> {\r\n    const locks = new Map<Id64String, LockState>();\r\n    for (const id of Id64.iterable(ids)) {\r\n      if (!this.holdsSharedLock(id))\r\n        locks.set(id, LockState.Shared);\r\n    }\r\n    return this.acquireAllLocks(locks);\r\n  }\r\n\r\n  /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */\r\n  public elementWasCreated(id: Id64String) {\r\n    this.insertLock(id, LockState.Exclusive, LockOrigin.NewElement);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** locks are not necessary during change propagation. */\r\n  private get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }\r\n\r\n  /** throw if locks are currently required and the exclusive lock is not held on the supplied element */\r\n  public checkExclusiveLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsExclusiveLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n  /** throw if locks are currently required and a shared lock is not held on the supplied element */\r\n  public checkSharedLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsSharedLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n}\r\n\r\n"]}
+{"version":3,"file":"ServerBasedLocks.js","sourceRoot":"","sources":["../../src/ServerBasedLocks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAAkG;AAClG,oDAAyD;AACzD,yDAAwD;AAExD,6CAA0C;AAC1C,yCAAsC;AAoBtC,gBAAgB;AAChB,MAAa,gBAAgB;IAK3B,YAAmB,MAAmB;QAHnB,WAAM,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAIzC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC;QACxB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,QAAQ,CAAC;QAChE,IAAI;YACF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAQ,CAAC,SAAS,CAAC,CAAC;SAChD;QAAC,OAAO,EAAE,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,2FAA2F,CAAC,CAAC;YACpH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;SAC3B;IACH,CAAC;IAdD,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAgBpC,KAAK;QACV,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YACpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,EAAc;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,qDAAqD,EAAE,CAAC,IAAI,EAAE,EAAE;YAChH,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,aAAa,KAAK,EAAE;gBAC/B,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;YAEvD,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,EAAe;QAClC,OAAO,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,oCAAoC,EAAE,CAAC,IAAI,EAAE,EAAE;YAClJ,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,OAAO,CAAC,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACxF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,qBAAqB;IACd,YAAY,CAAC,KAAgB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,0CAA0C,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1F,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,eAAe;QAC1B,MAAM,uBAAU,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,yBAAyB;QACrF,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAEO,UAAU,CAAC,EAAc,EAAE,KAAgB,EAAE,MAAkB;QACrE,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,6HAA6H,EAAE,CAAC,IAAI,EAAE,EAAE;YAC9K,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACnB,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC5B,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YACvB,IAAI,uBAAQ,CAAC,cAAc,KAAK,EAAE;gBAChC,MAAM,IAAI,yBAAW,CAAC,EAAE,EAAE,iCAAiC,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,uBAAuB,CAAC,EAA0B;QACxD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,oBAAM,CAAC,aAAa;YACjD,OAAO,KAAK,CAAC,CAAC,gBAAgB;QAEhC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,4BAAS,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,4BAAS,CAAC,SAAS;YAC3G,OAAO,IAAI,CAAC;QAEd,wIAAwI;QACxI,IAAI,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC;YACvC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,4BAAS,CAAC,SAAS,qBAAwB,CAAC;QAE9E,yIAAyI;QACzI,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,QAAS,EAAE,4BAAS,CAAC,SAAS,qBAAwB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,+DAA+D;IACjM,CAAC;IAED,mGAAmG;IAC5F,kBAAkB,CAAC,EAAc;QACtC,2GAA2G;QAC3G,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,KAAK,4BAAS,CAAC,SAAS,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEM,eAAe,CAAC,EAAc;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACpC,gKAAgK;QAChK,OAAO,CAAC,KAAK,KAAK,4BAAS,CAAC,MAAM,IAAI,KAAK,KAAK,4BAAS,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,sIAAsI;IAC9H,aAAa,CAAC,EAA0B,EAAE,KAAsB;QACtE,gHAAgH;QAChH,0GAA0G;QAC1G,IAAI,EAAE,KAAK,SAAS,IAAI,CAAC,mBAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACpF,OAAO;QAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC;QACnD,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,iCAAiC;IACxE,CAAC;IAED,sGAAsG;IAC9F,mBAAmB,CAAC,EAAc,EAAE,KAAsB;QAChE,MAAM,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,gCAAgC;QACxE,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,kBAAkB;IAC3D,CAAC;IAED,mEAAmE;IAC3D,KAAK,CAAC,eAAe,CAAC,KAAc;QAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,yBAAyB;YAC7C,OAAO;QAET,MAAM,WAAW,GAAG,IAAI,GAAG,EAAc,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAEjD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE;YAChC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,8CAA8C;gBACpE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,4BAAS,CAAC,MAAM,CAAC,CAAC;SACvC;QAED,MAAM,uBAAU,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,yBAAyB;QACzF,KAAK,MAAM,IAAI,IAAI,KAAK;YACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,mBAAsB,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,GAA8C;QACtE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/C,IAAI,GAAG,CAAC,MAAM,EAAE;YACd,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC1C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;oBAC3B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,4BAAS,CAAC,MAAM,CAAC,CAAC;aACnC;SACF;QACD,IAAI,GAAG,CAAC,SAAS,EAAE;YACjB,KAAK,MAAM,EAAE,IAAI,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;gBAC7C,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;oBAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,4BAAS,CAAC,SAAS,CAAC,CAAC;aACtC;SACF;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED,wGAAwG;IACjG,iBAAiB,CAAC,EAAc;QACrC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,4BAAS,CAAC,SAAS,qBAAwB,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,yDAAyD;IACzD,IAAY,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAElF,uGAAuG;IAChG,kBAAkB,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACvE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,8BAA8B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACtH,CAAC;IAED,kGAAkG;IAC3F,eAAe,CAAC,EAAc,EAAE,IAAY,EAAE,SAAiB;QACpE,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,2BAA2B,IAAI,QAAQ,SAAS,QAAQ,EAAE,GAAG,CAAC,CAAC;IACnH,CAAC;CAEF;AAlLD,4CAkLC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\n\r\nimport { DbResult, Id64, Id64Arg, Id64String, IModelStatus, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModel, IModelError } from \"@itwin/core-common\";\r\nimport { LockMap, LockState } from \"./BackendHubAccess\";\r\nimport { BriefcaseDb, LockControl } from \"./IModelDb\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SQLiteDb } from \"./SQLiteDb\";\r\n\r\n/**\r\n * Both the Model and Parent of an element are considered \"owners\" of their member elements. That means:\r\n * 1) they must hold at least a shared lock before an exclusive lock can be acquired for their members\r\n * 2) if they hold an exclusive lock, then all of their members are exclusively locked implicitly.\r\n * @internal\r\n */\r\nexport interface ElementOwners {\r\n  readonly modelId: Id64String;\r\n  readonly parentId: Id64String | undefined;\r\n}\r\n\r\n// eslint-disable-next-line no-restricted-syntax\r\nconst enum LockOrigin {\r\n  Acquired = 0,\r\n  NewElement = 1,\r\n  Discovered = 2,\r\n}\r\n\r\n/** @internal */\r\nexport class ServerBasedLocks implements LockControl {\r\n  public get isServerBased() { return true; }\r\n  protected readonly lockDb = new SQLiteDb();\r\n  protected readonly briefcase: BriefcaseDb;\r\n\r\n  public constructor(iModel: BriefcaseDb) {\r\n    this.briefcase = iModel;\r\n    const dbName = `${iModel.nativeDb.getTempFileBaseName()}-locks`;\r\n    try {\r\n      this.lockDb.openDb(dbName, OpenMode.ReadWrite);\r\n    } catch (_e) {\r\n      this.lockDb.createDb(dbName);\r\n      this.lockDb.executeSQL(\"CREATE TABLE locks(id INTEGER PRIMARY KEY NOT NULL,state INTEGER NOT NULL,origin INTEGER)\");\r\n      this.lockDb.saveChanges();\r\n    }\r\n  }\r\n\r\n  public close() {\r\n    if (this.lockDb.isOpen)\r\n      this.lockDb.closeDb();\r\n  }\r\n\r\n  private getOwners(id: Id64String): ElementOwners {\r\n    return this.briefcase.withPreparedSqliteStatement(\"SELECT ModelId,ParentId FROM bis_Element WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_ROW !== rc)\r\n        throw new IModelError(rc, `element ${id} not found`);\r\n\r\n      return { modelId: stmt.getValueId(0), parentId: stmt.getValueId(1) };\r\n    });\r\n  }\r\n\r\n  private getLockState(id?: Id64String): LockState | undefined {\r\n    return (id === undefined || !Id64.isValid(id)) ? undefined : this.lockDb.withPreparedSqliteStatement(\"SELECT state FROM locks WHERE id=?\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      return (DbResult.BE_SQLITE_ROW === stmt.step()) ? stmt.getValueInteger(0) : undefined;\r\n    });\r\n  }\r\n\r\n  /** Clear the cache of locally held locks.\r\n   * Note: does *not* release locks from server.\r\n   */\r\n  private clearAllLocks() {\r\n    this.lockDb.executeSQL(\"DELETE FROM locks\");\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** only for tests */\r\n  public getLockCount(state: LockState): number {\r\n    return this.lockDb.withSqliteStatement(\"SELECT count(*) FROM locks WHERE state=?\", (stmt) => {\r\n      stmt.bindInteger(1, state);\r\n      stmt.step();\r\n      return stmt.getValueInteger(0);\r\n    });\r\n  }\r\n\r\n  public async releaseAllLocks(): Promise<void> {\r\n    await IModelHost.hubAccess.releaseAllLocks(this.briefcase); // throws if unsuccessful\r\n    this.clearAllLocks();\r\n  }\r\n\r\n  private insertLock(id: Id64String, state: LockState, origin: LockOrigin): true {\r\n    this.lockDb.withPreparedSqliteStatement(\"INSERT INTO locks(id,state,origin) VALUES (?,?,?) ON CONFLICT(id) DO UPDATE SET state=excluded.state,origin=excluded.origin\", (stmt) => {\r\n      stmt.bindId(1, id);\r\n      stmt.bindInteger(2, state);\r\n      stmt.bindInteger(3, origin);\r\n      const rc = stmt.step();\r\n      if (DbResult.BE_SQLITE_DONE !== rc)\r\n        throw new IModelError(rc, \"can't insert lock into database\");\r\n    });\r\n    return true;\r\n  }\r\n\r\n  private ownerHoldsExclusiveLock(id: Id64String | undefined): boolean {\r\n    if (id === undefined || id === IModel.rootSubjectId)\r\n      return false; // has no owners\r\n\r\n    const { modelId, parentId } = this.getOwners(id);\r\n    if (this.getLockState(modelId) === LockState.Exclusive || this.getLockState(parentId) === LockState.Exclusive)\r\n      return true;\r\n\r\n    // see if this model is exclusively locked by one of its owners. If so, save that fact on modelId so future tests won't have to descend.\r\n    if (this.ownerHoldsExclusiveLock(modelId))\r\n      return this.insertLock(modelId, LockState.Exclusive, LockOrigin.Discovered);\r\n\r\n    // see if the parent is exclusively locked by one of its owners. If so, save that fact on parentId so future tests won't have to descend.\r\n    return this.ownerHoldsExclusiveLock(parentId) ? this.insertLock(parentId!, LockState.Exclusive, LockOrigin.Discovered) : false; // eslint-disable-line @typescript-eslint/no-non-null-assertion\r\n  }\r\n\r\n  /** Determine whether an the exclusive lock is already held by an element (or one of its owners) */\r\n  public holdsExclusiveLock(id: Id64String): boolean {\r\n    // see if we hold the exclusive lock. or if one of the element's owners is exclusively locked (recursively)\r\n    return this.getLockState(id) === LockState.Exclusive || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  public holdsSharedLock(id: Id64String): boolean {\r\n    const state = this.getLockState(id);\r\n    // see if we hold shared or exclusive lock, or if an owner has exclusive lock. If so we implicitly have shared lock, but owner holding shared lock doesn't help.\r\n    return (state === LockState.Shared || state === LockState.Exclusive) || this.ownerHoldsExclusiveLock(id);\r\n  }\r\n\r\n  /** if the shared lock on the element supplied is not already held, add it to the set of shared locks required. Then, check owners. */\r\n  private addSharedLock(id: Id64String | undefined, locks: Set<Id64String>) {\r\n    // if the id is not valid, or of the lock is already in the set, or if we already hold a shared lock, we're done\r\n    // Note: if we hold a shared lock, it is guaranteed that we also hold all required shared locks on owners.\r\n    if (id === undefined || !Id64.isValid(id) || locks.has(id) || this.holdsSharedLock(id))\r\n      return;\r\n\r\n    locks.add(id); // add to set of needed shared locks\r\n    this.addOwnerSharedLocks(id, locks); // check parent models and groups\r\n  }\r\n\r\n  /** add owners (recursively) of an element to a list of required shared locks, if not already held. */\r\n  private addOwnerSharedLocks(id: Id64String, locks: Set<Id64String>) {\r\n    const el = this.getOwners(id);\r\n    this.addSharedLock(el.parentId, locks); // if this element is in a group\r\n    this.addSharedLock(el.modelId, locks); // check its model\r\n  }\r\n\r\n  /** attempt to acquire all necessary locks for a set of elements */\r\n  private async acquireAllLocks(locks: LockMap) {\r\n    if (locks.size === 0) // no locks are required.\r\n      return;\r\n\r\n    const sharedLocks = new Set<Id64String>();\r\n    for (const lock of locks)\r\n      this.addOwnerSharedLocks(lock[0], sharedLocks);\r\n\r\n    for (const shared of sharedLocks) {\r\n      if (!locks.has(shared)) // we may already be asking for exclusive lock\r\n        locks.set(shared, LockState.Shared);\r\n    }\r\n\r\n    await IModelHost.hubAccess.acquireLocks(this.briefcase, locks); // throws if unsuccessful\r\n    for (const lock of locks)\r\n      this.insertLock(lock[0], lock[1], LockOrigin.Acquired);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  public async acquireLocks(arg: { shared?: Id64Arg, exclusive?: Id64Arg }): Promise<void> {\r\n    const locks = new Map<Id64String, LockState>();\r\n    if (arg.shared) {\r\n      for (const id of Id64.iterable(arg.shared)) {\r\n        if (!this.holdsSharedLock(id))\r\n          locks.set(id, LockState.Shared);\r\n      }\r\n    }\r\n    if (arg.exclusive) {\r\n      for (const id of Id64.iterable(arg.exclusive)) {\r\n        if (!this.holdsExclusiveLock(id))\r\n          locks.set(id, LockState.Exclusive);\r\n      }\r\n    }\r\n    return this.acquireAllLocks(locks);\r\n  }\r\n\r\n  /** When an element is newly created in a session, we hold the lock on it implicitly. Save that fact. */\r\n  public elementWasCreated(id: Id64String) {\r\n    this.insertLock(id, LockState.Exclusive, LockOrigin.NewElement);\r\n    this.lockDb.saveChanges();\r\n  }\r\n\r\n  /** locks are not necessary during change propagation. */\r\n  private get _locksAreRequired() { return !this.briefcase.txns.isIndirectChanges; }\r\n\r\n  /** throw if locks are currently required and the exclusive lock is not held on the supplied element */\r\n  public checkExclusiveLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsExclusiveLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `exclusive lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n  /** throw if locks are currently required and a shared lock is not held on the supplied element */\r\n  public checkSharedLock(id: Id64String, type: string, operation: string) {\r\n    if (this._locksAreRequired && !this.holdsSharedLock(id))\r\n      throw new IModelError(IModelStatus.LockNotHeld, `shared lock not held on ${type} for ${operation} (id=${id})`);\r\n  }\r\n\r\n}\r\n\r\n"]}

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RpcBriefcaseUtility.d.ts","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAA2D,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EACL,cAAc,EAAE,qBAAqB,EAAe,kBAAkB,EAAE,cAAc,EAAiB,WAAW,EAAsB,QAAQ,EACjJ,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAe,QAAQ,EAAc,MAAM,aAAa,CAAC;AAMhE,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,CAAC,EAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AACD;;;GAGG;AACH,qBAAa,mBAAmB;mBAET,eAAe;IA4DpC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmC;mBAC9C,aAAa;IAYlC;;;;OAIG;WACiB,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc;IAUnF;;;OAGG;WACiB,IAAI,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;WAkElD,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAE,MAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAIvK"}
+{"version":3,"file":"RpcBriefcaseUtility.d.ts","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAyE,MAAM,qBAAqB,CAAC;AACzH,OAAO,EACL,cAAc,EAAE,qBAAqB,EAAe,kBAAkB,EAAE,cAAc,EAAiB,WAAW,EAAsB,QAAQ,EACjJ,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAe,QAAQ,EAAc,MAAM,aAAa,CAAC;AAMhE,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,CAAC,EAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AACD;;;GAGG;AACH,qBAAa,mBAAmB;mBAET,eAAe;IA4DpC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmC;mBAC9C,aAAa;IAYlC;;;;OAIG;WACiB,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc;IAUnF;;;OAGG;WACiB,IAAI,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;WAkElD,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAE,MAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAIvK"}

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js

@@ -147,7 +147,7 @@ class RpcBriefcaseUtility {
             core_bentley_1.Logger.logTrace(loggerCategory, "using V2 checkpoint briefcase", () => ({ ...tokenProps }));
         }
         catch (e) {
-            core_bentley_1.Logger.logTrace(loggerCategory, "unable to open V2 checkpoint - falling back to V1 checkpoint", () => ({ error: e, ...tokenProps }));
+            core_bentley_1.Logger.logTrace(loggerCategory, "unable to open V2 checkpoint - falling back to V1 checkpoint", () => ({ error: core_bentley_1.BentleyError.getErrorProps(e), ...tokenProps }));
             // this isn't a v2 checkpoint. Set up a race between the specified timeout period and the open. Throw an RpcPendingResponse exception if the timeout happens first.
             const request = {
                 checkpoint,

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA2G;AAC3G,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAA+F;AAC/F,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAE3C,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IAEtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,CAAC,QAAQ;YACnC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;QAEvE,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE;YACvC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;SACtD;aAAM;YACL,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;SAC1F;QAED,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,iBAAiB,mCAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE;YACb,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAChC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE;oBACxC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;wBACnC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS;4BAC3B,OAAO,WAA0B,CAAC;wBACpC,IAAI;4BACF,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,MAAK,MAAA,UAAU,CAAC,SAAS,0CAAE,EAAE,CAAA,EAAE;gCAChD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,MAAA,MAAA,UAAU,CAAC,SAAS,0CAAE,KAAK,mCACzC,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACvJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;6BAC7E;4BACD,OAAO,EAAE,CAAC;yBACX;wBAAC,OAAO,KAAU,EAAE;4BACnB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;yBACtE;qBACF;iBACF;aACF;SACF;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/E,CAAC;IAGO,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,IAAI,IAAI,CAAC,iBAAiB;YACxB,OAAO,IAAI,CAAC,iBAAiB,CAAC;QAEhC,IAAI;YACF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC;SACrC;gBAAS;YACR,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAE,oCAAoC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,SAAS,KAAK,QAAQ;YACxB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;QAEpF,4FAA4F;QAC5F,MAAM,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC3C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;QAEvF,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE;YACvE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;gBACvF,MAAM,IAAI,gCAAkB,EAAE,CAAC;aAChC;YACD,wEAAwE;YACxE,OAAO,WAAW,CAAC;SACpB;QAED,IAAI,SAAS,KAAK,UAAU,CAAC,QAAQ;YACnC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;QACvE,IAAI,SAAS,KAAK,UAAU,CAAC,OAAO;YAClC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;QACtE,IAAI,SAAS,KAAK,UAAU,CAAC,SAAS;YACpC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAExE,MAAM,UAAU,GAAoB;YAClC,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,kCAAkC;QAClC,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE;YACN,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;YAC1F,mCAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC9B,OAAO,EAAE,CAAC;SACX;QAED,IAAI;YACF,wBAAwB;YACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACnD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,+BAA+B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;SAC7F;QAAC,OAAO,CAAC,EAAE;YACV,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8DAA8D,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;YAErI,mKAAmK;YACnK,MAAM,OAAO,GAAG;gBACd,UAAU;gBACV,SAAS,EAAE,uCAAmB,CAAC,WAAW,CAAC,UAAU,CAAC;gBACtD,UAAU,EAAE,EAAE;aACf,CAAC;YACF,EAAE,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,uCAAmB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;YAElF,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8BAA8B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC3F,MAAM,IAAI,gCAAkB,EAAE,CAAC;aAChC;YACD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;SACpF;QAED,mCAAgB,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;CAEF;AApKD,kDAoKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport { AccessToken, assert, BeDuration, BentleyStatus, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\r\nimport { CheckpointManager, CheckpointProps, V1CheckpointManager } from \"../CheckpointManager\";\r\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\r\n\r\n/** @internal */\r\nexport interface DownloadAndOpenArgs {\r\n  activity: RpcActivity;\r\n  tokenProps: IModelRpcOpenProps;\r\n  syncMode: SyncMode;\r\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\r\n  timeout?: number;\r\n  forceDownload?: boolean;\r\n}\r\n/**\r\n * Utility to open the iModel for Read/Write RPC interfaces\r\n * @internal\r\n */\r\nexport class RpcBriefcaseUtility {\r\n\r\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    const { activity, tokenProps } = args;\r\n    const accessToken = activity.accessToken;\r\n    if (undefined === tokenProps.iModelId)\r\n      throw new IModelError(BentleyStatus.ERROR, \"iModelId is undefined.\");\r\n\r\n    const iModelId = tokenProps.iModelId;\r\n    let myBriefcaseIds: number[];\r\n    if (args.syncMode === SyncMode.PullOnly) {\r\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\r\n    } else {\r\n      // check with iModelHub and see if we already have acquired any briefcaseIds\r\n      myBriefcaseIds = await IModelHost.hubAccess.getMyBriefcaseIds({ accessToken, iModelId });\r\n    }\r\n\r\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\r\n\r\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\r\n    if (resolvers) {\r\n      for (const resolver of resolvers) {\r\n        for (const briefcaseId of myBriefcaseIds) {\r\n          const fileName = resolver({ briefcaseId, iModelId });\r\n          if (IModelJsFs.existsSync(fileName)) {\r\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\r\n            if (briefcaseDb !== undefined)\r\n              return briefcaseDb as BriefcaseDb;\r\n            try {\r\n              if (args.forceDownload)\r\n                throw new Error(); // causes delete below\r\n              const db = await BriefcaseDb.open({ fileName });\r\n              if (db.changeset.id !== tokenProps.changeset?.id) {\r\n                assert(undefined !== tokenProps.changeset);\r\n                const toIndex = tokenProps.changeset?.index ??\r\n                  (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\r\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\r\n              }\r\n              return db;\r\n            } catch (error: any) {\r\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\r\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\r\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\r\n            }\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    // no local briefcase available. Download one and open it.\r\n    assert(undefined !== tokenProps.iTwinId);\r\n    const request: RequestNewBriefcaseArg = {\r\n      accessToken,\r\n      iTwinId: tokenProps.iTwinId,\r\n      iModelId,\r\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\r\n    };\r\n\r\n    const props = await BriefcaseManager.downloadBriefcase(request);\r\n    return BriefcaseDb.open({ rpcActivity: activity, fileName: props.fileName });\r\n  }\r\n\r\n  private static _briefcasePromise: Promise<BriefcaseDb> | undefined;\r\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    if (this._briefcasePromise)\r\n      return this._briefcasePromise;\r\n\r\n    try {\r\n      this._briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\r\n      return await this._briefcasePromise;\r\n    } finally {\r\n      this._briefcasePromise = undefined;  // the download and open is now done\r\n    }\r\n  }\r\n\r\n  /** find a previously opened iModel for RPC.\r\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\r\n   * to refresh the daemon, even though it will be used for all authorized users.\r\n   * @param the IModelRpcProps to locate the opened iModel.\r\n   */\r\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\r\n    const iModelDb = IModelDb.tryFindByKey(iModel.key);\r\n    if (undefined === iModelDb)\r\n      throw new IModelError(IModelStatus.NotOpen, \"iModel is not opened\", () => iModel);\r\n\r\n    // call reattach, just in case this is a V2 checkpoint whose accessToken is about to expire.\r\n    await iModelDb.reattachDaemon(accessToken);\r\n    return iModelDb;\r\n  }\r\n\r\n  /**\r\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\r\n   * a RpcPendingResponse exception is thrown\r\n   */\r\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\r\n    const { activity, tokenProps, syncMode } = args;\r\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", () => ({ ...tokenProps }));\r\n\r\n    const timeout = args.timeout ?? 1000;\r\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\r\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\r\n\r\n      if (briefcaseDb === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", () => ({ ...tokenProps }));\r\n        throw new RpcPendingResponse();\r\n      }\r\n      // note: usage is logged in BriefcaseManager.downloadNewBriefcaseAndOpen\r\n      return briefcaseDb;\r\n    }\r\n\r\n    if (undefined === tokenProps.iModelId)\r\n      throw new IModelError(BentleyStatus.ERROR, \"iModelId is undefined.\");\r\n    if (undefined === tokenProps.iTwinId)\r\n      throw new IModelError(BentleyStatus.ERROR, \"iTwinId is undefined.\");\r\n    if (undefined === tokenProps.changeset)\r\n      throw new IModelError(BentleyStatus.ERROR, \"Changeset is undefined.\");\r\n\r\n    const checkpoint: CheckpointProps = {\r\n      iModelId: tokenProps.iModelId,\r\n      iTwinId: tokenProps.iTwinId,\r\n      changeset: tokenProps.changeset,\r\n      accessToken: activity.accessToken,\r\n    };\r\n\r\n    // opening a checkpoint, readonly.\r\n    let db: SnapshotDb | void;\r\n    // first check if it's already open\r\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\r\n    if (db) {\r\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", () => ({ ...tokenProps }));\r\n      BriefcaseManager.logUsage(db);\r\n      return db;\r\n    }\r\n\r\n    try {\r\n      // now try V2 checkpoint\r\n      db = await SnapshotDb.openCheckpointV2(checkpoint);\r\n      Logger.logTrace(loggerCategory, \"using V2 checkpoint briefcase\", () => ({ ...tokenProps }));\r\n    } catch (e) {\r\n      Logger.logTrace(loggerCategory, \"unable to open V2 checkpoint - falling back to V1 checkpoint\", () => ({ error: e, ...tokenProps }));\r\n\r\n      // this isn't a v2 checkpoint. Set up a race between the specified timeout period and the open. Throw an RpcPendingResponse exception if the timeout happens first.\r\n      const request = {\r\n        checkpoint,\r\n        localFile: V1CheckpointManager.getFileName(checkpoint),\r\n        aliasFiles: [],\r\n      };\r\n      db = await BeDuration.race(timeout, V1CheckpointManager.getCheckpointDb(request));\r\n\r\n      if (db === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open V1 checkpoint - pending\", () => ({ ...tokenProps }));\r\n        throw new RpcPendingResponse();\r\n      }\r\n      Logger.logTrace(loggerCategory, \"Opened V1 checkpoint\", () => ({ ...tokenProps }));\r\n    }\r\n\r\n    BriefcaseManager.logUsage(db, activity);\r\n    return db;\r\n  }\r\n\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> {\r\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyH;AACzH,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAA+F;AAC/F,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAE3C,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IAEtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAI,SAAS,KAAK,UAAU,CAAC,QAAQ;YACnC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;QAEvE,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE;YACvC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;SACtD;aAAM;YACL,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;SAC1F;QAED,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,iBAAiB,mCAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE;YACb,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;gBAChC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE;oBACxC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;wBACnC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS;4BAC3B,OAAO,WAA0B,CAAC;wBACpC,IAAI;4BACF,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,MAAK,MAAA,UAAU,CAAC,SAAS,0CAAE,EAAE,CAAA,EAAE;gCAChD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,MAAA,MAAA,UAAU,CAAC,SAAS,0CAAE,KAAK,mCACzC,CAAC,MAAM,uBAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACvJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;6BAC7E;4BACD,OAAO,EAAE,CAAC;yBACX;wBAAC,OAAO,KAAU,EAAE;4BACnB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;yBACtE;qBACF;iBACF;aACF;SACF;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/E,CAAC;IAGO,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,IAAI,IAAI,CAAC,iBAAiB;YACxB,OAAO,IAAI,CAAC,iBAAiB,CAAC;QAEhC,IAAI;YACF,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC;SACrC;gBAAS;YACR,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAE,oCAAoC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,SAAS,KAAK,QAAQ;YACxB,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,OAAO,EAAE,sBAAsB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC;QAEpF,4FAA4F;QAC5F,MAAM,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC3C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;QAEvF,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE;YACvE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE;gBAC7B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;gBACvF,MAAM,IAAI,gCAAkB,EAAE,CAAC;aAChC;YACD,wEAAwE;YACxE,OAAO,WAAW,CAAC;SACpB;QAED,IAAI,SAAS,KAAK,UAAU,CAAC,QAAQ;YACnC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;QACvE,IAAI,SAAS,KAAK,UAAU,CAAC,OAAO;YAClC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC;QACtE,IAAI,SAAS,KAAK,UAAU,CAAC,SAAS;YACpC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,yBAAyB,CAAC,CAAC;QAExE,MAAM,UAAU,GAAoB;YAClC,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,kCAAkC;QAClC,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE;YACN,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;YAC1F,mCAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC9B,OAAO,EAAE,CAAC;SACX;QAED,IAAI;YACF,wBAAwB;YACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACnD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,+BAA+B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;SAC7F;QAAC,OAAO,CAAC,EAAE;YACV,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8DAA8D,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,2BAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;YAEjK,mKAAmK;YACnK,MAAM,OAAO,GAAG;gBACd,UAAU;gBACV,SAAS,EAAE,uCAAmB,CAAC,WAAW,CAAC,UAAU,CAAC;gBACtD,UAAU,EAAE,EAAE;aACf,CAAC;YACF,EAAE,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,uCAAmB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;YAElF,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,8BAA8B,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC3F,MAAM,IAAI,gCAAkB,EAAE,CAAC;aAChC;YACD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,sBAAsB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;SACpF;QAED,mCAAgB,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;CAEF;AApKD,kDAoKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport { AccessToken, assert, BeDuration, BentleyError, BentleyStatus, IModelStatus, Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\r\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\r\nimport { CheckpointManager, CheckpointProps, V1CheckpointManager } from \"../CheckpointManager\";\r\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { IModelJsFs } from \"../IModelJsFs\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\r\n\r\n/** @internal */\r\nexport interface DownloadAndOpenArgs {\r\n  activity: RpcActivity;\r\n  tokenProps: IModelRpcOpenProps;\r\n  syncMode: SyncMode;\r\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\r\n  timeout?: number;\r\n  forceDownload?: boolean;\r\n}\r\n/**\r\n * Utility to open the iModel for Read/Write RPC interfaces\r\n * @internal\r\n */\r\nexport class RpcBriefcaseUtility {\r\n\r\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    const { activity, tokenProps } = args;\r\n    const accessToken = activity.accessToken;\r\n    if (undefined === tokenProps.iModelId)\r\n      throw new IModelError(BentleyStatus.ERROR, \"iModelId is undefined.\");\r\n\r\n    const iModelId = tokenProps.iModelId;\r\n    let myBriefcaseIds: number[];\r\n    if (args.syncMode === SyncMode.PullOnly) {\r\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\r\n    } else {\r\n      // check with iModelHub and see if we already have acquired any briefcaseIds\r\n      myBriefcaseIds = await IModelHost.hubAccess.getMyBriefcaseIds({ accessToken, iModelId });\r\n    }\r\n\r\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\r\n\r\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\r\n    if (resolvers) {\r\n      for (const resolver of resolvers) {\r\n        for (const briefcaseId of myBriefcaseIds) {\r\n          const fileName = resolver({ briefcaseId, iModelId });\r\n          if (IModelJsFs.existsSync(fileName)) {\r\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\r\n            if (briefcaseDb !== undefined)\r\n              return briefcaseDb as BriefcaseDb;\r\n            try {\r\n              if (args.forceDownload)\r\n                throw new Error(); // causes delete below\r\n              const db = await BriefcaseDb.open({ fileName });\r\n              if (db.changeset.id !== tokenProps.changeset?.id) {\r\n                assert(undefined !== tokenProps.changeset);\r\n                const toIndex = tokenProps.changeset?.index ??\r\n                  (await IModelHost.hubAccess.getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\r\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\r\n              }\r\n              return db;\r\n            } catch (error: any) {\r\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\r\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\r\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\r\n            }\r\n          }\r\n        }\r\n      }\r\n    }\r\n\r\n    // no local briefcase available. Download one and open it.\r\n    assert(undefined !== tokenProps.iTwinId);\r\n    const request: RequestNewBriefcaseArg = {\r\n      accessToken,\r\n      iTwinId: tokenProps.iTwinId,\r\n      iModelId,\r\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\r\n    };\r\n\r\n    const props = await BriefcaseManager.downloadBriefcase(request);\r\n    return BriefcaseDb.open({ rpcActivity: activity, fileName: props.fileName });\r\n  }\r\n\r\n  private static _briefcasePromise: Promise<BriefcaseDb> | undefined;\r\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\r\n    if (this._briefcasePromise)\r\n      return this._briefcasePromise;\r\n\r\n    try {\r\n      this._briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\r\n      return await this._briefcasePromise;\r\n    } finally {\r\n      this._briefcasePromise = undefined;  // the download and open is now done\r\n    }\r\n  }\r\n\r\n  /** find a previously opened iModel for RPC.\r\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\r\n   * to refresh the daemon, even though it will be used for all authorized users.\r\n   * @param the IModelRpcProps to locate the opened iModel.\r\n   */\r\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\r\n    const iModelDb = IModelDb.tryFindByKey(iModel.key);\r\n    if (undefined === iModelDb)\r\n      throw new IModelError(IModelStatus.NotOpen, \"iModel is not opened\", () => iModel);\r\n\r\n    // call reattach, just in case this is a V2 checkpoint whose accessToken is about to expire.\r\n    await iModelDb.reattachDaemon(accessToken);\r\n    return iModelDb;\r\n  }\r\n\r\n  /**\r\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\r\n   * a RpcPendingResponse exception is thrown\r\n   */\r\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\r\n    const { activity, tokenProps, syncMode } = args;\r\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", () => ({ ...tokenProps }));\r\n\r\n    const timeout = args.timeout ?? 1000;\r\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\r\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\r\n\r\n      if (briefcaseDb === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", () => ({ ...tokenProps }));\r\n        throw new RpcPendingResponse();\r\n      }\r\n      // note: usage is logged in BriefcaseManager.downloadNewBriefcaseAndOpen\r\n      return briefcaseDb;\r\n    }\r\n\r\n    if (undefined === tokenProps.iModelId)\r\n      throw new IModelError(BentleyStatus.ERROR, \"iModelId is undefined.\");\r\n    if (undefined === tokenProps.iTwinId)\r\n      throw new IModelError(BentleyStatus.ERROR, \"iTwinId is undefined.\");\r\n    if (undefined === tokenProps.changeset)\r\n      throw new IModelError(BentleyStatus.ERROR, \"Changeset is undefined.\");\r\n\r\n    const checkpoint: CheckpointProps = {\r\n      iModelId: tokenProps.iModelId,\r\n      iTwinId: tokenProps.iTwinId,\r\n      changeset: tokenProps.changeset,\r\n      accessToken: activity.accessToken,\r\n    };\r\n\r\n    // opening a checkpoint, readonly.\r\n    let db: SnapshotDb | void;\r\n    // first check if it's already open\r\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\r\n    if (db) {\r\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", () => ({ ...tokenProps }));\r\n      BriefcaseManager.logUsage(db);\r\n      return db;\r\n    }\r\n\r\n    try {\r\n      // now try V2 checkpoint\r\n      db = await SnapshotDb.openCheckpointV2(checkpoint);\r\n      Logger.logTrace(loggerCategory, \"using V2 checkpoint briefcase\", () => ({ ...tokenProps }));\r\n    } catch (e) {\r\n      Logger.logTrace(loggerCategory, \"unable to open V2 checkpoint - falling back to V1 checkpoint\", () => ({ error: BentleyError.getErrorProps(e), ...tokenProps }));\r\n\r\n      // this isn't a v2 checkpoint. Set up a race between the specified timeout period and the open. Throw an RpcPendingResponse exception if the timeout happens first.\r\n      const request = {\r\n        checkpoint,\r\n        localFile: V1CheckpointManager.getFileName(checkpoint),\r\n        aliasFiles: [],\r\n      };\r\n      db = await BeDuration.race(timeout, V1CheckpointManager.getCheckpointDb(request));\r\n\r\n      if (db === undefined) {\r\n        Logger.logTrace(loggerCategory, \"Open V1 checkpoint - pending\", () => ({ ...tokenProps }));\r\n        throw new RpcPendingResponse();\r\n      }\r\n      Logger.logTrace(loggerCategory, \"Opened V1 checkpoint\", () => ({ ...tokenProps }));\r\n    }\r\n\r\n    BriefcaseManager.logUsage(db, activity);\r\n    return db;\r\n  }\r\n\r\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> {\r\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\r\n  }\r\n\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-backend",
-  "version": "3.0.0-dev.146",
+  "version": "3.0.0-dev.151",
   "description": "iTwin.js backend components",
   "main": "lib/cjs/core-backend.js",
   "typings": "lib/cjs/core-backend",
@@ -24,24 +24,24 @@
     "url": "http://www.bentley.com"
   },
   "peerDependencies": {
-    "@bentley/itwin-client": "^3.0.0-dev.146",
-    "@itwin/core-bentley": "^3.0.0-dev.146",
-    "@itwin/core-common": "^3.0.0-dev.146",
-    "@itwin/core-geometry": "^3.0.0-dev.146",
-    "@itwin/ecschema-metadata": "^3.0.0-dev.146"
+    "@bentley/itwin-client": "^3.0.0-dev.151",
+    "@itwin/core-bentley": "^3.0.0-dev.151",
+    "@itwin/core-common": "^3.0.0-dev.151",
+    "@itwin/core-geometry": "^3.0.0-dev.151",
+    "@itwin/ecschema-metadata": "^3.0.0-dev.151"
   },
   "//devDependencies": [
     "NOTE: All peerDependencies should also be listed as devDependencies since peerDependencies are not considered by npm install",
     "NOTE: All tools used by scripts in this package must be listed as devDependencies"
   ],
   "devDependencies": {
-    "@bentley/itwin-client": "3.0.0-dev.146",
-    "@itwin/build-tools": "3.0.0-dev.146",
-    "@itwin/core-bentley": "3.0.0-dev.146",
-    "@itwin/core-common": "3.0.0-dev.146",
-    "@itwin/core-geometry": "3.0.0-dev.146",
-    "@itwin/ecschema-metadata": "3.0.0-dev.146",
-    "@itwin/eslint-plugin": "3.0.0-dev.146",
+    "@bentley/itwin-client": "3.0.0-dev.151",
+    "@itwin/build-tools": "3.0.0-dev.151",
+    "@itwin/core-bentley": "3.0.0-dev.151",
+    "@itwin/core-common": "3.0.0-dev.151",
+    "@itwin/core-geometry": "3.0.0-dev.151",
+    "@itwin/ecschema-metadata": "3.0.0-dev.151",
+    "@itwin/eslint-plugin": "3.0.0-dev.151",
     "@types/chai": "^4.1.4",
     "@types/chai-as-promised": "^7",
     "@types/fs-extra": "^4.0.7",
@@ -67,7 +67,7 @@
   "dependencies": {
     "@azure/storage-blob": "^12.7.0",
     "@bentley/imodeljs-native": "3.0.24",
-    "@itwin/core-telemetry": "3.0.0-dev.146",
+    "@itwin/core-telemetry": "3.0.0-dev.151",
     "form-data": "^2.3.2",
     "fs-extra": "^8.1.0",
     "json5": "^2.2.0",