Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT License.

using System;
using Microsoft.TypeSpec.Generator.ClientModel.Snippets;
using Microsoft.TypeSpec.Generator.Expressions;
using Microsoft.TypeSpec.Generator.Primitives;
using Microsoft.TypeSpec.Generator.Snippets;
Expand Down Expand Up @@ -37,6 +38,21 @@ public abstract MethodBodyStatement[] CreateMessage(
public abstract ValueExpression KeyAuthorizationPolicy(ValueExpression credential, ValueExpression headerName, ValueExpression? keyPrefix = null);
public abstract ValueExpression TokenAuthorizationPolicy(ValueExpression credential, ValueExpression scopes);
public virtual ValueExpression? UserAgentPolicy(CSharpType clientType) => null;

/// <summary>
/// Gets whether the client options of this pipeline carry model proxies. When <c>true</c>, generated clients store
/// the options returned by <see cref="GetModelReaderWriterOptions(ValueExpression)"/> and pass them to every model
/// they read and write in their operations. Pipelines whose client options don't carry model proxies keep the
/// default (<c>false</c>), and their clients use the shared wire options.
/// </summary>
public virtual bool SupportsModelProxies => false;

/// <summary>
/// Gets the <c>ModelReaderWriterOptions</c> a generated client uses to read and write models in its operations,
/// built from its client options. Only called when <see cref="SupportsModelProxies"/> is <c>true</c>.
/// </summary>
/// <param name="clientOptions">The client options expression.</param>
public virtual ValueExpression GetModelReaderWriterOptions(ValueExpression clientOptions) => ModelSerializationExtensionsSnippets.Wire;
public abstract ClientPipelineApi FromExpression(ValueExpression expression);
public abstract ClientPipelineApi ToExpression();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System;
using System.ClientModel;
using System.ClientModel.Primitives;
using System.Collections.Generic;
using System.IO;
using System.Xml;
Expand Down Expand Up @@ -35,6 +36,25 @@ public class BinaryContentHelperDefinition : InternalHelperProvider
protected override IReadOnlyList<CSharpType> BuildBodyDependencyTypes() =>
[ScmCodeModelGenerator.Instance.ModelSerializationExtensionsDefinition.Type];

// Clients whose options carry model proxies pass their options so the proxies apply to the items written here.
// The parameter is optional so existing callers, such as custom code, keep writing with the wire options.
private static ParameterProvider? CreateOptionsParameter()
=> ScmCodeModelGenerator.Instance.TypeFactory.ClientPipelineApi.ToExpression().SupportsModelProxies
? new ParameterProvider("options", FormattableStringHelpers.Empty, typeof(ModelReaderWriterOptions), defaultValue: Null)
: null;

private static ScopedApi<ModelReaderWriterOptions> GetOptions(ParameterProvider? optionsParameter)
=> optionsParameter?.As<ModelReaderWriterOptions>() ?? ModelSerializationExtensionsSnippets.Wire;

// options ??= ModelSerializationExtensions.WireOptions;
private static MethodBodyStatement DefaultOptions(ParameterProvider? optionsParameter)
=> optionsParameter is null
? MethodBodyStatement.Empty
: optionsParameter.Assign(ModelSerializationExtensionsSnippets.Wire, nullCoalesce: true).Terminate();

private static ParameterProvider[] WithOptions(ParameterProvider? optionsParameter, params ParameterProvider[] parameters)
=> optionsParameter is null ? parameters : [.. parameters, optionsParameter];

protected override MethodProvider[] BuildMethods()
{
var methods = new List<MethodProvider>
Expand All @@ -61,10 +81,11 @@ private MethodProvider BuildFromEnumerableTMethod()
var enumerableTType = typeof(IEnumerable<>);
CSharpType tType = enumerableTType.GetGenericArguments()[0];
var enumerableParameter = new ParameterProvider("enumerable", FormattableStringHelpers.Empty, enumerableTType);
var optionsParameter = CreateOptionsParameter();
var signature = new MethodSignature(
Name: _fromEnumerableName,
Modifiers: _methodModifiers,
Parameters: [enumerableParameter],
Parameters: WithOptions(optionsParameter, enumerableParameter),
ReturnType: _requestBodyType,
GenericArguments: [tType],
GenericParameterConstraints: [Where.NotNull(tType)],
Expand All @@ -73,6 +94,7 @@ private MethodProvider BuildFromEnumerableTMethod()

var body = new List<MethodBodyStatement>
{
DefaultOptions(optionsParameter),
Declare("content", New.Instance<Utf8JsonBinaryContentDefinition>(), out var content)
};
var writer = content.JsonWriter();
Expand All @@ -81,7 +103,7 @@ private MethodProvider BuildFromEnumerableTMethod()
writer.WriteStartArray(),
new ForEachStatement("item", enumerableParameter.As(enumerableParameter.Type), out var item)
{
writer.WriteObjectValue(item.As(tType), ModelSerializationExtensionsSnippets.Wire)
writer.WriteObjectValue(item.As(tType), GetOptions(optionsParameter))
},
writer.WriteEndArray(),
MethodBodyStatement.EmptyLine,
Expand Down Expand Up @@ -130,10 +152,11 @@ private MethodProvider BuildFromReadOnlySpanMethod()
var spanType = typeof(ReadOnlySpan<>);
CSharpType tType = spanType.GetGenericArguments()[0];
var spanParameter = new ParameterProvider("span", FormattableStringHelpers.Empty, spanType);
var optionsParameter = CreateOptionsParameter();
var signature = new MethodSignature(
Name: _fromEnumerableName,
Modifiers: _methodModifiers,
Parameters: [spanParameter],
Parameters: WithOptions(optionsParameter, spanParameter),
ReturnType: _requestBodyType,
GenericArguments: [tType],
GenericParameterConstraints: [Where.NotNull(tType)],
Expand All @@ -142,6 +165,7 @@ private MethodProvider BuildFromReadOnlySpanMethod()

var body = new List<MethodBodyStatement>
{
DefaultOptions(optionsParameter),
Declare("content", New.Instance<Utf8JsonBinaryContentDefinition>(), out var content)
};
var writer = content.JsonWriter();
Expand All @@ -151,7 +175,7 @@ private MethodProvider BuildFromReadOnlySpanMethod()
Declare("i", Int(0), out var i),
new ForStatement(null, i.LessThan(spanParameter.Property(nameof(ReadOnlySpan<byte>.Length))), i.Increment())
{
writer.WriteObjectValue(new IndexerExpression(spanParameter, i).As(tType), ModelSerializationExtensionsSnippets.Wire)
writer.WriteObjectValue(new IndexerExpression(spanParameter, i).As(tType), GetOptions(optionsParameter))
},
writer.WriteEndArray(),
MethodBodyStatement.EmptyLine,
Expand All @@ -166,10 +190,11 @@ private MethodProvider BuildFromDictionaryTMethod()
var dictionaryTType = typeof(IDictionary<,>);
CSharpType valueType = dictionaryTType.GetGenericArguments()[1];
var dictionaryParameter = new ParameterProvider("dictionary", FormattableStringHelpers.Empty, new CSharpType(dictionaryTType, typeof(string), valueType));
var optionsParameter = CreateOptionsParameter();
var signature = new MethodSignature(
Name: _fromDictionaryName,
Modifiers: _methodModifiers,
Parameters: [dictionaryParameter],
Parameters: WithOptions(optionsParameter, dictionaryParameter),
ReturnType: _requestBodyType,
GenericArguments: [valueType],
GenericParameterConstraints: [Where.NotNull(valueType)],
Expand All @@ -178,6 +203,7 @@ private MethodProvider BuildFromDictionaryTMethod()

var body = new List<MethodBodyStatement>
{
DefaultOptions(optionsParameter),
Declare("content", New.Instance<Utf8JsonBinaryContentDefinition>(), out var content)
};
var writer = content.JsonWriter();
Expand All @@ -187,7 +213,7 @@ private MethodProvider BuildFromDictionaryTMethod()
new ForEachStatement("item", dictionaryParameter.As(dictionaryParameter.Type), out var item)
{
writer.WritePropertyName(item.Property("Key")),
writer.WriteObjectValue(item.Property("Value").As(valueType), ModelSerializationExtensionsSnippets.Wire)
writer.WriteObjectValue(item.Property("Value").As(valueType), GetOptions(optionsParameter))
},
writer.WriteEndObject(),
MethodBodyStatement.EmptyLine,
Expand Down Expand Up @@ -285,10 +311,11 @@ private MethodProvider BuildFromEnumerableXmlMethod()
var enumerableParameter = new ParameterProvider("enumerable", FormattableStringHelpers.Empty, enumerableTType);
var rootNameHintParameter = new ParameterProvider("rootNameHint", FormattableStringHelpers.Empty, typeof(string));
var childNameHintParameter = new ParameterProvider("childNameHint", FormattableStringHelpers.Empty, typeof(string));
var optionsParameter = CreateOptionsParameter();
var signature = new MethodSignature(
Name: _fromEnumerableName,
Modifiers: _methodModifiers,
Parameters: [enumerableParameter, rootNameHintParameter, childNameHintParameter],
Parameters: WithOptions(optionsParameter, enumerableParameter, rootNameHintParameter, childNameHintParameter),
ReturnType: _requestBodyType,
GenericArguments: [tType],
GenericParameterConstraints: [Where.NotNull(tType)],
Expand All @@ -304,7 +331,7 @@ private MethodProvider BuildFromEnumerableXmlMethod()
xmlWriter.WriteStartElement(rootNameHintParameter),
new ForEachStatement("item", enumerableParameter.As(enumerableParameter.Type), out var item)
{
xmlWriter.WriteObjectValue(item.As(tType), ModelSerializationExtensionsSnippets.Wire, childNameHintParameter)
xmlWriter.WriteObjectValue(item.As(tType), GetOptions(optionsParameter), childNameHintParameter)
},
xmlWriter.WriteEndElement(),
]);
Expand All @@ -319,7 +346,7 @@ private MethodProvider BuildFromEnumerableXmlMethod()
[Int(0), streamVar.Property(nameof(MemoryStream.Position)).CastTo(typeof(int))])))))
]);

