feat(releases): release.entry.getMany() (#2673)

Author: ethan-ozelius-contentful

lib/adapters/REST/endpoints/release-entry.ts

@@ -1,5 +1,9 @@
 import type { AxiosInstance } from 'contentful-sdk-core'
-import type { GetReleaseEntryParams } from '../../../common-types'
+import type {
+  GetReleaseEntryParams,
+  GetSpaceEnvironmentParams,
+  QueryParams,
+} from '../../../common-types'
 import type { RestEndpoint } from '../types'
 import * as raw from './raw'
 
@@ -13,3 +17,15 @@ export const get: RestEndpoint<'ReleaseEntry', 'get'> = (
     `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`
   )
 }
+
+export const getMany: RestEndpoint<'ReleaseEntry', 'getMany'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams & QueryParams & { releaseId: string }
+) => {
+  params.query = { ...params.query, 'sys.schemaVersion': 'Release.V2' }
+
+  return raw.get(
+    http,
+    `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries`
+  )
+}

lib/common-types.ts

@@ -1851,6 +1851,10 @@ export type MRActions = {
       params: GetReleaseEntryParams
       return: EntryProps<any, any>
     }
+    getMany: {
+      params: GetManyReleaseEntryParams
+      return: CollectionProp<EntryProps<any, any>>
+    }
   }
   ReleaseAction: {
     get: {
@@ -2335,6 +2339,11 @@ export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
   releaseId: string
   entryId: string
 }
+
+export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
+  releaseId: string
+}
+
 export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & { contentTypeId: string }
 export type GetSnapshotForEntryParams = GetSpaceEnvironmentParams & { entryId: string }
 export type GetSpaceEnvAliasParams = GetSpaceParams & { environmentAliasId: string }

lib/plain/common-types.ts

@@ -8,6 +8,7 @@ import type {
   GetBulkActionParams,
   GetContentTypeParams,
   GetEnvironmentTemplateParams,
+  GetManyReleaseEntryParams,
   GetOrganizationMembershipParams,
   GetOrganizationParams,
   GetReleaseEntryParams,
@@ -440,6 +441,24 @@ export type PlainClientAPI = {
           }
         >
       >
+      getMany<T extends KeyValueMap = KeyValueMap>(
+        params: OptionalDefaults<GetManyReleaseEntryParams>
+      ): Promise<
+        CollectionProp<
+          EntryProps<
+            T,
+            {
+              release: {
+                sys: {
+                  type: 'Link'
+                  linkType: 'Entry' | 'Asset'
+                  id: string
+                }
+              }
+            }
+          >
+        >
+      >
     }
     archive(params: OptionalDefaults<GetReleaseParams & { version: number }>): Promise<ReleaseProps>
     get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>

lib/plain/plain-client.ts

