Troubleshooting Playwright

Troubleshooting Playwright integration with Currents

If you are experiencing issues with using @currents/playwright, please collect more information about the failure and submit a support request via our support channels.

👇 tl;dr follow the steps below for effective troubleshooting, thank you 🙏🏻

Collect environment information

• Affected Run URL

• The exact command used to run Playwright

• Screenshots if applicable

Collect and share the debug logs

• npx pwc --pwc-debug=remote ...

• or set debug: "remote" in Currents reporter configuration

1. Collecting Environment Information

Please collect the following information to help us effectively debug the problem:

• The associated dashboard Run URL

• Screenshots if applicable

• Your setup method and configuration files

• The exact command used to run playwright

• Environment information (use the command below)

Use the following command to print information about your CI environment

npx envinfo --system --binaries --browsers --npmPackages --duplicates --npmGlobalPackages

2. Activate Debug Mode

@currents/playwright simplifies collecting the debug information by automatically uploading the logs to Currents.

Capture and share the full debug log - that will help the support person identify the root cause faster

To enable uploading the debug logs:

• provide --pwc-debug flag to pwc CLI command, OR

• set CURRENTS_DEBUG environment variable, OR

• provide debug option to reporter configuration.

The following values will enable uploading the debug logs to our servers:

• remote will upload the debug logs to Currents servers.

• full will print the logs to stdout and also upload them to Currents.

For example:

pwc

# on Linux
npx pwc --pwc-debug=remote ... 

# on Windows
cmd /V /C npx pwc --pwc-debug=remote ...

Environment variable

# on 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 \ // a unique CI build ID
CURRENTS_DEBUG=remote \
npx playwright test

# on Windows
## - set the environment variables first
cmd /V /C ^
set CURRENTS_DEBUG=remote ^
set CURRENTS_PROJECT_ID=project_id&& ^
set CURRENTS_RECORD_KEY=record_key&& ^
set CURRENTS_CI_BUILD_ID=unique_build_id

## - the run the command
npx playwright test ...

Reporter configuration

import { currentsReporter } from "@currents/playwright";
import { PlaywrightTestConfig } from "@playwright/test";

// Reference: https://playwright.dev/docs/test-configuration
const config: PlaywrightTestConfig = {
  // ...
  reporter: [
    currentsReporter({
      ciBuildId: Date.now().toString(),
      projectId: "bnsqNa",
      recordKey: "***",
      tag: ["playwright", "test"],
      debug: "remote"
    }),
  ],
};
export default config;

When enabled, the debug logs will be uploaded to Currents servers and a confirmation message will be shown after the run's completion, for example:

Remote debug logs notification example