Update Pusher module export since now it's platform-specific

Author: VickyStash

src/libs/API/index.ts

@@ -5,7 +5,7 @@ import Log from '@libs/Log';
 import {HandleUnusedOptimisticID, Logging, Pagination, Reauthentication, RecheckConnection, SaveResponseInOnyx} from '@libs/Middleware';
 import {isOffline} from '@libs/Network/NetworkStore';
 import {push as pushToSequentialQueue, waitForIdle as waitForSequentialQueueIdle} from '@libs/Network/SequentialQueue';
-import {getPusherSocketID} from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
 import {processWithMiddleware, use} from '@libs/Request';
 import {getLength as getPersistedRequestsLength} from '@userActions/PersistedRequests';
 import CONST from '@src/CONST';
@@ -70,7 +70,7 @@ function prepareRequest<TCommand extends ApiCommand>(
 
         // We send the pusherSocketID with all write requests so that the api can include it in push events to prevent Pusher from sending the events to the requesting client. The push event
         // is sent back to the requesting client in the response data instead, which prevents a replay effect in the UI. See https://github.com/Expensify/App/issues/12775.
-        pusherSocketID: isWriteRequest ? getPusherSocketID() : undefined,
+        pusherSocketID: isWriteRequest ? Pusher.getPusherSocketID() : undefined,
     };
 
     // Assemble all request metadata (used by middlewares, and for persisted requests stored in Onyx)

src/libs/Navigation/AppNavigator/AuthScreens.tsx

@@ -34,7 +34,7 @@ import type {AuthScreensParamList, CentralPaneName, CentralPaneScreensParamList}
 import {isOnboardingFlowName} from '@libs/NavigationUtils';
 import NetworkConnection from '@libs/NetworkConnection';
 import onyxSubscribe from '@libs/onyxSubscribe';
-import * as Pusher from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
 import PusherConnectionManager from '@libs/PusherConnectionManager';
 import * as ReportUtils from '@libs/ReportUtils';
 import * as SearchQueryUtils from '@libs/SearchQueryUtils';

src/libs/Pusher/index.native.ts

