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.

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

[Unified Recorder] recorder.configureClient() design similar to the perf framework #19362

Merged
merged 12 commits into from
Dec 15, 2021

Conversation

HarshaNalluru
Copy link
Member

@HarshaNalluru HarshaNalluru commented Dec 14, 2021

Adds configureClient method to the TestProxytHttpClient to allow instrumenting the client with the recorder policy which helps in enabling the recorder to redirect the requests of your tests to the proxy tool.

Fixes #19364

@check-enforcer
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

@HarshaNalluru HarshaNalluru marked this pull request as ready for review December 15, 2021 00:13
@HarshaNalluru HarshaNalluru changed the title Harshan/recorder instrument [Unified Recorder] recorder.configureClient() design similar to the perf framework Dec 15, 2021
Copy link
Member

@witemple-msft witemple-msft left a comment

Choose a reason for hiding this comment

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

I like this a lot. Feels a bit nicer to say "the recorder acts on the client" and not have to have each test insert an object into the pipeline in its own code. Now if you ever need to change the way that this initialization is done, you can do it in one place instead of 150+.

sdk/test-utils/recorder-new/src/core-v2-recorder.ts Outdated Show resolved Hide resolved
sdk/test-utils/recorder-new/src/core-v2-recorder.ts Outdated Show resolved Hide resolved
Copy link
Member

@timovv timovv left a comment

Choose a reason for hiding this comment

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

Looks good :)

Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>
Copy link
Member

@jeremymeng jeremymeng left a comment

Choose a reason for hiding this comment

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

Looks good to me

@HarshaNalluru HarshaNalluru merged commit 6befed7 into Azure:main Dec 15, 2021
@HarshaNalluru HarshaNalluru deleted the harshan/recorder-instrument branch December 15, 2021 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Unified Recorder] Come up with a recorder.configureClient() design similar to the perf framework
6 participants