@itwin/core-backend 3.4.0-dev.61 → 3.4.0-dev.63

package/lib/cjs/IModelHost.js

@@ -1,490 +1,490 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module IModelHost
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileNameResolver = exports.KnownLocations = exports.Platform = exports.IModelHost = exports.IModelHostConfiguration = void 0;
-const imodeljs_native_1 = require("@bentley/imodeljs-native");
-const object_storage_azure_1 = require("@itwin/object-storage-azure");
-const cloud_agnostic_core_1 = require("@itwin/cloud-agnostic-core");
-const object_storage_core_1 = require("@itwin/object-storage-core");
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const core_telemetry_1 = require("@itwin/core-telemetry");
-const inversify_1 = require("inversify");
-const os = require("os");
-const path = require("path");
-const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
-const BisCoreSchema_1 = require("./BisCoreSchema");
-const BriefcaseManager_1 = require("./BriefcaseManager");
-const CloudStorageBackend_1 = require("./CloudStorageBackend");
-const FunctionalSchema_1 = require("./domains/FunctionalSchema");
-const GenericSchema_1 = require("./domains/GenericSchema");
-const GeoCoordConfig_1 = require("./GeoCoordConfig");
-const IModelJsFs_1 = require("./IModelJsFs");
-const DevToolsRpcImpl_1 = require("./rpc-impl/DevToolsRpcImpl");
-const IModelReadRpcImpl_1 = require("./rpc-impl/IModelReadRpcImpl");
-const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
-const SnapshotIModelRpcImpl_1 = require("./rpc-impl/SnapshotIModelRpcImpl");
-const WipRpcImpl_1 = require("./rpc-impl/WipRpcImpl");
-const RpcBackend_1 = require("./RpcBackend");
-const TileStorage_1 = require("./TileStorage");
-const Settings_1 = require("./workspace/Settings");
-const SettingsSchemas_1 = require("./workspace/SettingsSchemas");
-const Workspace_1 = require("./workspace/Workspace");
-const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
-/** Configuration of core-backend.
- * @public
- */
-class IModelHostConfiguration {
-    constructor() {
-        /** @internal */
-        this.tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
-        /** @internal */
-        this.tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
-        /** @internal */
-        this.logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;
-        /** @internal */
-        this.logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;
-    }
-}
-exports.IModelHostConfiguration = IModelHostConfiguration;
-IModelHostConfiguration.defaultTileRequestTimeout = 20 * 1000;
-IModelHostConfiguration.defaultLogTileLoadTimeThreshold = 40;
-IModelHostConfiguration.defaultLogTileSizeThreshold = 20 * 1000000;
-/**
- * Settings for `IModelHost.appWorkspace`.
- * @note this includes the default dictionary from the SettingsSpecRegistry
- */
-class ApplicationSettings extends Settings_1.BaseSettings {
-    constructor() {
-        super();
-        this._remove = SettingsSchemas_1.SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());
-        this.updateDefaults();
-    }
-    verifyPriority(priority) {
-        if (priority >= Settings_1.SettingsPriority.iModel) // iModel settings may not appear in ApplicationSettings
-            throw new Error("Use IModelSettings");
-    }
-    updateDefaults() {
-        const defaults = {};
-        for (const [schemaName, val] of SettingsSchemas_1.SettingsSchemas.allSchemas) {
-            if (val.default)
-                defaults[schemaName] = val.default;
-        }
-        this.addDictionary("_default_", 0, defaults);
-    }
-    close() {
-        if (this._remove) {
-            this._remove();
-            this._remove = undefined;
-        }
-    }
-}
-/** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.
- * See [the learning article]($docs/learning/backend/IModelHost.md)
- * @public
- */
-class IModelHost {
-    constructor() { }
-    /** @internal */
-    static get platform() {
-        if (this._platform === undefined)
-            throw new Error("IModelHost.startup must be called first");
-        return this._platform;
-    }
-    /** A uniqueId for this session */
-    static get sessionId() { return this.session.sessionId; }
-    static set sessionId(id) { this.session.sessionId = id; }
-    /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */
-    static get applicationId() { return this.session.applicationId; }
-    static set applicationId(id) { this.session.applicationId = id; }
-    /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
-    static get applicationVersion() { return this.session.applicationVersion; }
-    static set applicationVersion(version) { this.session.applicationVersion = version; }
-    /** Root directory holding files that iTwin.js caches */
-    static get cacheDir() { return this._cacheDir; }
-    /** The application [[Workspace]] for this `IModelHost`
-     * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).
-     * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and
-     * attempting to add them to this Workspace will fail.
-     * @beta
-     */
-    static get appWorkspace() { return this._appWorkspace; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
-    /** Get the current access token for this IModelHost, or a blank string if none is available.
-     * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
-     * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
-     * obtains the token and forwards it to the frontend.
-     * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value
-     * returned by this method may change over time throughout the course of a session.
-     */
-    static async getAccessToken() {
-        var _a, _b;
-        try {
-            return (_b = (await ((_a = this.authorizationClient) === null || _a === void 0 ? void 0 : _a.getAccessToken()))) !== null && _b !== void 0 ? _b : "";
-        }
-        catch (e) {
-            return "";
-        }
-    }
-    /** @internal */
-    static flushLog() {
-        return this.platform.flushLog();
-    }
-    /** @internal */
-    static loadNative() {
-        const platform = Platform.load();
-        this.registerPlatform(platform);
-    }
-    static registerPlatform(platform) {
-        this._platform = platform;
-        if (undefined === platform)
-            return;
-        platform.logger = core_bentley_1.Logger;
-    }
-    /** @internal */
-    static setHubAccess(hubAccess) { this._hubAccess = hubAccess; }
-    /** get the current hubAccess, if present.
-     * @beta
-     */
-    static getHubAccess() { return this._hubAccess; }
-    /** Provides access to the IModelHub for this IModelHost
-     * @beta
-     * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
-     * To determine whether one is present, use [[getHubAccess]].
-     */
-    static get hubAccess() {
-        if (this._hubAccess === undefined)
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "No BackendHubAccess supplied in IModelHostOptions");
-        return this._hubAccess;
-    }
-    static initializeWorkspace(configuration) {
-        const settingAssets = path.join(KnownLocations.packageAssetsDir, "Settings");
-        SettingsSchemas_1.SettingsSchemas.addDirectory(path.join(settingAssets, "Schemas"));
-        this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
-        this.appWorkspace.settings.addDirectory(settingAssets, Settings_1.SettingsPriority.defaults);
-        GeoCoordConfig_1.GeoCoordConfig.onStartup();
-        // allow applications to load their default settings
-        this.onWorkspaceStartup.raiseEvent();
-    }
-    /** Returns true if IModelHost is started.  */
-    static get isValid() { return this._isValid; }
-    /** This method must be called before any iTwin.js services are used.
-     * @param options Host configuration data.
-     * Raises [[onAfterStartup]].
-     * @see [[shutdown]].
-     */
-    static async startup(options) {
-        var _a, _b, _c, _d;
-        if (this._isValid)
-            return; // we're already initialized
-        this._isValid = true;
-        options = options !== null && options !== void 0 ? options : {};
-        if (IModelHost.sessionId === "")
-            IModelHost.sessionId = core_bentley_1.Guid.createValue();
-        this.authorizationClient = options.authorizationClient;
-        this.logStartup();
-        this.backendVersion = require("../../package.json").version; // eslint-disable-line @typescript-eslint/no-var-requires
-        (0, RpcBackend_1.initializeRpcBackend)(options.enableOpenTelemetry);
-        if (this._platform === undefined) {
-            try {
-                this.loadNative();
-            }
-            catch (error) {
-                core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (options));
-                throw error;
-            }
-        }
-        if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
-            this.platform.setCrashReporting(options.crashReportingConfig);
-            core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
-                enableCrashDumps: (_a = options.crashReportingConfig) === null || _a === void 0 ? void 0 : _a.enableCrashDumps,
-                wantFullMemoryDumps: (_b = options.crashReportingConfig) === null || _b === void 0 ? void 0 : _b.wantFullMemoryDumps,
-                enableNodeReport: (_c = options.crashReportingConfig) === null || _c === void 0 ? void 0 : _c.enableNodeReport,
-                uploadToBentley: (_d = options.crashReportingConfig) === null || _d === void 0 ? void 0 : _d.uploadToBentley,
-            });
-            if (options.crashReportingConfig.enableNodeReport) {
-                if (process.report !== undefined) {
-                    process.report.reportOnFatalError = true;
-                    process.report.reportOnUncaughtException = true;
-                    process.report.directory = options.crashReportingConfig.crashDir;
-                    core_bentley_1.Logger.logTrace(loggerCategory, "Configured Node.js crash reporting");
-                }
-                else {
-                    core_bentley_1.Logger.logWarning(loggerCategory, "Unable to configure Node.js crash reporting");
-                }
-            }
-        }
-        this.setupHostDirs(options);
-        this.initializeWorkspace(options);
-        BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
-        [
-            IModelReadRpcImpl_1.IModelReadRpcImpl,
-            IModelTileRpcImpl_1.IModelTileRpcImpl,
-            SnapshotIModelRpcImpl_1.SnapshotIModelRpcImpl,
-            WipRpcImpl_1.WipRpcImpl,
-            DevToolsRpcImpl_1.DevToolsRpcImpl,
-        ].forEach((rpc) => rpc.register()); // register all of the RPC implementations
-        [
-            BisCoreSchema_1.BisCoreSchema,
-            GenericSchema_1.GenericSchema,
-            FunctionalSchema_1.FunctionalSchema,
-        ].forEach((schema) => schema.registerSchema()); // register all of the schemas
-        if (undefined !== options.hubAccess)
-            this._hubAccess = options.hubAccess;
-        this.configuration = options;
-        this.setupTileCache();
-        process.once("beforeExit", IModelHost.shutdown);
-        this.onAfterStartup.raiseEvent();
-    }
-    static logStartup() {
-        if (!core_bentley_1.Logger.isEnabled(loggerCategory, core_bentley_1.LogLevel.Trace))
-            return;
-        // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing
-        let startupInfo = {};
-        const serviceName = process.env.FABRIC_SERVICE_NAME;
-        if (serviceName) {
-            // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85
-            const serviceNameComponents = serviceName.split("/");
-            if (serviceNameComponents.length === 7) {
-                startupInfo = {
-                    ...startupInfo,
-                    iTwinId: serviceNameComponents[4],
-                    iModelId: serviceNameComponents[5],
-                    changesetId: serviceNameComponents[6],
-                };
-            }
-        }
-        core_bentley_1.Logger.logTrace(loggerCategory, "IModelHost.startup", () => startupInfo);
-    }
-    static setupHostDirs(configuration) {
-        var _a;
-        const setupDir = (dir) => {
-            dir = path.normalize(dir);
-            IModelJsFs_1.IModelJsFs.recursiveMkDirSync(dir);
-            return dir;
-        };
-        this._cacheDir = setupDir((_a = configuration.cacheDir) !== null && _a !== void 0 ? _a : imodeljs_native_1.NativeLibrary.defaultCacheDir);
-        this._briefcaseCacheDir = path.join(this._cacheDir, "imodels");
-    }
-    /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
-    static async shutdown() {
-        var _a;
-        // NB: This method is set as a node listener where `this` is unbound
-        if (!IModelHost._isValid)
-            return;
-        IModelHost._isValid = false;
-        IModelHost.onBeforeShutdown.raiseEvent();
-        IModelHost.configuration = undefined;
-        // eslint-disable-next-line deprecation/deprecation
-        IModelHost.tileCacheService = undefined;
-        // eslint-disable-next-line deprecation/deprecation
-        IModelHost.tileUploader = undefined;
-        IModelHost.tileStorage = undefined;
-        (_a = IModelHost._appWorkspace) === null || _a === void 0 ? void 0 : _a.close();
-        IModelHost._appWorkspace = undefined;
-        Workspace_1.ITwinWorkspace.finalize();
-        process.removeListener("beforeExit", IModelHost.shutdown);
-    }
-    /**
-     * Add or update a property that should be included in a crash report.
-     * @param name The name of the property
-     * @param value The value of the property
-     * @alpha
-     */
-    static setCrashReportProperty(name, value) {
-        (0, core_bentley_1.assert)(undefined !== this._platform);
-        this._platform.setCrashReportProperty(name, value);
-    }
-    /**
-     * Remove a previously defined property so that will not be included in a crash report.
-     * @param name The name of the property
-     * @alpha
-     */
-    static removeCrashReportProperty(name) {
-        (0, core_bentley_1.assert)(undefined !== this._platform);
-        this._platform.setCrashReportProperty(name, undefined);
-    }
-    /**
-     * Get all properties that will be included in a crash report.
-     * @alpha
-     */
-    static getCrashReportProperties() {
-        (0, core_bentley_1.assert)(undefined !== this._platform);
-        return this._platform.getCrashReportProperties();
-    }
-    /** The directory where application assets may be found */
-    static get appAssetsDir() { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }
-    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
-     * @internal
-     */
-    static get tileTreeRequestTimeout() {
-        var _a, _b;
-        return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileTreeRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
-    }
-    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a "pending" status.
-     * @internal
-     */
-    static get tileContentRequestTimeout() {
-        var _a, _b;
-        return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileContentRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
-    }
-    /** The backend will log when a tile took longer to load than this threshold in seconds. */
-    static get logTileLoadTimeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileLoadTimeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
-    /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
-    static get logTileSizeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileSizeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileSizeThreshold; }
-    /** Whether external tile caching is active.
-     * @internal
-     */
-    static get usingExternalTileCache() {
-        return undefined !== IModelHost.tileStorage;
-    }
-    /** Whether to restrict tile cache URLs by client IP address.
-     * @internal
-     */
-    static get restrictTileUrlsByClientIp() { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }
-    /** Whether to compress cached tiles.
-     * @internal
-     */
-    static get compressCachedTiles() { var _a; return false !== ((_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.compressCachedTiles); }
-    static setupTileCache() {
-        (0, core_bentley_1.assert)(undefined !== IModelHost.configuration);
-        const config = IModelHost.configuration;
-        // eslint-disable-next-line deprecation/deprecation
-        const service = config.tileCacheService;
-        const storage = config.tileCacheStorage;
-        const credentials = config.tileCacheAzureCredentials;
-        if (!service && !storage && !credentials) {
-            this.platform.setUseTileCache(true);
-            return;
-        }
-        this.platform.setUseTileCache(false);
-        // eslint-disable-next-line deprecation/deprecation
-        IModelHost.tileUploader = new CloudStorageBackend_1.CloudStorageTileUploader();
-        if (credentials) {
-            if (storage || service)
-                throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Cannot use both Azure and custom cloud storage providers for tile cache.");
-            this.setupAzureTileCache(credentials);
-        }
-        if (service) {
-            if (!storage)
-                core_bentley_1.Logger.logWarning(loggerCategory, "Using tileCacheService without tileCacheStorage is unsupported");
-            IModelHost.tileCacheService = service; // eslint-disable-line deprecation/deprecation
-        }
-        if (storage)
-            IModelHost.tileStorage = new TileStorage_1.TileStorage(storage);
-    }
-    static setupAzureTileCache(credentials) {
-        var _a;
-        const config = {
-            // eslint-disable-next-line @typescript-eslint/naming-convention
-            ServerSideStorage: {
-                dependencyName: "azure",
-                accountName: credentials.account,
-                accountKey: credentials.accessKey,
-                baseUrl: (_a = credentials.baseUrl) !== null && _a !== void 0 ? _a : `https://${credentials.account}.blob.core.windows.net`,
-            },
-        };
-        const ioc = new inversify_1.Container();
-        ioc.bind(cloud_agnostic_core_1.Types.dependenciesConfig).toConstantValue(config);
-        new object_storage_azure_1.AzureServerStorageBindings().register(ioc, config.ServerSideStorage);
-        IModelHost.tileStorage = new TileStorage_1.TileStorage(ioc.get(object_storage_core_1.ServerStorage));
-        // eslint-disable-next-line deprecation/deprecation
-        IModelHost.tileCacheService = new CloudStorageBackend_1.AzureBlobStorage(credentials); // needed for backwards compatibility with old frontends
-    }
-    /** @internal */
-    static computeSchemaChecksum(arg) {
-        return this.platform.computeSchemaChecksum(arg);
-    }
-}
-exports.IModelHost = IModelHost;
-/** @alpha */
-IModelHost.telemetry = new core_telemetry_1.TelemetryManager();
-IModelHost.backendVersion = "";
-IModelHost._cacheDir = "";
-/** Event raised during startup to allow loading settings data */
-IModelHost.onWorkspaceStartup = new core_bentley_1.BeEvent();
-/** Event raised just after the backend IModelHost was started */
-IModelHost.onAfterStartup = new core_bentley_1.BeEvent();
-/** Event raised just before the backend IModelHost is to be shut down */
-IModelHost.onBeforeShutdown = new core_bentley_1.BeEvent();
-/** @internal */
-IModelHost.session = { applicationId: "2686", applicationVersion: "1.0.0", sessionId: "" };
-IModelHost._isValid = false;
-/** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].
- * @public
- */
-class Platform {
-    /** Get the name of the platform. */
-    static get platformName() {
-        return process.platform;
-    }
-    /** @internal */
-    static load() {
-        return core_bentley_1.ProcessDetector.isMobileAppBackend ? process._linkedBinding("iModelJsNative") : imodeljs_native_1.NativeLibrary.load();
-    }
-}
-exports.Platform = Platform;
-/** Well known directories that may be used by the application. Also see [[Platform]]
- * @public
- */
-class KnownLocations {
-    /** The directory where the imodeljs-native assets are stored. */
-    static get nativeAssetsDir() { return IModelHost.platform.DgnDb.getAssetsDir(); }
-    /** The directory where the core-backend assets are stored. */
-    static get packageAssetsDir() {
-        return path.join(__dirname, "assets");
-    }
-    /** The temporary directory. */
-    static get tmpdir() {
-        return os.tmpdir();
-    }
-}
-exports.KnownLocations = KnownLocations;
-/** Extend this class to provide custom file name resolution behavior.
- * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.
- * @see [[IModelHost.snapshotFileNameResolver]]
- * @public
- */
-class FileNameResolver {
-    /** Resolve a file name from the specified key.
-     * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.
-     * @returns The resolved file name or `undefined` if not found.
-     */
-    tryResolveKey(_fileKey) { return undefined; }
-    /** Resolve a file name from the specified key.
-     * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.
-     * @returns The resolved file name.
-     * @throws [[IModelError]] if not found.
-     */
-    resolveKey(fileKey) {
-        const resolvedFileName = this.tryResolveKey(fileKey);
-        if (undefined === resolvedFileName) {
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${fileKey} not resolved`);
-        }
-        return resolvedFileName;
-    }
-    /** Resolve the input file name, which may be a partial name, into a full path file name.
-     * @param inFileName The partial file name.
-     * @returns The resolved full path file name or `undefined` if not found.
-     */
-    tryResolveFileName(inFileName) { return inFileName; }
-    /** Resolve the input file name, which may be a partial name, into a full path file name.
-     * @param inFileName The partial file name.
-     * @returns The resolved full path file name.
-     * @throws [[IModelError]] if not found.
-     */
-    resolveFileName(inFileName) {
-        const resolvedFileName = this.tryResolveFileName(inFileName);
-        if (undefined === resolvedFileName) {
-            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${inFileName} not resolved`);
-        }
-        return resolvedFileName;
-    }
-}
-exports.FileNameResolver = FileNameResolver;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModelHost
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileNameResolver = exports.KnownLocations = exports.Platform = exports.IModelHost = exports.IModelHostConfiguration = void 0;
+const imodeljs_native_1 = require("@bentley/imodeljs-native");
+const object_storage_azure_1 = require("@itwin/object-storage-azure");
+const cloud_agnostic_core_1 = require("@itwin/cloud-agnostic-core");
+const object_storage_core_1 = require("@itwin/object-storage-core");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const core_telemetry_1 = require("@itwin/core-telemetry");
+const inversify_1 = require("inversify");
+const os = require("os");
+const path = require("path");
+const BackendLoggerCategory_1 = require("./BackendLoggerCategory");
+const BisCoreSchema_1 = require("./BisCoreSchema");
+const BriefcaseManager_1 = require("./BriefcaseManager");
+const CloudStorageBackend_1 = require("./CloudStorageBackend");
+const FunctionalSchema_1 = require("./domains/FunctionalSchema");
+const GenericSchema_1 = require("./domains/GenericSchema");
+const GeoCoordConfig_1 = require("./GeoCoordConfig");
+const IModelJsFs_1 = require("./IModelJsFs");
+const DevToolsRpcImpl_1 = require("./rpc-impl/DevToolsRpcImpl");
+const IModelReadRpcImpl_1 = require("./rpc-impl/IModelReadRpcImpl");
+const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
+const SnapshotIModelRpcImpl_1 = require("./rpc-impl/SnapshotIModelRpcImpl");
+const WipRpcImpl_1 = require("./rpc-impl/WipRpcImpl");
+const RpcBackend_1 = require("./RpcBackend");
+const TileStorage_1 = require("./TileStorage");
+const Settings_1 = require("./workspace/Settings");
+const SettingsSchemas_1 = require("./workspace/SettingsSchemas");
+const Workspace_1 = require("./workspace/Workspace");
+const loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelHost;
+/** Configuration of core-backend.
+ * @public
+ */
+class IModelHostConfiguration {
+    constructor() {
+        /** @internal */
+        this.tileTreeRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
+        /** @internal */
+        this.tileContentRequestTimeout = IModelHostConfiguration.defaultTileRequestTimeout;
+        /** @internal */
+        this.logTileLoadTimeThreshold = IModelHostConfiguration.defaultLogTileLoadTimeThreshold;
+        /** @internal */
+        this.logTileSizeThreshold = IModelHostConfiguration.defaultLogTileSizeThreshold;
+    }
+}
+exports.IModelHostConfiguration = IModelHostConfiguration;
+IModelHostConfiguration.defaultTileRequestTimeout = 20 * 1000;
+IModelHostConfiguration.defaultLogTileLoadTimeThreshold = 40;
+IModelHostConfiguration.defaultLogTileSizeThreshold = 20 * 1000000;
+/**
+ * Settings for `IModelHost.appWorkspace`.
+ * @note this includes the default dictionary from the SettingsSpecRegistry
+ */
+class ApplicationSettings extends Settings_1.BaseSettings {
+    constructor() {
+        super();
+        this._remove = SettingsSchemas_1.SettingsSchemas.onSchemaChanged.addListener(() => this.updateDefaults());
+        this.updateDefaults();
+    }
+    verifyPriority(priority) {
+        if (priority >= Settings_1.SettingsPriority.iModel) // iModel settings may not appear in ApplicationSettings
+            throw new Error("Use IModelSettings");
+    }
+    updateDefaults() {
+        const defaults = {};
+        for (const [schemaName, val] of SettingsSchemas_1.SettingsSchemas.allSchemas) {
+            if (val.default)
+                defaults[schemaName] = val.default;
+        }
+        this.addDictionary("_default_", 0, defaults);
+    }
+    close() {
+        if (this._remove) {
+            this._remove();
+            this._remove = undefined;
+        }
+    }
+}
+/** IModelHost initializes ($backend) and captures its configuration. A backend must call [[IModelHost.startup]] before using any backend classes.
+ * See [the learning article]($docs/learning/backend/IModelHost.md)
+ * @public
+ */
+class IModelHost {
+    constructor() { }
+    /** @internal */
+    static get platform() {
+        if (this._platform === undefined)
+            throw new Error("IModelHost.startup must be called first");
+        return this._platform;
+    }
+    /** A uniqueId for this session */
+    static get sessionId() { return this.session.sessionId; }
+    static set sessionId(id) { this.session.sessionId = id; }
+    /** The Id of this application - needs to be set only if it is an agent application. The applicationId will otherwise originate at the frontend. */
+    static get applicationId() { return this.session.applicationId; }
+    static set applicationId(id) { this.session.applicationId = id; }
+    /** The version of this application - needs to be set if is an agent application. The applicationVersion will otherwise originate at the frontend. */
+    static get applicationVersion() { return this.session.applicationVersion; }
+    static set applicationVersion(version) { this.session.applicationVersion = version; }
+    /** Root directory holding files that iTwin.js caches */
+    static get cacheDir() { return this._cacheDir; }
+    /** The application [[Workspace]] for this `IModelHost`
+     * @note this `Workspace` only holds [[WorkspaceContainer]]s and [[Settings]] scoped to the currently loaded application(s).
+     * All organization, iTwin, and iModel based containers or settings must be accessed through [[IModelDb.workspace]] and
+     * attempting to add them to this Workspace will fail.
+     * @beta
+     */
+    static get appWorkspace() { return this._appWorkspace; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    /** Get the current access token for this IModelHost, or a blank string if none is available.
+     * @note for web backends, this will *always* return a blank string because the backend itself has no token (but never needs one either.)
+     * For all IpcHosts, where this backend is servicing a single frontend, this will be the user's token. For ElectronHost, the backend
+     * obtains the token and forwards it to the frontend.
+     * @note accessTokens expire periodically and are automatically refreshed, if possible. Therefore tokens should not be saved, and the value
+     * returned by this method may change over time throughout the course of a session.
+     */
+    static async getAccessToken() {
+        var _a, _b;
+        try {
+            return (_b = (await ((_a = this.authorizationClient) === null || _a === void 0 ? void 0 : _a.getAccessToken()))) !== null && _b !== void 0 ? _b : "";
+        }
+        catch (e) {
+            return "";
+        }
+    }
+    /** @internal */
+    static flushLog() {
+        return this.platform.flushLog();
+    }
+    /** @internal */
+    static loadNative() {
+        const platform = Platform.load();
+        this.registerPlatform(platform);
+    }
+    static registerPlatform(platform) {
+        this._platform = platform;
+        if (undefined === platform)
+            return;
+        platform.logger = core_bentley_1.Logger;
+    }
+    /** @internal */
+    static setHubAccess(hubAccess) { this._hubAccess = hubAccess; }
+    /** get the current hubAccess, if present.
+     * @beta
+     */
+    static getHubAccess() { return this._hubAccess; }
+    /** Provides access to the IModelHub for this IModelHost
+     * @beta
+     * @note If [[IModelHostOptions.hubAccess]] was undefined when initializing this class, accessing this property will throw an error.
+     * To determine whether one is present, use [[getHubAccess]].
+     */
+    static get hubAccess() {
+        if (this._hubAccess === undefined)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "No BackendHubAccess supplied in IModelHostOptions");
+        return this._hubAccess;
+    }
+    static initializeWorkspace(configuration) {
+        const settingAssets = path.join(KnownLocations.packageAssetsDir, "Settings");
+        SettingsSchemas_1.SettingsSchemas.addDirectory(path.join(settingAssets, "Schemas"));
+        this._appWorkspace = new Workspace_1.ITwinWorkspace(new ApplicationSettings(), configuration.workspace);
+        this.appWorkspace.settings.addDirectory(settingAssets, Settings_1.SettingsPriority.defaults);
+        GeoCoordConfig_1.GeoCoordConfig.onStartup();
+        // allow applications to load their default settings
+        this.onWorkspaceStartup.raiseEvent();
+    }
+    /** Returns true if IModelHost is started.  */
+    static get isValid() { return this._isValid; }
+    /** This method must be called before any iTwin.js services are used.
+     * @param options Host configuration data.
+     * Raises [[onAfterStartup]].
+     * @see [[shutdown]].
+     */
+    static async startup(options) {
+        var _a, _b, _c, _d;
+        if (this._isValid)
+            return; // we're already initialized
+        this._isValid = true;
+        options = options !== null && options !== void 0 ? options : {};
+        if (IModelHost.sessionId === "")
+            IModelHost.sessionId = core_bentley_1.Guid.createValue();
+        this.authorizationClient = options.authorizationClient;
+        this.logStartup();
+        this.backendVersion = require("../../package.json").version; // eslint-disable-line @typescript-eslint/no-var-requires
+        (0, RpcBackend_1.initializeRpcBackend)(options.enableOpenTelemetry);
+        if (this._platform === undefined) {
+            try {
+                this.loadNative();
+            }
+            catch (error) {
+                core_bentley_1.Logger.logError(loggerCategory, "Error registering/loading the native platform API", () => (options));
+                throw error;
+            }
+        }
+        if (options.crashReportingConfig && options.crashReportingConfig.crashDir && !core_bentley_1.ProcessDetector.isElectronAppBackend && !core_bentley_1.ProcessDetector.isMobileAppBackend) {
+            this.platform.setCrashReporting(options.crashReportingConfig);
+            core_bentley_1.Logger.logTrace(loggerCategory, "Configured crash reporting", {
+                enableCrashDumps: (_a = options.crashReportingConfig) === null || _a === void 0 ? void 0 : _a.enableCrashDumps,
+                wantFullMemoryDumps: (_b = options.crashReportingConfig) === null || _b === void 0 ? void 0 : _b.wantFullMemoryDumps,
+                enableNodeReport: (_c = options.crashReportingConfig) === null || _c === void 0 ? void 0 : _c.enableNodeReport,
+                uploadToBentley: (_d = options.crashReportingConfig) === null || _d === void 0 ? void 0 : _d.uploadToBentley,
+            });
+            if (options.crashReportingConfig.enableNodeReport) {
+                if (process.report !== undefined) {
+                    process.report.reportOnFatalError = true;
+                    process.report.reportOnUncaughtException = true;
+                    process.report.directory = options.crashReportingConfig.crashDir;
+                    core_bentley_1.Logger.logTrace(loggerCategory, "Configured Node.js crash reporting");
+                }
+                else {
+                    core_bentley_1.Logger.logWarning(loggerCategory, "Unable to configure Node.js crash reporting");
+                }
+            }
+        }
+        this.setupHostDirs(options);
+        this.initializeWorkspace(options);
+        BriefcaseManager_1.BriefcaseManager.initialize(this._briefcaseCacheDir);
+        [
+            IModelReadRpcImpl_1.IModelReadRpcImpl,
+            IModelTileRpcImpl_1.IModelTileRpcImpl,
+            SnapshotIModelRpcImpl_1.SnapshotIModelRpcImpl,
+            WipRpcImpl_1.WipRpcImpl,
+            DevToolsRpcImpl_1.DevToolsRpcImpl,
+        ].forEach((rpc) => rpc.register()); // register all of the RPC implementations
+        [
+            BisCoreSchema_1.BisCoreSchema,
+            GenericSchema_1.GenericSchema,
+            FunctionalSchema_1.FunctionalSchema,
+        ].forEach((schema) => schema.registerSchema()); // register all of the schemas
+        if (undefined !== options.hubAccess)
+            this._hubAccess = options.hubAccess;
+        this.configuration = options;
+        this.setupTileCache();
+        process.once("beforeExit", IModelHost.shutdown);
+        this.onAfterStartup.raiseEvent();
+    }
+    static logStartup() {
+        if (!core_bentley_1.Logger.isEnabled(loggerCategory, core_bentley_1.LogLevel.Trace))
+            return;
+        // Extract the iModel details from environment - note this is very specific to Bentley hosted backends, but is quite useful for tracing
+        let startupInfo = {};
+        const serviceName = process.env.FABRIC_SERVICE_NAME;
+        if (serviceName) {
+            // e.g., fabric:/iModelWebViewer3.0/iModelJSGuest/1/08daaeb3-b56f-480b-9051-7efc834d18ae/512d971d-b641-4735-bb1c-c07ab3e44ce7/c1315fcce125ca40b2d405bb7809214daf8b4c85
+            const serviceNameComponents = serviceName.split("/");
+            if (serviceNameComponents.length === 7) {
+                startupInfo = {
+                    ...startupInfo,
+                    iTwinId: serviceNameComponents[4],
+                    iModelId: serviceNameComponents[5],
+                    changesetId: serviceNameComponents[6],
+                };
+            }
+        }
+        core_bentley_1.Logger.logTrace(loggerCategory, "IModelHost.startup", () => startupInfo);
+    }
+    static setupHostDirs(configuration) {
+        var _a;
+        const setupDir = (dir) => {
+            dir = path.normalize(dir);
+            IModelJsFs_1.IModelJsFs.recursiveMkDirSync(dir);
+            return dir;
+        };
+        this._cacheDir = setupDir((_a = configuration.cacheDir) !== null && _a !== void 0 ? _a : imodeljs_native_1.NativeLibrary.defaultCacheDir);
+        this._briefcaseCacheDir = path.join(this._cacheDir, "imodels");
+    }
+    /** This method must be called when an iTwin.js host is shut down. Raises [[onBeforeShutdown]] */
+    static async shutdown() {
+        var _a;
+        // NB: This method is set as a node listener where `this` is unbound
+        if (!IModelHost._isValid)
+            return;
+        IModelHost._isValid = false;
+        IModelHost.onBeforeShutdown.raiseEvent();
+        IModelHost.configuration = undefined;
+        // eslint-disable-next-line deprecation/deprecation
+        IModelHost.tileCacheService = undefined;
+        // eslint-disable-next-line deprecation/deprecation
+        IModelHost.tileUploader = undefined;
+        IModelHost.tileStorage = undefined;
+        (_a = IModelHost._appWorkspace) === null || _a === void 0 ? void 0 : _a.close();
+        IModelHost._appWorkspace = undefined;
+        Workspace_1.ITwinWorkspace.finalize();
+        process.removeListener("beforeExit", IModelHost.shutdown);
+    }
+    /**
+     * Add or update a property that should be included in a crash report.
+     * @param name The name of the property
+     * @param value The value of the property
+     * @alpha
+     */
+    static setCrashReportProperty(name, value) {
+        (0, core_bentley_1.assert)(undefined !== this._platform);
+        this._platform.setCrashReportProperty(name, value);
+    }
+    /**
+     * Remove a previously defined property so that will not be included in a crash report.
+     * @param name The name of the property
+     * @alpha
+     */
+    static removeCrashReportProperty(name) {
+        (0, core_bentley_1.assert)(undefined !== this._platform);
+        this._platform.setCrashReportProperty(name, undefined);
+    }
+    /**
+     * Get all properties that will be included in a crash report.
+     * @alpha
+     */
+    static getCrashReportProperties() {
+        (0, core_bentley_1.assert)(undefined !== this._platform);
+        return this._platform.getCrashReportProperties();
+    }
+    /** The directory where application assets may be found */
+    static get appAssetsDir() { return undefined !== IModelHost.configuration ? IModelHost.configuration.appAssetsDir : undefined; }
+    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileTreeProps should wait before returning a "pending" status.
+     * @internal
+     */
+    static get tileTreeRequestTimeout() {
+        var _a, _b;
+        return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileTreeRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
+    }
+    /** The time, in milliseconds, for which IModelTileRpcInterface.requestTileContent should wait before returning a "pending" status.
+     * @internal
+     */
+    static get tileContentRequestTimeout() {
+        var _a, _b;
+        return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.tileContentRequestTimeout) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultTileRequestTimeout;
+    }
+    /** The backend will log when a tile took longer to load than this threshold in seconds. */
+    static get logTileLoadTimeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileLoadTimeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileLoadTimeThreshold; }
+    /** The backend will log when a tile is loaded with a size in bytes above this threshold. */
+    static get logTileSizeThreshold() { var _a, _b; return (_b = (_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.logTileSizeThreshold) !== null && _b !== void 0 ? _b : IModelHostConfiguration.defaultLogTileSizeThreshold; }
+    /** Whether external tile caching is active.
+     * @internal
+     */
+    static get usingExternalTileCache() {
+        return undefined !== IModelHost.tileStorage;
+    }
+    /** Whether to restrict tile cache URLs by client IP address.
+     * @internal
+     */
+    static get restrictTileUrlsByClientIp() { return undefined !== IModelHost.configuration && (IModelHost.configuration.restrictTileUrlsByClientIp ? true : false); }
+    /** Whether to compress cached tiles.
+     * @internal
+     */
+    static get compressCachedTiles() { var _a; return false !== ((_a = IModelHost.configuration) === null || _a === void 0 ? void 0 : _a.compressCachedTiles); }
+    static setupTileCache() {
+        (0, core_bentley_1.assert)(undefined !== IModelHost.configuration);
+        const config = IModelHost.configuration;
+        // eslint-disable-next-line deprecation/deprecation
+        const service = config.tileCacheService;
+        const storage = config.tileCacheStorage;
+        const credentials = config.tileCacheAzureCredentials;
+        if (!service && !storage && !credentials) {
+            this.platform.setUseTileCache(true);
+            return;
+        }
+        this.platform.setUseTileCache(false);
+        // eslint-disable-next-line deprecation/deprecation
+        IModelHost.tileUploader = new CloudStorageBackend_1.CloudStorageTileUploader();
+        if (credentials) {
+            if (storage || service)
+                throw new core_common_1.IModelError(core_common_1.BentleyStatus.ERROR, "Cannot use both Azure and custom cloud storage providers for tile cache.");
+            this.setupAzureTileCache(credentials);
+        }
+        if (service) {
+            if (!storage)
+                core_bentley_1.Logger.logWarning(loggerCategory, "Using tileCacheService without tileCacheStorage is unsupported");
+            IModelHost.tileCacheService = service; // eslint-disable-line deprecation/deprecation
+        }
+        if (storage)
+            IModelHost.tileStorage = new TileStorage_1.TileStorage(storage);
+    }
+    static setupAzureTileCache(credentials) {
+        var _a;
+        const config = {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            ServerSideStorage: {
+                dependencyName: "azure",
+                accountName: credentials.account,
+                accountKey: credentials.accessKey,
+                baseUrl: (_a = credentials.baseUrl) !== null && _a !== void 0 ? _a : `https://${credentials.account}.blob.core.windows.net`,
+            },
+        };
+        const ioc = new inversify_1.Container();
+        ioc.bind(cloud_agnostic_core_1.Types.dependenciesConfig).toConstantValue(config);
+        new object_storage_azure_1.AzureServerStorageBindings().register(ioc, config.ServerSideStorage);
+        IModelHost.tileStorage = new TileStorage_1.TileStorage(ioc.get(object_storage_core_1.ServerStorage));
+        // eslint-disable-next-line deprecation/deprecation
+        IModelHost.tileCacheService = new CloudStorageBackend_1.AzureBlobStorage(credentials); // needed for backwards compatibility with old frontends
+    }
+    /** @internal */
+    static computeSchemaChecksum(arg) {
+        return this.platform.computeSchemaChecksum(arg);
+    }
+}
+exports.IModelHost = IModelHost;
+/** @alpha */
+IModelHost.telemetry = new core_telemetry_1.TelemetryManager();
+IModelHost.backendVersion = "";
+IModelHost._cacheDir = "";
+/** Event raised during startup to allow loading settings data */
+IModelHost.onWorkspaceStartup = new core_bentley_1.BeEvent();
+/** Event raised just after the backend IModelHost was started */
+IModelHost.onAfterStartup = new core_bentley_1.BeEvent();
+/** Event raised just before the backend IModelHost is to be shut down */
+IModelHost.onBeforeShutdown = new core_bentley_1.BeEvent();
+/** @internal */
+IModelHost.session = { applicationId: "2686", applicationVersion: "1.0.0", sessionId: "" };
+IModelHost._isValid = false;
+/** Information about the platform on which the app is running. Also see [[KnownLocations]] and [[IModelJsFs]].
+ * @public
+ */
+class Platform {
+    /** Get the name of the platform. */
+    static get platformName() {
+        return process.platform;
+    }
+    /** @internal */
+    static load() {
+        return core_bentley_1.ProcessDetector.isMobileAppBackend ? process._linkedBinding("iModelJsNative") : imodeljs_native_1.NativeLibrary.load();
+    }
+}
+exports.Platform = Platform;
+/** Well known directories that may be used by the application. Also see [[Platform]]
+ * @public
+ */
+class KnownLocations {
+    /** The directory where the imodeljs-native assets are stored. */
+    static get nativeAssetsDir() { return IModelHost.platform.DgnDb.getAssetsDir(); }
+    /** The directory where the core-backend assets are stored. */
+    static get packageAssetsDir() {
+        return path.join(__dirname, "assets");
+    }
+    /** The temporary directory. */
+    static get tmpdir() {
+        return os.tmpdir();
+    }
+}
+exports.KnownLocations = KnownLocations;
+/** Extend this class to provide custom file name resolution behavior.
+ * @note Only `tryResolveKey` and/or `tryResolveFileName` need to be overridden as the implementations of `resolveKey` and `resolveFileName` work for most purposes.
+ * @see [[IModelHost.snapshotFileNameResolver]]
+ * @public
+ */
+class FileNameResolver {
+    /** Resolve a file name from the specified key.
+     * @param _fileKey The key that identifies the file name in a `Map` or other similar data structure.
+     * @returns The resolved file name or `undefined` if not found.
+     */
+    tryResolveKey(_fileKey) { return undefined; }
+    /** Resolve a file name from the specified key.
+     * @param fileKey The key that identifies the file name in a `Map` or other similar data structure.
+     * @returns The resolved file name.
+     * @throws [[IModelError]] if not found.
+     */
+    resolveKey(fileKey) {
+        const resolvedFileName = this.tryResolveKey(fileKey);
+        if (undefined === resolvedFileName) {
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${fileKey} not resolved`);
+        }
+        return resolvedFileName;
+    }
+    /** Resolve the input file name, which may be a partial name, into a full path file name.
+     * @param inFileName The partial file name.
+     * @returns The resolved full path file name or `undefined` if not found.
+     */
+    tryResolveFileName(inFileName) { return inFileName; }
+    /** Resolve the input file name, which may be a partial name, into a full path file name.
+     * @param inFileName The partial file name.
+     * @returns The resolved full path file name.
+     * @throws [[IModelError]] if not found.
+     */
+    resolveFileName(inFileName) {
+        const resolvedFileName = this.tryResolveFileName(inFileName);
+        if (undefined === resolvedFileName) {
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `${inFileName} not resolved`);
+        }
+        return resolvedFileName;
+    }
+}
+exports.FileNameResolver = FileNameResolver;
 //# sourceMappingURL=IModelHost.js.map