@itwin/core-backend 4.2.0-dev.3 → 4.2.0-dev.31

package/lib/cjs/IModelDb.js

@@ -8,8 +8,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StandaloneDb = exports.SnapshotDb = exports.BriefcaseDb = exports.IModelDb = exports.BriefcaseLocalValue = void 0;
-const path_1 = require("path");
 const fs = require("fs");
+const path_1 = require("path");
+const touch = require("touch");
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_common_1 = require("@itwin/core-common");
 const core_geometry_1 = require("@itwin/core-geometry");
@@ -24,7 +25,6 @@ const CodeSpecs_1 = require("./CodeSpecs");
 const ConcurrentQuery_1 = require("./ConcurrentQuery");
 const ECSqlStatement_1 = require("./ECSqlStatement");
 const Element_1 = require("./Element");
-const ElementAspect_1 = require("./ElementAspect");
 const ElementGraphics_1 = require("./ElementGraphics");
 const Entity_1 = require("./Entity");
 const GeoCoordConfig_1 = require("./GeoCoordConfig");
@@ -33,6 +33,7 @@ const IModelJsFs_1 = require("./IModelJsFs");
 const IpcHost_1 = require("./IpcHost");
 const Model_1 = require("./Model");
 const Relationship_1 = require("./Relationship");
+const SchemaSync_1 = require("./SchemaSync");
 const ServerBasedLocks_1 = require("./ServerBasedLocks");
 const SqliteStatement_1 = require("./SqliteStatement");
 const TxnManager_1 = require("./TxnManager");
@@ -123,6 +124,10 @@ class IModelDb extends core_common_1.IModel {
         this.changeset = this.nativeDb.getCurrentChangeset();
         this.onChangesetApplied.raiseEvent();
     }
+    /** @internal */
+    restartDefaultTxn() {
+        this.nativeDb.restartDefaultTxn();
+    }
     get fontMap() {
         return this._fontMap ?? (this._fontMap = new core_common_1.FontMap(this.nativeDb.readFontMap()));
     }
@@ -150,12 +155,18 @@ class IModelDb extends core_common_1.IModel {
         (0, core_bentley_1.assert)(undefined !== super.iModelId);
         return super.iModelId;
     } // GuidString | undefined for the IModel superclass, but required for all IModelDb subclasses
