@testomatio/reporter 2.18.0 → 2.19.0-beta

package/lib/constants.d.ts

@@ -38,3 +38,4 @@ export namespace REPORTER_REQUEST_RETRIES {
 }
 export const SCREENSHOTS_ON_STEPS: boolean;
 export const DEBUG_FILE: "testomatio.debug";
+export const S3_CREDENTIALS_REFRESH_INTERVAL_MS: number;

package/lib/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEBUG_FILE = exports.SCREENSHOTS_ON_STEPS = exports.REPORTER_REQUEST_RETRIES = exports.testomatLogoURL = exports.REQUEST_TIMEOUT = exports.MARKDOWN_REPORT = exports.HTML_REPORT = exports.BATCH_MODE = exports.STATUS = exports.CSV_HEADERS = exports.TESTOMAT_TMP_STORAGE_DIR = exports.APP_PREFIX = void 0;
+exports.S3_CREDENTIALS_REFRESH_INTERVAL_MS = exports.DEBUG_FILE = exports.SCREENSHOTS_ON_STEPS = exports.REPORTER_REQUEST_RETRIES = exports.testomatLogoURL = exports.REQUEST_TIMEOUT = exports.MARKDOWN_REPORT = exports.HTML_REPORT = exports.BATCH_MODE = exports.STATUS = exports.CSV_HEADERS = exports.TESTOMAT_TMP_STORAGE_DIR = exports.APP_PREFIX = void 0;
 exports.getCreateRunRequestTimeout = getCreateRunRequestTimeout;
 const picocolors_1 = __importDefault(require("picocolors"));
 const os_1 = __importDefault(require("os"));
