qase-javascript-commons 2.4.10 → 2.4.12

package/changelog.md

@@ -1,3 +1,15 @@
+# qase-javascript-commons@2.4.12
+
+## What's new
+
+Improved the retry mechanism for uploading attachments.
+
+# qase-javascript-commons@2.4.11
+
+## What's new
+
+Added retry mechanism for uploading attachments.
+
 # qase-javascript-commons@2.4.10
 
 ## What's new

package/dist/client/clientV1.d.ts

@@ -21,6 +21,27 @@ export declare class ClientV1 implements IClient {
     private getErrorMessage;
     uploadAttachment(attachment: Attachment): Promise<string>;
     protected uploadAttachments(attachments: Attachment[]): Promise<string[]>;
+    /**
+     * Upload attachment with retry logic for 429 errors
+     * @param project Project code
+     * @param data Attachment data
+     * @param attachmentName Attachment name for logging
+     * @param maxRetries Maximum number of retry attempts
+     * @param initialDelay Initial delay in milliseconds
+     * @returns Promise with upload response
+     */
+    private uploadAttachmentWithRetry;
+    /**
+     * Extract Retry-After header value from response or return null
+     * @param error Axios error
+     * @returns Retry-After value in milliseconds or null
+     */
+    private getRetryAfter;
+    /**
+     * Delay execution for specified milliseconds
+     * @param ms Milliseconds to delay
+     */
+    private delay;
     private prepareAttachmentData;
     private getEnvironmentId;
     private prepareRunObject;

package/dist/client/clientV1.js

@@ -145,11 +145,21 @@ class ClientV1 {
             return [];
         }
         const uploadedHashes = [];
-        for (const attachment of attachments) {
+        // Add initial random delay to spread out requests from different workers/shard
+        // This helps prevent all workers from hitting the API at the same time
+        if (attachments.length > 0) {
+            const initialJitter = Math.random() * 500; // 0-500ms random delay
+            await this.delay(initialJitter);
+        }
+        for (let i = 0; i < attachments.length; i++) {
+            const attachment = attachments[i];
+            if (!attachment) {
+                continue;
+            }
             try {
                 this.logger.logDebug(`Uploading attachment: ${attachment.file_path ?? attachment.file_name}`);
                 const data = this.prepareAttachmentData(attachment);
-                const response = await this.attachmentClient.uploadAttachment(this.config.project, [data]);
+                const response = await this.uploadAttachmentWithRetry(this.config.project, [data], attachment.file_path ?? attachment.file_name);
                 const hash = response.data.result?.[0]?.hash;
                 if (hash) {
                     uploadedHashes.push(hash);
@@ -158,9 +168,96 @@ class ClientV1 {
             catch (error) {
                 this.logger.logError('Cannot upload attachment:', error);
             }
+            // Add delay between requests to avoid rate limiting
+            // Skip delay after the last attachment
+            if (i < attachments.length - 1) {
+                // Increased delay with random jitter to prevent synchronization
+                const baseDelay = 1000; // 1000ms (1 second) base delay
+                const jitter = Math.random() * 300; // 0-300ms random jitter
+                await this.delay(baseDelay + jitter);
+            }
         }
         return uploadedHashes;
     }
+    /**
+     * Upload attachment with retry logic for 429 errors
+     * @param project Project code
+     * @param data Attachment data
+     * @param attachmentName Attachment name for logging
+     * @param maxRetries Maximum number of retry attempts
+     * @param initialDelay Initial delay in milliseconds
+     * @returns Promise with upload response
+     */
+    async uploadAttachmentWithRetry(project, data, attachmentName, maxRetries = 5, initialDelay = 1000) {
+        let lastError;
+        let delay = initialDelay;
+        for (let attempt = 0; attempt <= maxRetries; attempt++) {
+            try {
+                return await this.attachmentClient.uploadAttachment(project, data);
+            }
+            catch (error) {
+                lastError = error;
+                // Check if it's a 429 error (Too Many Requests)
+                if ((0, is_axios_error_1.isAxiosError)(error)) {
+                    if (error.response?.status === 429) {
+                        if (attempt < maxRetries) {
+                            const retryAfter = this.getRetryAfter(error);
+                            const baseWaitTime = retryAfter ?? delay;
+                            // Add jitter (random delay) to prevent all workers from retrying simultaneously
+                            // Jitter is 10-30% of the wait time to spread out retry attempts
+                            const jitterPercent = 0.1 + Math.random() * 0.2; // 10-30%
+                            const jitter = baseWaitTime * jitterPercent;
+                            const waitTime = Math.floor(baseWaitTime + jitter);
+                            this.logger.logDebug(`Rate limit exceeded (429) for attachment "${attachmentName}". ` +
+                                `Retrying in ${waitTime}ms (attempt ${attempt + 1}/${maxRetries})`);
+                            await this.delay(waitTime);
+                            // Exponential backoff: double the delay for next attempt
+                            delay = Math.min(delay * 2, 30000); // Cap at 30 seconds
+                        }
+                        else {
+                            this.logger.logError(`Failed to upload attachment "${attachmentName}" after ${maxRetries} retries due to rate limiting`);
+                        }
+                    }
+                    else {
+                        // For non-429 errors, throw immediately
+                        throw error;
+                    }
+                }
+                else {
+                    // For non-Axios errors, throw immediately
+                    throw error;
+                }
+            }
+        }
+        // If we exhausted all retries, throw the last error
+        throw lastError;
+    }
+    /**
+     * Extract Retry-After header value from response or return null
+     * @param error Axios error
+     * @returns Retry-After value in milliseconds or null
+     */
+    getRetryAfter(error) {
+        const headers = error.response?.headers;
+        if (!headers) {
+            return null;
+        }
+        const retryAfterHeader = headers['retry-after'];
+        if (retryAfterHeader && typeof retryAfterHeader === 'string') {
+            const retryAfterSeconds = parseInt(retryAfterHeader, 10);
+            if (!isNaN(retryAfterSeconds)) {
+                return retryAfterSeconds * 1000; // Convert to milliseconds
+            }
+        }
+        return null;
+    }
+    /**
+     * Delay execution for specified milliseconds
+     * @param ms Milliseconds to delay
+     */
+    delay(ms) {
+        return new Promise(resolve => setTimeout(resolve, ms));
+    }
     prepareAttachmentData(attachment) {
         if (attachment.file_path) {
             return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.4.10",
+  "version": "2.4.12",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,31 +24,32 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "ajv": "^8.12.0",
+    "ajv": "^8.17.1",
     "async-mutex": "~0.5.0",
     "chalk": "^4.1.2",
-    "env-schema": "^5.2.0",
-    "form-data": "^4.0.4",
+    "env-schema": "^5.2.1",
+    "form-data": "^4.0.5",
     "lodash.get": "^4.4.2",
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
-    "mime-types": "^2.1.33",
+    "mime-types": "^2.1.35",
     "qase-api-client": "~1.1.0",
-    "qase-api-v2-client": "~1.0.1",
+    "qase-api-v2-client": "~1.0.3",
     "strip-ansi": "^6.0.1",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@types/jest": "^29.5.2",
-    "@types/lodash.get": "^4.4.7",
-    "@types/lodash.merge": "^4.6.7",
-    "@types/lodash.mergewith": "^4.6.7",
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "@types/lodash.get": "^4.4.9",
+    "@types/lodash.merge": "^4.6.9",
+    "@types/lodash.mergewith": "^4.6.9",
     "@types/mime-types": "^2.1.4",
-    "@types/node": "^20.12.5",
-    "@types/uuid": "^9.0.1",
-    "axios": "^1.12.0",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0"
+    "@types/minimatch": "^6.0.0",
+    "@types/node": "^20.19.25",
+    "@types/uuid": "^9.0.8",
+    "axios": "^1.13.2",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.5"
   }
 }

package/tsconfig.build.json

@@ -2,7 +2,9 @@
   "extends": "./tsconfig.json",
 
   "compilerOptions": {
-    "noEmit": false
+    "noEmit": false,
+    "skipLibCheck": true,
+    "types": []
   },
 
   "include": ["./src/**/*.ts"]