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

Add core-http-compat in Key Vault Admin #20900

Closed

Conversation

JonathanCrd
Copy link
Member

@JonathanCrd JonathanCrd commented Mar 17, 2022

Packages impacted by this PR

@azure/keyvault-admin

Issues associated with this PR

Describe the problem that is addressed by this PR

KeyVault Admin has already migrated to the new Core client and Core rest pipeline libraries, however, this introduced too many breaking changes. In order to minimize the braking changes, core-http-compat was created. This PR regenerates the client with the latest version of autorest, with the core-http-compat-mode flag set to true, and no longer depending on core-http.

Checklists

  • Added impacted package name to the issue description
  • Does this PR needs any fixes in the SDK Generator?** (If so, create an Issue in the Autorest/typescript repository and link it here)
  • Added a changelog (if necessary)

@JonathanCrd JonathanCrd self-assigned this Mar 17, 2022
@ghost ghost added the KeyVault label Mar 17, 2022
@JonathanCrd
Copy link
Member Author

I don't think I need to do a minor version bump for this, but please let me know if I should.

@JonathanCrd JonathanCrd marked this pull request as ready for review March 17, 2022 17:06
Copy link
Member

@maorleger maorleger left a comment

Choose a reason for hiding this comment

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

🚀 I think this is fine but I am really surprised there are no code changes associated with this - does core-http-compat patch things when included? Like how does CommonClientOptions gets replaced with ExtendedCommonClientOptions?

@JonathanCrd
Copy link
Member Author

🚀 I think this is fine but I am really surprised there are no code changes associated with this - does core-http-compat patch things when included? Like how does CommonClientOptions gets replaced with ExtendedCommonClientOptions?

@maorleger thanks for pointing this out, I updated the ClientOptions to extend from ExtendedCommonClientOptions.

@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

@JonathanCrd
Copy link
Member Author

/azp run js - keyvault - ci

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@maorleger
Copy link
Member

maorleger commented Mar 22, 2022

Just thinking about this, this is such a niche package (600 weekly downloads) with such a narrow API I wonder if it's even worth the added complexity of the core-http compat shim here...

Like there's only one previous version, it's hardly used, and when it is used it's mostly for admin tasks (backup/restore, access control) against a managed HSM. it doesn't even work on normal key vault.

I advocate skipping this for keyvault-admin

@maorleger maorleger closed this Mar 22, 2022
@maorleger
Copy link
Member

maorleger commented Mar 22, 2022

Huh, I pressed ctrl+enter I think and it closed the PR - sorry about that!

@maorleger maorleger reopened this Mar 22, 2022
@maorleger maorleger self-requested a review March 22, 2022 19:28
@JonathanCrd
Copy link
Member Author

Just thinking about this, this is such a niche package (600 weekly downloads) with such a narrow API I wonder if it's even worth the added complexity of the core-http compat shim here...

Like there's only one previous version, it's hardly used, and when it is used it's mostly for admin tasks (backup/restore, access control) against a managed HSM. it doesn't even work on normal key vault.

I advocate skipping this for keyvault-admin

If that it's the case, I can agree on skipping this package.
@sarangan12 what do you think about this?

@JonathanCrd
Copy link
Member Author

A new version of Key Vault Admin has been released without the core-http-compat changes, therefore I'm closing this PR.

This PR can be reopened in the future if customers want this compat feature.

@JonathanCrd JonathanCrd deleted the Migrate-KeyVault-Admin-CoreV2 branch June 17, 2022 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants