Your First Playwright Run

Running Playwright tests with Currents Dashboard

Integrate Currents with Playwright to enable recording test results together with screenshots, videos, and traces, unlocking more effective troubleshooting, analytics and proactive monitoring. Automate your team's workflows using REST API, WebHooks and built-in integration with Slack, GitHub, and more.

Overview

Setting Up Playwright in 2 minutes

Here's an overview of what steps you'll need to take to start running Playwright tests using the Currents dashboard and a CI:

1. Create an organization and a project

2. Install @currents/playwright npm package

3. Enable traces, videos and screenshots in playwright.config.js|ts to enhance the dashboard test results

4. Run the tests using pwc CLI command or by configuring an extra reporter

Prerequisites

Create an Organization and a Project

After signing up for the dashboard service, you will be prompted to create a new organization and a project. You can change their names later.

After creating a new organization and a project, you'll see on-screen instructions with your newly created Project ID and Record Key.

Select Playwright from the framework selection list and then choose the preferred installation method (see below).

Install @currents/playwright package

npm i -D @currents/playwright

Enable traces, videos and screenshots (Recommended)

Enable traces, videos and screenshots in playwright.config.js|ts to enhance the dashboard test results.

use: {
    // ...
    trace: "on",
    video: "on",
    screenshot: "on",
}

Create your first Playwright run

There are two ways to integrate Currents to your Playwright project. You can use our CLI, or integrate using reporter configuration.

Using the CLI

@currents/playwright provides an executable script named pwc - it runs playwright with a predefined configuration.

Run pwc to create your first Playwright run in Currents dashboard.

npx pwc --key RECORD_KEY --project-id PROJECT_ID

• Set the Record Key, and Project ID obtained from Currents dashboard in the previous step.

Explore @currents/playwright npm package documentation for configuration options.

Using reporter configuration

Add @currents/playwright reporter to playwright.config.js|ts

Explicitly add the reporter to Playwright configuration:

import { defineConfig, devices, PlaywrightTestConfig } from "@playwright/test";
import { CurrentsConfig, currentsReporter } from "@currents/playwright";

const currentsConfig: CurrentsConfig = {
  recordKey: "secret record key", // 📖 https://currents.dev/readme/guides/record-key
  projectId: "project id", // get one at https://app.currents.dev
};

const config: PlaywrightTestConfig = {
  use: {
    trace: "on",
    video: "on",
    screenshot: "on",
  },
  
  reporter: [currentsReporter(currentsConfig)], // 👈🏻 add Currents reporter

  projects: [
    {
      name: "chromium",
      retries: 2,
      use: {
        ...devices["Desktop Chrome"],
      },
    },
  ],

};

export default defineConfig(config);

You can also set environment variables to provide the configuration options to Currents reporter:

Linux

CURRENTS_PROJECT_ID=PROJECT_ID \ // the projectId from https://app.currents.dev
CURRENTS_RECORD_KEY=RECORD_KEY \ // the record key from https://app.currents.dev
CURRENTS_CI_BUILD_ID=hello-currents \
npx playwright test

Windows

cmd /V /C "set CURRENTS_PROJECT_ID=PROJECT_ID // the projectId from https://app.currents.dev
&& set CURRENTS_RECORD_KEY=RECORD_KEY // the record key from https://app.currents.dev
&& set CURRENTS_CI_BUILD_ID=hello-currents 
&& npx playwright test"

With the reporter configured, you can run npx playwright test to start sending the results to Currents dashboard.

Explore the Newly Created Run

If Currents reporter is set up correctly, the execution results will show on the Currents dashboard. Additionally, a link to the recorded run will also be available at the end of the execution:

A link to recorded results appearing at the end of Playwright tests execution

Explore

Learn more about our dashboard and its features.

Setup CI

Speed Up CI

Playwright Tags

Test Status

Insights and Analytics

Run Details