@@ -69,6 +69,10 @@ const REPORTER_REQUEST_RETRIES = {
 exports.REPORTER_REQUEST_RETRIES = REPORTER_REQUEST_RETRIES;
 const DEBUG_FILE = 'testomatio.debug';
 exports.DEBUG_FILE = DEBUG_FILE;
+// temporary S3 tokens live ~1 hour; refresh credentials well before that so artifact
+// uploads keep working on long runs
+const S3_CREDENTIALS_REFRESH_INTERVAL_MS = 40 * 60 * 1000;
+exports.S3_CREDENTIALS_REFRESH_INTERVAL_MS = S3_CREDENTIALS_REFRESH_INTERVAL_MS;
 function getCreateRunRequestTimeout() {
     return Math.max(REQUEST_TIMEOUT, 80 * 1000);
 }
@@ -98,3 +102,5 @@ module.exports.testomatLogoURL = testomatLogoURL;
 module.exports.REPORTER_REQUEST_RETRIES = REPORTER_REQUEST_RETRIES;
 
 module.exports.DEBUG_FILE = DEBUG_FILE;
+
+module.exports.S3_CREDENTIALS_REFRESH_INTERVAL_MS = S3_CREDENTIALS_REFRESH_INTERVAL_MS;

package/lib/pipe/testomatio.d.ts

@@ -30,6 +30,8 @@ declare class TestomatioPipe implements Pipe {
     retriesTimestamps: any[];
     reportingCanceledDueToReqFailures: boolean;
     notReportedTestsCount: number;
+    /** @type {NodeJS.Timeout | null} */
+    s3CredentialsRefreshTimer: NodeJS.Timeout | null;
     isEnabled: boolean;
     url: any;
     apiKey: any;

package/lib/pipe/testomatio.js

@@ -63,6 +63,8 @@ class TestomatioPipe {
         this.retriesTimestamps = [];
         this.reportingCanceledDueToReqFailures = false;
         this.notReportedTestsCount = 0;
+        /** @type {NodeJS.Timeout | null} */
+        this.s3CredentialsRefreshTimer = null;
         this.isEnabled = false;
         this.url = params.testomatioUrl || process.env.TESTOMATIO_URL || 'https://app.testomat.io';
         this.apiKey = params.apiKey || config_js_1.config.TESTOMATIO;
@@ -311,8 +313,10 @@ class TestomatioPipe {
                 timeout: (0, constants_js_1.getCreateRunRequestTimeout)(),
                 responseType: 'json',
             });
-            if (resp.data.artifacts)
+            if (resp.data.artifacts) {
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
+                this.#startS3CredentialsRefresh(runParams);
+            }
             if (resp.data.url) {
                 const respUrl = new URL(resp.data.url);
                 this.runUrl = `${this.url}${respUrl.pathname}`;
@@ -337,8 +341,10 @@ class TestomatioPipe {
             this.runId = resp.data.uid;
             this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
             this.runPublicUrl = resp.data.public_url;
-            if (resp.data.artifacts)
+            if (resp.data.artifacts) {
                 (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
+                this.#startS3CredentialsRefresh(runParams);
+            }
             this.store.runUrl = this.runUrl;
             this.store.runPublicUrl = this.runPublicUrl;
             this.store.runId = this.runId;
@@ -363,6 +369,49 @@ class TestomatioPipe {
         }
         debug('"createRun" function finished');
     }
+    /**
+     * Starts periodic refreshing of S3 credentials for long runs.
+     * Temporary S3 tokens (STS) expire after ~1 hour, so without refreshing,
+     * artifact uploads fail for every test reported later in the run.
+     * The same run params are re-sent on refresh (same as updating an existing run),
+     * and fresh credentials are taken from the response's `artifacts` field.
+     * @param {Record<string, any>} runParams
+     */
+    #startS3CredentialsRefresh(runParams) {
+        if (this.s3CredentialsRefreshTimer)
+            return;
+        this.s3CredentialsRefreshTimer = setInterval(() => {
+            this.#refreshS3Credentials(runParams);
+        }, constants_js_1.S3_CREDENTIALS_REFRESH_INTERVAL_MS);
+        this.s3CredentialsRefreshTimer.unref?.();
+        debug(`S3 credentials refresh started (every ${constants_js_1.S3_CREDENTIALS_REFRESH_INTERVAL_MS / 60000} min)`);
+    }
+    #refreshS3Credentials = async (runParams) => {
+        if (!this.isEnabled || !this.runId)
+            return;
+        const { ci, access_event, ...refreshParams } = runParams;
+        try {
+            const resp = await this.client.request({
+                method: 'PUT',
+                url: `/api/reporter/${this.runId}`,
+                data: { ...refreshParams, api_key: this.apiKey },
+                responseType: 'json',
+            });
+            if (resp.data?.artifacts) {
+                (0, pipe_utils_js_1.setS3Credentials)(resp.data.artifacts);
+                debug('S3 credentials refreshed');
+            }
+        }
+        catch (err) {
+            debug('Failed to refresh S3 credentials:', err.message || err);
+        }
+    };
+    #stopS3CredentialsRefresh() {
+        if (this.s3CredentialsRefreshTimer) {
+            clearInterval(this.s3CredentialsRefreshTimer);
+            this.s3CredentialsRefreshTimer = null;
+        }
+    }
     /**
      * Decides whether to skip test reporting in case of too many request failures
      * @returns {boolean}
@@ -506,6 +555,7 @@ class TestomatioPipe {
     async finishRun(params) {
         if (!this.isEnabled)
             return;
+        this.#stopS3CredentialsRefresh();
         await this.#batchUpload();
         if (this.batch.intervalFunction) {
             clearInterval(this.batch.intervalFunction);
@@ -577,6 +627,7 @@ class TestomatioPipe {
     #disablePipe() {
         this.isEnabled = false;
         this.apiKey = null;
+        this.#stopS3CredentialsRefresh();
         // clear interval function, otherwise the proccess will continue indefinitely
         if (this.batch.intervalFunction) {
             clearInterval(this.batch.intervalFunction);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.18.0",
+  "version": "2.19.0-beta",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=22"

package/src/constants.js

@@ -60,6 +60,10 @@ const REPORTER_REQUEST_RETRIES = {
 
 const DEBUG_FILE = 'testomatio.debug';
 
+// temporary S3 tokens live ~1 hour; refresh credentials well before that so artifact
+// uploads keep working on long runs
+const S3_CREDENTIALS_REFRESH_INTERVAL_MS = 40 * 60 * 1000;
+
 function getCreateRunRequestTimeout() {
   return Math.max(REQUEST_TIMEOUT, 80 * 1000);
 }
@@ -78,4 +82,5 @@ export {
   REPORTER_REQUEST_RETRIES,
   SCREENSHOTS_ON_STEPS,
   DEBUG_FILE,
+  S3_CREDENTIALS_REFRESH_INTERVAL_MS,
 };

package/src/pipe/testomatio.js

@@ -9,6 +9,7 @@ import {
   REQUEST_TIMEOUT,
   getCreateRunRequestTimeout,
   REPORTER_REQUEST_RETRIES,
+  S3_CREDENTIALS_REFRESH_INTERVAL_MS,
 } from '../constants.js';
 import {
   isValidUrl,
@@ -72,6 +73,8 @@ class TestomatioPipe {
     this.retriesTimestamps = [];
     this.reportingCanceledDueToReqFailures = false;
     this.notReportedTestsCount = 0;
+    /** @type {NodeJS.Timeout | null} */
+    this.s3CredentialsRefreshTimer = null;
 
     this.isEnabled = false;
     this.url = params.testomatioUrl || process.env.TESTOMATIO_URL || 'https://app.testomat.io';
@@ -346,7 +349,10 @@ class TestomatioPipe {
         timeout: getCreateRunRequestTimeout(),
         responseType: 'json',
       });
