Merge pull request #193 from reportportal/develop

Release 5.1.2
reportportal · Feb 20, 2024 · 6df9f62 · 6df9f62
2 parents 2e9c766 + 0508342
commit 6df9f62
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+### Fixed
+- Execution sequence for retried tests [#134](https://github.com/reportportal/agent-js-playwright/issues/134).
 
 ## [5.1.1] - 2024-01-23
 ### Added

diff --git a/README.md b/README.md
@@ -6,17 +6,18 @@ Library is used only for implementors of custom listeners for ReportPortal.
 
 ## Already implemented listeners:
 
-* [Jest integration](https://github.com/reportportal/agent-js-jest)
+* [Playwright integration](https://github.com/reportportal/agent-js-playwright)
 * [Cypress integration](https://github.com/reportportal/agent-js-cypress)
+* [Jest integration](https://github.com/reportportal/agent-js-jest)
 * [Mocha integration](https://github.com/reportportal/agent-js-mocha)
-* [Jasmine integration](https://github.com/reportportal/agent-js-jasmine)
-* [Nightwatch integration](https://github.com/reportportal/agent-js-nightwatch)
-* [Cucumber integration](https://github.com/reportportal/agent-js-cucumber)
-* [Codecept integration](https://github.com/reportportal/agent-js-codecept)
+* [Webdriverio integration](https://github.com/reportportal/agent-js-webdriverio)
 * [Postman integration](https://github.com/reportportal/agent-js-postman)
+* [Cucumber integration](https://github.com/reportportal/agent-js-cucumber)
+* [Vitest integration](https://github.com/reportportal/agent-js-vitest)
+* [Jasmine integration](https://github.com/reportportal/agent-js-jasmine)
 * [TestCafe integration](https://github.com/reportportal/agent-js-testcafe)
-* [Webdriverio integration](https://github.com/reportportal/agent-js-webdriverio)
-* [Playwright integration](https://github.com/reportportal/agent-js-playwright)
+* [Codecept integration](https://github.com/reportportal/agent-js-codecept)
+* [Nightwatch integration](https://github.com/reportportal/agent-js-nightwatch)
 
 Examples for test framework integrations from the list above described in [examples](https://github.com/reportportal/examples-js) repository.
 
@@ -61,7 +62,7 @@ When creating a client instance, you need to specify the following options:
 | headers               | Optional   | {}       | The object with custom headers for internal http client.                                                                                                                                                                                            |
 | debug                 | Optional   | false    | This flag allows seeing the logs of the client. Useful for debugging.                                                                                                                                                                               |
 | isLaunchMergeRequired | Optional   | false    | Allows client to merge launches into one at the end of the run via saving their UUIDs to the temp files at filesystem . At the end of the run launches can be merged using `mergeLaunches` method. Temp file format: `rplaunch-${launch_uuid}.tmp`. |
-| restClientConfig      | Optional   | Not set  | The object with `agent` property for configure [http(s)](https://nodejs.org/api/https.html#https_https_request_url_options_callback) client, may contain other client options eg. `timeout`. For debugging and displaying logs you can set `debug: true`                                                       |
+| restClientConfig      | Optional   | Not set  | `axios` like http client [config](https://github.com/axios/axios#request-config). May contain `agent` property for configure [http(s)](https://nodejs.org/api/https.html#https_https_request_url_options_callback) client, and other client options eg. `timeout`. For debugging and displaying logs you can set `debug: true`.                                                       |
 | launchUuidPrint       | Optional   | false    | Whether to print the current launch UUID.                                                                                                                                                                                                           |
 | launchUuidPrintOutput | Optional   | 'STDOUT' | Launch UUID printing output. Possible values: 'STDOUT', 'STDERR'. Works only if `launchUuidPrint` set to `true`.                                                                                                                                    |
 | token                 | Deprecated | Not set  | Use `apiKey` instead.                                                                                                                                                                                                                               |

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-5.1.1
+5.1.2-SNAPSHOT
diff --git a/lib/report-portal-client.js b/lib/report-portal-client.js
@@ -53,7 +53,8 @@ class RPClient {
     });
     this.statistics = new Statistics(EVENT_NAME, agentParams);
     this.launchUuid = '';
-    this.nonRetriedItemMap = new Map();
+    this.itemRetriesChainMap = new Map();
+    this.itemRetriesChainKeyMapByTempId = new Map();
   }
 
   // eslint-disable-next-line valid-jsdoc
@@ -67,10 +68,27 @@ class RPClient {
     }
   }
 
-  calculateNonRetriedItemMapKey(launchId, parentId, name, itemId = '') {
+  calculateItemRetriesChainMapKey(launchId, parentId, name, itemId = '') {
     return `${launchId}__${parentId}__${name}__${itemId}`;
   }
 
+  // eslint-disable-next-line valid-jsdoc
+  /**
+   *
+   * @Private
+   */
+  cleanItemRetriesChain(tempIds) {
+    tempIds.forEach((id) => {
+      const key = this.itemRetriesChainKeyMapByTempId.get(id);
+
+      if (key) {
+        this.itemRetriesChainMap.delete(key);
+      }
+
+      this.itemRetriesChainKeyMapByTempId.delete(id);
+    });
+  }
+
   getUniqId() {
     return UniqId();
   }
@@ -488,20 +506,17 @@ class RPClient {
       parentPromise = parentObj.promiseStart;
     }
 
-    const itemKey = this.calculateNonRetriedItemMapKey(
+    const itemKey = this.calculateItemRetriesChainMapKey(
       launchTempId,
       parentTempId,
       testItemDataRQ.name,
       testItemDataRQ.uniqueId,
     );
-    const firstNonRetriedItemPromise = testItemDataRQ.retry && this.nonRetriedItemMap.get(itemKey);
-    if (firstNonRetriedItemPromise) {
-      parentPromise = Promise.all([parentPromise, firstNonRetriedItemPromise]);
-    }
+    const executionItemPromise = testItemDataRQ.retry && this.itemRetriesChainMap.get(itemKey);
 
     const tempId = this.getUniqId();
     this.map[tempId] = this.getNewItemObj((resolve, reject) => {
-      parentPromise.then(
+      (executionItemPromise || parentPromise).then(
         () => {
           const realLaunchId = this.map[launchTempId].realId;
           let url = 'item/';
@@ -515,7 +530,6 @@ class RPClient {
             (response) => {
               this.logDebug(`Success start item with tempId ${tempId}`, response);
               this.map[tempId].realId = response.id;
-              this.nonRetriedItemMap.delete(itemKey);
               resolve(response);
             },
             (error) => {
@@ -531,10 +545,8 @@ class RPClient {
       );
     });
     this.map[parentMapId].children.push(tempId);
-
-    if (!testItemDataRQ.retry) {
-      this.nonRetriedItemMap.set(itemKey, this.map[tempId].promiseStart);
-    }
+    this.itemRetriesChainKeyMapByTempId.set(tempId, itemKey);
+    this.itemRetriesChainMap.set(itemKey, this.map[tempId].promiseStart);
 
     return {
       tempId,
@@ -602,7 +614,7 @@ class RPClient {
             }
           });
         }
-
+        this.cleanItemRetriesChain(itemObj.children);
         this.cleanMap(itemObj.children);
 
         this.logDebug(`Finish test item with tempId ${itemTempId}`, finishTestItemRQ);

diff --git a/spec/report-portal-client.spec.js b/spec/report-portal-client.spec.js
@@ -63,15 +63,15 @@ describe('ReportPortal javascript client', () => {
     });
   });
 
-  describe('calculateNonRetriedItemMapKey', () => {
+  describe('calculateItemRetriesChainMapKey', () => {
     it("should return correct parameter's string", () => {
       const client = new RPClient({
         apiKey: 'test',
         project: 'test',
         endpoint: 'https://abc.com',
       });
 
-      const str = client.calculateNonRetriedItemMapKey('lId', 'pId', 'name', 'itemId');
+      const str = client.calculateItemRetriesChainMapKey('lId', 'pId', 'name', 'itemId');
 
       expect(str).toEqual('lId__pId__name__itemId');
     });
@@ -83,7 +83,7 @@ describe('ReportPortal javascript client', () => {
         endpoint: 'https://abc.com',
       });
 
-      const str = client.calculateNonRetriedItemMapKey('lId', 'pId', 'name');
+      const str = client.calculateItemRetriesChainMapKey('lId', 'pId', 'name');
 
       expect(str).toEqual('lId__pId__name__');
     });
@@ -725,17 +725,17 @@ describe('ReportPortal javascript client', () => {
           promiseStart: Promise.resolve(),
         },
       };
-      spyOn(client.nonRetriedItemMap, 'get').and.resolveTo();
+      spyOn(client.itemRetriesChainMap, 'get').and.resolveTo();
       spyOn(client.restClient, 'create').and.resolveTo({});
       spyOn(client, 'getUniqId').and.returnValue('4n5pxq24kpiob12og9');
 
-      const result = client.startTestItem({ retry: true }, 'id1', 'id');
+      const result = client.startTestItem({ retry: false }, 'id1', 'id');
 
       expect(result.tempId).toEqual('4n5pxq24kpiob12og9');
       return expectAsync(result.promise).toBeResolved();
     });
 
-    it('should call nonRetriedItemMap if retry is false', () => {
+    it('should get previous try promise from itemRetriesChainMap if retry is true', () => {
       const client = new RPClient({
         apiKey: 'startLaunchTest',
         endpoint: 'https://rp.us/api/v1',
@@ -754,17 +754,14 @@ describe('ReportPortal javascript client', () => {
           promiseStart: Promise.resolve(),
         },
       };
-      spyOn(client, 'calculateNonRetriedItemMapKey').and.returnValue('id1__name__');
+      spyOn(client, 'calculateItemRetriesChainMapKey').and.returnValue('id1__name__');
       spyOn(client, 'getUniqId').and.returnValue('4n5pxq24kpiob12og9');
       spyOn(client.map['4n5pxq24kpiob12og9'], 'promiseStart').and.resolveTo();
-      spyOn(client.nonRetriedItemMap, 'set');
+      spyOn(client.itemRetriesChainMap, 'get');
 
-      client.startTestItem({ retry: false }, 'id1');
+      client.startTestItem({ retry: true }, 'id1');
 
-      expect(client.nonRetriedItemMap.set).toHaveBeenCalledWith(
-        'id1__name__',
-        client.map['4n5pxq24kpiob12og9'].promiseStart,
-      );
+      expect(client.itemRetriesChainMap.get).toHaveBeenCalledWith('id1__name__');
     });
   });