@testomatio/reporter 1.6.6 → 1.6.8

package/lib/adapter/playwright.js

@@ -55,11 +55,28 @@ class PlaywrightReporter {
       logs = `\n\n${chalk.bold('Logs:')}\n${chalk.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
     }
     const manuallyAttachedArtifacts = services.artifacts.get(fullTestTitle);
-    const keyValues = services.keyValues.get(fullTestTitle);
+    const testMeta = services.keyValues.get(fullTestTitle);
     const rid = test.id || test.testId || uuidv4();
 
+    /**
+     * @type {{
+     * browser?: string,
+     * dependencies: string[],
+     * isMobile?: boolean
+     * metadata: Record<string, any>,
+     * name: string,
+     * }}
+     */
+    const project = {
+      browser: test.parent.project().use.defaultBrowserType,
+      dependencies: test.parent.project().dependencies,
+      isMobile: test.parent.project().use.isMobile,
+      metadata: test.parent.project().metadata,
+      name: test.parent.project().name,
+    };
+
     const reportTestPromise = this.client.addTestRun(checkStatus(result.status), {
-      rid,
+      rid: `${rid}-${project.name}`,
       error,
       test_id: getTestomatIdFromTestTitle(`${title} ${test.tags?.join(' ')}`),
       suite_title,
@@ -68,12 +85,19 @@ class PlaywrightReporter {
       time: duration,
       logs,
       manuallyAttachedArtifacts,
-      meta: keyValues,
+      meta: {
+        browser: project.browser,
+        isMobile: project.isMobile,
+        project: project.name,
+        projectDependencies: project.dependencies?.length ? project.dependencies : null,
+        ...testMeta,
+        ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
+      },
       file: test.location?.file,
     });
 
     this.uploads.push({
-      rid,
+      rid: `${rid}-${project.name}`,
       title: test.title,
       files: result.attachments.filter(a => a.body || a.path),
       file: test.location?.file,

package/lib/client.js

@@ -165,6 +165,28 @@ class Client {
     } = testData;
     let { message = '' } = testData;
 
+    // stringify meta values and limit keys and values length to 255
+    if (meta) {
+      for (const key in meta) {
+        if (key === undefined || key === null) continue;
+        if (typeof meta[key] === 'object') {
+          meta[key] = JSON.stringify(meta[key]);
+        }
+        // cut values
+        if (meta[key].length > 255) {
+          meta[key] = meta[key].substring(0, 255);
+          debug(APP_PREFIX, `Meta info value "${meta[key]}" is too long, trimmed to 255 characters`);
+        }
+        // cut keys
+        if (key.length > 255) {
+          const newKey = key.substring(0, 255);
+          meta[newKey] = meta[key];
+          delete meta[key];
+          debug(APP_PREFIX, `Meta info key "${key}" is too long, trimmed to 255 characters`);
+        }
+      }
+    }
+
     let errorFormatted = '';
     if (error) {
       errorFormatted += this.formatError(error) || '';
@@ -259,7 +281,7 @@ class Client {
             APP_PREFIX,
             `🗄️ ${this.uploader.successfulUploads.length} artifacts ${
               process.env.TESTOMATIO_PRIVATE_ARTIFACTS ? 'privately' : chalk.bold('publicly')
-            } 🟢 uploaded to S3 bucket`,
+            } 🟢uploaded to S3 bucket`,
           );
         }
 
