@itwin/core-backend 5.1.0-dev.0 → 5.1.0-dev.10

package/lib/esm/IModelDb.js

@@ -8,8 +8,8 @@
 import * as fs from "fs";
 import { join } from "path";
 import * as touch from "touch";
-import { assert, BeEvent, BentleyStatus, ChangeSetStatus, DbChangeStage, DbConflictCause, DbConflictResolution, DbResult, Guid, Id64, IModelStatus, JsonUtils, Logger, LogLevel, OpenMode, } from "@itwin/core-bentley";
-import { BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryRowFormat, SchemaState, ViewStoreRpc, } from "@itwin/core-common";
+import { assert, BeEvent, BentleyStatus, ChangeSetStatus, DbChangeStage, DbConflictCause, DbConflictResolution, DbResult, Guid, Id64, IModelStatus, JsonUtils, Logger, LogLevel, LRUMap, OpenMode } from "@itwin/core-bentley";
+import { BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryRowFormat, SchemaState, ViewStoreRpc } from "@itwin/core-common";
 import { Range2d, Range3d } from "@itwin/core-geometry";
 import { BackendLoggerCategory } from "./BackendLoggerCategory";
 import { BriefcaseManager } from "./BriefcaseManager";
@@ -44,9 +44,10 @@ import { SettingsImpl } from "./internal/workspace/SettingsImpl";
 import { IModelNative } from "./internal/NativePlatform";
 import { createNoOpLockControl } from "./internal/NoLocks";
 import { createIModelDbFonts } from "./internal/IModelDbFontsImpl";
-import { _close, _hubAccess, _nativeDb, _releaseAllLocks } from "./internal/Symbols";
+import { _cache, _close, _hubAccess, _nativeDb, _releaseAllLocks } from "./internal/Symbols";
 import { SchemaContext, SchemaJsonLocater } from "@itwin/ecschema-metadata";
 import { SchemaMap } from "./Schema";
+import { ElementLRUCache } from "./internal/ElementLRUCache";
 // spell:ignore fontid fontmap
 const loggerCategory = BackendLoggerCategory.IModelDb;
 /** @internal */
