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.

Sign up for GitHub

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

Jump to bottom

tsp, dpg, keep enum type for client parameters, not change it to string type #4911

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
+802 −239
Draft

tsp, dpg, keep enum type for client parameters, not change it to string type #4911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
27d1069
logic to not change enum to string type for data-plane path/url param…
haolingdong-msft Nov 1, 2024
74b3f84
test template change
haolingdong-msft Nov 1, 2024
ee68228
regen
haolingdong-msft Nov 1, 2024
c81d303
format
haolingdong-msft Nov 1, 2024
7ca033d
Refine logics to add the checks on whether to remove model from param…
haolingdong-msft Nov 14, 2024
88ab744
Merge remote-tracking branch 'remote/main' into host-parameter-enum-a…
haolingdong-msft Nov 14, 2024
32035eb
format
haolingdong-msft Nov 14, 2024
78f6a3f
regenerate
haolingdong-msft Nov 14, 2024
0e5b7df
update tests
haolingdong-msft Nov 14, 2024
7f98ae5
remove import *
haolingdong-msft Nov 14, 2024
cd304bd
add todo for non-string enum
haolingdong-msft Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/http-client-java/emitter/src/code-model-builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ export class CodeModelBuilder {
} else {
const schema = this.processSchema(arg.type, arg.name);
this.trackSchemaUsage(schema, {
usage: [SchemaContext.Input, SchemaContext.Output /*SchemaContext.Public*/],
usage: [SchemaContext.Input, SchemaContext.Output, SchemaContext.Public],
});
parameter = new Parameter(arg.name, arg.doc ?? "", schema, {
implementation: ImplementationLocation.Client,
Expand Down
11 changes: 8 additions & 3 deletions ...n/java/com/microsoft/typespec/http/client/generator/core/mapper/ProxyParameterMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@ public ProxyMethodParameter map(Parameter parameter) {

IType clientType = wireType.getClientType();

if (settings.isDataPlaneClient()) {
if (isRemoveModelFromParameter(parameter, clientType)) {
clientType = SchemaUtil.removeModelFromParameter(parameterRequestLocation, clientType);
}

builder.clientType(clientType);

if (wireType instanceof ListType
Expand All @@ -88,7 +89,7 @@ public ProxyMethodParameter map(Parameter parameter) {
if (parameterRequestLocation
!= RequestParameterLocation.BODY /* && parameterRequestLocation != RequestParameterLocation.FormData */) {
wireType = ClassType.STRING;
} else if (settings.isDataPlaneClient()) {
} else if (isRemoveModelFromParameter(parameter, wireType)) {
wireType = SchemaUtil.removeModelFromParameter(parameterRequestLocation, wireType);
}
} else if (wireType instanceof ListType
Expand All @@ -102,7 +103,7 @@ public ProxyMethodParameter map(Parameter parameter) {
} else {
wireType = ClassType.STRING;
}
} else if (settings.isDataPlaneClient()) {
} else if (isRemoveModelFromParameter(parameter, wireType)) {
wireType = SchemaUtil.removeModelFromParameter(parameterRequestLocation, wireType);
}
builder.wireType(wireType);
Expand Down Expand Up @@ -182,6 +183,10 @@ public ProxyMethodParameter map(Parameter parameter) {
return builder.build();
}

protected boolean isRemoveModelFromParameter(Parameter parameter, IType clientType) {
return JavaSettings.getInstance().isDataPlaneClient();
}

protected ProxyMethodParameter.Builder createProxyMethodParameterBuilder() {
return new ProxyMethodParameter.Builder();
}
Expand Down
6 changes: 5 additions & 1 deletion ...in/java/com/microsoft/typespec/http/client/generator/core/mapper/ServiceClientMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ protected List<ServiceClientProperty> processClientProperties(Client client, Str
String serviceClientPropertyName = CodeNamer.getPropertyName(p.getLanguage().getJava().getName());

IType serviceClientPropertyClientType = Mappers.getSchemaMapper().map(p.getSchema());
if (settings.isDataPlaneClient()) {
if (isRemoveModelFromParameter(p, serviceClientPropertyClientType)) {
// mostly for Enum to String
serviceClientPropertyClientType = SchemaUtil.removeModelFromParameter(RequestParameterLocation.URI,
serviceClientPropertyClientType);
Expand Down Expand Up @@ -281,6 +281,10 @@ protected List<ServiceClientProperty> processClientProperties(Client client, Str
return serviceClientProperties;
}

protected boolean isRemoveModelFromParameter(Parameter parameter, IType type) {
return JavaSettings.getInstance().isDataPlaneClient();
}

protected void processParametersAndConstructors(ServiceClient.Builder builder, Client client, CodeModel codeModel,
List<ServiceClientProperty> serviceClientProperties, Proxy proxy) {
JavaSettings settings = JavaSettings.getInstance();
Expand Down
19 changes: 16 additions & 3 deletions ...om/microsoft/typespec/http/client/generator/core/template/example/ProtocolTestWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import com.microsoft.typespec.http.client.generator.core.extension.model.codemodel.Scheme;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.AsyncSyncClient;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.ClassType;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.EnumType;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.ServiceClient;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.ServiceClientProperty;
import com.microsoft.typespec.http.client.generator.core.model.clientmodel.TestContext;
Expand Down Expand Up @@ -83,9 +84,21 @@ public ProtocolTestWriter(TestContext testContext) {
String defaultValueExpression = serviceClientProperty.getDefaultValueExpression();
String expr;
if (defaultValueExpression == null) {
expr = String.format("Configuration.getGlobalConfiguration().get(\"%1$s\", %2$s)",
serviceClientProperty.getName().toUpperCase(Locale.ROOT), ClassType.STRING
.defaultValueExpression(serviceClientProperty.getName().toLowerCase(Locale.ROOT)));
if (serviceClientProperty.getType() instanceof EnumType) {
// TODO: handle non-string enum
expr = String.format(
"%1$s.fromString(Configuration.getGlobalConfiguration().get(\"%2$s\", %3$s))",
serviceClientProperty.getType(),
serviceClientProperty.getName().toUpperCase(Locale.ROOT),
ClassType.STRING.defaultValueExpression(
serviceClientProperty.getName().toLowerCase(Locale.ROOT)));

} else {
expr = String.format("Configuration.getGlobalConfiguration().get(\"%1$s\", %2$s)",
serviceClientProperty.getName().toUpperCase(Locale.ROOT),
ClassType.STRING.defaultValueExpression(
serviceClientProperty.getName().toLowerCase(Locale.ROOT)));
}
} else {
expr = String.format("Configuration.getGlobalConfiguration().get(\"%1$s\", %2$s)",
serviceClientProperty.getName().toUpperCase(Locale.ROOT), defaultValueExpression);
Expand Down
5 changes: 3 additions & 2 deletions ...tp-client-generator-test/src/main/java/client/structure/service/ClientAClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package client.structure.service;

import client.structure.service.implementation.ClientAClientImpl;
import client.structure.service.models.ClientType;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
Expand Down Expand Up @@ -194,7 +195,7 @@ public ClientAClientBuilder endpoint(String endpoint) {
* Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
*/
@Generated
private String client;
private ClientType client;

/**
* Sets Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
Expand All @@ -203,7 +204,7 @@ public ClientAClientBuilder endpoint(String endpoint) {
* @return the ClientAClientBuilder.
*/
@Generated
public ClientAClientBuilder client(String client) {
public ClientAClientBuilder client(ClientType client) {
this.client = client;
return this;
}
Expand Down
5 changes: 3 additions & 2 deletions ...tp-client-generator-test/src/main/java/client/structure/service/ClientBClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package client.structure.service;

import client.structure.service.implementation.ClientBClientImpl;
import client.structure.service.models.ClientType;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
Expand Down Expand Up @@ -194,7 +195,7 @@ public ClientBClientBuilder endpoint(String endpoint) {
* Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
*/
@Generated
private String client;
private ClientType client;

/**
* Sets Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
Expand All @@ -203,7 +204,7 @@ public ClientBClientBuilder endpoint(String endpoint) {
* @return the ClientBClientBuilder.
*/
@Generated
public ClientBClientBuilder client(String client) {
public ClientBClientBuilder client(ClientType client) {
this.client = client;
return this;
}
Expand Down
5 changes: 3 additions & 2 deletions ...http-client-generator-test/src/main/java/client/structure/service/FirstClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package client.structure.service;

import client.structure.service.implementation.FirstClientImpl;
import client.structure.service.models.ClientType;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
Expand Down Expand Up @@ -201,7 +202,7 @@ public FirstClientBuilder endpoint(String endpoint) {
* Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
*/
@Generated
private String client;
private ClientType client;

/**
* Sets Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
Expand All @@ -210,7 +211,7 @@ public FirstClientBuilder endpoint(String endpoint) {
* @return the FirstClientBuilder.
*/
@Generated
public FirstClientBuilder client(String client) {
public FirstClientBuilder client(ClientType client) {
this.client = client;
return this;
}
Expand Down
5 changes: 3 additions & 2 deletions ...-generator-test/src/main/java/client/structure/service/RenamedOperationClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package client.structure.service;

import client.structure.service.implementation.RenamedOperationClientImpl;
import client.structure.service.models.ClientType;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
Expand Down Expand Up @@ -199,7 +200,7 @@ public RenamedOperationClientBuilder endpoint(String endpoint) {
* Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
*/
@Generated
private String client;
private ClientType client;

/**
* Sets Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
Expand All @@ -208,7 +209,7 @@ public RenamedOperationClientBuilder endpoint(String endpoint) {
* @return the RenamedOperationClientBuilder.
*/
@Generated
public RenamedOperationClientBuilder client(String client) {
public RenamedOperationClientBuilder client(ClientType client) {
this.client = client;
return this;
}
Expand Down
5 changes: 3 additions & 2 deletions ...ent-generator-test/src/main/java/client/structure/service/ServiceClientClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package client.structure.service;

import client.structure.service.implementation.ServiceClientClientImpl;
import client.structure.service.models.ClientType;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
Expand Down Expand Up @@ -207,7 +208,7 @@ public ServiceClientClientBuilder endpoint(String endpoint) {
* Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
*/
@Generated
private String client;
private ClientType client;

/**
* Sets Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
Expand All @@ -216,7 +217,7 @@ public ServiceClientClientBuilder endpoint(String endpoint) {
* @return the ServiceClientClientBuilder.
*/
@Generated
public ServiceClientClientBuilder client(String client) {
public ServiceClientClientBuilder client(ClientType client) {
this.client = client;
return this;
}
Expand Down
5 changes: 3 additions & 2 deletions ...generator-test/src/main/java/client/structure/service/TwoOperationGroupClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package client.structure.service;

import client.structure.service.implementation.TwoOperationGroupClientImpl;
import client.structure.service.models.ClientType;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
Expand Down Expand Up @@ -195,7 +196,7 @@ public TwoOperationGroupClientBuilder endpoint(String endpoint) {
* Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
*/
@Generated
private String client;
private ClientType client;

/**
* Sets Need to be set as 'default', 'multi-client', 'renamed-operation', 'two-operation-group' in client.
Expand All @@ -204,7 +205,7 @@ public TwoOperationGroupClientBuilder endpoint(String endpoint) {
* @return the TwoOperationGroupClientBuilder.
*/
@Generated
public TwoOperationGroupClientBuilder client(String client) {
public TwoOperationGroupClientBuilder client(ClientType client) {
this.client = client;
return this;
}
Expand Down
9 changes: 5 additions & 4 deletions ...client-generator-test/src/main/java/client/structure/service/implementation/BarsImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

package client.structure.service.implementation;

import client.structure.service.models.ClientType;
import com.azure.core.annotation.ExpectedResponses;
import com.azure.core.annotation.Host;
import com.azure.core.annotation.HostParam;
Expand Down Expand Up @@ -60,7 +61,7 @@ public interface BarsService {
@UnexpectedResponseExceptionType(value = ResourceNotFoundException.class, code = { 404 })
@UnexpectedResponseExceptionType(value = ResourceModifiedException.class, code = { 409 })
@UnexpectedResponseExceptionType(HttpResponseException.class)
Mono<Response<Void>> five(@HostParam("endpoint") String endpoint, @HostParam("client") String client,
Mono<Response<Void>> five(@HostParam("endpoint") String endpoint, @HostParam("client") ClientType client,
RequestOptions requestOptions, Context context);

@Post("/five")
Expand All @@ -69,7 +70,7 @@ Mono<Response<Void>> five(@HostParam("endpoint") String endpoint, @HostParam("cl
@UnexpectedResponseExceptionType(value = ResourceNotFoundException.class, code = { 404 })
@UnexpectedResponseExceptionType(value = ResourceModifiedException.class, code = { 409 })
@UnexpectedResponseExceptionType(HttpResponseException.class)
Response<Void> fiveSync(@HostParam("endpoint") String endpoint, @HostParam("client") String client,
Response<Void> fiveSync(@HostParam("endpoint") String endpoint, @HostParam("client") ClientType client,
RequestOptions requestOptions, Context context);

@Post("/six")
Expand All @@ -78,7 +79,7 @@ Response<Void> fiveSync(@HostParam("endpoint") String endpoint, @HostParam("clie
@UnexpectedResponseExceptionType(value = ResourceNotFoundException.class, code = { 404 })
@UnexpectedResponseExceptionType(value = ResourceModifiedException.class, code = { 409 })
@UnexpectedResponseExceptionType(HttpResponseException.class)
Mono<Response<Void>> six(@HostParam("endpoint") String endpoint, @HostParam("client") String client,
Mono<Response<Void>> six(@HostParam("endpoint") String endpoint, @HostParam("client") ClientType client,
RequestOptions requestOptions, Context context);

@Post("/six")
Expand All @@ -87,7 +88,7 @@ Mono<Response<Void>> six(@HostParam("endpoint") String endpoint, @HostParam("cli
@UnexpectedResponseExceptionType(value = ResourceNotFoundException.class, code = { 404 })
@UnexpectedResponseExceptionType(value = ResourceModifiedException.class, code = { 409 })
@UnexpectedResponseExceptionType(HttpResponseException.class)
Response<Void> sixSync(@HostParam("endpoint") String endpoint, @HostParam("client") String client,
Response<Void> sixSync(@HostParam("endpoint") String endpoint, @HostParam("client") ClientType client,
RequestOptions requestOptions, Context context);
}

Expand Down
5 changes: 3 additions & 2 deletions ...ent-generator-test/src/main/java/client/structure/service/implementation/BazFoosImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

package client.structure.service.implementation;

import client.structure.service.models.ClientType;
import com.azure.core.annotation.ExpectedResponses;
import com.azure.core.annotation.Host;
import com.azure.core.annotation.HostParam;
Expand Down Expand Up @@ -60,7 +61,7 @@ public interface BazFoosService {
@UnexpectedResponseExceptionType(value = ResourceNotFoundException.class, code = { 404 })
@UnexpectedResponseExceptionType(value = ResourceModifiedException.class, code = { 409 })
@UnexpectedResponseExceptionType(HttpResponseException.class)
Mono<Response<Void>> seven(@HostParam("endpoint") String endpoint, @HostParam("client") String client,
Mono<Response<Void>> seven(@HostParam("endpoint") String endpoint, @HostParam("client") ClientType client,
RequestOptions requestOptions, Context context);

@Post("/seven")
Expand All @@ -69,7 +70,7 @@ Mono<Response<Void>> seven(@HostParam("endpoint") String endpoint, @HostParam("c
@UnexpectedResponseExceptionType(value = ResourceNotFoundException.class, code = { 404 })
@UnexpectedResponseExceptionType(value = ResourceModifiedException.class, code = { 409 })
@UnexpectedResponseExceptionType(HttpResponseException.class)
Response<Void> sevenSync(@HostParam("endpoint") String endpoint, @HostParam("client") String client,
Response<Void> sevenSync(@HostParam("endpoint") String endpoint, @HostParam("client") ClientType client,
RequestOptions requestOptions, Context context);
}

Expand Down
Loading
Loading