@testomatio/reporter 2.6.2 → 2.6.4-beta-acl

package/lib/pipe/testomatio.js

@@ -80,16 +80,10 @@ class TestomatioPipe {
                 shouldRetry: error => {
                     if (!error.response)
                         return false;
-                    switch (error.response?.status) {
-                        case 400: // Bad request (probably wrong API key)
-                        case 404: // Test not matched
-                        case 429: // Rate limit exceeded
-                        case 500: // Internal server error
-                            return false;
-                        default:
-                            break;
-                    }
-                    return error.response?.status >= 401; // Retry on 401+ and 5xx
+                    // no need to retry on 4xx errors, because they caused by user mistake, thus retrying will not help
+                    // 500 could also be related to both user or server mistake, but decided not to retry for now
+                    // this code code be changed to retry 500 too if needed
+                    return error.response?.status >= 501; // Retry only on server errors
                 },
             },
         });
@@ -270,6 +264,8 @@ class TestomatioPipe {
             const errorText = err.response?.data?.message || err.message;
             debug('Error creating run', err);
             console.log(errorText || err);
+            if (err.response?.status === 403)
+                this.#disablePipe();
             if (!this.apiKey)
                 console.error('Testomat.io API key is not set');
             if (!this.apiKey?.startsWith('tstmt'))
@@ -318,6 +314,8 @@ class TestomatioPipe {
             maxContentLength: Infinity,
         })
             .catch(err => {
+            if (err.response?.status === 403)
+                this.#disablePipe();
             this.requestFailures++;
             this.notReportedTestsCount++;
             if (err.response) {
@@ -369,6 +367,8 @@ class TestomatioPipe {
             maxContentLength: Infinity,
         })
             .catch(err => {
+            if (err.response?.status === 403)
+                this.#disablePipe();
             this.requestFailures++;
             this.notReportedTestsCount += testsToSend.length;
             if (err.response) {
@@ -478,6 +478,17 @@ class TestomatioPipe {
         }
         debug('Run finished');
     }
+    #disablePipe() {
+        this.isEnabled = false;
+        this.apiKey = null;
+        // clear interval function, otherwise the proccess will continue indefinitely
+        if (this.batch.intervalFunction) {
+            clearInterval(this.batch.intervalFunction);
+            this.batch.intervalFunction = null;
+            this.batch.isEnabled = false;
+        }
+        this.batch.tests = [];
+    }
     #logFailedResponse(error) {
         let responseBody = stringify(error.response?.data ?? error.response ?? error, { pretty: true });
         if (!responseBody)

package/lib/uploader.js

@@ -40,6 +40,7 @@ class S3Uploader {
             'TESTOMATIO_DISABLE_ARTIFACTS',
             'TESTOMATIO_PRIVATE_ARTIFACTS',
             'TESTOMATIO_ARTIFACT_MAX_SIZE_MB',
+            'TESTOMATIO_S3_NO_ACL',
         ];
     }
     resetConfig() {
@@ -91,7 +92,7 @@ class S3Uploader {
      * @returns
      */
     async #uploadToS3(Body, Key, file) {
-        const { S3_BUCKET, TESTOMATIO_PRIVATE_ARTIFACTS } = this.getConfig();
+        const { S3_BUCKET, TESTOMATIO_PRIVATE_ARTIFACTS, TESTOMATIO_S3_NO_ACL } = this.getConfig();
         const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
         if (!S3_BUCKET || !Body) {
             console.log(constants_js_1.APP_PREFIX, picocolors_1.default.bold(picocolors_1.default.red(`Failed uploading '${Key}'. Please check S3 credentials`)), this.getMaskedConfig());
@@ -105,8 +106,10 @@ class S3Uploader {
             Key,
             Body,
         };
-        // disable ACL for I AM roles
-        if (!s3Config.credentials.sessionToken) {
+        // disable ACL for IAM roles or GCS (GCS doesn't support x-amz-acl header)
+        // to precent potential issues, forece setting TESTOMATIO_S3_NO_ACL env var too in such case
+        const isGCS = s3Config.endpoint && s3Config.endpoint.includes('storage.googleapis.com');
+        if (!s3Config.credentials.sessionToken && !TESTOMATIO_S3_NO_ACL && !isGCS) {
             params.ACL = ACL;
         }
         try {
@@ -119,7 +122,7 @@ class S3Uploader {
         catch (e) {
             this.failedUploads.push({ path: file.path, size: file.size });
             debug('S3 uploading error:', e);
-            console.log(constants_js_1.APP_PREFIX, 'Upload failed:', e.message, '\nConfig:\n', this.getMaskedConfig());
+            console.log(constants_js_1.APP_PREFIX, 'Upload failed:', e.message, `\nFile:\n ${file.path}, size: ${(0, filesize_1.filesize)(file.size || 0)}`, '\nConfig:\n', this.getMaskedConfig());
         }
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.6.2",
+  "version": "2.6.4-beta-acl",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/pipe/testomatio.js

@@ -87,16 +87,10 @@ class TestomatioPipe {
         httpMethodsToRetry: ['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE', 'POST'],
         shouldRetry: error => {
           if (!error.response) return false;
-          switch (error.response?.status) {
-            case 400: // Bad request (probably wrong API key)
-            case 404: // Test not matched
-            case 429: // Rate limit exceeded
-            case 500: // Internal server error
-              return false;
-            default:
-              break;
-          }
-          return error.response?.status >= 401; // Retry on 401+ and 5xx
+          // no need to retry on 4xx errors, because they caused by user mistake, thus retrying will not help
+          // 500 could also be related to both user or server mistake, but decided not to retry for now
+          // this code code be changed to retry 500 too if needed
+          return error.response?.status >= 501; // Retry only on server errors
         },
       },
     });
@@ -300,6 +294,7 @@ class TestomatioPipe {
       const errorText = err.response?.data?.message || err.message;
       debug('Error creating run', err);
       console.log(errorText || err);
+      if (err.response?.status === 403) this.#disablePipe();
       if (!this.apiKey) console.error('Testomat.io API key is not set');
       if (!this.apiKey?.startsWith('tstmt')) console.error('Testomat.io API key is invalid');
 
@@ -353,6 +348,7 @@ class TestomatioPipe {
         maxContentLength: Infinity,
       })
       .catch(err => {
+        if (err.response?.status === 403) this.#disablePipe();
         this.requestFailures++;
         this.notReportedTestsCount++;
         if (err.response) {
@@ -403,6 +399,7 @@ class TestomatioPipe {
         maxContentLength: Infinity,
       })
       .catch(err => {
+        if (err.response?.status === 403) this.#disablePipe();
         this.requestFailures++;
         this.notReportedTestsCount += testsToSend.length;
         if (err.response) {
@@ -526,6 +523,19 @@ class TestomatioPipe {
     debug('Run finished');
   }
 
+  #disablePipe() {
+    this.isEnabled = false;
+    this.apiKey = null;
+
+    // clear interval function, otherwise the proccess will continue indefinitely
+    if (this.batch.intervalFunction) {
+      clearInterval(this.batch.intervalFunction);
+      this.batch.intervalFunction = null;
+      this.batch.isEnabled = false;
+    }              
+    this.batch.tests = [];
+  }
+
   #logFailedResponse(error) {
     let responseBody = stringify(error.response?.data ?? error.response ?? error, { pretty: true });
     if (!responseBody) responseBody = '<empty>';

package/src/uploader.js

@@ -38,6 +38,7 @@ export class S3Uploader {
       'TESTOMATIO_DISABLE_ARTIFACTS',
       'TESTOMATIO_PRIVATE_ARTIFACTS',
       'TESTOMATIO_ARTIFACT_MAX_SIZE_MB',
+      'TESTOMATIO_S3_NO_ACL',
     ];
   }
 
@@ -97,7 +98,7 @@ export class S3Uploader {
    * @returns
    */
   async #uploadToS3(Body, Key, file) {
-    const { S3_BUCKET, TESTOMATIO_PRIVATE_ARTIFACTS } = this.getConfig();
+    const { S3_BUCKET, TESTOMATIO_PRIVATE_ARTIFACTS, TESTOMATIO_S3_NO_ACL } = this.getConfig();
     const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
 
     if (!S3_BUCKET || !Body) {
@@ -118,14 +119,15 @@ export class S3Uploader {
       Key,
       Body,
     };
-    // disable ACL for I AM roles
-    if (!s3Config.credentials.sessionToken) {
+    // disable ACL for IAM roles or GCS (GCS doesn't support x-amz-acl header)
+    // to precent potential issues, forece setting TESTOMATIO_S3_NO_ACL env var too in such case
+    const isGCS = s3Config.endpoint && s3Config.endpoint.includes('storage.googleapis.com');
+    if (!s3Config.credentials.sessionToken && !TESTOMATIO_S3_NO_ACL && !isGCS) {
       params.ACL = ACL;
     }
 
     try {
       const upload = new Upload({ client: s3, params });
-
       const link = await this.getS3LocationLink(upload);
       this.successfulUploads.push({ path: file.path, size: file.size, link });
       debug(`📤 Uploaded artifact. File: ${file.path}, size: ${prettyBytes(file.size || 0)}, link: ${link}`);
@@ -133,7 +135,14 @@ export class S3Uploader {
     } catch (e) {
       this.failedUploads.push({ path: file.path, size: file.size });
       debug('S3 uploading error:', e);
-      console.log(APP_PREFIX, 'Upload failed:', e.message, '\nConfig:\n', this.getMaskedConfig());
+      console.log(
+        APP_PREFIX,
+        'Upload failed:',
+        e.message,
+        `\nFile:\n ${file.path}, size: ${prettyBytes(file.size || 0)}`,
+        '\nConfig:\n',
+        this.getMaskedConfig(),
+      );
     }
   }