From 792fa0fc9ab7a4d178cf688d01c4024079444936 Mon Sep 17 00:00:00 2001 From: Ilya Date: Mon, 20 Nov 2023 18:30:08 +0100 Subject: [PATCH] Bump version of client-javascript. Add missing option. Fix vulnerabilities (#133) --- CHANGELOG.md | 7 +++++++ README.md | 37 ++++++++++++++++++++----------------- package-lock.json | 8 ++++---- package.json | 2 +- utils/objectUtils.js | 3 +++ 5 files changed, 35 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5c31530..127ed8c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +### Fixed +- `isLaunchMergeRequired` option from `client-javascript` missed. +### Changed +- `@reportportal/client-javascript` bumped to version `5.0.14`. `launchUuidPrint` and `launchUuidPrintOutput` configuration options introduced. +- Readme file updated. +### Security +- Updated versions of vulnerable packages (@babel/traverse). ## [5.0.6] - 2023-07-18 ### Changed diff --git a/README.md b/README.md index df0a0f7..5286e68 100755 --- a/README.md +++ b/README.md @@ -76,23 +76,26 @@ In case you use the jest config section of `package.json`, add the following ent The full list of available options presented below. -| 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 'https://server:8080/api/v1'. | -| launch | Required | | Name of launch at creation. | -| project | Required | | The name of the project in which the launches will be created. | -| attributes | Optional | [] | Launch attributes. | -| description | Optional | '' | Launch description. | -| rerun | Optional | false | Enable [rerun](https://reportportal.io/docs/dev-guides/RerunDevelopersGuide) | -| rerunOf | Optional | Not set | UUID of launch you want to rerun. If not specified, reportportal will update the latest launch with the same name | -| mode | Optional | 'DEFAULT' | Results will be submitted to Launches page
*'DEBUG'* - Results will be submitted to Debug page. | -| skippedIssue | Optional | true | reportportal provides feature to mark skipped tests as not 'To Investigate'.
Option could be equal boolean values:
*true* - skipped tests considered as issues and will be marked as 'To Investigate' on reportportal.
*false* - skipped tests will not be marked as 'To Investigate' on application. | -| debug | Optional | false | This flag allows seeing the logs of the client-javascript. Useful for debugging. | -| launchId | Optional | Not set | The _ID_ of an already existing launch. The launch must be in 'IN_PROGRESS' status while the tests are running. Please note that if this _ID_ is provided, the launch will not be finished at the end of the run and must be finished separately. | -| logLaunchLink | Optional | false | This flag allows print the URL of the Launch of the tests in console. | -| 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`](https://github.com/reportportal/client-javascript#timeout-30000ms-on-axios-requests).
Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details. | -| 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 'https://server:8080/api/v1'. | +| launch | Required | | Name of launch at creation. | +| project | Required | | The name of the project in which the launches will be created. | +| attributes | Optional | [] | Launch attributes. | +| description | Optional | '' | Launch description. | +| rerun | Optional | false | Enable [rerun](https://reportportal.io/docs/dev-guides/RerunDevelopersGuide) | +| rerunOf | Optional | Not set | UUID of launch you want to rerun. If not specified, reportportal will update the latest launch with the same name | +| mode | Optional | 'DEFAULT' | Results will be submitted to Launches page
*'DEBUG'* - Results will be submitted to Debug page. | +| skippedIssue | Optional | true | reportportal provides feature to mark skipped tests as not 'To Investigate'.
Option could be equal boolean values:
*true* - skipped tests considered as issues and will be marked as 'To Investigate' on reportportal.
*false* - skipped tests will not be marked as 'To Investigate' on application. | +| debug | Optional | false | This flag allows seeing the logs of the client-javascript. Useful for debugging. | +| launchId | Optional | Not set | The _ID_ of an already existing launch. The launch must be in 'IN_PROGRESS' status while the tests are running. Please note that if this _ID_ is provided, the launch will not be finished at the end of the run and must be finished separately. | +| logLaunchLink | Optional | false | This flag allows print the URL of the Launch of the tests in console. | +| 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`](https://github.com/reportportal/client-javascript#timeout-30000ms-on-axios-requests).
Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details. | +| isLaunchMergeRequired | Optional | false | This flag determines whether to create temp files with the UUIDs of started launches and allow them to be merged using [`client-javascript`'s `mergeLaunches` method](https://github.com/reportportal/client-javascript#mergelaunches). Temp file format: `rplaunch-${launch_uuid}.tmp`. | +| 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. | The following options can be overridden using ENVIRONMENT variables: diff --git a/package-lock.json b/package-lock.json index 3b61eae..d3b82a4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "5.0.6", "license": "Apache-2.0", "dependencies": { - "@reportportal/client-javascript": "^5.0.12", + "@reportportal/client-javascript": "^5.0.14", "strip-ansi": "^6.0.1" }, "devDependencies": { @@ -1218,9 +1218,9 @@ } }, "node_modules/@reportportal/client-javascript": { - "version": "5.0.12", - "resolved": "https://registry.npmjs.org/@reportportal/client-javascript/-/client-javascript-5.0.12.tgz", - "integrity": "sha512-ECLvuDLV7KyKs0wG9Sis3ZqHOq9VMg3fywm1VDegd5HGDKC1hoXxFKfz6ngPY8FZ5O1nt1UJvgEs47shtPHQCg==", + "version": "5.0.14", + "resolved": "https://registry.npmjs.org/@reportportal/client-javascript/-/client-javascript-5.0.14.tgz", + "integrity": "sha512-4ge9ddOB1rFlzqI6j43qCw0cyjQOloiPChA1EFyF3dcV2BXHzGbh8S3SNhwxibvlQtV6piU8e0W9CLN4UWXvSA==", "dependencies": { "axios": "^0.27.2", "axios-retry": "^3.4.0", diff --git a/package.json b/package.json index 863bdfb..1dc43b6 100755 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "constants" ], "dependencies": { - "@reportportal/client-javascript": "^5.0.12", + "@reportportal/client-javascript": "^5.0.14", "strip-ansi": "^6.0.1" }, "devDependencies": { diff --git a/utils/objectUtils.js b/utils/objectUtils.js index 8538f84..ffda06c 100644 --- a/utils/objectUtils.js +++ b/utils/objectUtils.js @@ -94,6 +94,9 @@ const getAgentOptions = (options = {}) => { restClientConfig: options.restClientConfig, launchId: process.env.RP_LAUNCH_ID || options.launchId, logLaunchLink: options.logLaunchLink, + isLaunchMergeRequired: options.isLaunchMergeRequired, + launchUuidPrint: options.launchUuidPrint, + launchUuidPrintOutput: options.launchUuidPrintOutput, }; };