var body = new MethodBodyStatement[] { outerUsing };
var body = new MethodBodyStatement[] { DefaultOptions(optionsParameter), outerUsing };

return new MethodProvider(signature, body, this);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System.ClientModel;
using System.ClientModel.Primitives;
using Microsoft.TypeSpec.Generator.ClientModel.Snippets;
using Microsoft.TypeSpec.Generator.Expressions;
using Microsoft.TypeSpec.Generator.Primitives;
using Microsoft.TypeSpec.Generator.Snippets;
Expand Down Expand Up @@ -33,6 +34,12 @@ public ClientPipelineProvider(ValueExpression original) : base(typeof(ClientPipe
public override ValueExpression Create(ValueExpression options, ValueExpression perRetryPolicies)
=> Static<ClientPipeline>().Invoke(nameof(ClientPipeline.Create), [options, New.Array(ScmCodeModelGenerator.Instance.TypeFactory.ClientPipelineApi.PipelinePolicyType), perRetryPolicies, New.Array(ScmCodeModelGenerator.Instance.TypeFactory.ClientPipelineApi.PipelinePolicyType)]).As<ClientPipeline>();

public override bool SupportsModelProxies => true;

// Copies ClientPipelineOptions.ModelProxies into the client's options; creating the pipeline freezes them.
public override ValueExpression GetModelReaderWriterOptions(ValueExpression clientOptions)
=> ModelSerializationExtensionsSnippets.ToWireOptions(clientOptions.Property(nameof(ClientPipelineOptions.ModelProxies)));

public override MethodBodyStatement[] CreateMessage(
HttpRequestOptionsApi requestOptions,
ValueExpression uri,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
using System.Linq;
using System.Threading;
using Microsoft.TypeSpec.Generator.ClientModel.Primitives;
using Microsoft.TypeSpec.Generator.ClientModel.Snippets;
using Microsoft.TypeSpec.Generator.ClientModel.Utilities;
using Microsoft.TypeSpec.Generator.EmitterRpc;
using Microsoft.TypeSpec.Generator.Expressions;
Expand Down Expand Up @@ -41,6 +42,7 @@ private record ApiVersionFields(FieldProvider Field, PropertyProvider? Correspon
private const string TokenProviderFieldName = "_tokenProvider";
private const string TokenCredentialFieldName = "_tokenCredential";
private const string EndpointFieldName = "_endpoint";
private const string ModelReaderWriterOptionsFieldName = "_modelReaderWriterOptions";
private const string CredentialParamName = "credential";
private const string SettingsParamName = "settings";
private const string ClientSuffix = "Client";
Expand Down Expand Up @@ -182,6 +184,16 @@ public ClientProvider(InputClient inputClient)
typeof(Uri),
EndpointFieldName,
this);
// Clients created through the mocking constructor skip the constructors that copy the client options' proxies,
// so the field starts with the shared wire options to keep their convenience methods working.
ModelReaderWriterOptionsField = ScmCodeModelGenerator.Instance.TypeFactory.ClientPipelineApi.ToExpression().SupportsModelProxies
? new FieldProvider(
FieldModifiers.Private | FieldModifiers.ReadOnly,
typeof(ModelReaderWriterOptions),
ModelReaderWriterOptionsFieldName,
this,
initializationValue: ModelSerializationExtensionsSnippets.Wire)
: null;
PipelineProperty = new(
description: $"The HTTP pipeline for sending and receiving REST requests and responses.",
modifiers: MethodSignatureModifiers.Public,
Expand Down Expand Up @@ -515,6 +527,12 @@ private IReadOnlyList<ParameterProvider> GetSubClientInternalConstructorParamete
PipelineProperty.AsParameter
};

// The parent passes the options it built from its client options so subclient operations use the same proxies.
if (ModelReaderWriterOptionsField != null)
{
subClientParameters.Add(ModelReaderWriterOptionsField.AsParameter);
}

// Auth credentials are NOT included here — the parent passes its authenticated
// pipeline, so the sub-client doesn't need separate credential parameters.
subClientParameters.Add(_subClientEndpointParameter);
Expand Down Expand Up @@ -624,6 +642,12 @@ private IReadOnlyList<ParameterProvider> GetClientParameters()
public PropertyProvider PipelineProperty { get; }
public FieldProvider EndpointField { get; }

/// <summary>
/// Gets the field holding the <see cref="ModelReaderWriterOptions"/> the client uses to read and write models, or
/// <c>null</c> when the client pipeline options don't carry model proxies.
/// </summary>
public FieldProvider? ModelReaderWriterOptionsField { get; }

public IReadOnlyList<ClientProvider> SubClients => _subClients.Value;

protected override string BuildRelativeFilePath() => Path.Combine("src", "Generated", $"{Name}.cs");
Expand Down Expand Up @@ -750,6 +774,11 @@ protected override FieldProvider[] BuildFields()
{
List<FieldProvider> fields = [EndpointField];

if (ModelReaderWriterOptionsField != null)
{
fields.Add(ModelReaderWriterOptionsField);
}

if (_apiKeyAuthFields != null)
{
// No longer add AuthField (_keyCredential) — auth is handled via AuthenticationPolicy parameter in the internal constructor
Expand Down Expand Up @@ -1361,6 +1390,13 @@ private MethodBodyStatement[] BuildPrimaryConstructorBody(IReadOnlyList<Paramete
body.Add(PipelineProperty.Assign(This.ToApi<ClientPipelineApi>().Create(clientOptionsParameter, perRetryPolicies)).Terminate());
}

// Creating the pipeline freezes the client options, so the options built here can't change afterwards.
if (ModelReaderWriterOptionsField != null)
{
body.Add(ModelReaderWriterOptionsField.Assign(
This.ToApi<ClientPipelineApi>().GetModelReaderWriterOptions(clientOptionsParameter)).Terminate());
}

foreach (var f in Fields)
{
var fieldInfo = _apiVersionFields?.FirstOrDefault(fieldInfo => fieldInfo.Field == f);
Expand Down
Loading
Loading