qase-javascript-commons 2.0.0 → 2.0.2

package/changelog.md

@@ -1,14 +1,36 @@
+# qase-javascript-commons@2.0.2
+
+## What's new
+
+Add new step status `skipped` to the test result data.
+Before this fix, the reporter didn't support the `skipped` status for test steps.
+
+For ApiV1 the `skipped` status will be converted to `blocked` status.
+For ApiV2 the `skipped` status will be converted to `skipped` status.
+
+# qase-javascript-commons@2.0.1
+
+## What's new
+
+Remove ANSI escape codes from the message and stack trace.
+Before this fix, the reporter added ANSI escape codes to the message and stack trace.
+
+```diff
+- Error: expect(received).toBe(expected) // Object.is equality
++ Error: expect(received).toBe(expected) // Object.is equality
+```
+
 # qase-javascript-commons@2.0.0
 
 ## What's new
 
 This is the first release version of the Qase JavaScript SDK.
 It is numbered `2.0.0` (and not `1.0.0`) to match the release series of 
-test reporters for Playwright, Cypress, Jest and other frameworks.
+test reporters for Playwright, Cypress, Jest, and other frameworks.
 
 ### Annotating test with field data
 
-Tests can now be annotated with data for system and custom fields in Qase.
+Tests can now be annotated with data for the system and custom fields in Qase.
 This feature is already implemented in the Playwright reporter:
 
 ```js
@@ -28,7 +50,7 @@ a standalone result, with its own run history.
 ### Attachments from files and variables
 
 Reporters can now upload attachments of various data types to Qase,
-both from files and from variables.
+both from files and variables.
 It enables flexible and meticulous logging, such as collecting full HTTP request data,
 including URL, headers, and payload.
 
@@ -42,7 +64,8 @@ It helps bring test results faster and enables acting on them long before the te
 Qase JavaScript SDK brings configuration with config files and environment variables
 to a common standard, used with Qase reporters in all languages and frameworks.
 
-For details, see the Configuration section in the README.
+For details, see the [Configuration](https://github.com/qase-tms/qase-javascript/tree/main/qase-javascript-commons#configuration)
+section in the README.
 
 ### Latest API
 

package/dist/models/step-execution.d.ts

@@ -1,7 +1,8 @@
 export declare enum StepStatusEnum {
     passed = "passed",
     failed = "failed",
-    blocked = "blocked"
+    blocked = "blocked",
+    skipped = "skipped"
 }
 export interface StepExecution {
     start_time: number | null;

package/dist/models/step-execution.js

@@ -6,4 +6,5 @@ var StepStatusEnum;
     StepStatusEnum["passed"] = "passed";
     StepStatusEnum["failed"] = "failed";
     StepStatusEnum["blocked"] = "blocked";
+    StepStatusEnum["skipped"] = "skipped";
 })(StepStatusEnum || (exports.StepStatusEnum = StepStatusEnum = {}));

package/dist/reporters/abstract-reporter.d.ts

@@ -48,4 +48,5 @@ export declare abstract class AbstractReporter implements InternalReporterInterf
      * @param {TestResultType[]} results
      */
     setTestResults(results: TestResultType[]): void;
+    private removeAnsiEscapeCodes;
 }

package/dist/reporters/abstract-reporter.js

@@ -32,6 +32,12 @@ class AbstractReporter {
     // eslint-disable-next-line @typescript-eslint/require-await
     async addTestResult(result) {
         this.logger.logDebug(`Adding test result: ${JSON.stringify(result)}`);
+        if (result.execution.stacktrace) {
+            result.execution.stacktrace = this.removeAnsiEscapeCodes(result.execution.stacktrace);
+        }
+        if (result.message) {
+            result.message = this.removeAnsiEscapeCodes(result.message);
+        }
         if (result.testops_id === null || !Array.isArray(result.testops_id)) {
             this.results.push(result);
             return;
@@ -55,5 +61,11 @@ class AbstractReporter {
     setTestResults(results) {
         this.results = results;
     }
+    removeAnsiEscapeCodes(str) {
+        const ansiEscapeSequences = new RegExp([
+            '\x1B[[(?);]{0,2}(;?\\d)*.',
+        ].join('|'), 'g');
+        return str.replace(ansiEscapeSequences, '');
+    }
 }
 exports.AbstractReporter = AbstractReporter;

package/dist/reporters/testops-reporter.js

@@ -404,6 +404,7 @@ TestOpsReporter.stepStatusMap = {
     [models_1.StepStatusEnum.passed]: qaseio_1.ResultStepStatus.PASSED,
     [models_1.StepStatusEnum.failed]: qaseio_1.ResultStepStatus.FAILED,
     [models_1.StepStatusEnum.blocked]: qaseio_1.ResultStepStatus.BLOCKED,
+    [models_1.StepStatusEnum.skipped]: qaseio_1.ResultStepStatus.SKIPPED,
 };
 /**
  * @type {Record<StepStatusEnum, ResultStepStatus>}
@@ -412,4 +413,5 @@ TestOpsReporter.stepStatusMapV1 = {
     [models_1.StepStatusEnum.passed]: qaseio_1.TestStepResultCreateStatusEnum.PASSED,
     [models_1.StepStatusEnum.failed]: qaseio_1.TestStepResultCreateStatusEnum.FAILED,
     [models_1.StepStatusEnum.blocked]: qaseio_1.TestStepResultCreateStatusEnum.BLOCKED,
+    [models_1.StepStatusEnum.skipped]: qaseio_1.TestStepResultCreateStatusEnum.BLOCKED,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -21,7 +21,7 @@
     "test": "jest --passWithNoTests",
     "clean": "rm -rf dist"
   },
-  "author": "Qase Team <dharding@dimitriharding.com>",
+  "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
     "ajv": "^8.12.0",