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

Jump to bottom

[Feature]: Conditionally save HAR recordings #33559

Open
mskelton opened this issue Nov 12, 2024 · 3 comments · May be fixed by #33628
Open

[Feature]: Conditionally save HAR recordings #33559

mskelton opened this issue Nov 12, 2024 · 3 comments · May be fixed by #33628
Assignees
@Skn0tt
Labels
v1.50

Comments

@mskelton
Copy link
Contributor

🚀 Feature Request

This has previously been discussed in #28825

Our company uses HAR recordings extensively for network replay in end-to-end tests so we have predictable network traffic when running our tests. When updating the HAR recordings with actual network traffic, we only want to update the saved HAR file on disk if the test passes. Currently, we have hacks to revert changes to the HARs if the test failed to prevent incomplete HARs from being committed.

Adding a function that accepts the test case and test result to allow conditionally saving the HAR based on test status, or other test information would be very helpful in enabling more network recording workflows like ours.

cc @olivierbeaulieu

Example

await context.routeFromHAR('index.har', {
  url: '**',
  update: true,
  updateContent: 'attach',
  shouldSave: (test: TestCase, result: TestResult) => result.status === 'passed',
})

Motivation

While a full network recording and playback solution is not currently in the scope of Playwright as has been discussed previously (#31809 (comment)), this feature would allow creating network recording/playback solutions much easier in user land.
@pavelfeldman
Copy link
Member

Adding a function that accepts the test case and test result to allow conditionally saving the HAR

When the test is running, would you like to use the network resources or read them off the old HAR?

@mskelton
Copy link
Contributor Author

@pavelfeldman The approach we use is setting an environment variable for RECORD=true or RECORD=false. If RECORD=true, we call routeFromHAR with update: true, and save the results to our repo. If RECORD=false, we call routeFromHAR with update: false, and use the saved HAR in our repo to replay all network activity in the tests. During record mode, we don't use the saved HARs at all, since we are using real network resources.

The goal here is that when we are running in RECORD=true mode, we can specify to only save the HAR file when the test passes.

@olivierbeaulieu Has documented this approach quite a bit in this issue: #18288 (comment). We have improved the matching logic much more since that original comment, but that at least provides a little bit of info into how some of the matching works.

@pavelfeldman
Copy link
Member

The goal here is that when we are running in RECORD=true mode, we can specify to only save the HAR file when the test passes.

Got it.

mskelton added a commit to mskelton/playwright that referenced this issue Nov 15, 2024
@mskelton
feat(routeFromHAR): add shouldSave option to control when to save H…
e0b9af1 
…AR files

Fixes microsoft#33559
@mskelton mskelton linked a pull request Nov 15, 2024 that will close this issue
Open
mskelton added a commit to mskelton/playwright that referenced this issue Nov 15, 2024
@mskelton
feat(routeFromHAR): add shouldSave option to control when to save H…
7e78f8e 
…AR files

Fixes microsoft#33559
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Skn0tt Skn0tt

Labels
v1.50
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(routeFromHAR): add shouldSave option to control when to save HAR files mskelton/playwright
3 participants
@pavelfeldman @Skn0tt @mskelton