@@ -344,6 +344,7 @@ export const createPlainClient = (
     release: {
       entry: {
         get: wrap(wrapParams, 'ReleaseEntry', 'get'),
+        getMany: wrap(wrapParams, 'ReleaseEntry', 'getMany'),
       },
       archive: wrap(wrapParams, 'Release', 'archive'),
       get: wrap(wrapParams, 'Release', 'get'),

test/integration/releasev2-integration.test.ts

@@ -6,6 +6,7 @@ import { makeLink } from '../utils'
 
 describe('Release Api v2', () => {
   let entry: EntryProps
+  let secondEntry: EntryProps
   let release: ReleaseProps
   let createReleaseClient: PlainClientAPI
 
@@ -29,6 +30,17 @@ describe('Release Api v2', () => {
       }
     )
 
+    secondEntry = await createReleaseClient.entry.create(
+      { ...defaultParams, contentTypeId: TestDefaults.contentType.withCrossSpaceReferenceId },
+      {
+        fields: {
+          title: {
+            'en-US': 'Second Test Entry for Release',
+          },
+        },
+      }
+    )
+
     release = await createReleaseClient.release.create(defaultParams, {
       title: 'Test Release',
       entities: {
@@ -38,6 +50,10 @@ describe('Release Api v2', () => {
             entity: makeLink('Entry', entry.sys.id),
             action: 'publish',
           },
+          {
+            entity: makeLink('Entry', secondEntry.sys.id),
+            action: 'publish',
+          },
         ],
       },
     })
@@ -51,22 +67,15 @@ describe('Release Api v2', () => {
     await createReleaseClient.entry.delete({
       entryId: entry.sys.id,
     })
+    await createReleaseClient.entry.delete({
+      entryId: secondEntry.sys.id,
+    })
     await timeoutToCalmRateLimiting()
   })
 
   describe('releaseSchemaVersion is provided as a default in client', () => {
-    let clientWithSchemaDefault: PlainClientAPI
-    beforeEach(() => {
-      const defaultParams = {
-        environmentId: TestDefaults.environmentId,
-        spaceId: TestDefaults.spaceId,
-        releaseSchemaVersion: 'Release.v2',
-      }
-      clientWithSchemaDefault = initPlainClient(defaultParams)
-    })
-
     it('release.create works', async () => {
-      const newRelease = await clientWithSchemaDefault.release.create(
+      const newRelease = await createReleaseClient.release.create(
         {
           environmentId: TestDefaults.environmentId,
           spaceId: TestDefaults.spaceId,
@@ -83,20 +92,20 @@ describe('Release Api v2', () => {
       )
       expect(newRelease.sys.schemaVersion).toEqual('Release.v2')
       // cleanup
-      await clientWithSchemaDefault.release.delete({
+      await createReleaseClient.release.delete({
         releaseId: newRelease.sys.id,
       })
     })
 
     it('release.query works', async () => {
-      const releases = await clientWithSchemaDefault.release.query({})
+      const releases = await createReleaseClient.release.query({})
       const fetchedRelease = releases.items.find((item) => item.sys.id === release.sys.id)
-      expect(fetchedRelease).toEqual(release)
+      expect(fetchedRelease?.sys.id).toEqual(release?.sys.id)
       expect(releases.pages).toStrictEqual({})
     })
 
     it('release.update works', async () => {
-      const updatedRelease = await clientWithSchemaDefault.release.update(
+      const updatedRelease = await createReleaseClient.release.update(
         {
           environmentId: TestDefaults.environmentId,
           spaceId: TestDefaults.spaceId,
@@ -111,13 +120,11 @@ describe('Release Api v2', () => {
             },
             items: [
               {
-                entity: {
-                  sys: {
-                    type: 'Link',
-                    linkType: 'Entry',
-                    id: entry.sys.id,
-                  },
-                },
+                entity: makeLink('Entry', entry.sys.id),
+                action: 'publish',
+              },
+              {
+                entity: makeLink('Entry', secondEntry.sys.id),
                 action: 'publish',
               },
             ],
@@ -129,7 +136,7 @@ describe('Release Api v2', () => {
     })
 
     it('release.entry.get works', async () => {
-      const entryInSpace = await clientWithSchemaDefault.release.entry.get({
+      const entryInSpace = await createReleaseClient.release.entry.get({
         releaseId: release.sys.id,
         entryId: entry.sys.id, // Using the same ID for simplicity
         environmentId: TestDefaults.environmentId,
@@ -138,6 +145,23 @@ describe('Release Api v2', () => {
       expect(entryInSpace.sys.id).toEqual(entry.sys.id)
       expect(entryInSpace.sys.release.sys.id).toEqual(release.sys.id)
     })
+
+    it('release.entry.getMany works', async () => {
+      const response = await createReleaseClient.release.entry.getMany({
+        releaseId: release.sys.id,
+
+        environmentId: TestDefaults.environmentId,
+        spaceId: TestDefaults.spaceId,
+      })
+
+      const entries = response.items as EntryProps[]
+      const foundFirstEntry = entries.find((e) => e.sys.id === entry.sys.id)
+      const foundSecondEntry = entries.find((e) => e.sys.id === secondEntry.sys.id)
+
+      expect(entries.length).toEqual(2)
+      expect(foundFirstEntry?.sys.id).toEqual(entry.sys.id)
+      expect(foundSecondEntry?.sys.id).toEqual(secondEntry.sys.id)
+    })
   })
 
   describe('releaseSchemaVersion is not provided as a default', () => {
@@ -192,13 +216,11 @@ describe('Release Api v2', () => {
             },
             items: [
               {
-                entity: {
-                  sys: {
-                    type: 'Link',
-                    linkType: 'Entry',
-                    id: entry.sys.id,
-                  },
-                },
+                entity: makeLink('Entry', entry.sys.id),
+                action: 'publish',
+              },
+              {
+                entity: makeLink('Entry', secondEntry.sys.id),
                 action: 'publish',
               },
             ],

test/unit/adapters/REST/endpoints/release-entry.test.ts

@@ -1,7 +1,7 @@
 import { describe, test, expect, vi, beforeEach, afterEach } from 'vitest'
 import { cloneMock } from '../../../mocks/entities'
 import * as raw from '../../../../../lib/adapters/REST/endpoints/raw'
-import { get } from '../../../../../lib/adapters/REST/endpoints/release-entry'
+import { get, getMany } from '../../../../../lib/adapters/REST/endpoints/release-entry'
 import { EntryProps } from '../../../../../lib/entities/entry'
 import { GetReleaseEntryParams } from '../../../../../lib/contentful-management'
 
@@ -10,10 +10,6 @@ describe('Rest ReleaseEntry', () => {
     any,
     { release: { sys: { type: 'Link'; linkType: 'Release'; id: string } } }
   >
-  let result: EntryProps<
-    any,
-    { release: { sys: { type: 'Link'; linkType: 'Release'; id: string } } }
-  >
   let rawGetSpy: any
   let params: GetReleaseEntryParams
   let httpMock: any
@@ -28,7 +24,7 @@ describe('Rest ReleaseEntry', () => {
       releaseId: 'black-friday',
       entryId: 'abc123',
     }
-    result = await get(httpMock, params)
+    await get(httpMock, params)
   })
 
   afterEach(() => {
@@ -42,11 +38,18 @@ describe('Rest ReleaseEntry', () => {
     )
   })
 
-  test('release.entry.get returns the correct entry', async () => {
-    expect(result).toEqual(mockReleaseEntry)
-  })
+  test('release.entry.getMany calls raw.get with the correct URL and params', async () => {
+    const expectedParams = {
+      spaceId: 'space123',
+      environmentId: 'master',
+      releaseId: 'black-friday',
+    }
+
+    await getMany(httpMock, expectedParams)
 
-  test('release.entry.get returns release metadata', async () => {
-    expect(result.sys.release).toBeDefined()
+    expect(rawGetSpy).toHaveBeenCalledWith(
+      httpMock,
+      '/spaces/space123/environments/master/releases/black-friday/entries'
+    )
   })
 })