@openfin/core 32.75.6 → 32.75.8

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "32.75.6",
+    "version": "32.75.8",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -2243,6 +2243,7 @@ export type FindInPageResult = {
 export type FrameInfo = {
     name: string;
     uuid: string;
+    url: string;
     entityType: EntityType;
     parent: Identity;
 };

package/src/api/interappbus/channel/index.d.ts

@@ -15,6 +15,7 @@ export interface ChannelMessage extends Message<any> {
 export declare class Channel extends EmitterBase<ChannelEvent> {
     #private;
     constructor(wire: Transport);
+    private channelExists;
     getAllChannels(): Promise<ProviderIdentity[]>;
     onChannelConnect(listener: (...args: any[]) => void): Promise<void>;
     onChannelDisconnect(listener: (...args: any[]) => void): Promise<void>;

package/src/api/interappbus/channel/index.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _Channel_connectionManager;
+var _Channel_connectionManager, _Channel_internalEmitter, _Channel_readyToConnect;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Channel = void 0;
 /* eslint-disable no-console */
@@ -18,16 +18,27 @@ const client_1 = require("./client");
 const provider_1 = require("./provider");
 const base_1 = require("../../base");
 const connection_manager_1 = require("./connection-manager");
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = () => { };
+const events_1 = require("events");
 class Channel extends base_1.EmitterBase {
     constructor(wire) {
         super(wire, 'channel');
         _Channel_connectionManager.set(this, void 0);
+        _Channel_internalEmitter.set(this, new events_1.EventEmitter());
+        _Channel_readyToConnect.set(this, void 0);
         __classPrivateFieldSet(this, _Channel_connectionManager, new connection_manager_1.ConnectionManager(wire), "f");
-        this.on('disconnected', (eventPayload) => {
-            client_1.default.handleProviderDisconnect(eventPayload);
-        }).catch((e) => console.error('Error setting up a disconnected listener:', e));
+        // OpenFin API has not been injected at construction time, *must* wait for API to be ready.
+        __classPrivateFieldSet(this, _Channel_readyToConnect, this.wire.environment.whenReady().then(() => {
+            this.on('disconnected', (eventPayload) => {
+                client_1.default.handleProviderDisconnect(eventPayload);
+            }).catch((e) => console.error('Error setting up a disconnected listener:', e));
+            return this.on('connected', (...args) => {
+                __classPrivateFieldGet(this, _Channel_internalEmitter, "f").emit('connected', ...args);
+            });
+        }), "f");
+    }
+    async channelExists(channelName) {
+        const channels = await this.getAllChannels();
+        return channels.some((providerIdentity) => providerIdentity.channelName === channelName);
     }
     async getAllChannels() {
         return this.wire.sendAction('get-all-channels').then(({ payload }) => payload.data);
@@ -38,47 +49,38 @@ class Channel extends base_1.EmitterBase {
     async onChannelDisconnect(listener) {
         await this.on('disconnected', listener);
     }
-    async connect(channelName, options) {
+    async connect(channelName, options = {}) {
         if (!channelName || typeof channelName !== 'string') {
             throw new Error('Please provide a channelName string to connect to a channel.');
         }
-        const opts = Object.assign(this.wire.environment.getDefaultChannelOptions().connect, options || {});
-        let resolver = noop;
-        let listener = noop;
-        const waitResponse = new Promise((resolve) => {
-            resolver = resolve;
-            listener = (payload) => {
-                if (channelName === payload.channelName) {
-                    this.removeListener('connected', listener);
-                    resolve(this.connect(channelName, opts));
-                }
-            };
-            this.on('connected', listener);
-        });
+        const opts = { wait: true, ...this.wire.environment.getDefaultChannelOptions().connect, ...options };
+        const shouldWait = opts.wait;
+        if (shouldWait) {
+            const channelExists = await this.channelExists(channelName);
+            if (!channelExists) {
+                console.warn(`Channel not found for channelName: ${channelName}, waiting for channel connection.`);
+                // Safeguard to ensure 'connected' listener was already added if we need to wait.
+                await __classPrivateFieldGet(this, _Channel_readyToConnect, "f");
+                await new Promise((resolve) => {
+                    const connectedListener = (payload) => {
+                        if (channelName === payload.channelName) {
+                            __classPrivateFieldGet(this, _Channel_internalEmitter, "f").removeListener('connected', connectedListener);
+                            resolve();
+                        }
+                    };
+                    __classPrivateFieldGet(this, _Channel_internalEmitter, "f").on('connected', connectedListener);
+                });
+            }
+        }
         try {
             const { offer, rtc: rtcPacket } = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientOffer(opts);
-            let connectionUrl;
-            const entityType = this.wire.environment.getCurrentEntityType();
-            if (entityType === 'iframe') {
-                // @ts-expect-error
-                // TODO: type this correctly (frame types are broken)
-                connectionUrl = (await this.fin.me.getInfo()).url;
-            }
-            else if (entityType === 'window' || entityType === 'view') {
-                connectionUrl = (await this.fin.me.getInfo()).url;
-            }
-            const res = await this.wire.sendAction('connect-to-channel', {
+            const connectionUrl = (await this.fin.me.getInfo()).url;
+            const { payload: { data: routingInfo } } = await this.wire.sendAction('connect-to-channel', {
                 channelName,
                 ...opts,
                 offer,
                 connectionUrl
             });
-            const { payload: { data: routingInfo } } = res;
-            // If there isn't a matching channel, the above sendAction call will error out and go to catch, skipping the logic below.
-            if (resolver) {
-                resolver();
-            }
-            this.removeListener('connected', listener);
             const strategy = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientStrategy(rtcPacket, routingInfo);
             const channel = new client_1.default(routingInfo, this.wire, strategy);
             // It is the client's responsibility to handle endpoint disconnection to the provider.
@@ -97,18 +99,13 @@ class Channel extends base_1.EmitterBase {
             });
             return channel;
         }
-        catch (e) {
-            const shouldWait = { wait: true, ...opts }.wait;
+        catch (error) {
             const internalNackMessage = 'internal-nack';
-            if (shouldWait && e.message && e.message.includes(internalNackMessage)) {
-                console.warn(`Channel not found for channelName: ${channelName}, waiting for channel connection.`);
-                return waitResponse;
-            }
-            if (e.message === internalNackMessage) {
-                throw new Error(`No channel found for channelName: ${channelName}`);
+            if (error.message.includes(internalNackMessage)) {
+                throw new Error(`No channel found for channelName: ${channelName}.`);
             }
             else {
-                throw new Error(e);
+                throw new Error(error);
             }
         }
     }
@@ -129,4 +126,4 @@ class Channel extends base_1.EmitterBase {
     }
 }
 exports.Channel = Channel;
-_Channel_connectionManager = new WeakMap();
+_Channel_connectionManager = new WeakMap(), _Channel_internalEmitter = new WeakMap(), _Channel_readyToConnect = new WeakMap();