chore: improve tests for reliability [] (#2847)

* chore: remove concurrent async calls to better help rate limiting

* chore: add waitForEnvironmentToBeReady to tests where it wasn't already there

* fix: fix lint

---------

Co-authored-by: Ely Lucas <ely.lucas@contentful.com>

Author: elylucasctfl

test/integration/comment-integration.test.ts

@@ -5,6 +5,7 @@ import {
   createTestSpace,
   initPlainClient,
   timeoutToCalmRateLimiting,
+  waitForEnvironmentToBeReady,
 } from '../helpers'
 import type { ContentType, Entry, Environment, PlainClientAPI, Space } from '../../lib/export-types'
 
@@ -19,11 +20,9 @@ describe('Comment Api', () => {
 
   beforeAll(async () => {
     plainClient = initPlainClient()
-    space = (await createTestSpace(defaultClient, 'Comment')) as Space
-    environment = (await createTestEnvironment(
-      space,
-      'Comment Testing Environment',
-    )) as unknown as Environment
+    space = await createTestSpace(defaultClient, 'Comment')
+    environment = await createTestEnvironment(space, 'Comment Testing Environment')
+    await waitForEnvironmentToBeReady(space, environment)
     contentType = await environment.createContentType({
       name: 'Content Type',
       fields: [

test/integration/content-type-integration.test.ts

@@ -6,6 +6,7 @@ import {
   generateRandomId,
   getDefaultSpace,
   timeoutToCalmRateLimiting,
+  waitForEnvironmentToBeReady,
 } from '../helpers'
 import type { Environment, ContentType, Space } from '../../lib/export-types'
 
@@ -23,6 +24,7 @@ describe('ContentType Api', () => {
 
     writeSpace = await createTestSpace(defaultClient, 'ContentType')
     writeEnvironment = await createTestEnvironment(writeSpace, 'Testing Environment')
+    await waitForEnvironmentToBeReady(writeSpace, writeEnvironment)
   })
 
   afterAll(async () => {

test/integration/locale-integration.test.ts

@@ -4,6 +4,7 @@ import {
   createTestEnvironment,
   createTestSpace,
   timeoutToCalmRateLimiting,
+  waitForEnvironmentToBeReady,
 } from '../helpers'
 import type { Space, Environment } from '../../lib/export-types'
 
@@ -14,6 +15,7 @@ describe('Locale API', () => {
   beforeAll(async () => {
     space = await createTestSpace(defaultClient, 'Locale')
     environment = await createTestEnvironment(space, 'Test')
+    await waitForEnvironmentToBeReady(space, environment)
   })
 
   afterAll(async () => {

test/integration/plain-client.test.ts

@@ -6,6 +6,7 @@ import {
   generateRandomId,
   getDefaultSpace,
   timeoutToCalmRateLimiting,
+  waitForEnvironmentToBeReady,
 } from '../helpers'
 import type { Environment, ContentType, Space } from '../../lib/export-types'
 
@@ -26,6 +27,7 @@ describe('ContentType Api', () => {
       writeSpace,
       'Testing Environment',
     )) as unknown as Environment
+    await waitForEnvironmentToBeReady(writeSpace, writeEnvironment)
   })
 
   afterAll(async () => {

test/integration/release-action-integration.test.ts

@@ -56,10 +56,8 @@ describe('ReleaseAction Api', () => {
       },
     }
 
-    ;[testRelease, testRelease2] = await Promise.all([
-      testEnvironment.createRelease(releasePayload),
-      testEnvironment.createRelease(releasePayload),
-    ])
+    testRelease = await testEnvironment.createRelease(releasePayload)
+    testRelease2 = await testEnvironment.createRelease(releasePayload)
 
     testReleaseAction = await testRelease.validate()
     testReleaseAction2 = await testRelease2.validate()

test/integration/release-integration.test.ts

@@ -87,22 +87,20 @@ describe('Release Api', () => {
     })
 
     it('Get Releases', async () => {
-      const [release1, release2] = await Promise.all([
-        testEnvironment.createRelease({
-          title: 'First release',
-          entities: {
-            sys: { type: 'Array' },
-            items: [makeLink('Entry', TestDefaults.entry.testEntryReleasesId)],
-          },
-        }),
-        testEnvironment.createRelease({
-          title: 'Second release',
-          entities: {
-            sys: { type: 'Array' },
-            items: [makeLink('Entry', TestDefaults.entry.testEntryReleasesId)],
-          },
-        }),
-      ])
+      const release1 = await testEnvironment.createRelease({
+        title: 'First release',
+        entities: {
+          sys: { type: 'Array' },
+          items: [makeLink('Entry', TestDefaults.entry.testEntryReleasesId)],
+        },
+      })
+      const release2 = await testEnvironment.createRelease({
+        title: 'Second release',
+        entities: {
+          sys: { type: 'Array' },
+          items: [makeLink('Entry', TestDefaults.entry.testEntryReleasesId)],
+        },
+      })
 
       const queryLimit = 1
       const queryResult = await testEnvironment.getReleases({
@@ -116,29 +114,25 @@ describe('Release Api', () => {
       expect(typeof queryResult.pages?.next).toBe('string')
 
       // cleanup
-      await Promise.all([
-        testEnvironment.deleteRelease(release1.sys.id),
-        testEnvironment.deleteRelease(release2.sys.id),
-      ])
+      await testEnvironment.deleteRelease(release1.sys.id)
+      await testEnvironment.deleteRelease(release2.sys.id)
     })
 
     it('Get Releases with query filters', async () => {
-      const [release1, release2] = await Promise.all([
-        testEnvironment.createRelease({
-          title: 'First release',
-          entities: {
-            sys: { type: 'Array' },
-            items: [makeLink('Entry', TestDefaults.entry.testEntryReleasesId)],
-          },
-        }),
-        testEnvironment.createRelease({
-          title: 'Second release',
-          entities: {
-            sys: { type: 'Array' },
-            items: [],
-          },
-        }),
-      ])
+      const release1 = await testEnvironment.createRelease({
+        title: 'First release',
+        entities: {
+          sys: { type: 'Array' },
+          items: [makeLink('Entry', TestDefaults.entry.testEntryReleasesId)],
+        },
+      })
+      const release2 = await testEnvironment.createRelease({
+        title: 'Second release',
+        entities: {
+          sys: { type: 'Array' },
+          items: [],
+        },
+      })
 
       const queryResult = await testEnvironment.getReleases({
         'entities[exists]': true,
@@ -151,10 +145,8 @@ describe('Release Api', () => {
       expect(queryResult.items[0].title).toBe('First release')
 
       // cleanup
-      await Promise.all([
-        testEnvironment.deleteRelease(release1.sys.id),
-        testEnvironment.deleteRelease(release2.sys.id),
-      ])
+      await testEnvironment.deleteRelease(release1.sys.id)
+      await testEnvironment.deleteRelease(release2.sys.id)
     })
   })
 

test/integration/scheduled-action-integration.test.ts

@@ -19,7 +19,9 @@ const cleanup = async (testSpace: Space, environmentId: string) => {
     'sys.status': 'scheduled',
   })
 
-  await Promise.all(scheduledActions.items.map((action) => action.delete()))
+  for (const action of scheduledActions.items) {
+    await action.delete()
+  }
 }
 
 describe('Scheduled Actions API', () => {
@@ -78,30 +80,22 @@ describe('Scheduled Actions API', () => {
     })
 
     it.skip('Query Scheduled Actions', async () => {
-      const [action1, action2] = await Promise.all([
-        testSpace.createScheduledAction({
-          entity: makeLink('Entry', TestDefaults.entry.testEntryId),
-          action: 'publish',
-          environment: makeLink('Environment', environment.sys.id),
-          scheduledFor: {
-            datetime,
-          },
-        }),
-        testSpace.createScheduledAction({
-          entity: makeLink('Asset', asset.sys.id),
-          action: 'unpublish',
-          environment: {
-            sys: {
-              type: 'Link',
-              linkType: 'Environment',
-              id: environment.sys.id,
-            },
-          },
-          scheduledFor: {
-            datetime,
-          },
-        }),
-      ])
+      const action1 = await testSpace.createScheduledAction({
+        entity: makeLink('Entry', TestDefaults.entry.testEntryId),
+        action: 'publish',
+        environment: makeLink('Environment', environment.sys.id),
+        scheduledFor: {
+          datetime,
+        },
+      })
+      const action2 = await testSpace.createScheduledAction({
+        entity: makeLink('Entry', TestDefaults.entry.testEntryId),
+        action: 'publish',
+        environment: makeLink('Environment', environment.sys.id),
+        scheduledFor: {
+          datetime,
+        },
+      })
 
       try {
         const queryLimit = 1

test/integration/tag-integration.test.ts

@@ -29,8 +29,9 @@ describe('Tags API', () => {
 
   afterEach(async () => {
     const tags = await environment.getTags({ limit: 1000 })
-    const deleting = tags.items.map((tag) => tag.delete())
-    await Promise.allSettled(deleting)
+    for (const tag of tags.items) {
+      await tag.delete().catch(() => {})
+    }
   })
 
   afterAll(async () => {