@@ -275,7 +297,7 @@ class Client {
 
           uploadedArtifacts.forEach(upload => {
             debug(
-              `🟢 Uploaded artifact`,
+              `🟢Uploaded artifact`,
               `${upload.relativePath},`,
               'size:',
               `${upload.sizePretty},`,
@@ -311,9 +333,7 @@ class Client {
           console.log(
             '\n',
             APP_PREFIX,
-            `🗄️ ${chalk.bold(this.uploader.skippedUploads.length)} artifacts uploading 🟡${chalk.bold(
-              'skipped',
-            )} (due to large size)`,
+            `🗄️ ${chalk.bold(this.uploader.skippedUploads.length)} artifacts uploading 🟡${chalk.bold('skipped')}`,
           );
           const skippedUploads = this.uploader.skippedUploads.map(file => ({
             relativePath: file.path.replace(process.cwd(), ''),

package/lib/pipe/testomatio.js

@@ -215,7 +215,7 @@ class TestomatioPipe {
       this.store.runPublicUrl = this.runPublicUrl;
       this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
-      process.env.runId = this.runId;      
+      process.env.runId = this.runId;
       debug('Run created', this.runId);
     } catch (err) {
       const errorText = err.response?.data?.message || err.message;
@@ -241,7 +241,7 @@ class TestomatioPipe {
     const cancelReporting = this.requestFailures >= parseInt(process.env.TESTOMATIO_MAX_REQUEST_FAILURES, 10);
     if (cancelReporting) {
       this.reportingCanceledDueToReqFailures = true;
-      const errorMessage = 
+      const errorMessage =
         `⚠️ ${process.env.TESTOMATIO_MAX_REQUEST_FAILURES} requests were failed, reporting to Testomat aborted.`;
       console.warn(`${APP_PREFIX} ${chalk.yellow(errorMessage)}`);
     }
@@ -371,7 +371,14 @@ class TestomatioPipe {
     if (!this.isEnabled) return;
 
     await this.#batchUpload();
-    if (this.batch.intervalFunction) clearInterval(this.batch.intervalFunction);
+    if (this.batch.intervalFunction) {
+      clearInterval(this.batch.intervalFunction);
+      // this code is required in case test is added after run is finished
+      // (e.g. if test has artifacts, add test function will be invoked only after artifacts are uploaded)
+      // batch stops working after run is finished; thus, disable it to use single test uploading
+      this.batch.intervalFunction = null;
+      this.batch.isEnabled = false;
+    }
 
     debug('Finishing run...');
 
@@ -396,6 +403,7 @@ class TestomatioPipe {
         await this.axios.put(`/api/reporter/${this.runId}`, {
           api_key: this.apiKey,
           status_event,
+          detach: params.detach,
           duration: params.duration,
           tests: params.tests,
         });

package/lib/reporter-functions.js

@@ -32,9 +32,13 @@ function addStep(message) {
 
 /**
  * Add key-value pair(s) to the test report
- * @param {*} keyValue
+ * @param {*} keyValue or key
+ * @param {string?} value
  */
-function setKeyValue(keyValue) {
+function setKeyValue(keyValue, value = null) {
+  if (value && typeof keyValue === 'string') {
+    keyValue = { [keyValue]: value };
+  }
   services.keyValues.put(keyValue);
 }
 

package/lib/uploader.js

@@ -106,14 +106,14 @@ class S3Uploader {
 
     debug('Uploading to S3:', Key);
 
-    const s3Config = this.#getS3Config()
+    const s3Config = this.#getS3Config();
     const s3 = new S3(s3Config);
 
     const params = {
       Bucket: S3_BUCKET,
       Key,
       Body,
-    }
+    };
 
     // disable ACL for I AM roles
     if (!s3Config.credentials.sessionToken) {
@@ -206,6 +206,9 @@ class S3Uploader {
    * @returns
    */
   async uploadFileByPath(filePath, pathInS3) {
+    // sometimes artifacts uploading started before createRun function completion
+    this.isEnabled = this.isEnabled ?? this.checkEnabled();
+
     const [runId, rid] = pathInS3;
 
     if (!filePath) return;
@@ -248,7 +251,11 @@ class S3Uploader {
       this.storeUploadedFile(filePath, runId, rid, false);
       this.skippedUploads.push(skippedArtifact);
       debug(
-        chalk.yellow(`Artifacts file ${JSON.stringify(skippedArtifact)} exceeds the maximum allowed size. Skipping.`),
+        chalk.yellow(
+          `Artifacts file ${JSON.stringify(skippedArtifact)} exceeds the maximum allowed size ${
+            TESTOMATIO_ARTIFACT_MAX_SIZE_MB
+          }MB. Skipping.`,
+        ),
       );
       return;
     }

package/lib/utils/pipe_utils.js

@@ -15,8 +15,8 @@ function setS3Credentials(artifacts) {
   if (artifacts.BUCKET) process.env.S3_BUCKET = artifacts.BUCKET;
   if (artifacts.SESSION_TOKEN) process.env.S3_SESSION_TOKEN = artifacts.SESSION_TOKEN;
   if (artifacts.presign) process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
-   // endpoint is not received from the server; and shuld be empty if IAM used (credentails obtained from the testomat)
-   process.env.S3_ENDPOINT = artifacts.ENDPOINT || '';
+  // endpoint is not received from the server; and shuld be empty if IAM used (credentails obtained from the testomat)
+  process.env.S3_ENDPOINT = artifacts.ENDPOINT || '';
 }
 /**
  * Generates mode request parameters based on the input params.

package/lib/xmlReader.js

@@ -21,7 +21,8 @@ const config = require('./config');
 const ridRunId = randomUUID();
 
 const TESTOMATIO_URL = process.env.TESTOMATIO_URL || 'https://app.testomat.io';
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN } = process.env;
+const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN, TESTOMATIO_MARK_DETACHED } =
+  process.env;
 
 const options = {
   ignoreDeclaration: true,
@@ -41,6 +42,7 @@ class XmlReader {
       title: TESTOMATIO_TITLE,
       env: TESTOMATIO_ENV,
       group_title: TESTOMATIO_RUNGROUP_TITLE,
+      detach: !!TESTOMATIO_MARK_DETACHED,
       // batch uploading is implemented for xml already
       isBatchEnabled: false,
     };
@@ -424,6 +426,7 @@ class XmlReader {
 
     const dataString = {
       ...this.stats,
+      detach: this.requestParams.detach,
       api_key: this.requestParams.apiKey,
       status: 'finished',
       tests: this.tests,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.6.6",
+  "version": "1.6.8",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",