@@ -9,19 +9,8 @@ import {authenticatePusher} from '@userActions/Session';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import TYPE from './EventType';
-import type {
-    Args,
-    ChunkedDataEvents,
-    EventCallbackError,
-    EventData,
-    PingPongEvent,
-    PusherEventName,
-    SocketEventCallback,
-    SocketEventName,
-    States,
-    UserIsLeavingRoomEvent,
-    UserIsTypingEvent,
-} from './types';
+import type {Args, ChunkedDataEvents, EventCallbackError, EventData, PusherEventName, SocketEventCallback, SocketEventName, States} from './types';
+import type PusherModule from './types';
 
 let shouldForceOffline = false;
 Onyx.connect({
@@ -349,6 +338,19 @@ if (window) {
     window.getPusherInstance = () => socket;
 }
 
-export {init, subscribe, unsubscribe, getChannel, isSubscribed, isAlreadySubscribing, sendEvent, disconnect, reconnect, registerSocketEventCallback, TYPE, getPusherSocketID};
-
-export type {EventCallbackError, States, UserIsTypingEvent, UserIsLeavingRoomEvent, PingPongEvent};
+const MobilePusher: PusherModule = {
+    init,
+    subscribe,
+    unsubscribe,
+    getChannel,
+    isSubscribed,
+    isAlreadySubscribing,
+    sendEvent,
+    disconnect,
+    reconnect,
+    registerSocketEventCallback,
+    TYPE,
+    getPusherSocketID,
+};
+
+export default MobilePusher;

src/libs/Pusher/index.ts

@@ -11,16 +11,14 @@ import type {
     ChunkedDataEvents,
     EventCallbackError,
     EventData,
-    PingPongEvent,
     PusherEventName,
     PusherSubscribtionErrorData,
     PusherWithAuthParams,
     SocketEventCallback,
     SocketEventName,
     States,
-    UserIsLeavingRoomEvent,
-    UserIsTypingEvent,
 } from './types';
+import type PusherModule from './types';
 
 let shouldForceOffline = false;
 Onyx.connect({
@@ -380,7 +378,7 @@ if (window) {
     window.getPusherInstance = () => socket;
 }
 
-export {
+const WebPusher: PusherModule = {
     init,
     subscribe,
     unsubscribe,
@@ -396,4 +394,4 @@ export {
     getPusherSocketID,
 };
 
-export type {EventCallbackError, States, UserIsTypingEvent, UserIsLeavingRoomEvent, PingPongEvent};
+export default WebPusher;

src/libs/Pusher/types.ts

@@ -79,6 +79,7 @@ type PusherModule = {
     registerSocketEventCallback: (cb: SocketEventCallback) => void;
     registerCustomAuthorizer?: (authorizer: ChannelAuthorizerGenerator) => void;
     getPusherSocketID: () => string | undefined;
+    TYPE: typeof TYPE;
 };
 
 export default PusherModule;

src/libs/PusherConnectionManager.ts

@@ -2,9 +2,8 @@ import type {ChannelAuthorizationCallback} from 'pusher-js/with-encryption';
 import CONST from '@src/CONST';
 import {authenticatePusher} from './actions/Session';
 import Log from './Log';
-import {reconnect, registerCustomAuthorizer, registerSocketEventCallback} from './Pusher';
-import type {EventCallbackError, States} from './Pusher';
-import type {SocketEventName} from './Pusher/types';
+import Pusher from './Pusher';
+import type {EventCallbackError, SocketEventName, States} from './Pusher/types';
 
 function init() {
     /**
@@ -13,13 +12,13 @@ function init() {
      * current valid token to generate the signed auth response
      * needed to subscribe to Pusher channels.
      */
-    registerCustomAuthorizer?.((channel) => ({
+    Pusher.registerCustomAuthorizer?.((channel) => ({
         authorize: (socketId: string, callback: ChannelAuthorizationCallback) => {
             authenticatePusher(socketId, channel.name, callback);
         },
     }));
 
-    registerSocketEventCallback((eventName: SocketEventName, error?: EventCallbackError | States) => {
+    Pusher.registerSocketEventCallback((eventName: SocketEventName, error?: EventCallbackError | States) => {
         switch (eventName) {
             case 'error': {
                 if (error && 'type' in error) {
@@ -35,7 +34,7 @@ function init() {
                         // On the advice from Pusher directly, they suggested to manually reconnect in those scenarios.
                         if (errorMessage) {
                             Log.hmmm('[PusherConnectionManager] Channels Error 1006 message', {errorMessage});
-                            reconnect();
+                            Pusher.reconnect();
                         }
                     } else if (errorType === CONST.ERROR.PUSHER_ERROR && code === 4201) {
                         // This means the connection was closed because Pusher did not receive a reply from the client when it pinged them for a response

src/libs/PusherUtils.ts

@@ -4,8 +4,8 @@ import CONST from '@src/CONST';
 import type {OnyxUpdatesFromServer} from '@src/types/onyx';
 import Log from './Log';
 import NetworkConnection from './NetworkConnection';
-import {subscribe} from './Pusher';
-import type {PingPongEvent} from './Pusher';
+import Pusher from './Pusher';
+import type {PingPongEvent} from './Pusher/types';
 
 type Callback = (data: OnyxUpdate[]) => Promise<void>;
 
@@ -50,7 +50,7 @@ function subscribeToPrivateUserChannelEvent(eventName: string, accountID: string
     function onSubscriptionFailed(error: Error) {
         Log.hmmm('Failed to subscribe to Pusher channel', {error, pusherChannelName, eventName});
     }
-    subscribe(pusherChannelName, eventName, onEventPush, onPusherResubscribeToPrivateUserChannel).catch(onSubscriptionFailed);
+    Pusher.subscribe(pusherChannelName, eventName, onEventPush, onPusherResubscribeToPrivateUserChannel).catch(onSubscriptionFailed);
 }
 
 export default {

src/libs/actions/Report.ts

@@ -79,7 +79,8 @@ import * as PhoneNumber from '@libs/PhoneNumber';
 import getPolicyEmployeeAccountIDs from '@libs/PolicyEmployeeListUtils';
 import {extractPolicyIDFromPath, getPolicy} from '@libs/PolicyUtils';
 import processReportIDDeeplink from '@libs/processReportIDDeeplink';
-import * as Pusher from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
+import type {UserIsLeavingRoomEvent, UserIsTypingEvent} from '@libs/Pusher/types';
 import * as ReportActionsUtils from '@libs/ReportActionsUtils';
 import type {OptimisticAddCommentReportAction, OptimisticChatReport} from '@libs/ReportUtils';
 import {
@@ -398,7 +399,7 @@ function getReportChannelName(reportID: string): string {
  *
  * This method makes sure that no matter which we get, we return the "new" format
  */
-function getNormalizedStatus(typingStatus: Pusher.UserIsTypingEvent | Pusher.UserIsLeavingRoomEvent): ReportUserIsTyping {
+function getNormalizedStatus(typingStatus: UserIsTypingEvent | UserIsLeavingRoomEvent): ReportUserIsTyping {
     let normalizedStatus: ReportUserIsTyping;
 
     if (typingStatus.userLogin) {
@@ -463,7 +464,7 @@ function subscribeToReportLeavingEvents(reportID: string | undefined) {
     Onyx.set(`${ONYXKEYS.COLLECTION.REPORT_USER_IS_LEAVING_ROOM}${reportID}`, false);
 
     const pusherChannelName = getReportChannelName(reportID);
-    Pusher.subscribe(pusherChannelName, Pusher.TYPE.USER_IS_LEAVING_ROOM, (leavingStatus: Pusher.UserIsLeavingRoomEvent) => {
+    Pusher.subscribe(pusherChannelName, Pusher.TYPE.USER_IS_LEAVING_ROOM, (leavingStatus: UserIsLeavingRoomEvent) => {
         // If the pusher message comes from OldDot, we expect the leaving status to be keyed by user
         // login OR by 'Concierge'. If the pusher message comes from NewDot, it is keyed by accountID
         // since personal details are keyed by accountID.
@@ -1499,7 +1500,7 @@ function saveReportDraftComment(reportID: string, comment: string | null, callba
 /** Broadcasts whether or not a user is typing on a report over the report's private pusher channel. */
 function broadcastUserIsTyping(reportID: string) {
     const privateReportChannelName = getReportChannelName(reportID);
-    const typingStatus: Pusher.UserIsTypingEvent = {
+    const typingStatus: UserIsTypingEvent = {
         [currentUserAccountID]: true,
     };
     Pusher.sendEvent(privateReportChannelName, Pusher.TYPE.USER_IS_TYPING, typingStatus);
@@ -1508,7 +1509,7 @@ function broadcastUserIsTyping(reportID: string) {
 /** Broadcasts to the report's private pusher channel whether a user is leaving a report */
 function broadcastUserIsLeavingRoom(reportID: string) {
     const privateReportChannelName = getReportChannelName(reportID);
-    const leavingStatus: Pusher.UserIsLeavingRoomEvent = {
+    const leavingStatus: UserIsLeavingRoomEvent = {
         [currentUserAccountID]: true,
     };
     Pusher.sendEvent(privateReportChannelName, Pusher.TYPE.USER_IS_LEAVING_ROOM, leavingStatus);

src/libs/actions/Session/index.ts

@@ -36,7 +36,7 @@ import * as MainQueue from '@libs/Network/MainQueue';
 import * as NetworkStore from '@libs/Network/NetworkStore';
 import {getCurrentUserEmail} from '@libs/Network/NetworkStore';
 import NetworkConnection from '@libs/NetworkConnection';
-import * as Pusher from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
 import {getReportIDFromLink, parseReportRouteParams as parseReportRouteParamsReportUtils} from '@libs/ReportUtils';
 import * as SessionUtils from '@libs/SessionUtils';
 import {clearSoundAssetsCache} from '@libs/Sound';

src/libs/actions/User.ts

@@ -32,7 +32,8 @@ import {isOffline} from '@libs/Network/NetworkStore';
 import * as SequentialQueue from '@libs/Network/SequentialQueue';
 import * as NumberUtils from '@libs/NumberUtils';
 import * as PersonalDetailsUtils from '@libs/PersonalDetailsUtils';
-import * as Pusher from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
+import type {PingPongEvent} from '@libs/Pusher/types';
 import PusherUtils from '@libs/PusherUtils';
 import * as ReportActionsUtils from '@libs/ReportActionsUtils';
 import * as ReportUtils from '@libs/ReportUtils';
@@ -905,7 +906,7 @@ function subscribeToPusherPong() {
         lastPongReceivedTimestamp = Date.now();
 
         // Calculate the latency between the client and the server
-        const pongEvent = pushJSON as Pusher.PingPongEvent;
+        const pongEvent = pushJSON as PingPongEvent;
         const latency = Date.now() - Number(pongEvent.pingTimestamp);
         Log.info(`[Pusher PINGPONG] The event took ${latency} ms`);
 

tests/utils/PusherHelper.ts

@@ -1,4 +1,4 @@
-import {init, sendEvent, TYPE, unsubscribe} from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
 import CONFIG from '@src/CONFIG';
 import CONST from '@src/CONST';
 import PusherConnectionManager from '@src/libs/PusherConnectionManager';
@@ -11,12 +11,12 @@ function setup() {
     // channel already in a subscribed state. These methods are normally used to prevent
     // duplicated subscriptions, but we don't need them for this test so forcing them to
     // return false will make the testing less complex.
-    jest.spyOn(require('@libs/Pusher'), 'isSubscribed').mockReturnValue(false);
-    jest.spyOn(require('@libs/Pusher'), 'isAlreadySubscribing').mockReturnValue(false);
+    jest.spyOn(Pusher, 'isSubscribed').mockReturnValue(false);
+    jest.spyOn(Pusher, 'isAlreadySubscribing').mockReturnValue(false);
 
     // Connect to Pusher
     PusherConnectionManager.init();
-    init({
+    Pusher.init({
         appKey: CONFIG.PUSHER.APP_KEY,
         cluster: CONFIG.PUSHER.CLUSTER,
         authEndpoint: `${CONFIG.EXPENSIFY.DEFAULT_API_ROOT}api/AuthenticatePusher?`,
@@ -29,13 +29,13 @@ function setup() {
 }
 
 function emitOnyxUpdate(args: OnyxServerUpdate[]) {
-    sendEvent(CHANNEL_NAME, TYPE.MULTIPLE_EVENTS, {
+    Pusher.sendEvent(CHANNEL_NAME, Pusher.TYPE.MULTIPLE_EVENTS, {
         type: 'pusher',
         lastUpdateID: 0,
         previousUpdateID: 0,
         updates: [
             {
-                eventType: TYPE.MULTIPLE_EVENT_TYPE.ONYX_API_UPDATE,
+                eventType: Pusher.TYPE.MULTIPLE_EVENT_TYPE.ONYX_API_UPDATE,
                 data: args,
             },
         ],
@@ -45,7 +45,7 @@ function emitOnyxUpdate(args: OnyxServerUpdate[]) {
 function teardown() {
     // Unsubscribe from account channel after each test since we subscribe in the function
     // subscribeToUserEvents and we don't want duplicate event subscriptions.
-    unsubscribe(CHANNEL_NAME);
+    Pusher.unsubscribe(CHANNEL_NAME);
 }
 
 export default {

tests/utils/TestHelper.ts

@@ -5,7 +5,7 @@ import Onyx from 'react-native-onyx';
 import type {ConnectOptions} from 'react-native-onyx/dist/types';
 import type {ApiCommand, ApiRequestCommandParameters} from '@libs/API/types';
 import {translateLocal} from '@libs/Localize';
-import {init} from '@libs/Pusher';
+import Pusher from '@libs/Pusher';
 import PusherConnectionManager from '@libs/PusherConnectionManager';
 import CONFIG from '@src/CONFIG';
 import CONST from '@src/CONST';
@@ -47,7 +47,7 @@ function setupApp() {
 
         // Connect to Pusher
         PusherConnectionManager.init();
-        init({
+        Pusher.init({
             appKey: CONFIG.PUSHER.APP_KEY,
             cluster: CONFIG.PUSHER.CLUSTER,
             authEndpoint: `${CONFIG.EXPENSIFY.DEFAULT_API_ROOT}api/AuthenticatePusher?`,