Add Azure DevCenter SDK #31300

chrissmiller · 2022-10-07T02:09:25Z

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.
Adds the initial public preview SDK for the Azure DevCenter service.

Azure/azure-sdk#4702

All SDK Contribution checklist:

The pull request does not introduce [breaking changes] (N/A, new service)
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

azure-sdk · 2022-10-11T16:41:14Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-developer-devcenter

…smiller/azure-sdk-for-java into chrismiller/devcenter-java

sdk/devcenter/azure-developer-devcenter/README.md

sdk/devcenter/azure-developer-devcenter/src/samples/README.md

...devcenter/src/samples/java/com/azure/developer/devcenter/generated/DevBoxesCreateDevBox.java

...er/azure-developer-devcenter/src/main/java/com/azure/developer/devcenter/DevBoxesClient.java

sdk/devcenter/azure-developer-devcenter/swagger/README.md

sdk/devcenter/azure-developer-devcenter/src/samples/README.md

sdk/devcenter/azure-developer-devcenter/README.md

...er/azure-developer-devcenter/src/main/java/com/azure/developer/devcenter/DevBoxesClient.java

weidongxu-microsoft · 2022-10-13T03:37:33Z

I am basically good with the PR.

Wait one or two days on @haolingdong-msft 's input, and Alan's input on DELETE LRO.

sdk/devcenter/azure-developer-devcenter/CHANGELOG.md

sdk/devcenter/azure-developer-devcenter/README.md

sdk/devcenter/azure-developer-devcenter/pom.xml

sdk/devcenter/azure-developer-devcenter/swagger/README.md

alzimmermsft · 2022-10-13T12:07:40Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+    @Generated private static final String[] DEFAULT_SCOPES = new String[] {"https://devcenter.azure.com/.default"};
+
+    @Generated
+    private final Map<String, String> properties = CoreUtils.getProperties("azure-developer-devcenter.properties");


For @weidongxu-microsoft, we should make this static as the resource shouldn't change during runtime and doesn't need to be parsed every time constructing a builder.

Azure/autorest.java#1764

alzimmermsft · 2022-10-13T12:09:39Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+    @Generated
+    @Override
+    public EnvironmentsClientBuilder pipeline(HttpPipeline pipeline) {
+        this.pipeline = pipeline;


For @weidongxu-microsoft, for pipeline and httpClient we should update this to copy what the hand-written builders do with logging a debug message if the HttpPipeline, or HttpClient, is set to null after being configured as there is a chance that it is a bug in user code:

if (this.pipeline != null && pipeline == null) { logger.info("HttpPipeline is being set to 'null' when it was previously configured."); }

Azure/autorest.java#1765

alzimmermsft · 2022-10-13T12:10:36Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+    @Generated
+    @Override
+    public EnvironmentsClientBuilder addPolicy(HttpPipelinePolicy customPolicy) {
+        pipelinePolicies.add(customPolicy);


For @weidongxu-microsoft, customPolicy needs to be checked for being non-null

Azure/autorest.java#1766

alzimmermsft · 2022-10-13T12:11:24Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+        if (httpLogOptions == null) {
+            httpLogOptions = new HttpLogOptions();
+        }
+        if (clientOptions == null) {
+            clientOptions = new ClientOptions();
+        }


For @weidongxu-microsoft, these should be updated to use local variables instead of mutating the builder

Azure/autorest.java#1768

Yeah, these are ancient code that I've not really pay attention when reviewing. Thx for pointing out.

alzimmermsft · 2022-10-13T12:15:24Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+        policies.addAll(
+                this.pipelinePolicies.stream()
+                        .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL)
+                        .collect(Collectors.toList()));


For @weidongxu-microsoft, minor nit as I've seen this elsewhere in generated code, we can flip this to something more performant. Right now, this will create a List to be used by addAll which many times converts the list back to an array. In the builder this won't be too bad as there is lower usage and it's not a hot path but in other places it could be:

this.pipelinePolicies().stream() .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL) .forEach(p -> policies.add(p));

Azure/autorest.java#1767

Co-authored-by: Alan Zimmer <[email protected]>

weidongxu-microsoft · 2022-10-14T01:53:57Z

Great thanks for Alan's detailed review. I've logged the codegen issues. I will let Shanghai team to pick them up as these are relatively simple to fix. We should be able to complete them before Nov. and DevCenter's GA version should be without these issues.

Chris, please check Alan's feedback on doc, and see if it can be improved.
Also please solve the conflict.

sdk/devcenter/azure-developer-devcenter/pom.xml

sdk/devcenter/azure-developer-devcenter/swagger/README.md

...rc/test/java/com/azure/developer/devcenter/generated/EnvironmentsUpdateEnvironmentTests.java

weidongxu-microsoft · 2022-10-14T01:44:39Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+    @Generated private static final String[] DEFAULT_SCOPES = new String[] {"https://devcenter.azure.com/.default"};
+
+    @Generated
+    private final Map<String, String> properties = CoreUtils.getProperties("azure-developer-devcenter.properties");


Azure/autorest.java#1764