-    /** @internal*/
-    get nativeDb() { return this._nativeDb; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
     /** Get the full path fileName of this iModelDb
      * @note this member is only valid while the iModel is opened.
      */
     get pathName() { return this.nativeDb.getFilePath(); }
+    /** Get the full path to this iModel's "watch file".
+     * A read-only briefcase opened with `watchForChanges: true` creates this file next to the briefcase file on open, if it doesn't already exist.
+     * A writable briefcase "touches" this file if it exists whenever it commits changes to the briefcase.
+     * The read-only briefcase can use a file watcher to react when the writable briefcase makes changes to the briefcase.
+     * This is more reliable than watching the sqlite WAL file.
+     * @internal
+     */
+    get watchFilePathName() { return `${this.pathName}-watch`; }
     /** @internal */
     constructor(args) {
         super({ ...args, iTwinId: args.nativeDb.getITwinId(), iModelId: args.nativeDb.getIModelId() });
@@ -175,7 +186,7 @@ class IModelDb extends core_common_1.IModel {
         this.onChangesetApplied = new core_bentley_1.BeEvent();
         /** Event called when the iModel is about to be closed. */
         this.onBeforeClose = new core_bentley_1.BeEvent();
-        this._nativeDb = args.nativeDb;
+        this.nativeDb = args.nativeDb;
         this.nativeDb.setIModelDb(this);
         this.loadSettingDictionaries();
         GeoCoordConfig_1.GeoCoordConfig.loadForImodel(this.workspace.settings); // load gcs data specified by iModel's settings dictionaries, must be done before calling initializeIModelDb
@@ -205,10 +216,9 @@ class IModelDb extends core_common_1.IModel {
         this._codeService?.close();
         this._codeService = undefined;
         this.nativeDb.closeIModel();
-        this._nativeDb = undefined; // the underlying nativeDb has been freed by closeIModel
     }
     /** @internal */
-    async refreshContainerSas(_userAccessToken) { }
+    async refreshContainer(_userAccessToken) { }
     /**
      * Called by derived classes before closing the connection
      * @internal
@@ -256,7 +266,7 @@ class IModelDb extends core_common_1.IModel {
     /** Return `true` if the underlying nativeDb is open and valid.
      * @internal
      */
-    get isOpen() { return undefined !== this.nativeDb; }
+    get isOpen() { return this.nativeDb.isOpen(); }
     /** Get the briefcase Id of this iModel */
     getBriefcaseId() { return this.isOpen ? this.nativeDb.getBriefcaseId() : core_common_1.BriefcaseIdValue.Illegal; }
     /**
@@ -332,9 +342,8 @@ class IModelDb extends core_common_1.IModel {
      * @public
      * */
     createQueryReader(ecsql, params, config) {
-        if (!this._nativeDb || !this._nativeDb.isOpen()) {
+        if (!this.nativeDb.isOpen())
             throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, "db not open");
-        }
         const executor = {
             execute: async (request) => {
                 return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this.nativeDb, request);
@@ -537,6 +546,7 @@ class IModelDb extends core_common_1.IModel {
     clearCaches() {
         this._statementCache.clear();
         this._sqliteStatementCache.clear();
+        this._classMetaDataRegistry = undefined;
     }
     /** Update the project extents for this iModel.
      * <p><em>Example:</em>
@@ -626,16 +636,34 @@ class IModelDb extends core_common_1.IModel {
      * @see querySchemaVersion
      */
     async importSchemas(schemaFileNames, options) {
-        if (this.nativeDb.getITwinId() !== core_bentley_1.Guid.empty) // if this iModel is associated with an iTwin, importing schema requires the schema lock
-            await this.acquireSchemaLock();
+        if (schemaFileNames.length === 0)
+            return;
         const maybeCustomNativeContext = options?.ecSchemaXmlContext?.nativeContext;
-        const nativeImportOptions = {
-            schemaLockHeld: true,
-            ecSchemaXmlContext: maybeCustomNativeContext,
-        };
-        const stat = this.nativeDb.importSchemas(schemaFileNames, nativeImportOptions);
-        if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat) {
-            throw new core_common_1.IModelError(stat, "Error importing schema");
+        if (this.nativeDb.schemaSyncEnabled()) {
+            await SchemaSync_1.SchemaSync.withLockedAccess(this, { openMode: core_bentley_1.OpenMode.Readonly, operationName: "schema sync" }, async (syncAccess) => {
+                const schemaSyncDbUri = syncAccess.getUri();
+                this.saveChanges();
+                let stat = this.nativeDb.importSchemas(schemaFileNames, { schemaLockHeld: false, ecSchemaXmlContext: maybeCustomNativeContext, schemaSyncDbUri });
+                if (core_bentley_1.DbResult.BE_SQLITE_ERROR_SchemaLockFailed === stat) {
+                    this.abandonChanges();
+                    if (this.nativeDb.getITwinId() !== core_bentley_1.Guid.empty)
+                        await this.acquireSchemaLock();
+                    stat = this.nativeDb.importSchemas(schemaFileNames, { schemaLockHeld: true, ecSchemaXmlContext: maybeCustomNativeContext, schemaSyncDbUri });
+                }
+                if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat)
+                    throw new core_common_1.IModelError(stat, "Error importing schema");
+            });
+        }
+        else {
+            const nativeImportOptions = {
+                schemaLockHeld: true,
+                ecSchemaXmlContext: maybeCustomNativeContext,
+            };
+            if (this.nativeDb.getITwinId() !== core_bentley_1.Guid.empty) // if this iModel is associated with an iTwin, importing schema requires the schema lock
+                await this.acquireSchemaLock();
+            const stat = this.nativeDb.importSchemas(schemaFileNames, nativeImportOptions);
+            if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat)
+                throw new core_common_1.IModelError(stat, "Error importing schema");
         }
         this.clearCaches();
     }
@@ -649,11 +677,30 @@ class IModelDb extends core_common_1.IModel {
      * @alpha
      */
     async importSchemaStrings(serializedXmlSchemas) {
-        if (this.iTwinId && this.iTwinId !== core_bentley_1.Guid.empty) // if this iModel is associated with an iTwin, importing schema requires the schema lock
-            await this.acquireSchemaLock();
-        const stat = this.nativeDb.importXmlSchemas(serializedXmlSchemas, { schemaLockHeld: true });
-        if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat)
-            throw new core_common_1.IModelError(stat, "Error importing schema");
+        if (serializedXmlSchemas.length === 0)
+            return;
+        if (this.nativeDb.schemaSyncEnabled()) {
+            await SchemaSync_1.SchemaSync.withLockedAccess(this, { openMode: core_bentley_1.OpenMode.Readonly, operationName: "schemaSync" }, async (syncAccess) => {
+                const schemaSyncDbUri = syncAccess.getUri();
+                this.saveChanges();
+                let stat = this.nativeDb.importXmlSchemas(serializedXmlSchemas, { schemaLockHeld: false, schemaSyncDbUri });
+                if (core_bentley_1.DbResult.BE_SQLITE_ERROR_SchemaLockFailed === stat) {
+                    this.abandonChanges();
+                    if (this.nativeDb.getITwinId() !== core_bentley_1.Guid.empty)
+                        await this.acquireSchemaLock();
+                    stat = this.nativeDb.importXmlSchemas(serializedXmlSchemas, { schemaLockHeld: true, schemaSyncDbUri });
+                }
+                if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat)
+                    throw new core_common_1.IModelError(stat, "Error importing schema");
+            });
+        }
+        else {
+            if (this.iTwinId && this.iTwinId !== core_bentley_1.Guid.empty) // if this iModel is associated with an iTwin, importing schema requires the schema lock
+                await this.acquireSchemaLock();
+            const stat = this.nativeDb.importXmlSchemas(serializedXmlSchemas, { schemaLockHeld: true });
+            if (core_bentley_1.DbResult.BE_SQLITE_OK !== stat)
+                throw new core_common_1.IModelError(stat, "Error importing schema");
+        }
         this.clearCaches();
     }
     /** Find an opened instance of any subclass of IModelDb, by filename
@@ -1094,6 +1141,16 @@ class IModelDb extends core_common_1.IModel {
             }
         });
     }
+    /**
+     * Controls how [Code]($common)s are copied from this iModel into another iModel, to work around problems with iModels created by older connectors. The [imodel-transformer](https://github.com/iTwin/imodel-transformer) sets this appropriately on your behalf - you should never need to set or interrogate this property yourself.
+     * @public
+     */
+    get codeValueBehavior() {
+        return this.nativeDb.getCodeValueBehavior();
+    }
+    set codeValueBehavior(newBehavior) {
+        this.nativeDb.setCodeValueBehavior(newBehavior);
+    }
 }
 /** Keep track of open imodels to support `tryFind` for RPC purposes */
 IModelDb._openDbs = new Map();
@@ -1692,18 +1749,77 @@ exports.IModelDb = IModelDb;
             }
             return this._queryAspect(aspectInstanceId, aspectClassFullName);
         }
