Merge pull request #209 from reportportal/develop

Release 5.2.0

.eslintignore

@@ -1,3 +1,3 @@
 node_modules
 build
-spec/**/*.json
+__tests__/**/*.json

.eslintrc

@@ -17,7 +17,7 @@
   "env": {
     "node": true,
     "es6": true,
-    "jasmine": true
+    "jest": true
   },
   "rules": {
     "valid-jsdoc": ["error", { "requireReturn": false }],

.github/CODEOWNERS

@@ -1 +1 @@
-* @AmsterGet @AliakseiLiasnitski
+* @AmsterGet

.github/workflows/CI-pipeline.yml

@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [12, 14, 16, 18, 20]
+        node: [14, 16, 18, 20, 22]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -50,8 +50,5 @@ jobs:
       - name: Run lint
         run: npm run lint
 
-      - name: Run tests
-        run: npm test
-
-      - name: Check coverage
+      - name: Run tests and check coverage
         run: npm run test:coverage

.github/workflows/publish.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
       - name: Install of node dependencies
         run: npm install
       - name: Run lint
@@ -45,7 +45,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           registry-url: 'https://registry.npmjs.org'
       - name: Install of node dependencies
         run: npm install
@@ -59,7 +59,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           registry-url: 'https://npm.pkg.github.com'
           scope: '@reportportal'
       - name: Publish to GPR

.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
       releaseVersion: ${{ steps.exposeVersion.outputs.releaseVersion }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Read version
         id: readVersion
         run: |
@@ -78,9 +78,9 @@ jobs:
       versionInfo: ${{ steps.readChangelogEntry.outputs.log_entry }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup NodeJS
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '12'
       - name: Configure git
@@ -139,7 +139,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Create Release
         id: createRelease
         uses: actions/create-release@v1

CHANGELOG.md

@@ -1,3 +1,11 @@
+### Changed
+- **Breaking change** Drop support of Node.js 12. The version [5.1.4](https://github.com/reportportal/client-javascript/releases/tag/v5.1.4) is the latest that supports it.
+- The client now creates an instance of the `axios` HTTP client in the constructor.
+- The `HOST` HTTP header is added to all requests as it was skipped by the HTTP client.
+### Fixed
+- Allow using `restClientConfig` in `checkConnect()` method. Thanks to [stevez](https://github.com/stevez).
+### Security
+- Updated versions of vulnerable packages (braces).
 
 ## [5.1.4] - 2024-05-22
 ### Fixed
@@ -23,6 +31,8 @@
 - **Breaking change** Drop support of Node.js 10. The version [5.0.15](https://github.com/reportportal/client-javascript/releases/tag/v5.0.15) is the latest that supports it.
 ### Security
 - Updated versions of vulnerable packages (axios, follow-redirects).
+### Deprecated
+- Node.js 12 usage. This minor version is the latest that supports Node.js 12.
 
 ## [5.0.15] - 2023-11-20
 ### Added

README.md

@@ -53,24 +53,24 @@ rpClient.checkConnect().then((response) => {
 
 When creating a client instance, you need to specify the following options:
 
-| Option                | Necessity  | Default  | Description                                                                                                                                                                                                                                         |
-|-----------------------|------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| apiKey                | Required   |          | User's reportportal token from which you want to send requests. It can be found on the profile page of this user.                                                                                                                                   |
-| endpoint              | Required   |          | URL of your server. For example, if you visit the page at 'https://server:8080/ui', then endpoint will be equal to 'https://server:8080/api/v1'.                                                                                                    |
-| launch                | Required   |          | Name of the launch at creation.                                                                                                                                                                                                                     |
-| project               | Required   |          | The name of the project in which the launches will be created.                                                                                                                                                                                      |
-| 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  | `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', 'FILE', 'ENVIRONMENT'. Works only if `launchUuidPrint` set to `true`. File format: `rp-launch-uuid-${launch_uuid}.tmp`. Env variable: `RP_LAUNCH_UUID`.                                                                                                                                      |
-| token                 | Deprecated | Not set  | Use `apiKey` instead.                                                                                                                                                                                                                               |
+| Option                | Necessity  | Default  | Description                                                                                                                                                                                                                                                                                                                     |
+|-----------------------|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| apiKey                | Required   |          | User's reportportal token from which you want to send requests. It can be found on the profile page of this user.                                                                                                                                                                                                               |
+| endpoint              | Required   |          | URL of your server. For example, if you visit the page at 'https://server:8080/ui', then endpoint will be equal to 'https://server:8080/api/v1'.                                                                                                                                                                                |
+| launch                | Required   |          | Name of the launch at creation.                                                                                                                                                                                                                                                                                                 |
+| project               | Required   |          | The name of the project in which the launches will be created.                                                                                                                                                                                                                                                                  |
+| 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  | `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', 'FILE', 'ENVIRONMENT'. Works only if `launchUuidPrint` set to `true`. File format: `rp-launch-uuid-${launch_uuid}.tmp`. Env variable: `RP_LAUNCH_UUID`.                                                                                                       |
+| token                 | Deprecated | Not set  | Use `apiKey` instead.                                                                                                                                                                                                                                                                                                           |
 
 ## Asynchronous reporting
 
-The client supports an asynchronous reporting.
-If you want the client to work asynchronously change `v1` to `v2` in addresses in endpoint.
+The client supports an asynchronous reporting (via the ReportPortal asynchronous API).
+If you want the client to report through the asynchronous API, change `v1` to `v2` in the `endpoint` address.
 
 ## API
 

VERSION

@@ -1 +1 @@
-5.1.4
+5.1.5-SNAPSHOT

spec/config.spec.js → __tests__/config.spec.js

@@ -23,19 +23,16 @@ describe('Config commons test suite', () => {
       expect(error).toBeInstanceOf(ReportPortalRequiredOptionError);
     });
 
-    it(
-      'should throw ReportPortalRequiredOptionError in case of option ' + 'not present in options',
-      () => {
-        let error;
-        try {
-          getRequiredOption({ other: 1 }, 'project');
-        } catch (e) {
-          error = e;
-        }
-        expect(error).toBeDefined();
-        expect(error).toBeInstanceOf(ReportPortalRequiredOptionError);
-      },
-    );
+    it('should throw ReportPortalRequiredOptionError in case of option not present in options', () => {
+      let error;
+      try {
+        getRequiredOption({ other: 1 }, 'project');
+      } catch (e) {
+        error = e;
+      }
+      expect(error).toBeDefined();
+      expect(error).toBeInstanceOf(ReportPortalRequiredOptionError);
+    });
   });
 
   describe('getApiKey', () => {
@@ -52,7 +49,7 @@ describe('Config commons test suite', () => {
     });
 
     it('should print warning to console if deprecated token option used', () => {
-      spyOn(console, 'warn');
+      jest.spyOn(console, 'warn').mockImplementation();
 
       getApiKey({ token: '1' });
 
@@ -75,7 +72,7 @@ describe('Config commons test suite', () => {
 
   describe('getClientConfig', () => {
     it('should print ReportPortalValidationError error to the console in case of options is not an object type', () => {
-      spyOn(console, 'dir');
+      jest.spyOn(console, 'dir').mockImplementation();
       getClientConfig('options');
 
       expect(console.dir).toHaveBeenCalledWith(
@@ -84,7 +81,7 @@ describe('Config commons test suite', () => {
     });
 
     it('should print ReportPortalRequiredOptionError to the console in case of "endpoint" option missed', () => {
-      spyOn(console, 'dir');
+      jest.spyOn(console, 'dir').mockImplementation();
       getClientConfig({
         apiKey: '123',
         project: 'prj',
@@ -94,7 +91,7 @@ describe('Config commons test suite', () => {
     });
 
     it('should print ReportPortalRequiredOptionError to the console in case of "project" option missed', () => {
-      spyOn(console, 'dir');
+      jest.spyOn(console, 'dir').mockImplementation();
       getClientConfig({
         apiKey: '123',
         endpoint: 'https://abc.com',
@@ -104,7 +101,7 @@ describe('Config commons test suite', () => {
     });
 
     it('should print ReportPortalRequiredOptionError to the console in case of "apiKey" option missed', () => {
-      spyOn(console, 'dir');
+      jest.spyOn(console, 'dir').mockImplementation();
       getClientConfig({
         project: 'prj',
         endpoint: 'https://abc.com',

spec/helpers.spec.js → __tests__/helpers.spec.js

@@ -2,11 +2,9 @@ const os = require('os');
 const fs = require('fs');
 const glob = require('glob');
 const helpers = require('../lib/helpers');
-const RestClient = require('../lib/rest');
 const pjson = require('../package.json');
 
 describe('Helpers', () => {
-
   describe('formatName', () => {
     it('slice last 256 symbols', () => {
       expect(helpers.formatName(`a${'b'.repeat(256)}`)).toBe('b'.repeat(256));
@@ -28,37 +26,9 @@ describe('Helpers', () => {
     });
   });
 
-  describe('getServerResults', () => {
-    it('calls RestClient#request', () => {
-      spyOn(RestClient, 'request');
-
-      helpers.getServerResult(
-        'http://localhost:80/api/v1',
-        { userId: 1 },
-        {
-          headers: {
-            'X-Custom-Header': 'WOW',
-          },
-        },
-        'POST',
-      );
-
-      expect(RestClient.request).toHaveBeenCalledWith(
-        'POST',
-        'http://localhost:80/api/v1',
-        { userId: 1 },
-        {
-          headers: {
-            'X-Custom-Header': 'WOW',
-          },
-        },
-      );
-    });
-  });
-
   describe('readLaunchesFromFile', () => {
     it('should return the right ids', () => {
-      spyOn(glob, 'sync').and.returnValue(['rplaunch-fileOne.tmp', 'rplaunch-fileTwo.tmp']);
+      jest.spyOn(glob, 'sync').mockReturnValue(['rplaunch-fileOne.tmp', 'rplaunch-fileTwo.tmp']);
 
       const ids = helpers.readLaunchesFromFile();
 
@@ -68,19 +38,19 @@ describe('Helpers', () => {
 
   describe('saveLaunchIdToFile', () => {
     it('should call fs.open method with right parameters', () => {
-      spyOn(fs, 'open');
+      jest.spyOn(fs, 'open').mockImplementation();
 
       helpers.saveLaunchIdToFile('fileOne');
 
-      expect(fs.open).toHaveBeenCalledWith('rplaunch-fileOne.tmp', 'w', jasmine.any(Function));
+      expect(fs.open).toHaveBeenCalledWith('rplaunch-fileOne.tmp', 'w', expect.any(Function));
     });
   });
 
   describe('getSystemAttribute', () => {
     it('should return correct system attributes', () => {
-      spyOn(os, 'type').and.returnValue('osType');
-      spyOn(os, 'arch').and.returnValue('osArchitecture');
-      spyOn(os, 'totalmem').and.returnValue('1');
+      jest.spyOn(os, 'type').mockReturnValue('osType');
+      jest.spyOn(os, 'arch').mockReturnValue('osArchitecture');
+      jest.spyOn(os, 'totalmem').mockReturnValue('1');
       const nodeVersion = process.version;
       const expectedAttr = [
         {
@@ -146,15 +116,11 @@ describe('Helpers', () => {
 
   describe('saveLaunchUuidToFile', () => {
     it('should call fs.open method with right parameters', () => {
-      spyOn(fs, 'open');
+      jest.spyOn(fs, 'open').mockImplementation();
 
       helpers.saveLaunchUuidToFile('fileOne');
 
-      expect(fs.open).toHaveBeenCalledWith(
-        'rp-launch-uuid-fileOne.tmp',
-        'w',
-        jasmine.any(Function),
-      );
+      expect(fs.open).toHaveBeenCalledWith('rp-launch-uuid-fileOne.tmp', 'w', expect.any(Function));
     });
   });
 });