Implement Response abstraction for Azure #46530

live1206 · 2024-10-10T09:47:02Z

Resolves #45705

live1206 · 2024-10-10T09:48:39Z

For now, we can't consume NuGet package from MGC due to microsoft/typespec#4507.

eng/packages/http-client-csharp/generator/Azure.Generator.sln

eng/packages/http-client-csharp/generator/Azure.Generator/src/Azure.Generator.csproj

live1206 · 2024-10-10T09:54:32Z

Will create a new PR to upgrade MGC version to reduce the changes in this PR.

jsquire · 2024-10-10T15:59:56Z

It would be super helpful for these to see an example of what the generated code looks like.

...ient-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.cs

.../generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.RestClient.cs

...ages/http-client-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/BasicTypeSpec.csproj

annelo-msft · 2024-10-23T16:58:22Z

...ient-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.cs

@@ -50,11 +52,11 @@ public BasicTypeSpecClient(Uri endpoint, ApiKeyCredential keyCredential, BasicTy

            _endpoint = endpoint;
            _keyCredential = keyCredential;
-            Pipeline = ClientPipeline.Create(options, Array.Empty<PipelinePolicy>(), new PipelinePolicy[] { ApiKeyAuthenticationPolicy.CreateHeaderApiKeyPolicy(_keyCredential, AuthorizationHeader) }, Array.Empty<PipelinePolicy>());
+            Pipeline = HttpPipelineBuilder.Build(options, new HttpPipelinePolicy[] {  });


Should this have an authentication policy?

annelo-msft · 2024-10-23T17:01:30Z

.../generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.RestClient.cs

-            PipelineRequest request = message.Request;
-            request.Method = "GET";
+            Request request = message.Request;
+            request.Method = new RequestMethod("GET");


RequestMethod.Get will prevent making an allocation here.

annelo-msft · 2024-10-23T17:01:52Z

.../generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.RestClient.cs

-            request.Headers.Set("Accept", "application/json");
-            message.Apply(options);
+            request.Uri = uri;
+            request.Headers.Add("head-parameter", headParameter);


Why Add and not Set?

annelo-msft · 2024-10-23T17:02:26Z

.../generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.RestClient.cs

-            PipelineRequest request = message.Request;
-            request.Method = "GET";
+            Request request = message.Request;
+            request.Method = new RequestMethod("GET");
            ClientUriBuilder uri = new ClientUriBuilder();


Does Azure.Core have ClientUriBuilder? I believe Azure clients can set the URI in the request directly.

annelo-msft · 2024-10-23T17:04:12Z

...harp/generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClientOptions.cs


 namespace BasicTypeSpec
 {
    /// <summary> Client options for <see cref="BasicTypeSpecClient"/>. </summary>
-    public partial class BasicTypeSpecClientOptions : ClientPipelineOptions
+    public partial class BasicTypeSpecClientOptions : ClientOptions


These will be more different going forward ... just a heads up that more will need to differ here.

annelo-msft · 2024-10-23T17:04:55Z

...nerator/TestProjects/Local/Basic-TypeSpec/src/Generated/Internal/ClientPipelineExtensions.cs

        {
-            await pipeline.SendAsync(message).ConfigureAwait(false);
+            await pipeline.SendAsync(message, default).ConfigureAwait(false);


This should pass the CancellationToken through to pipeline.Send from RequestContext.

annelo-msft · 2024-10-23T17:05:39Z

...nerator/TestProjects/Local/Basic-TypeSpec/src/Generated/Internal/ClientPipelineExtensions.cs

            }

-            PipelineResponse response = message.BufferResponse ? message.Response : message.ExtractResponse();
+            Response response = message.BufferResponse ? message.Response : ExtractResponseContent(message);


We should sync on ExtractResponseContent ... this may not be the right pattern for Azure clients.

annelo-msft · 2024-10-23T17:07:06Z

...ent-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/Generated/Internal/ErrorResult.cs


 namespace BasicTypeSpec
 {
-    internal partial class ErrorResult<T> : ClientResult<T>


We should remove this from unbranded clients. SCM-based clients should never throw from a property.

live1206 · 2024-10-24T00:48:53Z

@annelo-msft Thanks a lot for reviewing the generated SDK for Azure Plugin!
The idea is not to have everything in place in this PR. The Azure plugin is still working in progress.
#46800 created to track comments in this PR and will have follow-up PRs to mitigate the remaining issues.

annelo-msft · 2024-10-24T15:23:31Z

Sounds great. Many thanks, @live1206!

live1206 added 8 commits September 25, 2024 10:55

wip

14b1a0b

Merge branch 'main' into response-abstraction

9eb7b36

wip

bffd020

Merge branch 'main' into response-abstraction

8696e52

minor

e169d91

implement abstraction for Azure

56e642f

Merge branch 'main' into response-abstraction

2b71d74

update MGC version

7645250

live1206 mentioned this pull request Oct 10, 2024

Response abstraction microsoft/typespec#4438

Merged

live1206 added the CodeGen Issues that relate to code generation label Oct 10, 2024

live1206 changed the title ~~Response abstraction~~ Implement Response abstraction for Azure Oct 10, 2024

live1206 commented Oct 10, 2024

View reviewed changes

eng/packages/http-client-csharp/generator/Azure.Generator.sln Outdated Show resolved Hide resolved

live1206 commented Oct 10, 2024

View reviewed changes

eng/packages/http-client-csharp/generator/Azure.Generator/src/Azure.Generator.csproj Outdated Show resolved Hide resolved

live1206 commented Oct 11, 2024

View reviewed changes

...ient-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.cs Show resolved Hide resolved

live1206 added 2 commits October 14, 2024 13:43

update

a0db58a

Merge branch 'main' into response-abstraction

e77c9fe

pshao25 reviewed Oct 15, 2024

View reviewed changes

.../generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.RestClient.cs Outdated Show resolved Hide resolved

pshao25 reviewed Oct 15, 2024

View reviewed changes

.../generator/TestProjects/Local/Basic-TypeSpec/src/Generated/BasicTypeSpecClient.RestClient.cs Show resolved Hide resolved

live1206 added 3 commits October 16, 2024 12:08

fix parameter name

d4cd170

Merge remote-tracking branch 'origin/main' into response-abstraction

e4a6a3b

update to use pacakge reference of MGC

d69064e

live1206 marked this pull request as ready for review October 18, 2024 04:03

live1206 requested review from JoshLove-msft, christothes, annelo-msft, KrzysztofCwalina and tg-msft as code owners October 18, 2024 04:03

live1206 requested review from jsquire, m-nash, ArthurMa1978, hallipr, weshaggard and benbp as code owners October 18, 2024 04:03

ArcturusZhang reviewed Oct 21, 2024

View reviewed changes

...ages/http-client-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/BasicTypeSpec.csproj Outdated Show resolved Hide resolved

pshao25 reviewed Oct 22, 2024

View reviewed changes

...ages/http-client-csharp/generator/TestProjects/Local/Basic-TypeSpec/src/BasicTypeSpec.csproj Show resolved Hide resolved

live1206 added 3 commits October 22, 2024 22:44

update version and fix format

58d5f6a

update MGC to package from main

1af2172

Merge branch 'main' into response-abstraction

e2f69e7

pshao25 approved these changes Oct 23, 2024

View reviewed changes

live1206 added 2 commits October 23, 2024 14:00

Add tests for SDK generation

db7e9fe

fix test

5019091

live1206 merged commit 47f3c9b into Azure:main Oct 23, 2024
40 checks passed

live1206 deleted the response-abstraction branch October 23, 2024 08:54

annelo-msft reviewed Oct 23, 2024

View reviewed changes

live1206 mentioned this pull request Oct 24, 2024

Refine Azure plugin to generate more accurate SDK for Azure #46800

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Response abstraction for Azure #46530

Implement Response abstraction for Azure #46530

live1206 commented Oct 10, 2024

live1206 commented Oct 10, 2024

live1206 commented Oct 10, 2024

jsquire commented Oct 10, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

annelo-msft Oct 23, 2024

live1206 commented Oct 24, 2024 •

edited

Loading

annelo-msft commented Oct 24, 2024

Implement Response abstraction for Azure #46530

Implement Response abstraction for Azure #46530

Conversation

live1206 commented Oct 10, 2024

live1206 commented Oct 10, 2024

live1206 commented Oct 10, 2024

jsquire commented Oct 10, 2024

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

live1206 commented Oct 24, 2024 • edited Loading

annelo-msft commented Oct 24, 2024

live1206 commented Oct 24, 2024 •

edited

Loading