Merge pull request Expensify#67581 from Expensify/arosiclair-log-done-onyx-updates

[No QA] Improve onyx update logging

Author: techievivek

src/libs/Notification/PushNotification/subscribeToPushNotifications.ts

@@ -52,7 +52,7 @@ Onyx.connect({
 });
 
 function applyOnyxData({reportID, onyxData, lastUpdateID, previousUpdateID, hasPendingOnyxUpdates = false}: PushNotificationData): Promise<void> {
-    Log.info(`[PushNotification] Applying onyx data in the ${Visibility.isVisible() ? 'foreground' : 'background'}`, false, {reportID});
+    Log.info(`[PushNotification] Applying onyx data in the ${Visibility.isVisible() ? 'foreground' : 'background'}`, false, {reportID, lastUpdateID});
 
     const logMissingOnyxDataInfo = (isDataMissing: boolean): boolean => {
         if (isDataMissing) {

src/libs/actions/OnyxUpdates.ts

@@ -26,9 +26,9 @@ let pusherEventsPromise = Promise.resolve();
 
 let airshipEventsPromise = Promise.resolve();
 
-function applyHTTPSOnyxUpdates(request: Request, response: Response) {
+function applyHTTPSOnyxUpdates(request: Request, response: Response, lastUpdateID: number) {
     Performance.markStart(CONST.TIMING.APPLY_HTTPS_UPDATES);
-    console.debug('[OnyxUpdateManager] Applying https update');
+    Log.info('[OnyxUpdateManager] Applying https update', false, {lastUpdateID});
     // For most requests we can immediately update Onyx. For write requests we queue the updates and apply them after the sequential queue has flushed to prevent a replay effect in
     // the UI. See https://github.com/Expensify/App/issues/12775 for more info.
     const updateHandler: (updates: OnyxUpdate[]) => Promise<unknown> = request?.data?.apiRequestType === CONST.API_REQUEST_TYPE.WRITE ? queueOnyxUpdates : Onyx.update;
@@ -64,40 +64,40 @@ function applyHTTPSOnyxUpdates(request: Request, response: Response) {
         })
         .then(() => {
             Performance.markEnd(CONST.TIMING.APPLY_HTTPS_UPDATES);
-            console.debug('[OnyxUpdateManager] Done applying HTTPS update');
+            Log.info('[OnyxUpdateManager] Done applying HTTPS update', false, {lastUpdateID});
             return Promise.resolve(response);
         });
 }
 
-function applyPusherOnyxUpdates(updates: OnyxUpdateEvent[]) {
+function applyPusherOnyxUpdates(updates: OnyxUpdateEvent[], lastUpdateID: number) {
     Performance.markStart(CONST.TIMING.APPLY_PUSHER_UPDATES);
 
     pusherEventsPromise = pusherEventsPromise.then(() => {
-        console.debug('[OnyxUpdateManager] Applying pusher update');
+        Log.info('[OnyxUpdateManager] Applying pusher update', false, {lastUpdateID});
     });
 
     pusherEventsPromise = updates
         .reduce((promise, update) => promise.then(() => PusherUtils.triggerMultiEventHandler(update.eventType, update.data)), pusherEventsPromise)
         .then(() => {
             Performance.markEnd(CONST.TIMING.APPLY_PUSHER_UPDATES);
-            console.debug('[OnyxUpdateManager] Done applying Pusher update');
+            Log.info('[OnyxUpdateManager] Done applying Pusher update', false, {lastUpdateID});
         });
 
     return pusherEventsPromise;
 }
 
-function applyAirshipOnyxUpdates(updates: OnyxUpdateEvent[]) {
+function applyAirshipOnyxUpdates(updates: OnyxUpdateEvent[], lastUpdateID: number) {
     Performance.markStart(CONST.TIMING.APPLY_AIRSHIP_UPDATES);
 
     airshipEventsPromise = airshipEventsPromise.then(() => {
-        console.debug('[OnyxUpdateManager] Applying Airship updates');
+        Log.info('[OnyxUpdateManager] Applying Airship updates', false, {lastUpdateID});
     });
 
     airshipEventsPromise = updates
         .reduce((promise, update) => promise.then(() => Onyx.update(update.data)), airshipEventsPromise)
         .then(() => {
             Performance.markEnd(CONST.TIMING.APPLY_AIRSHIP_UPDATES);
-            console.debug('[OnyxUpdateManager] Done applying Airship updates');
+            Log.info('[OnyxUpdateManager] Done applying Airship updates', false, {lastUpdateID});
         });
 
     return airshipEventsPromise;
@@ -136,7 +136,7 @@ function apply({lastUpdateID, type, request, response, updates}: OnyxUpdatesFrom
 
             // We use a spread here instead of delete because we don't want to change the response for other middlewares
             const {onyxData, ...responseWithoutOnyxData} = response;
-            return applyHTTPSOnyxUpdates(request, responseWithoutOnyxData);
+            return applyHTTPSOnyxUpdates(request, responseWithoutOnyxData, Number(lastUpdateID));
         }
 
         return Promise.resolve();
@@ -145,13 +145,13 @@ function apply({lastUpdateID, type, request, response, updates}: OnyxUpdatesFrom
         Onyx.merge(ONYXKEYS.ONYX_UPDATES_LAST_UPDATE_ID_APPLIED_TO_CLIENT, Number(lastUpdateID));
     }
     if (type === CONST.ONYX_UPDATE_TYPES.HTTPS && request && response) {
-        return applyHTTPSOnyxUpdates(request, response);
+        return applyHTTPSOnyxUpdates(request, response, Number(lastUpdateID));
     }
     if (type === CONST.ONYX_UPDATE_TYPES.PUSHER && updates) {
-        return applyPusherOnyxUpdates(updates);
+        return applyPusherOnyxUpdates(updates, Number(lastUpdateID));
     }
     if (type === CONST.ONYX_UPDATE_TYPES.AIRSHIP && updates) {
-        return applyAirshipOnyxUpdates(updates);
+        return applyAirshipOnyxUpdates(updates, Number(lastUpdateID));
     }
 }
 

src/libs/actions/__mocks__/OnyxUpdates.ts

@@ -24,7 +24,7 @@ const apply = jest.fn(({lastUpdateID, request, response}: OnyxUpdatesFromServer)
     }
 
     if (request && response) {
-        return applyHTTPSOnyxUpdates(request, response).then(() => undefined);
+        return applyHTTPSOnyxUpdates(request, response, Number(lastUpdateID)).then(() => undefined);
     }
 
     return Promise.resolve();