weidongxu-microsoft · 2022-10-14T01:45:49Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+    @Generated
+    @Override
+    public EnvironmentsClientBuilder pipeline(HttpPipeline pipeline) {
+        this.pipeline = pipeline;


Azure/autorest.java#1765

weidongxu-microsoft · 2022-10-14T01:47:11Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+    @Generated
+    @Override
+    public EnvironmentsClientBuilder addPolicy(HttpPipelinePolicy customPolicy) {
+        pipelinePolicies.add(customPolicy);


Azure/autorest.java#1766

weidongxu-microsoft · 2022-10-14T01:48:10Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+        policies.addAll(
+                this.pipelinePolicies.stream()
+                        .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL)
+                        .collect(Collectors.toList()));


Azure/autorest.java#1767

weidongxu-microsoft · 2022-10-14T01:50:44Z

...veloper-devcenter/src/main/java/com/azure/developer/devcenter/EnvironmentsClientBuilder.java

+        if (httpLogOptions == null) {
+            httpLogOptions = new HttpLogOptions();
+        }
+        if (clientOptions == null) {
+            clientOptions = new ClientOptions();
+        }


Azure/autorest.java#1768

Yeah, these are ancient code that I've not really pay attention when reviewing. Thx for pointing out.

...er/azure-developer-devcenter/src/main/java/com/azure/developer/devcenter/DevBoxesClient.java

weidongxu-microsoft · 2022-10-17T02:41:48Z

/azp run java - devcenter - ci

azure-pipelines · 2022-10-17T02:42:07Z

Azure Pipelines successfully started running 1 pipeline(s).

sdk/devcenter/azure-developer-devcenter/swagger/README.md

chrissmiller added 4 commits October 6, 2022 21:01

Adding generated code

7e55b29

Adding samples

2b062a9

Add tests

48b8fd8

Update pom, ci, and cleanup style warnings

ca88ee0

chrissmiller requested review from hallipr, JimSuplizio, joshfree, srnagar, anuchandy, conniey, lmolkova and JonathanGiles as code owners October 7, 2022 02:09

chrissmiller added 2 commits October 7, 2022 00:36

Adding recordings for live tests

186e93d

Update version_client.txt

0408f8c

chrissmiller requested review from alzimmermsft, samvaity and g2vinay as code owners October 11, 2022 15:47

Merge branch 'main' into chrismiller/devcenter-java

890c422

chrissmiller added 2 commits October 11, 2022 13:03

Update versions

1616d27

Merge branch 'chrismiller/devcenter-java' of https://github.com/chris…

b9a1857

…smiller/azure-sdk-for-java into chrismiller/devcenter-java

weidongxu-microsoft requested review from haolingdong-msft and weidongxu-microsoft October 12, 2022 01:03

weidongxu-microsoft reviewed Oct 12, 2022

View reviewed changes

haolingdong-msft reviewed Oct 12, 2022

View reviewed changes

sdk/devcenter/azure-developer-devcenter/swagger/README.md Outdated Show resolved Hide resolved

chrissmiller added 2 commits October 12, 2022 13:03

Update READMEs and samples

333b6ec

Add readme structure

13430a6

weidongxu-microsoft reviewed Oct 13, 2022

View reviewed changes

Fix tenant env variable

776ef67

alzimmermsft reviewed Oct 13, 2022

View reviewed changes

Update sdk/devcenter/azure-developer-devcenter/pom.xml

755c69f

Co-authored-by: Alan Zimmer <[email protected]>

weidongxu-microsoft approved these changes Oct 14, 2022

View reviewed changes

sebrenna and others added 2 commits October 14, 2022 09:16

addressing pull request comments

bdfab6e

Resolve merge conflicts

a1fe4a7

weidongxu-microsoft reviewed Oct 17, 2022

View reviewed changes

sdk/devcenter/azure-developer-devcenter/swagger/README.md Show resolved Hide resolved

weidongxu-microsoft merged commit 759494f into Azure:main Oct 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Azure DevCenter SDK #31300

Add Azure DevCenter SDK #31300

chrissmiller commented Oct 7, 2022

azure-sdk commented Oct 11, 2022

weidongxu-microsoft commented Oct 13, 2022 •

edited

Loading

alzimmermsft Oct 13, 2022

weidongxu-microsoft Oct 14, 2022

alzimmermsft Oct 13, 2022

weidongxu-microsoft Oct 14, 2022

alzimmermsft Oct 13, 2022

weidongxu-microsoft Oct 14, 2022

alzimmermsft Oct 13, 2022

weidongxu-microsoft Oct 14, 2022

alzimmermsft Oct 13, 2022

weidongxu-microsoft Oct 14, 2022

weidongxu-microsoft commented Oct 14, 2022 •

edited

Loading

weidongxu-microsoft Oct 14, 2022

weidongxu-microsoft Oct 14, 2022

weidongxu-microsoft Oct 14, 2022

weidongxu-microsoft Oct 14, 2022

weidongxu-microsoft Oct 14, 2022

weidongxu-microsoft commented Oct 17, 2022

azure-pipelines bot commented Oct 17, 2022

Add Azure DevCenter SDK #31300

Add Azure DevCenter SDK #31300

Conversation

chrissmiller commented Oct 7, 2022

Description

All SDK Contribution checklist:

azure-sdk commented Oct 11, 2022

weidongxu-microsoft commented Oct 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weidongxu-microsoft commented Oct 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weidongxu-microsoft commented Oct 17, 2022

azure-pipelines bot commented Oct 17, 2022

weidongxu-microsoft commented Oct 13, 2022 •

edited

Loading

weidongxu-microsoft commented Oct 14, 2022 •

edited

Loading