+        runInstanceQuery(sql, elementId, excludedClassFullNames) {
+            return this._iModel.withPreparedStatement(sql, (statement) => {
+                statement.bindId("elementId", elementId);
+                const aspects = [];
+                while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
+                    const row = {};
+                    const parsedRow = JSON.parse(statement.getValue(0).getString());
+                    // eslint-disable-next-line guard-for-in
+                    for (const key in parsedRow) {
+                        const jsName = core_common_1.ECJsNames.toJsName(key[0].toUpperCase() + key.substring(1));
+                        Object.defineProperty(row, jsName, { enumerable: true, configurable: true, writable: true, value: parsedRow[key] });
+                    }
+                    const aspectProps = row;
+                    aspectProps.classFullName = aspectProps.className.replace(".", ":"); // add in property required by EntityProps
+                    aspectProps.className = undefined; // clear property from SELECT $ that we don't want in the final instance
+                    if ((undefined === excludedClassFullNames) || !excludedClassFullNames.has(aspectProps.classFullName))
+                        aspects.push(this._iModel.constructEntity(aspectProps));
+                }
+                return aspects;
+            });
+        }
         /** Get the ElementAspect instances that are owned by the specified element.
          * @param elementId Get ElementAspects associated with this Element
          * @param aspectClassFullName Optionally filter ElementAspects polymorphically by this class name
+         * @param excludedClassFullNames Optional filter to exclude aspects from classes in the given set.
          * @throws [[IModelError]]
          */