-      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+      if (resp.data.artifacts) {
+        setS3Credentials(resp.data.artifacts);
+        this.#startS3CredentialsRefresh(runParams);
+      }
       if (resp.data.url) {
         const respUrl = new URL(resp.data.url);
         this.runUrl = `${this.url}${respUrl.pathname}`;
@@ -374,7 +380,10 @@ class TestomatioPipe {
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
       this.runPublicUrl = resp.data.public_url;
 
-      if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+      if (resp.data.artifacts) {
+        setS3Credentials(resp.data.artifacts);
+        this.#startS3CredentialsRefresh(runParams);
+      }
 
       this.store.runUrl = this.runUrl;
       this.store.runPublicUrl = this.runPublicUrl;
@@ -401,6 +410,49 @@ class TestomatioPipe {
     debug('"createRun" function finished');
   }
 
+  /**
+   * Starts periodic refreshing of S3 credentials for long runs.
+   * Temporary S3 tokens (STS) expire after ~1 hour, so without refreshing,
+   * artifact uploads fail for every test reported later in the run.
+   * The same run params are re-sent on refresh (same as updating an existing run),
+   * and fresh credentials are taken from the response's `artifacts` field.
+   * @param {Record<string, any>} runParams
+   */
+  #startS3CredentialsRefresh(runParams) {
+    if (this.s3CredentialsRefreshTimer) return;
+    this.s3CredentialsRefreshTimer = setInterval(() => {
+      this.#refreshS3Credentials(runParams);
+    }, S3_CREDENTIALS_REFRESH_INTERVAL_MS);
+    this.s3CredentialsRefreshTimer.unref?.();
+    debug(`S3 credentials refresh started (every ${S3_CREDENTIALS_REFRESH_INTERVAL_MS / 60000} min)`);
+  }
+
+  #refreshS3Credentials = async runParams => {
+    if (!this.isEnabled || !this.runId) return;
+    const { ci, access_event, ...refreshParams } = runParams;
+    try {
+      const resp = await this.client.request({
+        method: 'PUT',
+        url: `/api/reporter/${this.runId}`,
+        data: { ...refreshParams, api_key: this.apiKey },
+        responseType: 'json',
+      });
+      if (resp.data?.artifacts) {
+        setS3Credentials(resp.data.artifacts);
+        debug('S3 credentials refreshed');
+      }
+    } catch (err) {
+      debug('Failed to refresh S3 credentials:', err.message || err);
+    }
+  };
+
+  #stopS3CredentialsRefresh() {
+    if (this.s3CredentialsRefreshTimer) {
+      clearInterval(this.s3CredentialsRefreshTimer);
+      this.s3CredentialsRefreshTimer = null;
+    }
+  }
+
   /**
    * Decides whether to skip test reporting in case of too many request failures
    * @returns {boolean}
@@ -545,6 +597,7 @@ class TestomatioPipe {
   async finishRun(params) {
     if (!this.isEnabled) return;
 
+    this.#stopS3CredentialsRefresh();
     await this.#batchUpload();
     if (this.batch.intervalFunction) {
       clearInterval(this.batch.intervalFunction);
@@ -637,6 +690,7 @@ class TestomatioPipe {
     this.isEnabled = false;
     this.apiKey = null;
 
+    this.#stopS3CredentialsRefresh();
     // clear interval function, otherwise the proccess will continue indefinitely
     if (this.batch.intervalFunction) {
       clearInterval(this.batch.intervalFunction);