@currents/playwright

Setup and usage instructions for Playwright integrartion with Currents Dashboard

Requirements
NodeJS 14.0.0+
Playwright 1.22.2+
The Playwright integration is in public beta mode. We have been polishing the integration, and improving the documentation and developer experience.
Setup
Install @currents/playwright package
npm i -D @currents/playwright
Update playwright.config.js|ts
Enabled traces, videos and screenshots in playwright.config.js|ts to enhance the dashboard test results.
Disable parallelizing tests in a single file because it is not currently supported
use: {
    // ...
    trace: "on",
    video: "on",
    screenshot: "on",
  }
Using @currents/playwright
Choose the preferred usage method for @currents/playwright 
pwc CLI command - it runs playwright with a predefined configuration
Alternatively, you can add @currents/playwright reporter to Playwright configuration file
pwc CLI command
Run pwc to create your first Playwright run in Currents dashboard. Set the record key, and project ID obtained from Currents dashboard in the previous step. Learn more about CI Build ID.
npx pwc --key RECORD_KEY --project-id PROJECT_ID --ci-build-id hello-currents
Starting from version 1.7.0 you can provide --tag CLI flag to add tags that will apply to the whole execution:
npx pwc --key RECORD_KEY --project-id PROJECT_ID --ci-build-id CI_BUILD_ID --tag tagA,tagB
@currents/playwright reporter
Alternatively, you can manually add the reporter to Playwright configuration and keep using playwright test CLI command. 
import { currentsReporter } from '@currents/playwright';
​
const currentsConfig = {
  ciBuildId: process.env.CURRENTS_CI_BUILD_ID,
  recordKey: process.env.CURRENTS_RECORD_KEY,
  projectId: process.env.CURRENTS_PROJECT_ID,
  tag: ["runTagA", "runTagB"],
};
reporter: [
  // explicitly provide reporter name and configuration
  [
    "@currents/playwright",
    currentsConfig
  ],
  // ...or use the helper function that ensures type safety
  currentsReporter(currentsConfig),
  /* other reporters, if exist, e.g.:
  ["html"]
  */
]
You can provide the required configuration as a parameter of currentsReporter function or as environment variables. 
Linux
Windows
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 \ // the CI build ID 
CURRENTS_TAG=tagA,tagB \
npx playwright test
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  // CI build id
&& set CURRENTS_TAG=tagA,tagB  // tags for the created run
&& npx playwright test"
With the reporter configured, you can run npx playwright test to start sending the results to Currents dashboard. Learn more about CI Build ID.
Examples
Check out the example repository for integrating with GitHub Actions: https://github.com/currents-dev/playwright-gh-actions-demo. Here’s a quick reference to configuration files:
​test-basic-pwc.yml - using pwc executable script
​test-basic-reporter.yml - using reporter configuration
Good To Know
Screenshots
By default, Playwright only captures screenshots at the end of a test, according to the provided screenshot option. Manually created screenshots are hidden by default and won't be attached to any test.
To send screenshots to Currents, they have to be attached to the test. For example, you can attach a screenshot to a test like this
const { test, expect } = require("@playwright/test");
​
test("basic test", async ({ page }, testInfo) => {
  await page.goto("<https://playwright.dev>");
  const screenshot = await page.screenshot();
  await testInfo.attach("screenshot", {
    body: screenshot,
    contentType: "image/png",
  });
});
For more information see the Playwright test info attachment documentation.
Limitations
We recommend using the native Playwright Shards while we are working on other types of orchestration-related features.
Reruns are not supported - rerunning with the same CI build ID would generate a warning and new results would not be uploaded. Please use a new CI build ID.
Cross-machine auto-cancellation is not currently supported
Full parallel mode (parallelizing tests in a single file) is not currently supported