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

[core] Added logger parameters to bearerTokenAuthenticationPolicy #18467

Merged
merged 7 commits into from
Nov 25, 2021

Conversation

sadasant
Copy link
Contributor

@sadasant sadasant commented Nov 1, 2021

This PR allows customizing the internal logger of the authorizeRequestOnClaimChallenge challenge provided by the @azure/core-client. Client developers would need to send the logger through at the moment they initialize the bearerTokenAuthenticationPolicy. Currently, there are no other uses for this logger in the bearerTokenAuthenticationPolicy, but this opens us to the possibility of adding more logging in the future.

This is based on feedback from @xirzec here: #17315 (comment)

@check-enforcer
Copy link

check-enforcer bot commented Nov 1, 2021

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

@azure-sdk
Copy link
Collaborator

API changes have been detected in @azure/core-rest-pipeline. You can review API changes here

API changes

+     logger?: AzureLogger;
+     logger?: AzureLogger;
+     logger?: AzureLogger;

@xirzec
Copy link
Member

xirzec commented Nov 1, 2021

The implementation looks good. Maybe we could have an example of how this would be used? Like, take the logger from a SDK package you're using CAE with and passing that logger as the logger for this thing?

@bterlson @jeremymeng what do you think?

@sadasant
Copy link
Contributor Author

sadasant commented Nov 1, 2021

@xirzec at the moment, nothing is using CAE, however: I can do as you say as part of this other PR: #18445 — where I have some recorded CAE tests on the Identity side (using all the necessary tools for a client to do CAE)

sadasant and others added 6 commits November 9, 2021 03:36
…am (Azure#18492)

* Add responseAsStream to PipelineRequest

* Use Number.POSITIVE_INFINITY to indicate that any status code should get raw response

* Remove unneeded property in client request and address comments

* Update changelog
allParams.map((x) => x.join(" ")).join("\n"),
`The WWW-Authenticate header was missing the necessary "claims" to perform the Continuous Access Evaluation authentication flow.`
);
});
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@xirzec I have added unit tests 🎉

Copy link
Member

@xirzec xirzec 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 change! Since I suggested it though, can @bterlson or @jeremymeng give their thoughts on the addition?

@azure-sdk
Copy link
Collaborator

API changes have been detected in @azure/core-rest-pipeline. You can review API changes here

API changes

+     logger?: AzureLogger;
+     logger?: AzureLogger;
+     logger?: AzureLogger;

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.

LGTM!

@sadasant sadasant merged commit abaff23 into Azure:main Nov 25, 2021
@sadasant sadasant deleted the core-client/cae-logger branch November 25, 2021 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants