Release 5.1.3 (#161)

* 5.1.2 -> 5.1.3-SNAPSHOT

* EPMRPP-100661 || Fix item temp ids processing to avoid name collisions (#160)

* Update changelog

---------

Co-authored-by: reportportal.io <reportportal.io>

Author: AmsterGet

CHANGELOG.md

@@ -1,3 +1,6 @@
+### Fixed
+- Fix test name collisions. Resolves [#153](https://github.com/reportportal/agent-js-jest/issues/153), [#155](https://github.com/reportportal/agent-js-jest/issues/155), [#147](https://github.com/reportportal/agent-js-jest/issues/147).
+- `ReportingApi.attachment` error with `sendLog` method.
 
 ## [5.1.2] - 2025-01-30
 ### Fixed

VERSION

@@ -1 +1 @@
-5.1.2
+5.1.3-SNAPSHOT

__tests__/mocks/data.js

@@ -17,7 +17,6 @@ const skippedTestResult = {
   status: TEST_ITEM_STATUSES.SKIPPED,
   ancestorTitles: ['Skipped suite name', 'Skipped test name'],
   failureMessages: [],
-  invocations: 2,
 };
 const testResult = {
   testResults: [failedTestResult],

__tests__/reporter.spec.js

@@ -119,50 +119,24 @@ describe('Reporter', () => {
       expect(spyStartSuites).toHaveBeenCalledTimes(0);
     });
 
-    test('should start and finish retries in case of any invocations of skipped tests', () => {
+    test('should start and finish skipped tests', () => {
       const spyStartStep = jest.spyOn(reporter, '_startStep');
       const spyFinishStep = jest.spyOn(reporter, '_finishStep');
 
-      reporter.onTestResult(testObj, testResultWithSkipped);
-      const skippedTestResultWithStartedAt = { startedAt: currentDateInMs, ...skippedTestResult };
-
-      expect(spyStartStep).toHaveBeenNthCalledWith(
-        1,
-        skippedTestResultWithStartedAt,
-        testObj.path,
-        false,
-      );
-      expect(spyStartStep).toHaveBeenNthCalledWith(
-        2,
-        skippedTestResultWithStartedAt,
-        testObj.path,
-        true,
-      );
-      expect(spyFinishStep).toHaveBeenCalledWith(skippedTestResultWithStartedAt);
-      expect(spyStartStep).toHaveBeenCalledTimes(2);
-      expect(spyFinishStep).toHaveBeenCalledTimes(2);
-    });
-
-    test('should start and finish just skipped test in case of no or empty invocations', () => {
-      const spyStartStep = jest.spyOn(reporter, '_startStep');
-      const spyFinishStep = jest.spyOn(reporter, '_finishStep');
-
-      const { invocations, ...skippedTestResultWithoutInvocations } = skippedTestResult;
-
       const testResult = {
-        testResults: [skippedTestResultWithoutInvocations],
+        testResults: [skippedTestResult],
         testFilePath,
       };
 
       reporter.onTestResult(testObj, testResult);
 
       const skippedTestResultWithStartedAt = {
         startedAt: currentDateInMs,
-        ...skippedTestResultWithoutInvocations,
+        ...skippedTestResult,
       };
 
       expect(spyStartStep).toHaveBeenCalledWith(skippedTestResultWithStartedAt, testObj.path);
-      expect(spyFinishStep).toHaveBeenCalledWith(skippedTestResultWithStartedAt);
+      expect(spyFinishStep).toHaveBeenCalledWith(skippedTestResultWithStartedAt, testObj.path);
       expect(spyStartStep).toHaveBeenCalledTimes(1);
       expect(spyFinishStep).toHaveBeenCalledTimes(1);
     });
@@ -312,7 +286,7 @@ describe('Reporter', () => {
         startTime: currentDateInMs,
         retry: false,
       };
-      const expectedTempStepIds = new Map([['Suite/Step', 'startTestItem']]);
+      const expectedTempStepIds = new Map([['example.js/Suite/Step', ['startTestItem']]]);
 
       expect(reporter.client.startTestItem).toHaveBeenCalledWith(
         expectedStartStepItemParameter,
@@ -343,19 +317,24 @@ describe('Reporter', () => {
   });
 
   describe('_finishStep', () => {
+    beforeEach(() => {
+      reporter.tempStepIds.set('example.js/suite/fake test', ['tempStepId']);
+    });
+
     test('_finishPassedTest should be called if step status is passed', () => {
       const spyFinishPassedTest = jest.spyOn(reporter, '_finishPassedStep');
       const spyFinishFailedTest = jest.spyOn(reporter, '_finishFailedStep');
       const spyFinishSkippedTest = jest.spyOn(reporter, '_finishSkippedStep');
 
-      reporter.tempStepIds.set('/fake test', 'tempStepId');
-
-      reporter._finishStep({
-        status: TEST_ITEM_STATUSES.PASSED,
-        failureMessages: [],
-        ancestorTitles: [],
-        title: 'fake test',
-      });
+      reporter._finishStep(
+        {
+          status: TEST_ITEM_STATUSES.PASSED,
+          failureMessages: [],
+          ancestorTitles: ['suite'],
+          title: 'fake test',
+        },
+        testFilePath,
+      );
 
       expect(spyFinishPassedTest).toHaveBeenCalled();
       expect(spyFinishFailedTest).not.toHaveBeenCalled();
@@ -367,16 +346,14 @@ describe('Reporter', () => {
       const spyFinishFailedTest = jest.spyOn(reporter, '_finishFailedStep');
       const spyFinishSkippedTest = jest.spyOn(reporter, '_finishSkippedStep');
 
-      reporter.tempStepIds.set('/fake test', 'tempStepId');
-
       reporter._finishStep(
         {
           status: TEST_ITEM_STATUSES.FAILED,
           failureMessages: ['error message'],
-          ancestorTitles: [],
+          ancestorTitles: ['suite'],
           title: 'fake test',
         },
-        false,
+        testFilePath,
       );
 
       expect(spyFinishFailedTest).toHaveBeenCalledWith('tempStepId', 'error message');
@@ -389,14 +366,15 @@ describe('Reporter', () => {
       const spyFinishFailedTest = jest.spyOn(reporter, '_finishFailedStep');
       const spyFinishSkippedTest = jest.spyOn(reporter, '_finishSkippedStep');
 
-      reporter.tempStepIds.set('/fake test', 'tempStepId');
-
-      reporter._finishStep({
-        status: TEST_ITEM_STATUSES.SKIPPED,
-        failureMessages: [],
-        ancestorTitles: [],
-        title: 'fake test',
-      });
+      reporter._finishStep(
+        {
+          status: TEST_ITEM_STATUSES.SKIPPED,
+          failureMessages: [],
+          ancestorTitles: ['suite'],
+          title: 'fake test',
+        },
+        testFilePath,
+      );
 
       expect(spyFinishSkippedTest).toHaveBeenCalled();
       expect(spyFinishPassedTest).not.toHaveBeenCalled();

package-lock.json

@@ -26,7 +26,7 @@
     "strip-ansi": "^6.0.1"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
     "eslint": "^8.57.0",
     "eslint-config-airbnb-base": "^15.0.0",

package.json

@@ -75,36 +75,24 @@ class JestReportPortal {
   onTestCaseStart(test, testCaseStartInfo) {
     this._startSuites(testCaseStartInfo.ancestorTitles, test.path, testCaseStartInfo.startedAt);
 
-    const isRetried = !!this.tempStepIds.get(getFullStepName(testCaseStartInfo));
-    this._startStep(testCaseStartInfo, test.path, isRetried);
+    this._startStep(testCaseStartInfo, test.path);
   }
 
   // TODO: cover with tests
   // Not called for `skipped` and `todo` specs
   onTestCaseResult(test, testCaseStartInfo) {
-    this._finishStep(testCaseStartInfo);
+    this._finishStep(testCaseStartInfo, test.path);
   }
 
   onTestResult(test, testResult) {
     // Handling `skipped` tests and their ancestors
-    const skippedTests = testResult.testResults.filter(
-      (t) => t.status === TEST_ITEM_STATUSES.SKIPPED,
-    );
-
-    skippedTests.forEach((testCaseInfo) => {
-      const testCaseWithStartTime = { startedAt: new Date().valueOf(), ...testCaseInfo };
-      this._startSuites(testCaseInfo.ancestorTitles, test.path, testCaseWithStartTime.startedAt);
-
-      if (testCaseWithStartTime.invocations) {
-        for (let i = 0; i < testCaseWithStartTime.invocations; i++) {
-          const isRetried = i > 0;
+    testResult.testResults.forEach((testCaseInfo) => {
+      if (testCaseInfo.status === TEST_ITEM_STATUSES.SKIPPED) {
+        const testCaseWithStartTime = { startedAt: new Date().valueOf(), ...testCaseInfo };
+        this._startSuites(testCaseInfo.ancestorTitles, test.path, testCaseWithStartTime.startedAt);
 
-          this._startStep(testCaseWithStartTime, test.path, isRetried);
-          this._finishStep(testCaseWithStartTime);
-        }
-      } else {
         this._startStep(testCaseWithStartTime, test.path);
-        this._finishStep(testCaseWithStartTime);
+        this._finishStep(testCaseWithStartTime, test.path);
       }
     });
 
@@ -152,9 +140,12 @@ class JestReportPortal {
     this.promises.push(promise);
   }
 
-  _startStep(test, testPath, isRetried = false) {
+  _startStep(test, testPath) {
     const fullStepName = getFullStepName(test);
     const codeRef = getCodeRef(testPath, fullStepName);
+    const retryIds = this.tempStepIds.get(codeRef);
+    const isRetried = !!retryIds;
+
     const stepStartObj = {
       type: TEST_ITEM_TYPES.STEP,
       name: test.title,
@@ -172,24 +163,32 @@ class JestReportPortal {
       this.tempLaunchId,
       parentId,
     );
+    // store item ids as array to not overwrite retry ids
+    let tempIdToStore = [tempId];
+
+    if (isRetried) {
+      tempIdToStore = retryIds.concat(tempIdToStore);
+    }
 
-    this.tempStepIds.set(fullStepName, tempId);
+    this.tempStepIds.set(codeRef, tempIdToStore);
     this.tempStepId = tempId;
     promiseErrorHandler(promise);
     this.promises.push(promise);
   }
 
-  _finishStep(test) {
-    const errorMsg = test.failureMessages[0];
-
+  _finishStep(test, testPath) {
     const fullName = getFullStepName(test);
-    const tempStepId = this.tempStepIds.get(fullName);
+    const codeRef = getCodeRef(testPath, fullName);
+    const tempStepIds = this.tempStepIds.get(codeRef);
+    const tempStepId = Array.isArray(tempStepIds) ? tempStepIds.shift() : undefined;
 
-    if (tempStepId === undefined) {
-      console.error(`Could not finish Test Step - "${fullName}". tempId not found`);
+    if (!tempStepId) {
+      console.error(`Could not finish Test Step - "${codeRef}". tempId not found`);
       return;
     }
 
+    const errorMsg = test.failureMessages[0];
+
     switch (test.status) {
       case TEST_ITEM_STATUSES.PASSED:
         this._finishPassedStep(tempStepId);

src/reporter.js

@@ -34,6 +34,6 @@ module.exports = class ReportingApi {
    * @param {String} description - file description (optional).
    */
   attachment(file, description) {
-    this.reporter.sendLog({ message: description, file });
+    this.reporter._sendLog({ message: description, file });
   }
 };