Skip to content

Commit

Permalink
Update language in test-proxy readme (#6057)
Browse files Browse the repository at this point in the history
* update readme to match reality, a follow-up issue is necessary to address rolling out the fixed behavior
  • Loading branch information
scbedd authored Apr 27, 2023
1 parent 39b1b2f commit 1cf47cd
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions tools/test-proxy/Azure.Sdk.Tools.TestProxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -583,11 +583,9 @@ The test-proxy offers further customization beyond that offered by sanitizers, m

### Redirection Settings

The test-proxy does NOT transparent follow redirects by default. That means that if the initial request sent by the test-proxy results in some `3XX` redirect status, it **will not** follow. It will return that redirect response to the client to allow THEM to handle the redirect.
The test-proxy follows redirects by default. That means that if the initial request sent by the test-proxy results in some `3XX` redirect status, it **will follow the redirect**.

In certain cases, this is not a possibility for the client. Javascript Browser tests are a great example of this. Since both "modes" are supported, the test-proxy exposes this as a setting `HandleRedirects`.

To set this setting, POST to the `/Admin/SetRecordingOptions` route.
In certain cases, a user will want to utilize both behaviors in their tests. For instance, the javascript `browser` tests run with redirect enabled, however for their `node` versions, the redirect functionality is explicitly disabled. The test-proxy exposes this as a setting `HandleRedirects` within the settings object POST-ed to `/Admin/SetRecordingOptions`.

Example:

Expand Down

0 comments on commit 1cf47cd

Please sign in to comment.