@openfin/node-adapter 40.82.2 → 40.82.4

package/out/node-adapter.js

@@ -355,19 +355,57 @@ var NotImplementedError_1 = transportErrors.NotImplementedError = NotImplemented
 class NotSupportedError extends Error {
 }
 var NotSupportedError_1 = transportErrors.NotSupportedError = NotSupportedError;
-class InternalError extends Error {
+class DeserializedError extends Error {
     constructor(err) {
         const { message, name, stack, ...rest } = err;
         super(message);
+        if ('cause' in err && err.cause) {
+            this.cause = new DeserializedError(err.cause);
+        }
         this.name = name || 'Error';
         this.stack = stack ?? this.toString();
-        Object.keys(rest).forEach(key => {
+        Object.keys(rest)
+            .filter((k) => k !== 'cause')
+            .forEach((key) => {
             this[key] = rest[key];
         });
     }
 }
 // For documentation of the error methods being used see here: https://v8.dev/docs/stack-trace-api
 class RuntimeError extends Error {
+    static trimEndCallSites(err, takeUntilRegex) {
+        // save original props
+        const length = Error.stackTraceLimit;
+        // eslint-disable-next-line no-underscore-dangle
+        const _prepareStackTrace = Error.prepareStackTrace;
+        // This will be called when we access the `stack` property
+        Error.prepareStackTrace = (_, stack) => stack;
+        // in channel errors, the error was already serialized so we need to handle both string and CallSite[]
+        const isString = typeof err.stack === 'string';
+        const stack = (isString ? err.stack?.split('\n') : err.stack) ?? [];
+        // restore original props
+        Error.prepareStackTrace = _prepareStackTrace;
+        Error.stackTraceLimit = length;
+        // stack is optional in non chromium contexts
+        if (stack.length) {
+            const newStack = [];
+            // remove this call ONLY if it's not a string
+            for (const line of isString ? stack : stack.slice(1)) {
+                // inclusive take until
+                newStack.push(line);
+                if (takeUntilRegex.test(line.toString())) {
+                    break;
+                }
+            }
+            if (isString) {
+                // maintain it as a string
+                err.stack = newStack.join('\n');
+            }
+            else {
+                err.stack = RuntimeError.prepareStackTrace(err, newStack);
+            }
+        }
+    }
     static getCallSite(callsToRemove = 0) {
         const length = Error.stackTraceLimit;
         const realCallsToRemove = callsToRemove + 1; // remove this call;
@@ -386,21 +424,82 @@ class RuntimeError extends Error {
         if (typeof Error.prepareStackTrace === 'function') {
             return Error.prepareStackTrace(err, callSites);
         }
-        let string = "";
-        string += err.name || "Error";
-        string += `: ${err.message || ""}`;
-        for (const callSite of callSites) {
-            string += `\n    at ${callSite.toString()}`;
-        }
-        return string;
-    }
-    ;
+        // TODO: this is just a first iteration, we can make this "nicer" at some point
+        // const EXCLUSIONS = ['IpcRenderer', 'Object.onMessage', 'Transport.onmessage', 'MessageReceiver.onmessage'];
+        let stackTrace = `${err.name || 'Error'}: ${err.message || ''}\n`;
+        stackTrace += callSites
+            .map((line) => `    at ${line}`)
+            // .filter((line) => !EXCLUSIONS.some((l) => line.includes(l)))
+            .join('\n');
+        return stackTrace;
+    }
+    /*
+
+    NON filtered stack trace example from MTP page channel-errors.tsx:
+
+    Caused by: ChannelError: Error from ch0
+        at ChannelClient.dispatch (<anonymous>:3:119560)
+        at eval (test-channel-errors.tsx:73:26)
+        at ChannelProvider.processAction (<anonymous>:3:116748)
+        at ChannelProvider.processAction (<anonymous>:3:149121)
+        at MessageReceiver.processChannelMessage (<anonymous>:3:131909)
+        at MessageReceiver.onmessage (<anonymous>:3:131232)
+        at Transport.onmessage (<anonymous>:3:282049)
+        at IpcRenderer.<anonymous> (<anonymous>:3:275150)
+        at IpcRenderer.emit (node:electron/js2c/sandbox_bundle:2:34834)
+        at Object.onMessage (node:electron/js2c/sandbox_bundle:2:51566)
+    Caused by: ChannelError: Error from ch0
+        at ChannelClient.dispatch (<anonymous>:3:119560)
+        at eval (test-channel-errors.tsx:73:26)
+        at ChannelProvider.processAction (<anonymous>:3:116748)
+        at ChannelProvider.processAction (<anonymous>:3:149121)
+        at MessageReceiver.processChannelMessage (<anonymous>:3:131909)
+        at MessageReceiver.onmessage (<anonymous>:3:131232)
+        at Transport.onmessage (<anonymous>:3:282049)
+        at IpcRenderer.<anonymous> (<anonymous>:3:275150)
+        at IpcRenderer.emit (node:electron/js2c/sandbox_bundle:2:34834)
+        at Object.onMessage (node:electron/js2c/sandbox_bundle:2:51566)
+    Caused by: ChannelError: Error from ch0
+        at ChannelClient.dispatch (<anonymous>:3:119560)
+        at eval (test-channel-errors.tsx:73:26)
+        at ChannelProvider.processAction (<anonymous>:3:116748)
+        at ChannelProvider.processAction (<anonymous>:3:149121)
+        at MessageReceiver.processChannelMessage (<anonymous>:3:131909)
+        at MessageReceiver.onmessage (<anonymous>:3:131232)
+        at Transport.onmessage (<anonymous>:3:282049)
+        at IpcRenderer.<anonymous> (<anonymous>:3:275150)
+        at IpcRenderer.emit (node:electron/js2c/sandbox_bundle:2:34834)
+        at Object.onMessage (node:electron/js2c/sandbox_bundle:2:51566)
+    Caused by: ChannelError: Error from ch0
+        at ChannelClient.dispatch (<anonymous>:3:119560)
+        at eval (test-channel-errors.tsx:50:23)
+        at ChannelProvider.processAction (<anonymous>:3:116748)
+        at ChannelProvider.processAction (<anonymous>:3:149121)
+        at MessageReceiver.processChannelMessage (<anonymous>:3:131909)
+        at MessageReceiver.onmessage (<anonymous>:3:131232)
+        at Transport.onmessage (<anonymous>:3:282049)
+        at IpcRenderer.<anonymous> (<anonymous>:3:275150)
+        at IpcRenderer.emit (node:electron/js2c/sandbox_bundle:2:34834)
+        at Object.onMessage (node:electron/js2c/sandbox_bundle:2:51566)
+    Caused by: Error: Error from ch0
+        at eval (test-channel-errors.tsx:54:19)
+        at ChannelProvider.processAction (<anonymous>:3:116748)
+        at ChannelProvider.processAction (<anonymous>:3:149121)
+        at MessageReceiver.processChannelMessage (<anonymous>:3:131909)
+        at MessageReceiver.onmessage (<anonymous>:3:131232)
+        at Transport.onmessage (<anonymous>:3:282049)
+        at IpcRenderer.<anonymous> (<anonymous>:3:275150)
+        at IpcRenderer.emit (node:electron/js2c/sandbox_bundle:2:34834)
+        at Object.onMessage (node:electron/js2c/sandbox_bundle:2:51566)
+
+    
+    */
     constructor(payload, callSites) {
         const { reason, error } = payload;
         super(reason);
-        this.name = 'RuntimeError';
+        this.name = this.constructor.name;
         if (error?.stack) {
-            this.cause = new InternalError(error);
+            this.cause = new DeserializedError(error);
         }
         if (callSites) {
             this.stack = RuntimeError.prepareStackTrace(this, callSites);
@@ -2751,9 +2850,14 @@ function requireInstance$2 () {
 	                // don't expose
 	            });
 	            const layoutWindow = await this.getCurrentWindow();
+	            let layoutWindowIdentity = layoutWindow.identity;
+	            // TODO: CORE-1857 - when we tearout active layout or drag a view out of a window, the above identity includes the whole window info.
+	            if (layoutWindowIdentity.identity) {
+	                layoutWindowIdentity = layoutWindowIdentity.identity;
+	            }
 	            try {
 	                const providerChannelClient = await __classPrivateFieldGet(this, _View_providerChannelClient, "f").getValue();
-	                const client = await layout_entities_1.LayoutNode.newLayoutEntitiesClient(providerChannelClient, layout_constants_1.LAYOUT_CONTROLLER_ID, layoutWindow.identity);
+	                const client = await layout_entities_1.LayoutNode.newLayoutEntitiesClient(providerChannelClient, layout_constants_1.LAYOUT_CONTROLLER_ID, layoutWindowIdentity);
 	                const layoutIdentity = await client.getLayoutIdentityForViewOrThrow(this.identity);
 	                return this.fin.Platform.Layout.wrap(layoutIdentity);
 	            }
@@ -2766,7 +2870,7 @@ function requireInstance$2 () {
 	                    throw e;
 	                }
 	                // fallback logic for missing endpoint
-	                return this.fin.Platform.Layout.wrap(layoutWindow.identity);
+	                return this.fin.Platform.Layout.wrap(layoutWindowIdentity);
 	            }
 	        };
 	        /**
@@ -5642,7 +5746,7 @@ function requireWindow () {
 Object.defineProperty(system, "__esModule", { value: true });
 system.System = void 0;
 const base_1$i = base;
-const transport_errors_1$2 = transportErrors;
+const transport_errors_1$6 = transportErrors;
 const window_1 = requireWindow();
 const events_1$6 = require$$0;
 /**
@@ -6128,7 +6232,8 @@ class System extends base_1$i.EmitterBase {
         return this.wire.sendAction('get-rvm-info').then(({ payload }) => payload.data);
     }
     /**
-     * Retrieves system information.
+     * Retrieves general system information. If you need more detailed information about the
+     * OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
      *
      * @example
      * ```js
@@ -6138,6 +6243,17 @@ class System extends base_1$i.EmitterBase {
     getHostSpecs() {
         return this.wire.sendAction('get-host-specs').then(({ payload }) => payload.data);
     }
+    /**
+     * Retrieves information about the OS and the currently logged in user.
+     *
+     * @example
+     * ```js
+     * fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
+     * ```
+     */
+    getOSInfo() {
+        return this.wire.sendAction('get-os-info').then(({ payload }) => payload.data);
+    }
     /**
      * Runs an executable or batch file. A path to the file must be included in options.
      * <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
@@ -6720,9 +6836,9 @@ class System extends base_1$i.EmitterBase {
         });
         // node.js environment not supported
         if (this.wire.environment.type !== 'openfin') {
-            throw new transport_errors_1$2.NotSupportedError('downloadAsset only supported in an OpenFin Render process');
+            throw new transport_errors_1$6.NotSupportedError('downloadAsset only supported in an OpenFin Render process');
         }
-        const callSite = transport_errors_1$2.RuntimeError.getCallSite();
+        const callSite = transport_errors_1$6.RuntimeError.getCallSite();
         const downloadId = this.wire.environment.getNextMessageId().toString();
         const dlProgressKey = `asset-download-progress-${downloadId}`;
         const dlErrorKey = `asset-download-error-${downloadId}`;
@@ -6742,7 +6858,7 @@ class System extends base_1$i.EmitterBase {
         const dlError = (payload) => {
             cleanListeners();
             const { reason, err: error } = payload;
-            reject(new transport_errors_1$2.RuntimeError({ reason, error }, callSite));
+            reject(new transport_errors_1$6.RuntimeError({ reason, error }, callSite));
         };
         const dlComplete = () => {
             cleanListeners();
@@ -6793,11 +6909,11 @@ class System extends base_1$i.EmitterBase {
      * ```
      */
     downloadRuntime(options, progressListener) {
-        const callsites = transport_errors_1$2.RuntimeError.getCallSite();
+        const callsites = transport_errors_1$6.RuntimeError.getCallSite();
         return new Promise((resolve, reject) => {
             // node.js environment not supported
             if (this.wire.environment.type !== 'openfin') {
-                reject(new transport_errors_1$2.NotSupportedError('downloadRuntime only supported in an OpenFin Render process'));
+                reject(new transport_errors_1$6.NotSupportedError('downloadRuntime only supported in an OpenFin Render process'));
                 return;
             }
             const downloadId = this.wire.environment.getNextMessageId().toString();
@@ -6819,7 +6935,7 @@ class System extends base_1$i.EmitterBase {
             const dlError = (payload) => {
                 cleanListeners();
                 const { reason, err: error } = payload;
-                reject(new transport_errors_1$2.RuntimeError({ reason, error }, callsites));
+                reject(new transport_errors_1$6.RuntimeError({ reason, error }, callsites));
             };
             const dlComplete = () => {
                 cleanListeners();
@@ -7554,6 +7670,7 @@ var channel = {};
 
 Object.defineProperty(channel, "__esModule", { value: true });
 channel.ChannelBase = channel.ProtectedItems = void 0;
+const transport_errors_1$5 = transportErrors;
 const resultOrPayload = (func) => async (topic, payload, senderIdentity) => {
     const res = await func(topic, payload, senderIdentity);
     return res === undefined ? payload : res;
@@ -7586,6 +7703,7 @@ class ChannelBase {
             return this.postAction ? await this.postAction(topic, actionProcessed, senderIdentity) : actionProcessed;
         }
         catch (e) {
+            transport_errors_1$5.RuntimeError.trimEndCallSites(e, /Channel.*processAction/);
             if (this.errorMiddleware) {
                 return this.errorMiddleware(topic, e, senderIdentity);
             }
@@ -7887,6 +8005,25 @@ class ChannelBase {
 }
 channel.ChannelBase = ChannelBase;
 
+var channelError = {};
+
+Object.defineProperty(channelError, "__esModule", { value: true });
+channelError.ChannelError = void 0;
+const transport_errors_1$4 = transportErrors;
+class ChannelError extends Error {
+    constructor(originalError, action, dispatchPayload, callsites) {
+        super(originalError.message);
+        this.action = action;
+        this.dispatchPayload = dispatchPayload;
+        this.name = this.constructor.name;
+        if ('cause' in originalError && originalError.cause instanceof Error) {
+            this.cause = originalError.cause;
+        }
+        this.stack = transport_errors_1$4.RuntimeError.prepareStackTrace(this, callsites);
+    }
+}
+channelError.ChannelError = ChannelError;
+
 var __classPrivateFieldGet$c = (commonjsGlobal && commonjsGlobal.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -7901,7 +8038,9 @@ var __classPrivateFieldSet$a = (commonjsGlobal && commonjsGlobal.__classPrivateF
 var _ChannelClient_protectedObj, _ChannelClient_strategy, _ChannelClient_close;
 Object.defineProperty(client, "__esModule", { value: true });
 client.ChannelClient = void 0;
+const transport_errors_1$3 = transportErrors;
 const channel_1$1 = channel;
+const channel_error_1$1 = channelError;
 const channelClientsByEndpointId = new Map();
 /**
  * Instance created to enable use of a channel as a client.  Allows for communication with the
@@ -8003,7 +8142,10 @@ class ChannelClient extends channel_1$1.ChannelBase {
      */
     async dispatch(action, payload) {
         if (__classPrivateFieldGet$c(this, _ChannelClient_strategy, "f").isEndpointConnected(this.providerIdentity.channelId)) {
-            return __classPrivateFieldGet$c(this, _ChannelClient_strategy, "f").send(this.providerIdentity.channelId, action, payload);
+            const callSites = transport_errors_1$3.RuntimeError.getCallSite();
+            return __classPrivateFieldGet$c(this, _ChannelClient_strategy, "f").send(this.providerIdentity.channelId, action, payload).catch((e) => {
+                throw new channel_error_1$1.ChannelError(e, action, payload, callSites);
+            });
         }
         throw new Error('The client you are trying to dispatch from is disconnected from the target provider.');
     }
@@ -8118,7 +8260,7 @@ class ClassicStrategy {
         _ClassicStrategy_endpointIdentityMap.set(this, new Map());
         // Store a set of cancellable promises to be able to reject them when client
         // connection problems occur
-        _ClassicStrategy_pendingMessagesByEndpointId.set(this, new Map);
+        _ClassicStrategy_pendingMessagesByEndpointId.set(this, new Map());
         this.send = async (endpointId, action, payload) => {
             const to = __classPrivateFieldGet$b(this, _ClassicStrategy_endpointIdentityMap, "f").get(endpointId);
             if (!to) {
@@ -8132,17 +8274,21 @@ class ClassicStrategy {
             }
             delete cleanId.isLocalEndpointId;
             // grab the promise before awaiting it to save in our pending messages map
-            const p = __classPrivateFieldGet$b(this, _ClassicStrategy_wire, "f")
-                .sendAction('send-channel-message', {
+            const p = __classPrivateFieldGet$b(this, _ClassicStrategy_wire, "f").sendAction('send-channel-message', {
                 ...cleanId,
                 providerIdentity: this.providerIdentity,
                 action,
                 payload
             });
             __classPrivateFieldGet$b(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId)?.add(p);
-            const raw = await p.catch((error) => {
+            const raw = await p
+                .catch((error) => {
+                if ('cause' in error) {
+                    throw error;
+                }
                 throw new Error(error.message);
-            }).finally(() => {
+            })
+                .finally(() => {
                 // clean up the pending promise
                 __classPrivateFieldGet$b(this, _ClassicStrategy_pendingMessagesByEndpointId, "f").get(endpointId)?.delete(p);
             });
@@ -8196,13 +8342,17 @@ var errors = {};
 Object.defineProperty(errors, "__esModule", { value: true });
 errors.errorToPOJO = void 0;
 function errorToPOJO(error) {
-    return {
+    const errorObj = {
         stack: error.stack,
         name: error.name,
         message: error.message,
         // support the case where stack is empty or missing
         toString: () => error.stack || error.toString()
     };
+    if ('cause' in error) {
+        errorObj.cause = errorToPOJO(error.cause);
+    }
+    return errorObj;
 }
 errors.errorToPOJO = errorToPOJO;
 
@@ -8221,7 +8371,7 @@ var _RTCEndpoint_processAction, _RTCEndpoint_disconnectListener;
 Object.defineProperty(endpoint, "__esModule", { value: true });
 endpoint.RTCEndpoint = void 0;
 /* eslint-disable @typescript-eslint/no-unused-vars */
-const errors_1$1 = errors;
+const errors_1$2 = errors;
 /*
 This handles sending RTC messages between RTC connections over the request and response data channels.
 */
@@ -8310,7 +8460,7 @@ class RTCEndpoint {
                     if (this.rtc.channels.response.readyState === 'open') {
                         this.rtc.channels.response.send(JSON.stringify({
                             messageId,
-                            error: (0, errors_1$1.errorToPOJO)(error),
+                            error: (0, errors_1$2.errorToPOJO)(error),
                             success: false
                         }));
                     }
@@ -8626,8 +8776,10 @@ var __classPrivateFieldSet$6 = (commonjsGlobal && commonjsGlobal.__classPrivateF
 var _ChannelProvider_connections, _ChannelProvider_protectedObj, _ChannelProvider_strategy, _ChannelProvider_removeEndpoint, _ChannelProvider_close;
 Object.defineProperty(provider, "__esModule", { value: true });
 provider.ChannelProvider = void 0;
-const channel_1 = channel;
+const transport_errors_1$2 = transportErrors;
 const runtimeVersioning_1 = runtimeVersioning;
+const channel_1 = channel;
+const channel_error_1 = channelError;
 /**
  * Instance created to enable use of a channel as a provider. Allows for communication with the {@link ChannelClient ChannelClients} by invoking an action on
  * a single client via {@link ChannelProvider#dispatch dispatch} or all clients via {@link ChannelProvider#publish publish}
@@ -8744,7 +8896,10 @@ class ChannelProvider extends channel_1.ChannelBase {
     dispatch(to, action, payload) {
         const endpointId = to.endpointId ?? this.getEndpointIdForOpenFinId(to, action);
         if (endpointId && __classPrivateFieldGet$8(this, _ChannelProvider_strategy, "f").isEndpointConnected(endpointId)) {
-            return __classPrivateFieldGet$8(this, _ChannelProvider_strategy, "f").send(endpointId, action, payload);
+            const callSites = transport_errors_1$2.RuntimeError.getCallSite();
+            return __classPrivateFieldGet$8(this, _ChannelProvider_strategy, "f").send(endpointId, action, payload).catch((e) => {
+                throw new channel_error_1.ChannelError(e, action, payload, callSites);
+            });
         }
         return Promise.reject(new Error(`Client connection with identity uuid: ${to.uuid} / name: ${to.name} / endpointId: ${endpointId} no longer connected.`));
     }
@@ -8957,6 +9112,7 @@ Object.defineProperty(messageReceiver$1, "__esModule", { value: true });
 messageReceiver$1.MessageReceiver = void 0;
 const client_1$1 = client;
 const base_1$g = base;
+const errors_1$1 = errors;
 /*
 This is a singleton (per fin object) tasked with routing messages coming off the ipc to the correct endpoint.
 It needs to be a singleton because there can only be one per wire. It tracks both clients and providers' processAction passed in via the strategy.
@@ -8985,6 +9141,7 @@ class MessageReceiver extends base_1$g.Base {
         if (!handler) {
             ackToSender.payload.success = false;
             ackToSender.payload.reason = `Client connection with identity uuid: ${this.wire.me.uuid} / name: ${this.wire.me.name} / endpointId: ${key} no longer connected.`;
+            ackToSender.payload.error = (0, errors_1$1.errorToPOJO)(new Error(ackToSender.payload.reason));
             return this.wire.sendRaw(ackToSender);
         }
         try {
@@ -8996,6 +9153,7 @@ class MessageReceiver extends base_1$g.Base {
         catch (e) {
             ackToSender.payload.success = false;
             ackToSender.payload.reason = e.message;
+            ackToSender.payload.error = (0, errors_1$1.errorToPOJO)(e);
             return this.wire.sendRaw(ackToSender);
         }
     }
@@ -17429,7 +17587,7 @@ class NodeEnvironment extends BaseEnvironment_1 {
         };
     }
     getAdapterVersionSync() {
-        return "40.82.2";
+        return "40.82.4";
     }
     observeBounds(element, onChange) {
         throw new Error('Method not implemented.');
@@ -17760,7 +17918,10 @@ class Transport extends events_1$1.EventEmitter {
                 }
                 else {
                     console.warn('Received invalid response from core', data);
-                    handleNack({ reason: 'invalid response shape' });
+                    handleNack({
+                        reason: 'invalid response shape',
+                        error: (0, errors_1.errorToPOJO)(new Error('Invalid response shape'))
+                    });
                 }
             }
             else if (!data.payload.success) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "40.82.2",
+    "version": "40.82.4",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",
@@ -23,7 +23,7 @@
     "author": "OpenFin",
     "dependencies": {
         "@types/node": "^20.14.2",
-        "@openfin/core": "40.82.2",
+        "@openfin/core": "40.82.4",
         "lodash": "^4.17.21",
         "ws": "^7.3.0"
     }