Fix platform event connection error messages

Improved error message when a connection could not be established ensure selected event is cleared out on org change
jetstreamapp · Dec 18, 2023 · c62e224 · c62e224
1 parent 909462c
commit c62e224
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 14 deletions.
diff --git a/apps/jetstream/src/app/components/platform-event-monitor/PlatformEventMonitor.tsx b/apps/jetstream/src/app/components/platform-event-monitor/PlatformEventMonitor.tsx
@@ -1,6 +1,6 @@
 import { css } from '@emotion/react';
 import { TITLES } from '@jetstream/shared/constants';
-import { useTitle } from '@jetstream/shared/ui-utils';
+import { useNonInitialEffect, useTitle } from '@jetstream/shared/ui-utils';
 import { SplitWrapper as Split } from '@jetstream/splitjs';
 import { ListItem, ListItemGroup, SalesforceOrgUi } from '@jetstream/types';
 import { AutoFullHeightContainer } from '@jetstream/ui';
@@ -46,6 +46,10 @@ export const PlatformEventMonitor: FunctionComponent<PlatformEventMonitorProps>
     };
   }, []);
 
+  useNonInitialEffect(() => {
+    setSelectedPublishEvent(null);
+  }, [selectedOrg]);
+
   useEffect(() => {
     const subscriptionEvents: ListItemGroup<string, PlatformEventObject>[] = [
       {
@@ -123,7 +127,7 @@ export const PlatformEventMonitor: FunctionComponent<PlatformEventMonitorProps>
   const hasErrorOrNoEvents = !hasPlatformEvents || platformEventFetchError;
 
   return (
-    <AutoFullHeightContainer className="slds-p-horizontal_x-small slds-scrollable_none">
+    <AutoFullHeightContainer className="slds-p-horizontal_x-small slds-scrollable_none" key={selectedOrg.uniqueId}>
       {hasErrorOrNoEvents && (
         <PlatformEventMonitorFetchEventStatus
           serverUrl={serverUrl}

diff --git a/apps/jetstream/src/app/components/platform-event-monitor/platform-event-monitor.types.ts b/apps/jetstream/src/app/components/platform-event-monitor/platform-event-monitor.types.ts
@@ -13,7 +13,13 @@ export interface EventMessage {
 }
 
 export interface EventMessageUnsuccessful extends EventMessage {
-  subscription: string;
-  error: string;
+  subscription?: string;
+  error?: string;
   successful: false;
+  failure?: {
+    connectionType: string;
+    exception?: string;
+    reason?: string;
+    transport?: string;
+  };
 }
diff --git a/apps/jetstream/src/app/components/platform-event-monitor/usePlatformEvent.ts b/apps/jetstream/src/app/components/platform-event-monitor/usePlatformEvent.ts
@@ -124,16 +124,22 @@ export function usePlatformEvent({ selectedOrg }: { selectedOrg: SalesforceOrgUi
   );
 
   const handleSubscribeError = useCallback((message: EventMessageUnsuccessful) => {
-    logger.warn('[PLATFORM EVENT][ERROR] unsubscribing');
-    fireToast({ type: 'error', message: `Error subscribing to event: ${message.subscription}. ${message.error}` });
-    setMessagesByChannel((item) => {
-      return Object.keys(item)
-        .filter((key) => key !== message.subscription)
-        .reduce((output: MessagesByChannel, key) => {
-          output[key] = item[key];
-          return output;
-        }, {});
-    });
+    logger.warn('[PLATFORM EVENT][ERROR]', message);
+    if (message.subscription) {
+      fireToast({ type: 'error', message: `Error subscribing to event: ${message.subscription}. ${message.error}` });
+      setMessagesByChannel((item) => {
+        return Object.keys(item)
+          .filter((key) => key !== message.subscription)
+          .reduce((output: MessagesByChannel, key) => {
+            output[key] = item[key];
+            return output;
+          }, {});
+      });
+    } else if (message.channel === '/meta/handshake') {
+      fireToast({ type: 'error', message: `Error subscribing to event: ${message.failure?.reason || 'Unknown reason'}.` });
+    } else {
+      fireToast({ type: 'error', message: `There was an unknown error subscribing to the event` });
+    }
   }, []);
 
   const subscribe = useCallback(