-        getAspects(elementId, aspectClassFullName) {
-            if (undefined === aspectClassFullName) {
-                const uniqueAspects = this._queryAspects(elementId, ElementAspect_1.ElementUniqueAspect.classFullName);
-                const multiAspects = this._queryAspects(elementId, ElementAspect_1.ElementMultiAspect.classFullName);
-                return uniqueAspects.concat(multiAspects);
+        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
+          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}`);
+                return allAspects;
             }
-            const aspects = this._queryAspects(elementId, aspectClassFullName);
+            // Check if class is abstract
+            const fullClassName = aspectClassFullName.split(":");
+            const val = this._iModel.nativeDb.getECClassMetaData(fullClassName[0], fullClassName[1]);
+            if (val.result !== undefined) {
+                const metaData = new core_common_1.EntityMetaData(JSON.parse(val.result));
+                if (metaData.modifier !== "Abstract") // Class is not abstract, use normal query to retrieve aspects
+                    return this._queryAspects(elementId, aspectClassFullName, excludedClassFullNames);
+            }
+            // If class specified is abstract, get the list of all classes derived from it
+            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]}'
+        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());
+                });
+                if (classIds.length > 0) {
+                    classIdList = classIds.join(",");
+                    IModelDb.Elements.classMap.set(aspectClassFullName, classIdList);
+                }
+            }
+            if (classIdList === undefined) {
+                core_bentley_1.Logger.logError(BackendLoggerCategory_1.BackendLoggerCategory.ECDb, `No aspects found for the class ${aspectClassFullName}`);
+                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})
+        ) 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}`);
             return aspects;
         }
         /** Insert a new ElementAspect into the iModel.
@@ -1749,6 +1865,7 @@ exports.IModelDb = IModelDb;
             });
         }
     }
+    Elements.classMap = new Map();
     IModelDb.Elements = Elements;
     /** The collection of views in an [[IModelDb]].
      * @public
@@ -1928,8 +2045,10 @@ exports.IModelDb = IModelDb;
             this._iModel.nativeDb.saveFileProperty(viewArg, JSON.stringify(props), thumbnail.image);
             return 0;
         }
-        /** Set the default view property the iModel
+        /** Set the default view property the iModel.
          * @param viewId The Id of the ViewDefinition to use as the default
+         * @deprecated in 4.2.x. Avoid setting this property - it is not practical for one single view to serve the needs of the many applications
+         * that might wish to view the contents of the iModel.
          */
         setDefaultViewId(viewId) {
             const spec = { namespace: "dgn_View", name: "DefaultView" };
@@ -2110,12 +2229,20 @@ class BriefcaseDb extends IModelDb {
         const openMode = (args.readonly || args.watchForChanges) ? core_bentley_1.OpenMode.Readonly : core_bentley_1.OpenMode.ReadWrite;
         const nativeDb = this.openDgnDb(file, openMode, undefined, args);
         const briefcaseDb = new BriefcaseDb({ nativeDb, key: file.key ?? core_bentley_1.Guid.createValue(), openMode, briefcaseId: nativeDb.getBriefcaseId() });
-        // If they asked to watch for changes, set an fs.watch on the "-wal" file (only it is modified while we hold this connection.)
+        // If they asked to watch for changes, set an fs.watch on the "-watch" file (only it is modified while we hold this connection.)
         // Whenever there are changes, restart our defaultTxn. That loads the changes from the other connection and sends
         // notifications as if they happened on this connection. Note: the watcher is called only when the backend event loop cycles.
         if (args.watchForChanges && undefined === args.container) {
-            const watcher = fs.watch(`${file.path}-wal`, { persistent: false }, () => nativeDb.restartDefaultTxn());
-            briefcaseDb.onBeforeClose.addOnce(() => watcher.close()); // Stop the watcher when we close this connection.
+            // Must touch the file synchronously - cannot watch a file until it exists.
+            touch.sync(briefcaseDb.watchFilePathName);
+            // Restart default txn to trigger events when watch file is changed by some other process.
+            const watcher = fs.watch(briefcaseDb.watchFilePathName, { persistent: false }, () => {
+                nativeDb.restartDefaultTxn();
+            });
+            // Stop the watcher when we close this connection.
+            briefcaseDb.onBeforeClose.addOnce(() => {
+                watcher.close();
+            });
         }
         if (openMode === core_bentley_1.OpenMode.ReadWrite && CodeService_1.CodeService.createForIModel) {
             try {
@@ -2130,23 +2257,39 @@ class BriefcaseDb extends IModelDb {
         this.onOpened.raiseEvent(briefcaseDb, args);
         return briefcaseDb;
     }
-    closeAndReopen(openMode) {
+    /** If the briefcase is read-only, reopen the native briefcase for writing.
+     * Execute the supplied function.
+     * If the briefcase was read-only, reopen the native briefcase as read-only.
+     * @note this._openMode is not changed from its initial value.
+     * @internal Exported strictly for tests.
+     */
+    async executeWritable(func) {
         const fileName = this.pathName;
+        try {
+            if (this.isReadonly)
+                this.closeAndReopen(core_bentley_1.OpenMode.ReadWrite, fileName);
+            await func();
+        }
+        finally {
+            if (this.isReadonly)
+                this.closeAndReopen(core_bentley_1.OpenMode.Readonly, fileName);
+        }
+    }
+    closeAndReopen(openMode, fileName) {
+        // Unclosed statements will produce BUSY error when attempting to close.
+        this.clearCaches();
+        // The following resets the native db's pointer to this JavaScript object.
         this.nativeDb.closeIModel();
         this.nativeDb.openIModel(fileName, openMode);
+        // Restore the native db's pointer to this JavaScript object.
+        this.nativeDb.setIModelDb(this);
     }
     /** Pull and apply changesets from iModelHub */
     async pullChanges(arg) {
-        if (this.isReadonly) // we allow pulling changes into a briefcase that is readonly - close and reopen it writeable
-            this.closeAndReopen(core_bentley_1.OpenMode.ReadWrite);
-        try {
+        await this.executeWritable(async () => {
             await BriefcaseManager_1.BriefcaseManager.pullAndApplyChangesets(this, arg ?? {});
             this.initializeIModelDb();
-        }
-        finally {
-            if (this.isReadonly) // if the briefcase was opened readonly - close and reopen it readonly
-                this.closeAndReopen(core_bentley_1.OpenMode.Readonly);
-        }
+        });
         IpcHost_1.IpcHost.notifyTxns(this, "notifyPulledChanges", this.changeset);
     }
     /** Push changes to iModelHub. */
@@ -2354,18 +2497,26 @@ class SnapshotDb extends IModelDb {
             snapshot.close();
             throw err;
         }
+        // unref timer, so it doesn't prevent a process from shutting down.
+        snapshot._restartDefaultTxnTimer = setTimeout(() => {
+            snapshot.restartDefaultTxn();
+        }, (10 * 60) * 1000).unref(); // 10 * 60 is 10 minutes in seconds, then converted to milliseconds (* 1000);
         snapshot._refreshSas = new RefreshV2CheckpointSas(container.accessToken, checkpoint.reattachSafetySeconds);
         return snapshot;
     }
-    /** Used to refresh the container sasToken using the current user's accessToken
+    /** Used to refresh the container sasToken using the current user's accessToken.
+     * Also restarts the timer which causes the default txn to be restarted on db if the timer activates.
      * @internal
      */
-    async refreshContainerSas(userAccessToken) {
+    async refreshContainer(userAccessToken) {
+        this._restartDefaultTxnTimer?.refresh();
         return this._refreshSas?.refreshSas(userAccessToken, this);
     }
     /** @internal */
     beforeClose() {
         super.beforeClose();
+        if (this._restartDefaultTxnTimer)
+            clearTimeout(this._restartDefaultTxnTimer);
         if (this._createClassViewsOnClose) { // check for flag set during create
             if (core_bentley_1.BentleyStatus.SUCCESS !== this.nativeDb.createClassViewsInDb()) {
                 throw new core_common_1.IModelError(core_bentley_1.IModelStatus.SQLiteError, "Error creating class views");