ReportPortal JavaScript Client

Common errors

• Error connection to server

  cause Incorrect `endpoint` URL, invalid `token`, or network connectivity issues to the ReportPortal server.
  fix Verify the `endpoint` URL format (e.g., `/api/v1`), confirm the `token` is correct, and ensure the ReportPortal server is running and accessible from the client's environment.

• TypeError: RPClient is not a constructor

  cause Attempting to use `import { RPClient } from 'reportportal-js-client';` in an ES Module context. The library exports `RPClient` as a default export.
  fix Use the correct ES Module import syntax: `import RPClient from 'reportportal-js-client';`.

• Error: Not all parameters are specified.

  cause Missing one or more required configuration parameters (`token`, `endpoint`, `launch`, `project`) when instantiating `RPClient`.
  fix Ensure all required parameters (`token`, `endpoint`, `launch`, `project`) are provided as properties in the configuration object when creating a new `RPClient` instance.

Warnings

• breaking Version 2.0.0 and subsequent versions dropped support for Report Portal 4. The client now exclusively supports Report Portal 5 and newer versions.
  Fix: Ensure your Report Portal server instance is version 5 or higher. If not, either downgrade the client to a 1.x version or upgrade your Report Portal server.
• gotcha The `endpoint` configuration parameter must specifically point to the ReportPortal API base URL, typically ending with `/api/v1` (or `/api/v2` for asynchronous reporting). Providing the UI URL (e.g., `http://server:8080/ui`) will lead to connection errors.
  Fix: Always format your endpoint as `http://your-instance.com:8080/api/v1` (or `v2`).
• gotcha For asynchronous reporting, the endpoint URL must be modified to use `/api/v2` instead of `/api/v1`. This is a specific behavior to enable a different reporting mode.
  Fix: Set `endpoint: "http://your-instance.com:8080/api/v2"` in the client configuration to utilize asynchronous reporting features.
• gotcha The `token` parameter is mandatory for authentication and must be a valid user token obtained from the user's profile page within the ReportPortal UI. Incorrect or missing tokens will result in authentication failures.
  Fix: Obtain the user token from your ReportPortal profile settings and ensure it is correctly provided in the client configuration.
• gotcha While the client API calls (e.g., `startLaunch`, `startTestItem`) are synchronous in the sense that they return immediately, the actual network requests are asynchronous and return Promises. It's crucial to handle these promises for operations like `checkConnect` or for ensuring data is sent before application exit.
  Fix: Always `await` or chain `.then()` and `.catch()` calls on methods that return a Promise (like `checkConnect`) to properly handle their completion or errors. For other methods, collect the `promise` property from the returned object if you need to await their completion.

Install

• npm install reportportal-js-client npm
• yarn add reportportal-js-client yarn
• pnpm add reportportal-js-client pnpm

Imports

• RPClient

  const RPClient = require('reportportal-js-client');

  Primary CommonJS import pattern as shown in official documentation and examples.
• RPClient
  wrong:

  import { RPClient } from 'reportportal-js-client';

  correct:

  import RPClient from 'reportportal-js-client';

  For ES Modules, the library provides a default export. Named imports will not work for the main client class.
• rpClient.helpers.now

  const startTime = rpClient.helpers.now();

  Access to utility functions like `now()` is through the client instance's `helpers` property.

Quickstart

Demonstrates how to initialize the ReportPortal client, check connectivity, and start and finish a basic launch.

import RPClient from 'reportportal-js-client';

const rpClient = new RPClient({
    token: process.env.REPORTPORTAL_TOKEN ?? 'YOUR_REPORTPORTAL_TOKEN',
    endpoint: process.env.REPORTPORTAL_ENDPOINT ?? 'http://your-instance.com:8080/api/v1',
    launch: process.env.REPORTPORTAL_LAUNCH_NAME ?? 'MyTestLaunch',
    project: process.env.REPORTPORTAL_PROJECT_NAME ?? 'MyProject'
});

rpClient.checkConnect().then((response) => {
    console.log('Successfully connected to ReportPortal server.');
    console.log(`Using account: ${response.fullName}`);

    const launchObj = rpClient.startLaunch({
        name: 'Client Test Launch',
        startTime: rpClient.helpers.now(),
        description: 'Example launch from quickstart',
        attributes: [{ key: 'env', value: 'dev' }]
    });

    console.log(`Launch started with tempId: ${launchObj.tempId}`);

    // You would typically add test items here and finish the launch later.
    // For this quickstart, we'll just finish it immediately for demonstration.
    rpClient.finishLaunch(launchObj.tempId, { endTime: rpClient.helpers.now() });
    console.log(`Launch ${launchObj.tempId} finished.`);

}, (error) => {
    console.error('Error connecting to ReportPortal server:');
    console.error(error);
});