feat: parity between overlayDrafts and perspectives=previewDrafts

src/syncingDataset.ts

@@ -3,6 +3,7 @@
 import {getPublishedId} from './drafts'
 import {applyPatchWithoutRev} from './patch'
 import {Config, EnvImplementations, MutationEvent, Subscription} from './types'
+import {compareString} from './utils'
 
 const DEBOUNCE_MS = 25
 
@@ -37,7 +38,9 @@
     stagedDocs = undefined
     flushTimeout = undefined
     previousTrx = undefined
-    onNotifyUpdate(overlayDrafts ? overlay(docs) : docs)
+    const finalDocs = overlayDrafts ? overlay(docs) : docs
+    finalDocs.sort((a, b) => compareString(a._id, b._id))
+    onNotifyUpdate(finalDocs)
   }
 
   if (!useListener) {
@@ -150,7 +153,7 @@
   groups.forEach((group, id) => {
     const document = documents.find((doc) => doc._id === id)
     if (!document) {
       // @todo handle
       // eslint-disable-next-line no-console
       console.warn('Received mutation for missing document %s', id)
       return
@@ -188,7 +191,7 @@
       overlayed.set(getPublishedId(doc), pretendThatItsPublished(doc))
     } else if (!existing) {
       // Published documents only override if draft doesn't exist
-      overlayed.set(doc._id, doc)
+      overlayed.set(doc._id, {...doc, _originalId: doc._id})
     }
   })
 
@@ -198,5 +201,5 @@
 // Strictly speaking it would be better to allow groq-js to resolve `draft.<id>`,
 // but for now this will have to do
 function pretendThatItsPublished(doc: SanityDocument): SanityDocument {
-  return {...doc, _id: getPublishedId(doc)}
+  return {...doc, _id: getPublishedId(doc), _originalId: doc._id}
 }

src/utils.ts

@@ -0,0 +1,5 @@
+export function compareString(a: string, b: string): number {
+  if (a > b) return 1
+  if (a < b) return -1
+  return 0
+}

test/query.test.ts

@@ -4,7 +4,7 @@ import {GroqStore} from '../src/types'
 import {describe, beforeAll, afterAll, test, expect} from 'vitest'
 
 describe(
-  'query',
+  'query with overlayDrafts',
   () => {
     let store: GroqStore
 
@@ -32,13 +32,57 @@ describe(
       expect(await store.query(groq`*[_type == "vendor"][].title | order(@ asc) [3]`)).toEqual(
         'Freia'
       )
-      expect(await store.query(groq`array::unique(*._type)`)).toEqual([
-        'category',
-        'product',
-        'sanity.imageAsset',
-        'vendor',
+      expect(new Set(await store.query(groq`array::unique(*._type)`))).toEqual(
+        new Set(['category', 'product', 'sanity.imageAsset', 'vendor'])
+      )
+    })
+
+    test('populates _originalId', async () => {
+      const id = await store.query(groq`*[_type == "vendor"][0]._originalId`)
+      expect(id).toBe('01ca40b6-e7fd-4676-af25-33f591de51c0')
+    })
+
+    test('sorts based on _id', async () => {
+      const titles = await store.query(groq`*[_type == "vendor"].title`)
+      expect(titles).toEqual([
+        'Kracie',
+        'Nestlè',
+        'Ferrero',
+        'Freia',
+        'Malaco',
+        'Chocolates Garoto',
+        'Katjes',
+        'Cadbury',
+        'Totte Gott',
       ])
     })
   },
   {timeout: 30000}
 )
+
+describe('query without overlayDrafts', () => {
+  let store: GroqStore
+
+  beforeAll(() => {
+    store = groqStore({...config, listen: false, overlayDrafts: false})
+  })
+
+  afterAll(async () => {
+    await store.close()
+  })
+
+  test('sorts based on _id', async () => {
+    const titles = await store.query(groq`*[_type == "vendor"].title`)
+    expect(titles).toEqual([
+      'Kracie',
+      'Nestlè',
+      'Ferrero',
+      'Freia',
+      'Malaco',
+      'Chocolates Garoto',
+      'Katjes',
+      'Cadbury',
+      'Totte Gott',
+    ])
+  })
+})