@itwin/core-backend 4.0.0-dev.28 → 4.0.0-dev.30

package/lib/cjs/IpcHost.js

@@ -1,277 +1,277 @@
-"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 NativeApp
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.throttleProgressCallback = exports.IpcHandler = exports.IpcHost = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const IModelDb_1 = require("./IModelDb");
-const IModelHost_1 = require("./IModelHost");
-const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
-const CheckpointManager_1 = require("./CheckpointManager");
-/**
- * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
- * @note if either end terminates, the other must too.
- * @public
- */
-class IpcHost {
-    /** Get the implementation of the [IpcSocketBackend]($common) interface. */
-    static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
-    /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
-    static get isValid() { return undefined !== this._ipc; }
-    /**
-     * Send a message to the frontend over an Ipc channel.
-     * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
-     * @param data The content of the message.
-     */
-    static send(channel, ...data) {
-        this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
-    }
-    /**
-     * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
-     * @param channel The name of the channel for this handler.
-     * @param handler A function that supplies the implementation for `channel`
-     * @note returns A function to call to remove the handler.
-     */
-    static handle(channel, handler) {
-        return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
-    }
-    /**
-     * Establish a handler to receive messages sent via [[IpcApp.send]].
-     * @param channel The name of the channel for the messages.
-     * @param listener A function called when messages are sent over `channel`
-     * @note returns A function to call to remove the listener.
-     */
-    static addListener(channel, listener) {
-        return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
-    }
-    /**
-     * Remove a previously registered listener
-     * @param channel The name of the channel for the listener previously registered with [[addListener]]
-     * @param listener The function passed to [[addListener]]
-     */
-    static removeListener(channel, listener) {
-        this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
-    }
-    static notify(channel, briefcase, methodName, ...args) {
-        if (this.isValid)
-            return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
-    }
-    /** @internal */
-    static notifyIpcFrontend(methodName, ...args) {
-        return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
-    }
-    /** @internal */
-    static notifyTxns(briefcase, methodName, ...args) {
-        this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
-    }
-    /** @internal */
-    static notifyEditingScope(briefcase, methodName, ...args) {
-        this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
-    }
-    /**
-     * Start the backend of an Ipc app.
-     * @param opt
-     * @note this method calls [[IModelHost.startup]] internally.
-     */
-    static async startup(opt) {
-        this._ipc = opt?.ipcHost?.socket;
-        if (opt?.ipcHost?.exceptions?.noStack)
-            this.noStack = true;
-        if (this.isValid) { // for tests, we use IpcHost but don't have a frontend
-            IpcAppHandler.register();
-        }
-        await IModelHost_1.IModelHost.startup(opt?.iModelHost);
-    }
-    /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
-    static async shutdown() {
-        this._ipc = undefined;
-        await IModelHost_1.IModelHost.shutdown();
-    }
-}
-exports.IpcHost = IpcHost;
-IpcHost.noStack = false;
-/**
- * Base class for all implementations of an Ipc interface.
- *
- * Create a subclass to implement your Ipc interface. Your class should be declared like this:
- * ```ts
- * class MyHandler extends IpcHandler implements MyInterface
- * ```
- * to ensure all methods and signatures are correct.
- *
- * Then, call `MyClass.register` at startup to connect your class to your channel.
- * @public
- */
-class IpcHandler {
-    /**
-     * Register this class as the handler for methods on its channel. This static method creates a new instance
-     * that becomes the handler and is `this` when its methods are called.
-     * @returns A function that can be called to remove the handler.
-     * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
-     */
-    static register() {
-        const impl = new this(); // create an instance of subclass. "as any" is necessary because base class is abstract
-        return IpcHost.handle(impl.channelName, async (_evt, funcName, ...args) => {
-            try {
-                const func = impl[funcName];
-                if (typeof func !== "function")
-                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.FunctionNotFound, `Method "${impl.constructor.name}.${funcName}" not found on IpcHandler registered for channel: ${impl.channelName}`);
-                return { result: await func.call(impl, ...args) };
-            }
-            catch (err) {
-                const ret = {
-                    error: {
-                        name: err.hasOwnProperty("name") ? err.name : err.constructor?.name ?? "Unknown Error",
-                        message: err.message ?? core_bentley_1.BentleyError.getErrorMessage(err),
-                        errorNumber: err.errorNumber ?? 0,
-                    },
-                };
-                if (!IpcHost.noStack)
-                    ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
-                return ret;
-            }
-        });
-    }
-}
-exports.IpcHandler = IpcHandler;
-/**
- * Implementation  of IpcAppFunctions
- */
-class IpcAppHandler extends IpcHandler {
-    constructor() {
-        super(...arguments);
-        this._iModelKeyToPullStatus = new Map();
-    }
-    get channelName() { return core_common_1.IpcAppChannel.Functions; }
-    async log(_timestamp, level, category, message, metaData) {
-        switch (level) {
-            case core_bentley_1.LogLevel.Error:
-                core_bentley_1.Logger.logError(category, message, metaData);
-                break;
-            case core_bentley_1.LogLevel.Info:
-                core_bentley_1.Logger.logInfo(category, message, metaData);
-                break;
-            case core_bentley_1.LogLevel.Trace:
-                core_bentley_1.Logger.logTrace(category, message, metaData);
-                break;
-            case core_bentley_1.LogLevel.Warning:
-                core_bentley_1.Logger.logWarning(category, message, metaData);
-                break;
-        }
-    }
-    async cancelTileContentRequests(tokenProps, contentIds) {
-        return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
-    }
-    async cancelElementGraphicsRequests(key, requestIds) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
-    }
-    async openBriefcase(args) {
-        const db = await IModelDb_1.BriefcaseDb.open(args);
-        return db.toJSON();
-    }
-    async openStandalone(filePath, openMode, opts) {
-        return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
-    }
-    async closeIModel(key) {
-        IModelDb_1.IModelDb.findByKey(key).close();
-    }
-    async saveChanges(key, description) {
-        IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
-    }
-    async hasPendingTxns(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
-    }
-    async isUndoPossible(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
-    }
-    async isRedoPossible(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
-    }
-    async getUndoString(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
-    }
-    async getRedoString(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
-    }
-    async pullChanges(key, toIndex, options) {
-        const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
-        this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Continue);
-        const checkAbort = () => this._iModelKeyToPullStatus.get(key) ?? CheckpointManager_1.ProgressStatus.Continue;
-        let onProgress;
-        if (options?.reportProgress) {
-            const progressCallback = (loaded, total) => {
-                IpcHost.send((0, core_common_1.getPullChangesIpcChannel)(iModelDb.iModelId), { loaded, total });
-                return checkAbort();
-            };
-            onProgress = throttleProgressCallback(progressCallback, checkAbort, options?.progressInterval);
-        }
-        else if (options?.enableCancellation) {
-            onProgress = checkAbort;
-        }
-        try {
-            await iModelDb.pullChanges({ toIndex, onProgress });
-        }
-        finally {
-            this._iModelKeyToPullStatus.delete(key);
-        }
-        return iModelDb.changeset;
-    }
-    async cancelPullChangesRequest(key) {
-        this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Abort);
-    }
-    async pushChanges(key, description) {
-        const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
-        await iModelDb.pushChanges({ description });
-        return iModelDb.changeset;
-    }
-    async toggleGraphicalEditingScope(key, startSession) {
-        const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
-        if (val.error)
-            throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
-        (0, core_bentley_1.assert)(undefined !== val.result);
-        return val.result;
-    }
-    async isGraphicalEditingSupported(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
-    }
-    async reverseTxns(key, numOperations) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
-    }
-    async reverseAllTxn(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
-    }
-    async reinstateTxn(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
-    }
-    async restartTxnSession(key) {
-        return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
-    }
-    async queryConcurrency(pool) {
-        return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
-    }
-}
-/**
- * Prevents progress callback being called more frequently when provided interval.
- * @internal
- */
-function throttleProgressCallback(func, checkAbort, progressInterval) {
-    const interval = progressInterval ?? 250; // by default, only send progress events every 250 milliseconds
-    let nextTime = Date.now() + interval;
-    const progressCallback = (loaded, total) => {
-        const now = Date.now();
-        if (loaded >= total || now >= nextTime) {
-            nextTime = now + interval;
-            return func(loaded, total);
-        }
-        return checkAbort();
-    };
-    return progressCallback;
-}
-exports.throttleProgressCallback = throttleProgressCallback;
+"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 NativeApp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throttleProgressCallback = exports.IpcHandler = exports.IpcHost = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const IModelDb_1 = require("./IModelDb");
+const IModelHost_1 = require("./IModelHost");
+const IModelTileRpcImpl_1 = require("./rpc-impl/IModelTileRpcImpl");
+const CheckpointManager_1 = require("./CheckpointManager");
+/**
+ * Used by applications that have a dedicated backend. IpcHosts may send messages to their corresponding IpcApp.
+ * @note if either end terminates, the other must too.
+ * @public
+ */
+class IpcHost {
+    /** Get the implementation of the [IpcSocketBackend]($common) interface. */
+    static get ipc() { return this._ipc; } // eslint-disable-line @typescript-eslint/no-non-null-assertion
+    /** Determine whether Ipc is available for this backend. This will only be true if [[startup]] has been called on this class. */
+    static get isValid() { return undefined !== this._ipc; }
+    /**
+     * Send a message to the frontend over an Ipc channel.
+     * @param channel the name of the channel matching the name registered with [[IpcApp.addListener]].
+     * @param data The content of the message.
+     */
+    static send(channel, ...data) {
+        this.ipc.send((0, core_common_1.iTwinChannel)(channel), ...data);
+    }
+    /**
+     * Establish a handler for an Ipc channel to receive [[Frontend.invoke]] calls
+     * @param channel The name of the channel for this handler.
+     * @param handler A function that supplies the implementation for `channel`
+     * @note returns A function to call to remove the handler.
+     */
+    static handle(channel, handler) {
+        return this.ipc.handle((0, core_common_1.iTwinChannel)(channel), handler);
+    }
+    /**
+     * Establish a handler to receive messages sent via [[IpcApp.send]].
+     * @param channel The name of the channel for the messages.
+     * @param listener A function called when messages are sent over `channel`
+     * @note returns A function to call to remove the listener.
+     */
+    static addListener(channel, listener) {
+        return this.ipc.addListener((0, core_common_1.iTwinChannel)(channel), listener);
+    }
+    /**
+     * Remove a previously registered listener
+     * @param channel The name of the channel for the listener previously registered with [[addListener]]
+     * @param listener The function passed to [[addListener]]
+     */
+    static removeListener(channel, listener) {
+        this.ipc.removeListener((0, core_common_1.iTwinChannel)(channel), listener);
+    }
+    static notify(channel, briefcase, methodName, ...args) {
+        if (this.isValid)
+            return this.send(`${channel}:${briefcase.key}`, methodName, ...args);
+    }
+    /** @internal */
+    static notifyIpcFrontend(methodName, ...args) {
+        return IpcHost.send(core_common_1.IpcAppChannel.AppNotify, methodName, ...args);
+    }
+    /** @internal */
+    static notifyTxns(briefcase, methodName, ...args) {
+        this.notify(core_common_1.IpcAppChannel.Txns, briefcase, methodName, ...args);
+    }
+    /** @internal */
+    static notifyEditingScope(briefcase, methodName, ...args) {
+        this.notify(core_common_1.IpcAppChannel.EditingScope, briefcase, methodName, ...args);
+    }
+    /**
+     * Start the backend of an Ipc app.
+     * @param opt
+     * @note this method calls [[IModelHost.startup]] internally.
+     */
+    static async startup(opt) {
+        this._ipc = opt?.ipcHost?.socket;
+        if (opt?.ipcHost?.exceptions?.noStack)
+            this.noStack = true;
+        if (this.isValid) { // for tests, we use IpcHost but don't have a frontend
+            IpcAppHandler.register();
+        }
+        await IModelHost_1.IModelHost.startup(opt?.iModelHost);
+    }
+    /** Shutdown IpcHost backend. Also calls [[IModelHost.shutdown]] */
+    static async shutdown() {
+        this._ipc = undefined;
+        await IModelHost_1.IModelHost.shutdown();
+    }
+}
+exports.IpcHost = IpcHost;
+IpcHost.noStack = false;
+/**
+ * Base class for all implementations of an Ipc interface.
+ *
+ * Create a subclass to implement your Ipc interface. Your class should be declared like this:
+ * ```ts
+ * class MyHandler extends IpcHandler implements MyInterface
+ * ```
+ * to ensure all methods and signatures are correct.
+ *
+ * Then, call `MyClass.register` at startup to connect your class to your channel.
+ * @public
+ */
+class IpcHandler {
+    /**
+     * Register this class as the handler for methods on its channel. This static method creates a new instance
+     * that becomes the handler and is `this` when its methods are called.
+     * @returns A function that can be called to remove the handler.
+     * @note this method should only be called once per channel. If it is called multiple times, subsequent calls replace the previous ones.
+     */
+    static register() {
+        const impl = new this(); // create an instance of subclass. "as any" is necessary because base class is abstract
+        return IpcHost.handle(impl.channelName, async (_evt, funcName, ...args) => {
+            try {
+                const func = impl[funcName];
+                if (typeof func !== "function")
+                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.FunctionNotFound, `Method "${impl.constructor.name}.${funcName}" not found on IpcHandler registered for channel: ${impl.channelName}`);
+                return { result: await func.call(impl, ...args) };
+            }
+            catch (err) {
+                const ret = {
+                    error: {
+                        name: err.hasOwnProperty("name") ? err.name : err.constructor?.name ?? "Unknown Error",
+                        message: err.message ?? core_bentley_1.BentleyError.getErrorMessage(err),
+                        errorNumber: err.errorNumber ?? 0,
+                    },
+                };
+                if (!IpcHost.noStack)
+                    ret.error.stack = core_bentley_1.BentleyError.getErrorStack(err);
+                return ret;
+            }
+        });
+    }
+}
+exports.IpcHandler = IpcHandler;
+/**
+ * Implementation  of IpcAppFunctions
+ */
+class IpcAppHandler extends IpcHandler {
+    constructor() {
+        super(...arguments);
+        this._iModelKeyToPullStatus = new Map();
+    }
+    get channelName() { return core_common_1.IpcAppChannel.Functions; }
+    async log(_timestamp, level, category, message, metaData) {
+        switch (level) {
+            case core_bentley_1.LogLevel.Error:
+                core_bentley_1.Logger.logError(category, message, metaData);
+                break;
+            case core_bentley_1.LogLevel.Info:
+                core_bentley_1.Logger.logInfo(category, message, metaData);
+                break;
+            case core_bentley_1.LogLevel.Trace:
+                core_bentley_1.Logger.logTrace(category, message, metaData);
+                break;
+            case core_bentley_1.LogLevel.Warning:
+                core_bentley_1.Logger.logWarning(category, message, metaData);
+                break;
+        }
+    }
+    async cancelTileContentRequests(tokenProps, contentIds) {
+        return (0, IModelTileRpcImpl_1.cancelTileContentRequests)(tokenProps, contentIds);
+    }
+    async cancelElementGraphicsRequests(key, requestIds) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.cancelElementGraphicsRequests(requestIds);
+    }
+    async openBriefcase(args) {
+        const db = await IModelDb_1.BriefcaseDb.open(args);
+        return db.toJSON();
+    }
+    async openStandalone(filePath, openMode, opts) {
+        return IModelDb_1.StandaloneDb.openFile(filePath, openMode, opts).getConnectionProps();
+    }
+    async closeIModel(key) {
+        IModelDb_1.IModelDb.findByKey(key).close();
+    }
+    async saveChanges(key, description) {
+        IModelDb_1.IModelDb.findByKey(key).saveChanges(description);
+    }
+    async hasPendingTxns(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.hasPendingTxns();
+    }
+    async isUndoPossible(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isUndoPossible();
+    }
+    async isRedoPossible(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isRedoPossible();
+    }
+    async getUndoString(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
+    }
+    async getRedoString(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.getUndoString();
+    }
+    async pullChanges(key, toIndex, options) {
+        const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
+        this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Continue);
+        const checkAbort = () => this._iModelKeyToPullStatus.get(key) ?? CheckpointManager_1.ProgressStatus.Continue;
+        let onProgress;
+        if (options?.reportProgress) {
+            const progressCallback = (loaded, total) => {
+                IpcHost.send((0, core_common_1.getPullChangesIpcChannel)(iModelDb.iModelId), { loaded, total });
+                return checkAbort();
+            };
+            onProgress = throttleProgressCallback(progressCallback, checkAbort, options?.progressInterval);
+        }
+        else if (options?.enableCancellation) {
+            onProgress = checkAbort;
+        }
+        try {
+            await iModelDb.pullChanges({ toIndex, onProgress });
+        }
+        finally {
+            this._iModelKeyToPullStatus.delete(key);
+        }
+        return iModelDb.changeset;
+    }
+    async cancelPullChangesRequest(key) {
+        this._iModelKeyToPullStatus.set(key, CheckpointManager_1.ProgressStatus.Abort);
+    }
+    async pushChanges(key, description) {
+        const iModelDb = IModelDb_1.BriefcaseDb.findByKey(key);
+        await iModelDb.pushChanges({ description });
+        return iModelDb.changeset;
+    }
+    async toggleGraphicalEditingScope(key, startSession) {
+        const val = IModelDb_1.IModelDb.findByKey(key).nativeDb.setGeometricModelTrackingEnabled(startSession);
+        if (val.error)
+            throw new core_common_1.IModelError(val.error.status, "Failed to toggle graphical editing scope");
+        (0, core_bentley_1.assert)(undefined !== val.result);
+        return val.result;
+    }
+    async isGraphicalEditingSupported(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.isGeometricModelTrackingSupported();
+    }
+    async reverseTxns(key, numOperations) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseTxns(numOperations);
+    }
+    async reverseAllTxn(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reverseAll();
+    }
+    async reinstateTxn(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.reinstateTxn();
+    }
+    async restartTxnSession(key) {
+        return IModelDb_1.IModelDb.findByKey(key).nativeDb.restartTxnSession();
+    }
+    async queryConcurrency(pool) {
+        return IModelHost_1.IModelHost.platform.queryConcurrency(pool);
+    }
+}
+/**
+ * Prevents progress callback being called more frequently when provided interval.
+ * @internal
+ */
+function throttleProgressCallback(func, checkAbort, progressInterval) {
+    const interval = progressInterval ?? 250; // by default, only send progress events every 250 milliseconds
+    let nextTime = Date.now() + interval;
+    const progressCallback = (loaded, total) => {
+        const now = Date.now();
+        if (loaded >= total || now >= nextTime) {
+            nextTime = now + interval;
+            return func(loaded, total);
+        }
+        return checkAbort();
+    };
+    return progressCallback;
+}
+exports.throttleProgressCallback = throttleProgressCallback;
 //# sourceMappingURL=IpcHost.js.map