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

To address the API review comments #27511

Conversation

saragluna
Copy link
Member

To address the API review comments, this PR will:

  • Add the missing Javadocs
  • Rename the *OptionsAware to *OptionsProvider
  • Rename Client, Retry and others to ClientOptions, RetryOptions and *Options.
  • Move the headers properties out from the ClientOptions and put it into the HttpClientOptions because

    AMQP SDKs dismiss this configuration and yes, it might be misleading in SDK, but it would really be nice not to expose headers configuration for AMQP at this point (until SDKs have some use for them).

  • Add private ctors to inner classes of AzureServiceType.

@ghost ghost added the azure-spring All azure-spring related issues label Mar 8, 2022
@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-cloud-azure-core. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-cloud-azure-service. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-cloud-azure-autoconfigure. You can review API changes here

private boolean enabled;
/**
* Comma-delimited list of compatible Spring Boot versions.
Copy link
Contributor

Choose a reason for hiding this comment

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

comment may not correctly describe the field.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you have suggestions for this?

@saragluna
Copy link
Member Author

/azp run java - spring - tests

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Bean
@ConditionalOnMissingBean
@ConditionalOnMissingProperty(prefix = "spring.jms.servicebus", name = "connection-string")
public static AzureServiceBusJmsPropertiesBeanPostProcessor azureServiceBusJmsPropertiesBeanPostProcessor(ObjectProvider<ConnectionStringProvider<AzureServiceType.ServiceBus>> connectionStringProviders) {
public static AzureServiceBusJmsPropertiesBeanPostProcessor azureServiceBusJmsPropertiesBeanPostProcessor(
ObjectProvider<ConnectionStringProvider<AzureServiceType.ServiceBus>> connectionStringProviders) {
Copy link
Contributor

Choose a reason for hiding this comment

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

why arg name use plural style?

Copy link
Member Author

Choose a reason for hiding this comment

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

this is not the change of this pr, but when you use ObjectProvider, it means there could be multiple such objects.

/**
* Get the login user of the AMQP broker.
* @return the login user of the AMQP broker.
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

why need comments in both field and getters at the same time?

Copy link
Member Author

Choose a reason for hiding this comment

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

The architects ask us to do so.

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-cloud-azure-core. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-cloud-azure-resourcemanager. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-messaging-azure. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-messaging-azure-eventhubs. You can review API changes here

@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure.spring:spring-cloud-azure-autoconfigure. You can review API changes here

@saragluna
Copy link
Member Author

/azp run java - spring - tests

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@check-enforcer
Copy link

check-enforcer bot commented Mar 8, 2022

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 java - [service] - ci

@stliu stliu merged commit 73b510a into Azure:feature/azure-spring-cloud-4.0 Mar 8, 2022
@saragluna saragluna added this to the Spring Cloud Azure 4.0 GA milestone Mar 8, 2022
@saragluna saragluna deleted the xiada/address-apiview-comments2 branch March 17, 2022 05:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
azure-spring All azure-spring related issues
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants