feat: Retry request with status code 202 (box/box-codegen#511) (#235)

box-sdk-build · web-flow · commit 03b8f4314ada · 2024-06-26T16:29:54.000+02:00
diff --git a/.codegen.json b/.codegen.json
@@ -1 +1 @@
-{ "engineHash": "4be1a1e", "specHash": "ee83bc7", "version": "1.1.0" }
+{ "engineHash": "1090584", "specHash": "fc01415", "version": "1.1.0" }
diff --git a/docs/skills.md b/docs/skills.md
@@ -52,21 +52,12 @@ See the endpoint docs at
 await client.skills.createBoxSkillCardsOnFile(file.id, {
   cards: [
     {
-      type: 'skill_card' as KeywordSkillCardTypeField,
-      skillCardType: 'keyword' as KeywordSkillCardSkillCardTypeField,
-      skillCardTitle: {
-        code: 'license-plates',
-        message: titleMessage,
-      } satisfies KeywordSkillCardSkillCardTitleField,
-      skill: new KeywordSkillCardSkillField({
-        id: skillId,
-        type: 'service' as KeywordSkillCardSkillTypeField,
-      }),
-      invocation: new KeywordSkillCardInvocationField({
-        id: invocationId,
-        type: 'skill_invocation' as KeywordSkillCardInvocationTypeField,
-      }),
-      entries: [{ text: 'DN86 BOX' } satisfies KeywordSkillCardEntriesField],
+      type: 'skill_card',
+      skillCardType: 'keyword',
+      skillCardTitle: { code: 'license-plates', message: titleMessage },
+      skill: { id: skillId, type: 'service' },
+      invocation: { id: invocationId, type: 'skill_invocation' },
+      entries: [{ text: 'DN86 BOX' }],
     } satisfies KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard,
   ],
 } satisfies CreateBoxSkillCardsOnFileRequestBody);
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/managers/chunkedUploads.generated.ts b/src/managers/chunkedUploads.generated.ts
@@ -713,11 +713,11 @@ export class ChunkedUploadsManager {
     const bytesEnd: number = lastIndex + chunkSize;
     const contentRange: string = ''.concat(
       'bytes ',
-      toString(bytesStart) as string,
+      (toString(bytesStart) as string)!,
       '-',
-      toString(bytesEnd) as string,
+      (toString(bytesEnd) as string)!,
       '/',
-      toString(acc.fileSize) as string
+      (toString(acc.fileSize) as string)!
     ) as string;
     const uploadedPart: UploadedPart = await this.uploadFilePart(
       acc.uploadSessionId,
@@ -732,10 +732,10 @@ export class ChunkedUploadsManager {
     if (!(partSha1 == sha1)) {
       throw new Error('Assertion failed');
     }
-    if (!(part.size == chunkSize)) {
+    if (!(part.size! == chunkSize)) {
       throw new Error('Assertion failed');
     }
-    if (!(part.offset == bytesStart)) {
+    if (!(part.offset! == bytesStart)) {
       throw new Error('Assertion failed');
     }
     acc.fileHash.updateHash(chunkBuffer);
diff --git a/src/networking/fetch.ts b/src/networking/fetch.ts
@@ -202,6 +202,9 @@ async function createRequestInit(options: FetchOptions): Promise<RequestInit> {
 
 const DEFAULT_MAX_ATTEMPTS = 5;
 const RETRY_BASE_INTERVAL = 1;
+const STATUS_CODE_ACCEPTED = 202,
+  STATUS_CODE_UNAUTHORIZED = 401,
+  STATUS_CODE_TOO_MANY_REQUESTS = 429;
 
 export async function fetch(
   resource: string,
@@ -267,10 +270,14 @@ export async function fetch(
     return fetch(fetchResponse.headers['location'], options);
   }
 
-  if (fetchResponse.status >= 400) {
+  const acceptedWithRetryAfter =
+    fetchResponse.status === STATUS_CODE_ACCEPTED &&
+    fetchResponse.headers['retry-after'];
+  if (fetchResponse.status >= 400 || acceptedWithRetryAfter) {
     const { numRetries = 0 } = fetchOptions;
 
-    const reauthenticationNeeded = fetchResponse.status == 401;
+    const reauthenticationNeeded =
+      fetchResponse.status == STATUS_CODE_UNAUTHORIZED;
     if (reauthenticationNeeded && fetchOptions.auth) {
       await fetchOptions.auth.refreshToken(fetchOptions.networkSession);
 
@@ -280,7 +287,9 @@ export async function fetch(
 
     const isRetryable =
       fetchOptions.contentType !== 'application/x-www-form-urlencoded' &&
-      (fetchResponse.status === 429 || fetchResponse.status >= 500);
+      (fetchResponse.status === STATUS_CODE_TOO_MANY_REQUESTS ||
+        acceptedWithRetryAfter ||
+        fetchResponse.status >= 500);
 
     if (isRetryable && numRetries < DEFAULT_MAX_ATTEMPTS) {
       const retryTimeout = fetchResponse.headers['retry-after']
diff --git a/src/test/chunkedUploads.generated.test.ts b/src/test/chunkedUploads.generated.test.ts
@@ -25,10 +25,10 @@ test('testChunkedUpload', async function testChunkedUpload(): Promise<any> {
     fileSize,
     parentFolderId
   );
-  if (!(uploadedFile.name == fileName)) {
+  if (!(uploadedFile.name! == fileName)) {
     throw new Error('Assertion failed');
   }
-  if (!(uploadedFile.size == fileSize)) {
+  if (!(uploadedFile.size! == fileSize)) {
     throw new Error('Assertion failed');
   }
   if (!(uploadedFile.parent!.id == parentFolderId)) {
diff --git a/src/test/skills.generated.test.ts b/src/test/skills.generated.test.ts
@@ -6,6 +6,10 @@ import { serializeCreateBoxSkillCardsOnFileRequestBody } from '../managers/skill
 import { deserializeCreateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
 import { serializeKeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard } from '../schemas/keywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard.generated.js';
 import { deserializeKeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard } from '../schemas/keywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard.generated.js';
+import { serializeUpdateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
+import { deserializeUpdateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
+import { serializeUpdateBoxSkillCardsOnFileRequestBodyOpField } from '../managers/skills.generated.js';
+import { deserializeUpdateBoxSkillCardsOnFileRequestBodyOpField } from '../managers/skills.generated.js';
 import { serializeKeywordSkillCardTypeField } from '../schemas/keywordSkillCard.generated.js';
 import { deserializeKeywordSkillCardTypeField } from '../schemas/keywordSkillCard.generated.js';
 import { serializeKeywordSkillCardSkillCardTypeField } from '../schemas/keywordSkillCard.generated.js';
@@ -22,17 +26,15 @@ import { serializeKeywordSkillCardInvocationTypeField } from '../schemas/keyword
 import { deserializeKeywordSkillCardInvocationTypeField } from '../schemas/keywordSkillCard.generated.js';
 import { serializeKeywordSkillCardEntriesField } from '../schemas/keywordSkillCard.generated.js';
 import { deserializeKeywordSkillCardEntriesField } from '../schemas/keywordSkillCard.generated.js';
-import { serializeUpdateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
-import { deserializeUpdateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
-import { serializeUpdateBoxSkillCardsOnFileRequestBodyOpField } from '../managers/skills.generated.js';
-import { deserializeUpdateBoxSkillCardsOnFileRequestBodyOpField } from '../managers/skills.generated.js';
 import { serializeKeywordSkillCard } from '../schemas/keywordSkillCard.generated.js';
 import { deserializeKeywordSkillCard } from '../schemas/keywordSkillCard.generated.js';
 import { BoxClient } from '../client.generated.js';
 import { FileFull } from '../schemas/fileFull.generated.js';
 import { SkillCardsMetadata } from '../schemas/skillCardsMetadata.generated.js';
 import { CreateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
 import { KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard } from '../schemas/keywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard.generated.js';
+import { UpdateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
+import { UpdateBoxSkillCardsOnFileRequestBodyOpField } from '../managers/skills.generated.js';
 import { KeywordSkillCardTypeField } from '../schemas/keywordSkillCard.generated.js';
 import { KeywordSkillCardSkillCardTypeField } from '../schemas/keywordSkillCard.generated.js';
 import { KeywordSkillCardSkillCardTitleField } from '../schemas/keywordSkillCard.generated.js';
@@ -41,8 +43,6 @@ import { KeywordSkillCardSkillTypeField } from '../schemas/keywordSkillCard.gene
 import { KeywordSkillCardInvocationField } from '../schemas/keywordSkillCard.generated.js';
 import { KeywordSkillCardInvocationTypeField } from '../schemas/keywordSkillCard.generated.js';
 import { KeywordSkillCardEntriesField } from '../schemas/keywordSkillCard.generated.js';
-import { UpdateBoxSkillCardsOnFileRequestBody } from '../managers/skills.generated.js';
-import { UpdateBoxSkillCardsOnFileRequestBodyOpField } from '../managers/skills.generated.js';
 import { getUuid } from '../internal/utils.js';
 import { getDefaultClient } from './commons.generated.js';
 import { uploadNewFile } from './commons.generated.js';
@@ -64,23 +64,12 @@ test('test_skills_cards_CRUD', async function test_skills_cards_CRUD(): Promise<
     await client.skills.createBoxSkillCardsOnFile(file.id, {
       cards: [
         {
-          type: 'skill_card' as KeywordSkillCardTypeField,
-          skillCardType: 'keyword' as KeywordSkillCardSkillCardTypeField,
-          skillCardTitle: {
-            code: 'license-plates',
-            message: titleMessage,
-          } satisfies KeywordSkillCardSkillCardTitleField,
-          skill: new KeywordSkillCardSkillField({
-            id: skillId,
-            type: 'service' as KeywordSkillCardSkillTypeField,
-          }),
-          invocation: new KeywordSkillCardInvocationField({
-            id: invocationId,
-            type: 'skill_invocation' as KeywordSkillCardInvocationTypeField,
-          }),
-          entries: [
-            { text: 'DN86 BOX' } satisfies KeywordSkillCardEntriesField,
-          ],
+          type: 'skill_card',
+          skillCardType: 'keyword',
+          skillCardTitle: { code: 'license-plates', message: titleMessage },
+          skill: { id: skillId, type: 'service' },
+          invocation: { id: invocationId, type: 'skill_invocation' },
+          entries: [{ text: 'DN86 BOX' }],
         } satisfies KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard,
       ],
     } satisfies CreateBoxSkillCardsOnFileRequestBody);

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{ "engineHash": "4be1a1e", "specHash": "ee83bc7", "version": "1.1.0" }`
	`1`	`+{ "engineHash": "1090584", "specHash": "fc01415", "version": "1.1.0" }`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,10 @@ test('testChunkedUpload', async function testChunkedUpload(): Promise<any> {`
`25`	`25`	`fileSize,`
`26`	`26`	`parentFolderId`
`27`	`27`	`);`
`28`		`- if (!(uploadedFile.name == fileName)) {`
	`28`	`+ if (!(uploadedFile.name! == fileName)) {`
`29`	`29`	`throw new Error('Assertion failed');`
`30`	`30`	`}`
`31`		`- if (!(uploadedFile.size == fileSize)) {`
	`31`	`+ if (!(uploadedFile.size! == fileSize)) {`
`32`	`32`	`throw new Error('Assertion failed');`
`33`	`33`	`}`
`34`	`34`	`if (!(uploadedFile.parent!.id == parentFolderId)) {`