Skip to content

Commit

Permalink
[http-client-csharp] Generate all req. response classifiers (microsof…
Browse files Browse the repository at this point in the history 
…t#5174)

This PR adds support for generating all the required response
classifiers for the generated client.

fixes: microsoft#4865
contributes to: microsoft#4903
  • Loading branch information
@jorgerangel-msft
jorgerangel-msft authored and Mingzhe Huang (from Dev Box) committed Dec 17, 2024
1 parent b4de5b8 commit 0d45c78
Show file tree
Hide file tree
Showing 10 changed files with 480 additions and 393 deletions.
2 changes: 2 additions & 0 deletions ...rosoft.Generator.CSharp.ClientModel/src/Providers/Abstractions/StatusCodeClassifierApi.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using Microsoft.Generator.CSharp.Expressions;
using Microsoft.Generator.CSharp.Primitives;
using Microsoft.Generator.CSharp.Snippets;
Expand All @@ -17,6 +18,7 @@ public StatusCodeClassifierApi(Type type, ValueExpression original) : base(type,
public abstract CSharpType ResponseClassifierType { get; }

public abstract ValueExpression Create(int code);
public abstract ValueExpression Create(IEnumerable<int> codes);
public abstract StatusCodeClassifierApi FromExpression(ValueExpression original);
public abstract StatusCodeClassifierApi ToExpression();
}
Expand Down
104 changes: 0 additions & 104 deletions ...tor/Microsoft.Generator.CSharp.ClientModel/src/Providers/Classifier2xxAnd4xxDefinition.cs
View file

This file was deleted.

7 changes: 6 additions & 1 deletion ...Microsoft.Generator.CSharp.ClientModel/src/Providers/PipelineMessageClassifierProvider.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
using static Microsoft.Generator.CSharp.Snippets.Snippet;
using System.ClientModel.Primitives;
using Microsoft.Generator.CSharp.Primitives;
using System.Collections.Generic;
using System.Linq;

namespace Microsoft.Generator.CSharp.ClientModel.Providers
{
Expand All @@ -20,7 +22,10 @@ public PipelineMessageClassifierProvider(ValueExpression original) : base(typeof
public override CSharpType ResponseClassifierType => typeof(PipelineMessageClassifier);

public override ValueExpression Create(int code)
=> Static<PipelineMessageClassifier>().Invoke(nameof(PipelineMessageClassifier.Create), [New.Array(typeof(ushort), true, true, [Literal(code)])]);
=> Create([code]);

public override ValueExpression Create(IEnumerable<int> codes)
=> Static<PipelineMessageClassifier>().Invoke(nameof(PipelineMessageClassifier.Create), [New.Array(typeof(ushort), true, true, [.. codes.Select(Literal)])]);

public override StatusCodeClassifierApi FromExpression(ValueExpression original)
=> new PipelineMessageClassifierProvider(original);
Expand Down
176 changes: 92 additions & 84 deletions ...harp/generator/Microsoft.Generator.CSharp.ClientModel/src/Providers/RestClientProvider.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Net.Http;
using Microsoft.Generator.CSharp.ClientModel.Primitives;
using Microsoft.Generator.CSharp.ClientModel.Snippets;
using Microsoft.Generator.CSharp.Expressions;
Expand All @@ -31,88 +30,41 @@ public class RestClientProvider : TypeProvider
private Dictionary<InputOperation, MethodProvider>? _methodCache;
private Dictionary<InputOperation, MethodProvider> MethodCache => _methodCache ??= [];

private readonly Dictionary<List<int>, PropertyProvider> _pipelineMessage20xClassifiers;
private readonly InputClient _inputClient;
internal ClientProvider ClientProvider { get; }

private FieldProvider _pipelineMessageClassifier200;
private FieldProvider _pipelineMessageClassifier201;
private FieldProvider _pipelineMessageClassifier202;
private FieldProvider _pipelineMessageClassifier204;
private FieldProvider _pipelineMessageClassifier2xxAnd4xx;
private TypeProvider _classifier2xxAnd4xxDefinition;

private PropertyProvider _classifier201Property;
private PropertyProvider _classifier200Property;
private PropertyProvider _classifier202Property;
private PropertyProvider _classifier204Property;
private PropertyProvider _classifier2xxAnd4xxProperty;

public RestClientProvider(InputClient inputClient, ClientProvider clientProvider)
{
_inputClient = inputClient;
ClientProvider = clientProvider;
_pipelineMessageClassifier200 = new FieldProvider(FieldModifiers.Private | FieldModifiers.Static, ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType, "_pipelineMessageClassifier200", this);
_pipelineMessageClassifier201 = new FieldProvider(FieldModifiers.Private | FieldModifiers.Static, ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType, "_pipelineMessageClassifier201", this);
_pipelineMessageClassifier202 = new FieldProvider(FieldModifiers.Private | FieldModifiers.Static, ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType, "_pipelineMessageClassifier202", this);
_pipelineMessageClassifier204 = new FieldProvider(FieldModifiers.Private | FieldModifiers.Static, ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType, "_pipelineMessageClassifier204", this);
_classifier2xxAnd4xxDefinition = new Classifier2xxAnd4xxDefinition(this);
_pipelineMessageClassifier2xxAnd4xx = new FieldProvider(FieldModifiers.Private | FieldModifiers.Static, _classifier2xxAnd4xxDefinition.Type, "_pipelineMessageClassifier2xxAnd4xx", this);
_classifier200Property = GetResponseClassifierProperty(_pipelineMessageClassifier200, 200);
_classifier201Property = GetResponseClassifierProperty(_pipelineMessageClassifier201, 201);
_classifier202Property = GetResponseClassifierProperty(_pipelineMessageClassifier202, 202);
_classifier204Property = GetResponseClassifierProperty(_pipelineMessageClassifier204, 204);
_classifier2xxAnd4xxProperty = new PropertyProvider(
$"Gets the PipelineMessageClassifier2xxAnd4xx",
MethodSignatureModifiers.Private | MethodSignatureModifiers.Static,
_classifier2xxAnd4xxDefinition.Type,
"PipelineMessageClassifier2xxAnd4xx",
new ExpressionPropertyBody(_pipelineMessageClassifier2xxAnd4xx.Assign(New.Instance(_classifier2xxAnd4xxDefinition.Type), true)),
this);
_pipelineMessage20xClassifiers = BuildPipelineMessage20xClassifiers();
}

internal ClientProvider ClientProvider { get; }

protected override string BuildRelativeFilePath() => Path.Combine("src", "Generated", $"{Name}.RestClient.cs");

protected override string BuildName() => _inputClient.Name.ToCleanName();

protected override PropertyProvider[] BuildProperties()
{
return
[
_classifier200Property,
_classifier201Property,
_classifier202Property,
_classifier204Property,
_classifier2xxAnd4xxProperty
];
}

private PropertyProvider GetResponseClassifierProperty(FieldProvider pipelineMessageClassifier, int code)
{
return new PropertyProvider(
null,
MethodSignatureModifiers.Private | MethodSignatureModifiers.Static,
ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType,
pipelineMessageClassifier.Name.Substring(1).ToCleanName(),
new ExpressionPropertyBody(
pipelineMessageClassifier.Assign(This.ToApi<StatusCodeClassifierApi>().Create(code))),
this);
return [.. _pipelineMessage20xClassifiers.Values.OrderBy(v => v.Name)];
}

protected override FieldProvider[] BuildFields()
{
return
[
_pipelineMessageClassifier200,
_pipelineMessageClassifier201,
_pipelineMessageClassifier202,
_pipelineMessageClassifier204,
_pipelineMessageClassifier2xxAnd4xx
];
}
List<FieldProvider> pipelineMessage20xClassifiersFields = new(_pipelineMessage20xClassifiers.Count);
var orderedClassifierProperties = _pipelineMessage20xClassifiers.Values.OrderBy(v => v.Name);

protected override TypeProvider[] BuildNestedTypes()
{
return [_classifier2xxAnd4xxDefinition];
foreach (var classifierProperty in orderedClassifierProperties)
{
if (classifierProperty.BackingField != null)
{
pipelineMessage20xClassifiersFields.Add(classifierProperty.BackingField);
}
}

return [.. pipelineMessage20xClassifiersFields];
}

protected override MethodProvider[] BuildMethods()
Expand All @@ -129,12 +81,6 @@ protected override MethodProvider[] BuildMethods()
return [.. methods];
}

private bool IsCreateRequest(MethodProvider method)
{
var span = method.Signature.Name.AsSpan();
return span.StartsWith("Create", StringComparison.Ordinal) && span.EndsWith("Request", StringComparison.Ordinal);
}

private MethodProvider BuildCreateRequestMethod(InputOperation operation)
{
var pipelineField = ClientProvider.PipelineProperty.ToApi<ClientPipelineApi>();
Expand Down Expand Up @@ -186,26 +132,50 @@ private IReadOnlyList<MethodBodyStatement> GetSetContent(HttpRequestApi request,
return contentParam is null ? [] : [request.Content().Assign(contentParam).Terminate()];
}

private PropertyProvider GetClassifier(InputOperation operation)
private Dictionary<List<int>, PropertyProvider> BuildPipelineMessage20xClassifiers()
{
if (operation.HttpMethod == HttpMethod.Head.ToString())
return _classifier2xxAnd4xxProperty;
// Contains a mapping of classifier status codes to their corresponding pipeline message classifier property
Dictionary<List<int>, PropertyProvider> classifiers = new(new StatusCodesComparer());

var response = operation.Responses.First(r => !r.IsErrorResponse); //should only be one of these

if (response.StatusCodes.Count == 1)
foreach (var inputOperation in _inputClient.Operations)
{
return response.StatusCodes[0] switch
var statusCodes = GetSuccessStatusCodes(inputOperation);
if (statusCodes.Count > 0 && !classifiers.ContainsKey(statusCodes))
{
200 => _classifier200Property,
201 => _classifier201Property,
202 => _classifier202Property,
204 => _classifier204Property,
_ => throw new InvalidOperationException($"Unexpected status code {response.StatusCodes[0]}")
};
var classifierNameSuffix = string.Join(string.Empty, statusCodes);
var classifierBackingField = new FieldProvider(
FieldModifiers.Private | FieldModifiers.Static,
ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType,
$"_pipelineMessageClassifier{classifierNameSuffix}",
this);

var classifierProperty = new PropertyProvider(
null,
MethodSignatureModifiers.Private | MethodSignatureModifiers.Static,
ClientModelPlugin.Instance.TypeFactory.StatusCodeClassifierApi.ResponseClassifierType,
classifierBackingField.Name.Substring(1).ToCleanName(),
new ExpressionPropertyBody(
classifierBackingField.Assign(This.ToApi<StatusCodeClassifierApi>().Create(GetSuccessStatusCodes(inputOperation)))),
this)
{
BackingField = classifierBackingField
};

classifiers[statusCodes] = classifierProperty;
}
}

throw new InvalidOperationException("Multiple status codes not supported");
return classifiers;
}

private PropertyProvider GetClassifier(InputOperation operation)
{
if (_pipelineMessage20xClassifiers.TryGetValue(GetSuccessStatusCodes(operation), out var classifier))
{
return classifier;
}

throw new InvalidOperationException($"Unexpected status codes for operation {operation.Name}");
}

private IEnumerable<MethodBodyStatement> AppendHeaderParameters(HttpRequestApi request, InputOperation operation, Dictionary<string, ParameterProvider> paramMap)
Expand Down Expand Up @@ -509,6 +479,26 @@ private static bool TryGetSpecialHeaderParam(InputParameter inputParameter, [Not
return false;
}

private static List<int> GetSuccessStatusCodes(InputOperation operation)
{
HashSet<int> statusCodes = [];
foreach (var response in operation.Responses)
{
if (response.IsErrorResponse)
continue;

foreach (var statusCode in response.StatusCodes)
{
if (statusCode >= 200 && statusCode < 300)
{
statusCodes.Add(statusCode);
}
}
}

return [.. statusCodes.OrderBy(i => i)];
}

internal MethodProvider GetCreateRequestMethod(InputOperation operation)
{
_ = Methods; // Ensure methods are built
Expand Down Expand Up @@ -637,5 +627,23 @@ internal enum MethodType
Protocol,
Convenience
}

private class StatusCodesComparer : IEqualityComparer<List<int>>
{
bool IEqualityComparer<List<int>>.Equals(List<int>? x, List<int>? y)
{
return x != null && y != null && x.SequenceEqual(y);
}

int IEqualityComparer<List<int>>.GetHashCode(List<int> obj)
{
HashCode hash = new();
foreach (var item in obj)
{
hash.Add(item);
}
return hash.ToHashCode();
}
}
}
}
Loading

0 comments on commit 0d45c78

Please sign in to comment.