@itwin/presentation-frontend 4.5.0-dev.2 → 4.5.0-dev.21

package/lib/esm/presentation-frontend/PresentationManager.js

@@ -1,7 +1,7 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
 /** @packageDocumentation
  * @module Core
  */
@@ -30,7 +30,9 @@ export class PresentationManager {
     get activeUnitSystem() {
         return this._explicitActiveUnitSystem ?? IModelApp.quantityFormatter.activeUnitSystem;
     }
-    set activeUnitSystem(value) { this._explicitActiveUnitSystem = value; }
+    set activeUnitSystem(value) {
+        this._explicitActiveUnitSystem = value;
+    }
     constructor(props) {
         /**
          * An event raised when hierarchies created using specific ruleset change
@@ -51,11 +53,11 @@ export class PresentationManager {
             // eslint-disable-next-line deprecation/deprecation
             this._explicitActiveUnitSystem = props.activeUnitSystem;
         }
-        this._requestsHandler = props?.rpcRequestsHandler ?? new RpcRequestsHandler(props ? { clientId: props.clientId, timeout: props.requestTimeout } : undefined);
+        this._requestsHandler =
+            props?.rpcRequestsHandler ?? new RpcRequestsHandler(props ? { clientId: props.clientId, timeout: props.requestTimeout } : undefined);
         this._rulesetVars = new Map();
         this._rulesets = RulesetManagerImpl.create();
         this._localizationHelper = new FrontendLocalizationHelper(props?.activeLocale);
-        this._connections = new Map();
         this._schemaContextProvider = props?.schemaContextProvider;
         this._defaultFormats = props?.defaultFormats;
         if (IpcApp.isValid) {
@@ -65,41 +67,38 @@ export class PresentationManager {
         }
     }
     /** Get / set active locale used for localizing presentation data */
-    get activeLocale() { return this._localizationHelper.locale; }
-    set activeLocale(locale) { this._localizationHelper.locale = locale; }
+    get activeLocale() {
+        return this._localizationHelper.locale;
+    }
+    set activeLocale(locale) {
+        this._localizationHelper.locale = locale;
+    }
     dispose() {
         if (this._clearEventListener) {
             this._clearEventListener();
             this._clearEventListener = undefined;
         }
     }
-    async onConnection(imodel) {
-        if (!this._connections.has(imodel))
-            this._connections.set(imodel, this.initializeIModel(imodel));
-        await this._connections.get(imodel);
-    }
-    async initializeIModel(imodel) {
-        imodel.onClose.addOnce(() => {
-            this._connections.delete(imodel);
-        });
-        await this.onNewiModelConnection(imodel);
-    }
     /** @note This is only called in native apps after changes in iModels */
     async handleUpdateAsync(report) {
         for (const imodelKey in report) {
             // istanbul ignore if
-            if (!report.hasOwnProperty(imodelKey))
+            if (!report.hasOwnProperty(imodelKey)) {
                 continue;
+            }
             const imodelReport = report[imodelKey];
             for (const rulesetId in imodelReport) {
                 // istanbul ignore if
-                if (!imodelReport.hasOwnProperty(rulesetId))
+                if (!imodelReport.hasOwnProperty(rulesetId)) {
                     continue;
+                }
                 const updateInfo = imodelReport[rulesetId];
-                if (updateInfo.content)
+                if (updateInfo.content) {
                     this.onIModelContentChanged.raiseEvent({ rulesetId, updateInfo: updateInfo.content, imodelKey });
-                if (updateInfo.hierarchy)
+                }
+                if (updateInfo.hierarchy) {
                     this.onIModelHierarchyChanged.raiseEvent({ rulesetId, updateInfo: updateInfo.hierarchy, imodelKey });
+                }
             }
         }
     }
@@ -107,7 +106,13 @@ export class PresentationManager {
      * Function that is called when a new IModelConnection is used to retrieve data.
      * @internal
      */
-    async onNewiModelConnection(_) { }
+    startIModelInitialization(_) { }
+    /**
+     * Function that should be called to finish initialization that was started at [[PresentationManager.startIModelInitialization]].
+     * Can be removed when [[FavoritePropertiesManager.has]] and [[FavoritePropertiesManager.sortFields]] are removed.
+     * @internal
+     */
+    async ensureIModelInitialized(_) { }
     /**
      * Create a new PresentationManager instance
      * @param props Optional properties used to configure the manager
@@ -116,13 +121,19 @@ export class PresentationManager {
         return new PresentationManager(props);
     }
     /** @internal */
-    get rpcRequestsHandler() { return this._requestsHandler; }
+    get rpcRequestsHandler() {
+        return this._requestsHandler;
+    }
     /** @internal */
-    get ipcRequestsHandler() { return this._ipcRequestsHandler; }
+    get ipcRequestsHandler() {
+        return this._ipcRequestsHandler;
+    }
     /**
      * Get rulesets manager
      */
-    rulesets() { return this._rulesets; }
+    rulesets() {
+        return this._rulesets;
+    }
     /**
      * Get ruleset variables manager for specific ruleset
      * @param rulesetId Id of the ruleset to get the vars manager for
@@ -139,8 +150,9 @@ export class PresentationManager {
         // 2. put all `requestOptions` members (if `locale` or `unitSystem` are set, they'll override the defaults put at #1)
         // 3. put `imodel` of type `IModelRpcProps` which overwrites the `imodel` from `requestOptions` put at #2
         const defaultOptions = {};
-        if (this.activeLocale)
+        if (this.activeLocale) {
             defaultOptions.locale = this.activeLocale;
+        }
         defaultOptions.unitSystem = this.activeUnitSystem; // eslint-disable-line deprecation/deprecation
         const { imodel, rulesetVariables, ...rpcRequestOptions } = requestOptions;
         return {
@@ -160,13 +172,14 @@ export class PresentationManager {
             const foundRuleset = await this._rulesets.get(rulesetOrId);
             foundRulesetOrId = foundRuleset ? foundRuleset.toJSON() : rulesetOrId;
         }
-        const rulesetId = (typeof foundRulesetOrId === "object") ? foundRulesetOrId.id : foundRulesetOrId;
+        const rulesetId = typeof foundRulesetOrId === "object" ? foundRulesetOrId.id : foundRulesetOrId;
         // All Id64Array variable values must be sorted for serialization to JSON to work. RulesetVariablesManager
         // sorts them before storing, so that part is taken care of, but we need to ensure that variables coming from
         // request options are also sorted.
         const variables = (rulesetVariables ?? []).map((variable) => {
-            if (variable.type === VariableValueTypes.Id64Array)
+            if (variable.type === VariableValueTypes.Id64Array) {
                 return { ...variable, value: OrderedId64Iterable.sortArray(variable.value) };
+            }
             return variable;
         });
         if (!this._ipcRequestsHandler) {
@@ -178,7 +191,7 @@ export class PresentationManager {
     }
     /** Retrieves nodes */
     async getNodes(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions) => this._requestsHandler.getPagedNodes({ ...rpcOptions, paging: partialPageOptions }));
@@ -187,14 +200,14 @@ export class PresentationManager {
     }
     /** Retrieves nodes count. */
     async getNodesCount(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         return this._requestsHandler.getNodesCount(rpcOptions);
     }
     /** Retrieves total nodes count and a single page of nodes. */
     async getNodesAndCount(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions) => this._requestsHandler.getPagedNodes({ ...rpcOptions, paging: partialPageOptions }));
@@ -209,16 +222,21 @@ export class PresentationManager {
      * @beta
      */
     async getNodesDescriptor(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
-        const options = await this.addRulesetAndVariablesToOptions(requestOptions);
-        const rpcOptions = this.toRpcTokenOptions({ ...options });
-        const result = await this._requestsHandler.getNodesDescriptor(rpcOptions);
-        const descriptor = Descriptor.fromJSON(result);
-        return descriptor ? this._localizationHelper.getLocalizedContentDescriptor(descriptor) : undefined;
+        this.startIModelInitialization(requestOptions.imodel);
+        try {
+            const options = await this.addRulesetAndVariablesToOptions(requestOptions);
+            const rpcOptions = this.toRpcTokenOptions({ ...options });
+            const result = await this._requestsHandler.getNodesDescriptor(rpcOptions);
+            const descriptor = Descriptor.fromJSON(result);
+            return descriptor ? this._localizationHelper.getLocalizedContentDescriptor(descriptor) : undefined;
+        }
+        finally {
+            await this.ensureIModelInitialized(requestOptions.imodel);
+        }
     }
     /** Retrieves paths from root nodes to children nodes according to specified keys. Intersecting paths will be merged. */
     async getNodePaths(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         const result = await this._requestsHandler.getNodePaths(rpcOptions);
@@ -227,7 +245,7 @@ export class PresentationManager {
     }
     /** Retrieves paths from root nodes to nodes containing filter text in their label. */
     async getFilteredNodePaths(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const result = await this._requestsHandler.getFilteredNodePaths(this.toRpcTokenOptions(options));
         // eslint-disable-next-line deprecation/deprecation
@@ -239,26 +257,31 @@ export class PresentationManager {
      * @public
      */
     async getContentSources(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions(requestOptions);
         const result = await this._requestsHandler.getContentSources(rpcOptions);
         return SelectClassInfo.listFromCompressedJSON(result.sources, result.classesMap);
     }
     /** Retrieves the content descriptor which describes the content and can be used to customize it. */
     async getContentDescriptor(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
-        const options = await this.addRulesetAndVariablesToOptions(requestOptions);
-        const rpcOptions = this.toRpcTokenOptions({
-            ...options,
-            keys: stripTransientElementKeys(options.keys).toJSON(),
-        });
-        const result = await this._requestsHandler.getContentDescriptor(rpcOptions);
-        const descriptor = Descriptor.fromJSON(result);
-        return descriptor ? this._localizationHelper.getLocalizedContentDescriptor(descriptor) : undefined;
+        this.startIModelInitialization(requestOptions.imodel);
+        try {
+            const options = await this.addRulesetAndVariablesToOptions(requestOptions);
+            const rpcOptions = this.toRpcTokenOptions({
+                ...options,
+                keys: stripTransientElementKeys(options.keys).toJSON(),
+            });
+            const result = await this._requestsHandler.getContentDescriptor(rpcOptions);
+            const descriptor = Descriptor.fromJSON(result);
+            return descriptor ? this._localizationHelper.getLocalizedContentDescriptor(descriptor) : undefined;
+        }
+        finally {
+            await this.ensureIModelInitialized(requestOptions.imodel);
+        }
     }
     /** Retrieves overall content set size. */
     async getContentSetSize(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({
             ...options,
@@ -273,43 +296,49 @@ export class PresentationManager {
     }
     /** Retrieves content set size and content which consists of a content descriptor and a page of records. */
     async getContentAndSize(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
-        const options = await this.addRulesetAndVariablesToOptions(requestOptions);
-        const rpcOptions = this.toRpcTokenOptions({
-            ...options,
-            descriptor: getDescriptorOverrides(requestOptions.descriptor),
-            keys: stripTransientElementKeys(requestOptions.keys).toJSON(),
-            ...(!requestOptions.omitFormattedValues && this._schemaContextProvider !== undefined ? { omitFormattedValues: true } : undefined),
-        });
-        let descriptor = (requestOptions.descriptor instanceof Descriptor) ? requestOptions.descriptor : undefined;
-        const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions, requestIndex) => {
-            if (0 === requestIndex && !descriptor) {
-                const content = await this._requestsHandler.getPagedContent({ ...rpcOptions, paging: partialPageOptions });
-                if (content) {
-                    descriptor = Descriptor.fromJSON(content.descriptor);
-                    return content.contentSet;
+        this.startIModelInitialization(requestOptions.imodel);
+        try {
+            const options = await this.addRulesetAndVariablesToOptions(requestOptions);
+            const rpcOptions = this.toRpcTokenOptions({
+                ...options,
+                descriptor: getDescriptorOverrides(requestOptions.descriptor),
+                keys: stripTransientElementKeys(requestOptions.keys).toJSON(),
+                ...(!requestOptions.omitFormattedValues && this._schemaContextProvider !== undefined ? { omitFormattedValues: true } : undefined),
+            });
+            let descriptor = requestOptions.descriptor instanceof Descriptor ? requestOptions.descriptor : undefined;
+            const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions, requestIndex) => {
+                if (0 === requestIndex && !descriptor) {
+                    const content = await this._requestsHandler.getPagedContent({ ...rpcOptions, paging: partialPageOptions });
+                    if (content) {
+                        descriptor = Descriptor.fromJSON(content.descriptor);
+                        return content.contentSet;
+                    }
+                    return { total: 0, items: [] };
                 }
-                return { total: 0, items: [] };
+                return this._requestsHandler.getPagedContentSet({ ...rpcOptions, paging: partialPageOptions });
+            });
+            if (!descriptor) {
+                return undefined;
             }
-            return this._requestsHandler.getPagedContentSet({ ...rpcOptions, paging: partialPageOptions });
-        });
-        if (!descriptor)
-            return undefined;
-        const items = result.items.map((itemJson) => Item.fromJSON(itemJson)).filter((item) => (item !== undefined));
-        const resultContent = new Content(descriptor, items);
-        if (!requestOptions.omitFormattedValues && this._schemaContextProvider) {
-            const koqPropertyFormatter = new KoqPropertyValueFormatter(this._schemaContextProvider(requestOptions.imodel), this._defaultFormats);
-            const contentFormatter = new ContentFormatter(new ContentPropertyValueFormatter(koqPropertyFormatter), requestOptions.unitSystem ?? this._explicitActiveUnitSystem ?? IModelApp.quantityFormatter.activeUnitSystem);
-            await contentFormatter.formatContent(resultContent);
+            const items = result.items.map((itemJson) => Item.fromJSON(itemJson)).filter((item) => item !== undefined);
+            const resultContent = new Content(descriptor, items);
+            if (!requestOptions.omitFormattedValues && this._schemaContextProvider) {
+                const koqPropertyFormatter = new KoqPropertyValueFormatter(this._schemaContextProvider(requestOptions.imodel), this._defaultFormats);
+                const contentFormatter = new ContentFormatter(new ContentPropertyValueFormatter(koqPropertyFormatter), requestOptions.unitSystem ?? this._explicitActiveUnitSystem ?? IModelApp.quantityFormatter.activeUnitSystem);
+                await contentFormatter.formatContent(resultContent);
+            }
+            return {
+                size: result.total,
+                content: this._localizationHelper.getLocalizedContent(resultContent),
+            };
+        }
+        finally {
+            await this.ensureIModelInitialized(requestOptions.imodel);
         }
-        return {
-            size: result.total,
-            content: this._localizationHelper.getLocalizedContent(resultContent),
-        };
     }
     /** Retrieves distinct values of specific field from the content. */
     async getPagedDistinctValues(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = {
             ...this.toRpcTokenOptions(options),
@@ -328,11 +357,12 @@ export class PresentationManager {
      * @public
      */
     async getElementProperties(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const results = await this._requestsHandler.getElementProperties(this.toRpcTokenOptions(requestOptions));
         // istanbul ignore if
-        if (!results)
+        if (!results) {
             return undefined;
+        }
         return this._localizationHelper.getLocalizedElementProperties(results);
     }
     /**
@@ -340,7 +370,7 @@ export class PresentationManager {
      * @public
      */
     async getContentInstanceKeys(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = {
             ...this.toRpcTokenOptions(options),
@@ -365,25 +395,26 @@ export class PresentationManager {
     }
     /** Retrieves display label definition of specific item. */
     async getDisplayLabelDefinition(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions({ ...requestOptions });
         const result = await this._requestsHandler.getDisplayLabelDefinition(rpcOptions);
         return this._localizationHelper.getLocalizedLabelDefinition(result);
     }
     /** Retrieves display label definition of specific items. */
     async getDisplayLabelDefinitions(requestOptions) {
-        await this.onConnection(requestOptions.imodel);
+        this.startIModelInitialization(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions({ ...requestOptions });
         const result = await buildPagedArrayResponse(undefined, async (partialPageOptions) => {
-            const partialKeys = (!partialPageOptions.start) ? rpcOptions.keys : rpcOptions.keys.slice(partialPageOptions.start);
+            const partialKeys = !partialPageOptions.start ? rpcOptions.keys : rpcOptions.keys.slice(partialPageOptions.start);
             return this._requestsHandler.getPagedDisplayLabelDefinitions({ ...rpcOptions, keys: partialKeys });
         });
         return this._localizationHelper.getLocalizedLabelDefinitions(result.items);
     }
 }
 const getDescriptorOverrides = (descriptorOrOverrides) => {
-    if (descriptorOrOverrides instanceof Descriptor)
+    if (descriptorOrOverrides instanceof Descriptor) {
         return descriptorOrOverrides.createDescriptorOverrides();
+    }
     return descriptorOrOverrides;
 };
 async function createPagedGeneratorResponse(props) {
@@ -401,14 +432,17 @@ async function createPagedGeneratorResponse(props) {
                 }
                 const receivedItemsCount = partialResult.items.length;
                 if (partialResult.total !== 0 && receivedItemsCount === 0) {
-                    if (pageStart >= partialResult.total)
+                    if (pageStart >= partialResult.total) {
                         throw new Error(`Requested page with start index ${pageStart} is out of bounds. Total number of items: ${partialResult.total}`);
+                    }
                     throw new Error("Paged request returned non zero total count but no items");
                 }
-                if (pageSize !== 0 && receivedItemsCount >= pageSize || receivedItemsCount >= (partialResult.total - pageStart))
+                if ((pageSize !== 0 && receivedItemsCount >= pageSize) || receivedItemsCount >= partialResult.total - pageStart) {
                     break;
-                if (pageSize !== 0)
+                }
+                if (pageSize !== 0) {
                     pageSize -= receivedItemsCount;
+                }
                 pageStart += receivedItemsCount;
                 partialResult = await props.get({ start: pageStart, size: pageSize }, requestIndex++);
             }
@@ -425,15 +459,16 @@ export const buildPagedArrayResponse = async (requestedPage, getter) => {
     return { total: gen.total, items };
 };
 const stripTransientElementKeys = (keys) => {
-    if (!keys.some((key) => Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME))
+    if (!keys.some((key) => Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME)) {
         return keys;
+    }
     const copy = new KeySet();
     copy.add(keys, (key) => {
         // the callback is not going to be called with EntityProps as KeySet converts them
         // to InstanceKeys, but we want to keep the EntityProps case for correctness
         // istanbul ignore next
-        const isTransient = Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME
-            || Key.isEntityProps(key) && key.classFullName === TRANSIENT_ELEMENT_CLASSNAME;
+        const isTransient = (Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME) ||
+            (Key.isEntityProps(key) && key.classFullName === TRANSIENT_ELEMENT_CLASSNAME);
         return !isTransient;
     });
     return copy;