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

[Recorder] Add advantages of migration #23426

Merged
merged 1 commit into from
Oct 7, 2022
Merged

[Recorder] Add advantages of migration #23426

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
9 changes: 8 additions & 1 deletion sdk/test-utils/recorder/MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,16 @@ This document outlines key differences between the legacy recorder and the new U

- [Docker] is required, as the [test proxy server] is run in a container during testing. When running the tests, ensure the Docker daemon is running and you have permission to use it. For WSL 2, running `sudo service docker start` and `sudo usermod -aG docker $USER` should be sufficient.

## Advantages of migration to v2
Copy link
Member Author

Choose a reason for hiding this comment

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

Please feel free to rephrase or add more here, @timovv.

- Recorder v2 handles secrets in the recordings better than v1 leveraging the new sanitizers/transformations approach.
- There are maintenance benefits to recorder v2, partly owing to the new test-proxy tool that is built to support recorders in various languages.
- Will allow us to run the tests in parallel in the future.
- All the recordings will be saved as JSON files instead of being JS files.
- Recordings will soon be migrated to an assets repository to lessen the load of the JS repo, which needs the packages to be migrated to recorder v2 first to grasp the benefits.

Copy link
Member

Choose a reason for hiding this comment

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

Maybe these are a bit subjective:

Suggested change
- The new recorder allows tests to imitate the live service more accurately during playback, since real HTTP requests are being made.
- The new recorder's API is more transparent and is easier to use compared to the old recorder.

## Upgrading to the Unified Recorder

The new recorder is version 2.0.0 of the `@azure-tools/test-recorder` package. Update the test-recorder dependency in your package.json file as follows:
The new recorder is version 2.x.y of the `@azure-tools/test-recorder` package. Update the test-recorder dependency in your package.json file as follows:

```json
{
Expand Down