@@ -576,6 +577,8 @@ export class IModelDb extends IModel {
         this._jsClassMap = undefined;
         this._schemaMap = undefined;
         this._schemaContext = undefined;
+        this.elements[_cache].clear();
+        this.models[_cache].clear();
     }
     /** Update the project extents for this iModel.
      * <p><em>Example:</em>
@@ -976,6 +979,24 @@ export class IModelDb extends IModel {
             return ClassRegistry.getClass(classFullName, this);
         }
     }
+    /** Constructs a ResolveInstanceKeyArgs from given parameters
+     * @throws [[IModelError]] if the combination of supplied parameters is invalid.
+     * @internal
+     */
+    getInstanceArgs(instanceId, baseClassName, federationGuid, code) {
+        if (instanceId && baseClassName) {
+            return { partialKey: { id: instanceId, baseClassName } };
+        }
+        else if (federationGuid) {
+            return { federationGuid };
+        }
+        else if (code) {
+            return { code };
+        }
+        else {
+            throw new IModelError(IModelStatus.InvalidId, "Either instanceId and baseClassName or federationGuid or code must be specified");
+        }
+    }
     /** Get metadata for a class. This method will load the metadata from the iModel into the cache as a side-effect, if necessary.
      * @throws [[IModelError]] if the metadata cannot be found nor loaded.
      * @deprecated in 5.0. Please use `getSchemaItem` from `SchemaContext` class instead.
@@ -1457,6 +1478,9 @@ function processSchemaWriteStatus(status) {
      */
     class Models {
         _iModel;
+        _modelCacheSize = 10;
+        /** @internal */
+        [_cache] = new LRUMap(this._modelCacheSize);
         /** @internal */
         constructor(_iModel) {
             this._iModel = _iModel;
@@ -1467,7 +1491,10 @@ function processSchemaWriteStatus(status) {
          * @see tryGetModelProps
          */
         getModelProps(id) {
-            return this.getModelJson({ id });
+            const model = this.tryGetModelProps(id);
+            if (undefined === model)
+                throw new IModelError(IModelStatus.NotFound, `Model=${id}`);
+            return model;
         }
         /** Get the ModelProps with the specified identifier.
          * @param modelId The Model identifier.
@@ -1477,7 +1504,25 @@ function processSchemaWriteStatus(status) {
          * @see getModelProps
          */
         tryGetModelProps(id) {
-            return this.tryGetModelJson({ id });
+            try {
+                if (IModelHost.configuration?.disableThinnedNativeInstanceWorkflow) {
+                    return this._iModel[_nativeDb].getModel({ id });
+                }
+                const cachedMdl = this[_cache].get(id);
+                if (cachedMdl) {
+                    return cachedMdl;
+                }
+                const options = { useJsNames: true };
+                const instanceKey = this.resolveModelKey({ id });
+                const rawInstance = this._iModel[_nativeDb].readInstance(instanceKey, options);
+                const classDef = this._iModel.getJsClass(rawInstance.classFullName);
+                const modelProps = classDef.deserialize({ row: rawInstance, iModel: this._iModel });
+                this[_cache].set(id, modelProps);
+                return modelProps;
+            }
+            catch {
+                return undefined;
+            }
         }
         /** Query for the last modified time for a [[Model]].
          * @param modelId The Id of the model.
@@ -1524,32 +1569,22 @@ function processSchemaWriteStatus(status) {
                 return model; // modelClass was not specified, cannot call instanceof to validate
             return model instanceof modelClass ? model : undefined;
         }
-        /** Read the properties for a Model as a json string.
-         * @param modelIdArg a json string with the identity of the model to load. Must have either "id" or "code".
-         * @returns a json string with the properties of the model.
-         * @throws [[IModelError]] if the model is not found or cannot be loaded.
-         * @see tryGetModelJson
-         * @internal
-         */
-        getModelJson(modelIdArg) {
-            const modelJson = this.tryGetModelJson(modelIdArg);
-            if (undefined === modelJson) {
-                throw new IModelError(IModelStatus.NotFound, `Model=(id: ${modelIdArg.id}, code: ${modelIdArg.code})`);
+        resolveModelKey(modelIdArg) {
+            const baseClassName = "BisCore:Model";
+            let args;
+            if (modelIdArg.id) {
+                args = { partialKey: { id: modelIdArg.id, baseClassName } };
             }
-            return modelJson;
-        }
-        /** Read the properties for a Model as a json string.
-         * @param modelIdArg a json string with the identity of the model to load. Must have either "id" or "code".
-         * @returns a json string with the properties of the model or `undefined` if the model is not found.
-         * @see getModelJson
-         */
-        tryGetModelJson(modelIdArg) {
-            try {
-                return this._iModel[_nativeDb].getModel(modelIdArg);
+            else if (modelIdArg.code) {
+                const modelId = this._iModel.elements.getElementProps({ code: modelIdArg.code }).id;
+                if (!modelId)
+                    throw new IModelError(IModelStatus.NotFound, `Model not found with code: [spec:${modelIdArg.code.spec}, scope:${modelIdArg.code.scope}, value:${modelIdArg.code.value}])`);
+                args = { partialKey: { id: modelId, baseClassName } };
             }
-            catch {
-                return undefined;
+            else {
+                throw new IModelError(IModelStatus.InvalidId, `Invalid model identifier: ${JSON.stringify(modelIdArg)}`);
             }
+            return this._iModel[_nativeDb].resolveInstanceKey(args);
         }
         /** Get the sub-model of the specified Element.
          * See [[IModelDb.Elements.queryElementIdByCode]] for more on how to find an element by Code.
@@ -1602,6 +1637,8 @@ function processSchemaWriteStatus(status) {
          */
         updateModel(props) {
             try {
+                if (props.id)
+                    this[_cache].delete(props.id);
                 this._iModel[_nativeDb].updateModel(props);
             }
             catch (err) {
@@ -1618,6 +1655,7 @@ function processSchemaWriteStatus(status) {
          * @see [[TxnManager.onModelGeometryChanged]] for the event emitted in response to such a change.
          */
         updateGeometryGuid(modelId) {
+            this._iModel.models[_cache].delete(modelId);
             const error = this._iModel[_nativeDb].updateModelGeometryGuid(modelId);
             if (error !== IModelStatus.Success)
                 throw new IModelError(error, `updating geometry guid for model ${modelId}`);
@@ -1629,6 +1667,7 @@ function processSchemaWriteStatus(status) {
         deleteModel(ids) {
             Id64.toIdSet(ids).forEach((id) => {
                 try {
+                    this[_cache].delete(id);
                     this._iModel[_nativeDb].deleteModel(id);
                 }
                 catch (err) {
@@ -1666,6 +1705,9 @@ function processSchemaWriteStatus(status) {
      */
     class Elements {
         _iModel;
+        _elementCacheSize = 50;
+        /** @internal */
+        [_cache] = new ElementLRUCache(this._elementCacheSize);
         /** @internal */
         constructor(_iModel) {
             this._iModel = _iModel;
@@ -1682,50 +1724,40 @@ function processSchemaWriteStatus(status) {
                 return !stmt.nextRow() ? undefined : stmt.getValueId(0);
             }) : undefined;
         }
-        /** Read element data from the iModel as JSON
-         * @param elementIdArg a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
-         * @returns The JSON properties of the element.
-         * @throws [[IModelError]] if the element is not found or cannot be loaded.
-         * @see tryGetElementJson
-         * @internal
-         */
-        getElementJson(elementId) {
-            const elementProps = this.tryGetElementJson(elementId);
-            if (undefined === elementProps)
-                throw new IModelError(IModelStatus.NotFound, `reading element={id: ${elementId.id} federationGuid: ${elementId.federationGuid}, code: ${elementId.code}}`);
-            return elementProps;
-        }
-        /** Read element data from the iModel as JSON
-         * @param loadProps - a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
-         * @returns The JSON properties of the element or `undefined` if the element is not found.
-         * @throws [[IModelError]] if the element exists, but cannot be loaded.
-         * @see getElementJson
-         */
-        tryGetElementJson(loadProps) {
-            try {
-                return this._iModel[_nativeDb].getElement(loadProps);
-            }
-            catch {
-                return undefined;
-            }
-        }
         /** Get properties of an Element by Id, FederationGuid, or Code
          * @throws [[IModelError]] if the element is not found or cannot be loaded.
          * @see tryGetElementProps
          */
         getElementProps(props) {
+            const elProp = this.tryGetElementProps(props);
+            if (undefined === elProp)
+                throw new IModelError(IModelStatus.NotFound, `element not found`);
+            return elProp;
+        }
+        resolveElementKey(props) {
+            const baseClassName = "BisCore:Element";
+            let args;
             if (typeof props === "string") {
-                props = Id64.isId64(props) ? { id: props } : { federationGuid: props };
+                args = Id64.isId64(props) ? { partialKey: { id: props, baseClassName } } : { federationGuid: props };
             }
             else if (props instanceof Code) {
-                props = { code: props };
+                args = { code: props };
             }
-            try {
-                return this._iModel[_nativeDb].getElement(props);
-            }
-            catch (err) {
-                throw new IModelError(err.errorNumber, err.message);
+            else {
+                if (props.id) {
+                    args = { partialKey: { id: props.id, baseClassName } };
+                }
+                else if (props.federationGuid) {
+                    args = { federationGuid: props.federationGuid };
+                }
+                else if (props.code) {
+                    args = { code: props.code };
+                }
+                else {
+                    throw new IModelError(IModelStatus.InvalidId, "Element Id or FederationGuid or Code is required");
+                }
             }
+            return this._iModel[_nativeDb].resolveInstanceKey(args);
         }
         /** Get properties of an Element by Id, FederationGuid, or Code
          * @returns The properties of the element or `undefined` if the element is not found.
@@ -1733,14 +1765,32 @@ function processSchemaWriteStatus(status) {
          * @note Useful for cases when an element may or may not exist and throwing an `Error` would be overkill.
          * @see getElementProps
          */
-        tryGetElementProps(elementId) {
-            if (typeof elementId === "string") {
-                elementId = Id64.isId64(elementId) ? { id: elementId } : { federationGuid: elementId };
+        tryGetElementProps(props) {
+            if (typeof props === "string") {
+                props = Id64.isId64(props) ? { id: props } : { federationGuid: props };
             }
-            else if (elementId instanceof Code) {
-                elementId = { code: elementId };
+            else if (props instanceof Code) {
+                props = { code: props };
+            }
+            try {
+                if (IModelHost.configuration?.disableThinnedNativeInstanceWorkflow) {
+                    return this._iModel[_nativeDb].getElement(props);
+                }
+                const cachedElm = this[_cache].get(props);
+                if (cachedElm) {
+                    return cachedElm.elProps;
+                }
+                const options = { ...props, useJsNames: true };
+                const instanceKey = this.resolveElementKey(props);
+                const rawInstance = this._iModel[_nativeDb].readInstance(instanceKey, options);
+                const classDef = this._iModel.getJsClass(rawInstance.classFullName);
+                const elementProps = classDef.deserialize({ row: rawInstance, iModel: this._iModel, options: { element: props } });
+                this[_cache].set({ elProps: elementProps, loadOptions: props });
+                return elementProps;
+            }
+            catch {
+                return undefined;
             }
-            return this.tryGetElementJson(elementId);
         }
         /** Get an element by Id, FederationGuid, or Code
          * @param elementId either the element's Id, Code, or FederationGuid, or an ElementLoadProps
@@ -1773,7 +1823,7 @@ function processSchemaWriteStatus(status) {
                 elementId = { code: elementId };
             else
                 elementId.onlyBaseProperties = false; // we must load all properties to construct the element.
-            const elementProps = this.tryGetElementJson(elementId);
+            const elementProps = this.tryGetElementProps(elementId);
             if (undefined === elementProps)
                 return undefined; // no Element with that elementId found
             const element = this._iModel.constructEntity(elementProps);
@@ -1837,6 +1887,11 @@ function processSchemaWriteStatus(status) {
          */
         insertElement(elProps, options) {
             try {
+                this[_cache].delete({
+                    id: elProps.id,
+                    federationGuid: elProps.federationGuid,
+                    code: elProps.code,
+                });
                 return elProps.id = this._iModel[_nativeDb].insertElement(elProps, options);
             }
             catch (err) {
@@ -1858,6 +1913,11 @@ function processSchemaWriteStatus(status) {
          */
         updateElement(elProps) {
             try {
+                this[_cache].delete({
+                    id: elProps.id,
+                    federationGuid: elProps.federationGuid,
+                    code: elProps.code,
+                });
                 this._iModel[_nativeDb].updateElement(elProps);
             }
             catch (err) {
@@ -1875,6 +1935,7 @@ function processSchemaWriteStatus(status) {
             const iModel = this._iModel;
             Id64.toIdSet(ids).forEach((id) => {
                 try {
+                    this[_cache].delete({ id });
                     iModel[_nativeDb].deleteElement(id);
                 }
                 catch (err) {
@@ -2094,9 +2155,9 @@ function processSchemaWriteStatus(status) {
          */
         getAspects(elementId, aspectClassFullName, excludedClassFullNames) {
             if (aspectClassFullName === undefined) {
-                const allAspects = this.runInstanceQuery(`SELECT $ FROM (
-          SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId
-            UNION ALL
+                const allAspects = this.runInstanceQuery(`SELECT $ FROM (
+          SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId
+            UNION ALL
           SELECT ECInstanceId, ECClassId FROM Bis.ElementUniqueAspect WHERE Element.Id = :elementId) OPTIONS USE_JS_PROP_NAMES DO_NOT_TRUNCATE_BLOB`, elementId, excludedClassFullNames);
                 if (allAspects.length === 0)
                     Logger.logInfo(BackendLoggerCategory.ECDb, `No aspects found for class ${aspectClassFullName} and element ${elementId}`);
@@ -2116,7 +2177,7 @@ function processSchemaWriteStatus(status) {
             if (classIdList === undefined) {
                 const classIds = [];
                 // eslint-disable-next-line @typescript-eslint/no-deprecated
-                this._iModel.withPreparedStatement(`select SourceECInstanceId from meta.ClassHasAllBaseClasses where TargetECInstanceId = (select ECInstanceId from meta.ECClassDef where Name='${fullClassName[1]}'
+                this._iModel.withPreparedStatement(`select SourceECInstanceId from meta.ClassHasAllBaseClasses where TargetECInstanceId = (select ECInstanceId from meta.ECClassDef where Name='${fullClassName[1]}'
         and Schema.Id = (select ECInstanceId from meta.ECSchemaDef where Name='${fullClassName[0]}')) and SourceECInstanceId != TargetECInstanceId`, 
                 // eslint-disable-next-line @typescript-eslint/no-deprecated
                 (statement) => {
@@ -2133,10 +2194,10 @@ function processSchemaWriteStatus(status) {
                 return [];
             }
             // Execute an instance query to retrieve all aspects from all the derived classes
-            const aspects = this.runInstanceQuery(`SELECT $ FROM (
-        SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
-          UNION ALL
-        SELECT ECInstanceId, ECClassId FROM Bis.ElementUniqueAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
+            const aspects = this.runInstanceQuery(`SELECT $ FROM (
+        SELECT ECInstanceId, ECClassId FROM Bis.ElementMultiAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
+          UNION ALL
+        SELECT ECInstanceId, ECClassId FROM Bis.ElementUniqueAspect WHERE Element.Id = :elementId AND ECClassId IN (${classIdList})
         ) OPTIONS USE_JS_PROP_NAMES DO_NOT_TRUNCATE_BLOB`, elementId, excludedClassFullNames);
             if (aspects.length === 0)
                 Logger.logInfo(BackendLoggerCategory.ECDb, `No aspects found for class ${aspectClassFullName} and element ${elementId}`);
@@ -2377,9 +2438,9 @@ function processSchemaWriteStatus(status) {
     }
     IModelDb.Views = Views;
     /** Represents the current state of a pollable tile content request.
-   * Note: lack of a "completed" state because polling a completed request returns the content as a Uint8Array.
-   * @internal
-   */
+    * Note: lack of a "completed" state because polling a completed request returns the content as a Uint8Array.
+    * @internal
+    */
     let TileContentState;
     (function (TileContentState) {
         TileContentState[TileContentState["New"] = 0] = "New";
@@ -2628,6 +2689,7 @@ export class BriefcaseDb extends IModelDb {
             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.clearECDbCache();
                 nativeDb.restartDefaultTxn();
                 briefcaseDb.changeset = briefcaseDb[_nativeDb].getCurrentChangeset();
             });