Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci(e2e): fix e2e all-test action error #2738

Merged
merged 1 commit into from
Jan 6, 2025
Merged

ci(e2e): fix e2e all-test action error #2738

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion internals/playwright-config/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const Config = ({ testDir, baseURL, storageState, devServerCommon }) =>
: {
command: devServerCommon,
url: baseURL,
reuseExistingServer: !process.env.CI,
reuseExistingServer: !!process.env.CI,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change from !process.env.CI to !!process.env.CI alters the logic to reuse the existing server only when the CI environment variable is truthy. This is a critical fix for ensuring correct behavior in CI environments.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

The review comment's suggestion is valid and should be implemented

Looking at the codebase, the CI environment variable is used in multiple places within the Playwright configuration, and there's even a comment indicating the expected value: // process.env.CI = 'true'. The current usage of !!process.env.CI could lead to unexpected behavior as it would treat any non-empty string as true. Since other parts of the configuration also rely on this environment variable for critical test behaviors (retries, workers, headless mode), it's important to be explicit about the expected value.

Key impacts found in the codebase:

  • Used for controlling test retries: retries: process.env.CI ? 2 : 0
  • Controls parallel test execution: workers: process.env.CI ? 1 : 2
  • Determines headless mode: headless: !!process.env.CI
  • Affects web server configuration: reuseExistingServer: !!process.env.CI

The suggested change to process.env.CI === 'true' would make the behavior more predictable and consistent with the documented expectation in the code comment.

🔗 Analysis chain

Ensure correct boolean interpretation of the CI environment variable.

Currently, !!process.env.CI will evaluate to true if CI is set to any non-empty string (e.g., 'true', 'false', '0', etc.). If you only want reuseExistingServer to be true when CI === 'true', consider parsing the string more explicitly:

- reuseExistingServer: !!process.env.CI,
+ reuseExistingServer: process.env.CI === 'true',

Let me verify how the CI environment variable is being used in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found

Script:

#!/bin/bash
# Search for usage of process.env.CI in the codebase
rg "process\.env\.CI" -A 2 -B 2

Length of output: 2212

Script:

#!/bin/bash
# Search for any configuration or documentation related to CI environment variable
fd "CI" --type f --exec grep -l "CI" {} \;

Length of output: 43

Script:

#!/bin/bash
# Look for any tests or configuration files that might set or use CI environment variable
rg "CI.*=.*['\"](true|false)" -A 2 -B 2

Length of output: 423

stdout: 'pipe'
},
projects: [
Expand Down
Loading