@sanity/sdk 2.14.1 → 2.16.0

package/src/releases/utils/sortReleases.test.ts

@@ -333,4 +333,40 @@ describe('sortReleases()', () => {
       expect(sorted[idx]['_id']).toContain(expectedName)
     })
   })
+
+  it('should not throw when a release has no metadata', () => {
+    // Releases created without a title/type can come back from the API with no
+    // `metadata` object at all. Sorting must not throw on these, otherwise the
+    // whole releases subscription errors and the list comes back empty.
+    const releaseWithoutMetadata = {
+      _id: '_.releases.rnometa',
+      _rev: 'rev',
+      _type: 'system.release',
+      _createdAt: '2024-10-24T00:00:00Z',
+      _updatedAt: '2024-10-24T00:00:00Z',
+      state: 'active',
+      name: 'rnometa',
+    } as unknown as ReleaseDocument
+
+    const releases: ReleaseDocument[] = [
+      createReleaseMock({
+        _id: '_.releases.rasap1',
+        _createdAt: '2024-10-25T00:00:00Z',
+        metadata: {releaseType: 'asap'},
+      }),
+      releaseWithoutMetadata,
+      createReleaseMock({
+        _id: '_.releases.rundecided1',
+        _createdAt: '2024-10-26T00:00:00Z',
+        metadata: {releaseType: 'undecided'},
+      }),
+    ]
+
+    let sorted: ReleaseDocument[] = []
+    expect(() => {
+      sorted = sortReleases(releases)
+    }).not.toThrow()
+    expect(sorted).toHaveLength(3)
+    expect(sorted.map((r) => r._id)).toContain('_.releases.rnometa')
+  })
 })

package/src/releases/utils/sortReleases.ts

@@ -6,25 +6,30 @@ export function sortReleases(releases: ReleaseDocument[] = []): ReleaseDocument[
   // The order should always be:
   // [undecided (sortByCreatedAt), scheduled(sortBy publishAt || metadata.intendedPublishAt), asap(sortByCreatedAt)]
   return [...releases].sort((a, b) => {
+    // metadata is optional on a release document; guard against releases that
+    // have no metadata at all so sorting can't throw and wipe out the list.
+    const aType = a.metadata?.releaseType
+    const bType = b.metadata?.releaseType
+
     // undecided are always first, then by createdAt descending
-    if (a.metadata.releaseType === 'undecided' && b.metadata.releaseType !== 'undecided') {
+    if (aType === 'undecided' && bType !== 'undecided') {
       return -1
     }
-    if (a.metadata.releaseType !== 'undecided' && b.metadata.releaseType === 'undecided') {
+    if (aType !== 'undecided' && bType === 'undecided') {
       return 1
     }
-    if (a.metadata.releaseType === 'undecided' && b.metadata.releaseType === 'undecided') {
+    if (aType === 'undecided' && bType === 'undecided') {
       // Sort by createdAt
       return new Date(b._createdAt).getTime() - new Date(a._createdAt).getTime()
     }
 
     // Scheduled are always at the middle, then by publishAt descending
-    if (a.metadata.releaseType === 'scheduled' && b.metadata.releaseType === 'scheduled') {
-      const aPublishAt = a['publishAt'] || a.metadata['intendedPublishAt']
+    if (aType === 'scheduled' && bType === 'scheduled') {
+      const aPublishAt = a['publishAt'] || a.metadata?.['intendedPublishAt']
       if (!aPublishAt) {
         return 1
       }
-      const bPublishAt = b['publishAt'] || b.metadata['intendedPublishAt']
+      const bPublishAt = b['publishAt'] || b.metadata?.['intendedPublishAt']
       if (!bPublishAt) {
         return -1
       }
@@ -32,13 +37,13 @@ export function sortReleases(releases: ReleaseDocument[] = []): ReleaseDocument[
     }
 
     // ASAP are always last, then by createdAt descending
-    if (a.metadata.releaseType === 'asap' && b.metadata.releaseType !== 'asap') {
+    if (aType === 'asap' && bType !== 'asap') {
       return 1
     }
-    if (a.metadata.releaseType !== 'asap' && b.metadata.releaseType === 'asap') {
+    if (aType !== 'asap' && bType === 'asap') {
       return -1
     }
-    if (a.metadata.releaseType === 'asap' && b.metadata.releaseType === 'asap') {
+    if (aType === 'asap' && bType === 'asap') {
       // Sort by createdAt
       return new Date(b._createdAt).getTime() - new Date(a._createdAt).getTime()
     }