From dd0e8ca031064010148416fe4c7931b7590d69c8 Mon Sep 17 00:00:00 2001
From: Aaron Boodman <aaron@aaronboodman.com>
Date: Thu, 11 Jul 2024 21:58:09 -1000
Subject: [PATCH] fix(replicache): Fix error message when cookie is object and
 out of order.

See: https://discord.com/channels/830183651022471199/1260896074122530826/1260896074122530826
---
 packages/replicache/src/sync/pull.test.ts | 16 +++++++++-
 packages/replicache/src/sync/pull.ts      | 36 +++++++++++++++--------
 2 files changed, 39 insertions(+), 13 deletions(-)

diff --git a/packages/replicache/src/sync/pull.test.ts b/packages/replicache/src/sync/pull.test.ts
index 925287c747..1ca7d173c2 100644
--- a/packages/replicache/src/sync/pull.test.ts
+++ b/packages/replicache/src/sync/pull.test.ts
@@ -873,7 +873,21 @@ test('begin try pull DD31', async () => {
       },
       expNewSyncHead: undefined,
       expBeginPullResult:
-        'Received cookie cookie_0 is < than last snapshot cookie cookie_1; ignoring client view',
+        'Received cookie "cookie_0" is < than last snapshot cookie "cookie_1"; ignoring client view',
+    },
+    {
+      name: 'pulls new state w/lesser cookie using _order -> beginPull errors',
+      numPendingMutations: 0,
+      pullResult: {
+        ...goodPullResp,
+        cookie: {
+          foo: 'bar',
+          order: 'cookie_0',
+        },
+      },
+      expNewSyncHead: undefined,
+      expBeginPullResult:
+        'Received cookie {"foo":"bar","order":"cookie_0"} is < than last snapshot cookie "cookie_1"; ignoring client view',
     },
     {
       name: 'pulls new state with identical client-lmid-changes in response (identical cookie and no patch)',
diff --git a/packages/replicache/src/sync/pull.ts b/packages/replicache/src/sync/pull.ts
index bcd205b127..ed7391cadb 100644
--- a/packages/replicache/src/sync/pull.ts
+++ b/packages/replicache/src/sync/pull.ts
@@ -336,8 +336,8 @@ export function handlePullResponseV0(
       throw new Error(
         badOrderMessage(
           `lastMutationID`,
-          response.lastMutationID,
-          baseLastMutationID,
+          String(response.lastMutationID),
+          String(baseLastMutationID),
         ),
       );
     }
@@ -350,12 +350,16 @@ export function handlePullResponseV0(
     if (deepEqual(frozenCookie, baseCookie)) {
       if (response.patch.length > 0) {
         lc.error?.(
-          `handlePullResponse: cookie ${baseCookie} did not change, but patch is not empty`,
+          `handlePullResponse: cookie ${JSON.stringify(
+            baseCookie,
+          )} did not change, but patch is not empty`,
         );
       }
       if (response.lastMutationID !== baseLastMutationID) {
         lc.error?.(
-          `handlePullResponse: cookie ${baseCookie} did not change, but lastMutationID did change`,
+          `handlePullResponse: cookie ${JSON.stringify(
+            baseCookie,
+          )} did not change, but lastMutationID did change`,
         );
       }
       return {
@@ -451,8 +455,8 @@ type HandlePullResponseResult =
 
 function badOrderMessage(
   name: string,
-  receivedValue: unknown,
-  lastSnapshotValue: unknown,
+  receivedValue: string,
+  lastSnapshotValue: string,
 ) {
   return `Received ${name} ${receivedValue} is < than last snapshot ${name} ${lastSnapshotValue}; ignoring client view`;
 }
@@ -485,7 +489,7 @@ export function handlePullResponseV1(
     // In DD31 this is expected to happen if a refresh occurs during a pull.
     if (!deepEqual(expectedBaseCookie, baseCookie)) {
       lc.debug?.(
-        'handlePullResponse: cookie mismatch, pull response is not applicable',
+        'handlePullResponse: cookie mismatch, response is not applicable',
       );
       return {
         type: HandlePullResponseResultType.CookieMismatch,
@@ -501,8 +505,8 @@ export function handlePullResponseV1(
         throw new Error(
           badOrderMessage(
             `${clientID} lastMutationID`,
-            lmidChange,
-            lastMutationID,
+            String(lmidChange),
+            String(lastMutationID),
           ),
         );
       }
@@ -511,20 +515,28 @@ export function handlePullResponseV1(
     const frozenResponseCookie = deepFreeze(response.cookie);
     if (compareCookies(frozenResponseCookie, baseCookie) < 0) {
       throw new Error(
-        badOrderMessage('cookie', frozenResponseCookie, baseCookie),
+        badOrderMessage(
+          'cookie',
+          JSON.stringify(frozenResponseCookie),
+          JSON.stringify(baseCookie),
+        ),
       );
     }
 
     if (deepEqual(frozenResponseCookie, baseCookie)) {
       if (response.patch.length > 0) {
         lc.error?.(
-          `handlePullResponse: cookie ${baseCookie} did not change, but patch is not empty`,
+          `handlePullResponse: cookie ${JSON.stringify(
+            baseCookie,
+          )} did not change, but patch is not empty`,
         );
       }
       if (Object.keys(response.lastMutationIDChanges).length > 0) {
         console.log(response.lastMutationIDChanges);
         lc.error?.(
-          `handlePullResponse: cookie ${baseCookie} did not change, but lastMutationIDChanges is not empty`,
+          `handlePullResponse: cookie ${JSON.stringify(
+            baseCookie,
+          )} did not change, but lastMutationIDChanges is not empty`,
         );
       }
       // If the cookie doesn't change, it's a nop.