http-client-java, support advanced-versioning on @added optional parameter in TypeSpec, in non-DPG

packages/http-client-java/generator/http-client-generator-clientcore-test/package.json

@@ -31,7 +31,7 @@
     "@typespec/streams": "0.76.0",
     "@azure-tools/typespec-azure-core": "0.62.0",
     "@azure-tools/typespec-client-generator-core": "0.62.0",
-    "@azure-tools/typespec-azure-resource-manager": "0.62.0",
+    "@azure-tools/typespec-azure-resource-manager": "0.62.1",
     "@azure-tools/typespec-autorest": "0.62.0"
   },
   "private": true

packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodMapper.java

@@ -355,16 +355,33 @@ private static JavaVisibility methodVisibilityInWrapperClient(Operation operatio
         }
     }
 
-    private static void createOverloadForVersioning(boolean isProtocolMethod, List<ClientMethod> methods,
-        ClientMethod baseMethod) {
+    protected void createOverloadForVersioning(List<ClientMethod> methods, ClientMethod baseMethod,
+        JavaVisibility methodWithContextVisibility, MethodPageDetails methodPageDetailsWithContext,
+        boolean isProtocolMethod) {
+        final ClientMethodType clientMethodType = baseMethod.getType();
         final List<ClientMethodParameter> parameters = baseMethod.getParameters();
-        if (!isProtocolMethod && JavaSettings.getInstance().isDataPlaneClient()) {
+        if (!isProtocolMethod) {
             if (parameters.stream().anyMatch(p -> p.getVersioning() != null && p.getVersioning().getAdded() != null)) {
+                // versioning of @added exists
                 final List<List<ClientMethodParameter>> signatures = findOverloadedSignatures(parameters);
                 for (List<ClientMethodParameter> overloadedParameters : signatures) {
-                    final ClientMethod overloadedMethod
-                        = baseMethod.newBuilder().parameters(overloadedParameters).build();
-                    methods.add(overloadedMethod);
+                    if (JavaSettings.getInstance().isDataPlaneClient()) {
+                        // DPG
+                        final ClientMethod overloadedMethod
+                            = baseMethod.newBuilder().parameters(overloadedParameters).build();
+                        methods.add(overloadedMethod);
+                    } else {
+                        // non-DPG
+                        ClientMethod.Builder overloadedMethodBuilder
+                            = baseMethod.newBuilder().parameters(overloadedParameters);
+                        if (methodPageDetailsWithContext != null) {
+                            overloadedMethodBuilder
+                                = overloadedMethodBuilder.methodPageDetails(methodPageDetailsWithContext);
+                        }
+                        final ClientMethod overloadedMethod = overloadedMethodBuilder.build();
+                        addClientMethodWithContext(methods, overloadedMethod, methodWithContextVisibility,
+                            isProtocolMethod);
+                    }
                 }
             }
         }
@@ -456,6 +473,9 @@ private void createSinglePageClientMethods(boolean isSync, ClientMethod baseMeth
             methods.add(singlePageMethod);
         }
 
+        // Pageable op '[Operation]SinglePage' overloads for versioning
+        createOverloadForVersioning(methods, singlePageMethod, methodWithContextVisibility, null, isProtocolMethod);
+
         // Generate '[Operation]SinglePage' overload with all parameters and Context.
         addClientMethodWithContext(methods, singlePageMethod, methodWithContextVisibility, isProtocolMethod);
     }
@@ -508,8 +528,9 @@ private void createPageStreamingClientMethods(boolean isSync, ClientMethod baseM
         if (settings.getSyncMethods() != SyncMethodsGeneration.NONE) {
             // generate the overload, if "sync-methods != NONE"
             methods.add(pagingMethod);
-            // overload for versioning
-            createOverloadForVersioning(isProtocolMethod, methods, pagingMethod);
+            // Pageable op '[Operation]' overloads for versioning
+            createOverloadForVersioning(methods, pagingMethod, methodWithContextVisibility,
+                methodPageDetailsWithContext, isProtocolMethod);
         }
 
         if (generateRequiredOnlyParametersOverload) {
@@ -575,6 +596,10 @@ private void createLroWithResponseClientMethods(boolean isSync, ClientMethod bas
             .hasWithContextOverload(methodWithContextVisibility != NOT_GENERATE)
             .build();
         methods.add(withResponseMethod);
+
+        // LRO '[Operation]WithResponse' overloads for versioning
+        createOverloadForVersioning(methods, withResponseMethod, methodWithContextVisibility, null, isProtocolMethod);
+
         addClientMethodWithContext(methods, withResponseMethod, methodWithContextVisibility, isProtocolMethod);
     }
 
@@ -614,6 +639,10 @@ private void createFluentLroWithResponseSyncClientMethods(Operation operation, C
             .methodVisibility(NOT_VISIBLE)
             .build();
         methods.add(withResponseSyncMethod);
+
+        // LRO '[Operation]' overloads for versioning
+        createOverloadForVersioning(methods, withResponseSyncMethod, NOT_VISIBLE, null, isProtocolMethod);
+
         addClientMethodWithContext(methods, withResponseSyncMethod, NOT_VISIBLE, isProtocolMethod);
     }
 
@@ -705,7 +734,7 @@ private void createLroBeginClientMethods(boolean isSync, ClientMethod lroBaseMet
         methods.add(beginLroMethod);
 
         // LRO 'begin[Operation]' sync or async method overloads with versioning.
-        createOverloadForVersioning(isProtocolMethod, methods, beginLroMethod);
+        createOverloadForVersioning(methods, beginLroMethod, methodWithContextVisibility, null, isProtocolMethod);
 
         if (generateRequiredOnlyParametersOverload) {
             // LRO 'begin[Operation]' sync or async method overload with only required parameters.
@@ -764,6 +793,10 @@ private void createSimpleWithResponseClientMethods(boolean isSync, ClientMethod
             .hasWithContextOverload(hasContextOverload)
             .methodVisibility(methodVisibility)
             .build();
+
+        // Simple op '[Operation]WithResponse' overloads for versioning
+        createOverloadForVersioning(methods, withResponseMethod, methodWithContextVisibility, null, isProtocolMethod);
+
         // Always generate an overload of WithResponse with non-required parameters without Context. It is only for sync
         // proxy method, and is usually filtered out in methodVisibility function.
         methods.add(withResponseMethod);
@@ -807,8 +840,8 @@ private void createSimpleValueClientMethods(boolean isSync, ClientMethod baseMet
             .build();
         methods.add(simpleMethod);
 
-        // overload for versioning
-        createOverloadForVersioning(isProtocolMethod, methods, simpleMethod);
+        // Simple op '[Operation]' overloads for versioning
+        createOverloadForVersioning(methods, simpleMethod, methodWithContextVisibility, null, isProtocolMethod);
 
         if (generateRequiredOnlyParametersOverload) {
             final ClientMethod simpleMethodWithRequiredParameters = simpleMethod.newBuilder()

packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/model/clientmodel/ClientMethodType.java

@@ -23,8 +23,6 @@ public enum ClientMethodType {
      * Mono<PagedResponseBase<H,T>>.
      */
     PagingAsyncSinglePage(2, true, false, false),
-    SimulatedPagingSync(3, false, false, true), // unused
-    SimulatedPagingAsync(4, false, false, false), // unused
     /**
      * represents long-running method that returns T where T is the final result of the LRO.
      */

packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/template/ClientMethodTemplate.java

@@ -140,6 +140,8 @@ protected static void addOptionalVariables(JavaBlock function, ClientMethod clie
     protected static void addOptionalAndConstantVariables(JavaBlock function, ClientMethod clientMethod,
         JavaSettings settings) {
         final List<ProxyMethodParameter> proxyMethodParameters = clientMethod.getProxyMethod().getParameters();
+        List<com.microsoft.typespec.http.client.generator.core.model.clientmodel.examplemodel.MethodParameter> methodParameters
+            = MethodUtil.getParameters(clientMethod, false);
         for (ProxyMethodParameter parameter : proxyMethodParameters) {
             if (parameter.isFromClient()) {
                 // parameter is scoped to the client, hence no local variable instantiation for it.
@@ -164,7 +166,17 @@ protected static void addOptionalAndConstantVariables(JavaBlock function, Client
 
             // If the parameter isn't required and the client method only uses required parameters, optional
             // parameters are omitted and will need to instantiated in the method.
-            boolean optionalOmitted = clientMethod.getOnlyRequiredParameters() && !parameter.isRequired();
+            boolean optionalOmitted = !parameter.isRequired() && parameter.getClientType() != ClassType.CONTEXT;
+            if (optionalOmitted) {
+                boolean parameterInClientMethodSignature = methodParameters.stream()
+                    .filter(p -> p.getProxyMethodParameter() == parameter)
+                    .findFirst()
+                    .map(p -> p.getClientMethodParameter())
+                    .isPresent();
+                // if the parameter is defined in client method signature,
+                // it does not need to be instantiated in local variable.
+                optionalOmitted = !parameterInClientMethodSignature;
+            }
 
             // Optional variables and constants are always null if their wire type and client type differ and applying
             // conversions between the types is ignored.

packages/http-client-java/generator/http-client-generator-mgmt/src/main/java/com/microsoft/typespec/http/client/generator/mgmt/mapper/FluentClientMethodMapper.java

@@ -135,6 +135,10 @@ private void createLroGetFinalResultClientMethods(boolean isSync, ClientMethod b
             .build();
         methods.add(lroGetFinalResultMethod);
 
+        // LRO '[Operation]' sync or async method overloads with versioning (for management).
+        createOverloadForVersioning(methods, lroGetFinalResultMethod, methodWithContextVisibility, null,
+            isProtocolMethod);
+
         if (generateRequiredOnlyParametersOverload) {
             final ClientMethod lroGetFinalResultMethodWithRequiredOnlyParameters = lroGetFinalResultMethod.newBuilder()
                 .onlyRequiredParameters(true)

packages/http-client-java/generator/http-client-generator-mgmt/src/main/java/com/microsoft/typespec/http/client/generator/mgmt/model/clientmodel/fluentmodel/ResourceOperation.java

@@ -131,7 +131,7 @@ private List<MethodParameter> getParametersByLocation(RequestParameterLocation p
     }
 
     private List<MethodParameter> getParametersByLocation(Set<RequestParameterLocation> parameterLocations) {
-        ClientMethod clientMethod = getMethodReferencesOfFullParameters().iterator().next().getInnerClientMethod();
+        ClientMethod clientMethod = getClientMethodOfFullParameters();
         Map<String, ProxyMethodParameter> proxyMethodParameterByClientParameterName = clientMethod.getProxyMethod()
             .getParameters()
             .stream()
@@ -145,6 +145,18 @@ private List<MethodParameter> getParametersByLocation(Set<RequestParameterLocati
             .collect(Collectors.toList());
     }
 
+    private ClientMethod getClientMethodOfFullParameters() {
+        List<FluentCollectionMethod> collectionMethods = getMethodReferencesOfFullParameters();
+        // take the client method with longest parameters
+        // it should be the client method of full parameters
+        collectionMethods.sort((m1, m2) -> {
+            int count1 = m1.getInnerClientMethod().getParameters().size();
+            int count2 = m2.getInnerClientMethod().getParameters().size();
+            return -Integer.compare(count1, count2);
+        });
+        return collectionMethods.get(0).getInnerClientMethod();
+    }
+
     public ClientMethodParameter getBodyParameter() {
         List<MethodParameter> parameters = getParametersByLocation(RequestParameterLocation.BODY);
         return parameters.isEmpty() ? null : parameters.iterator().next().getClientMethodParameter();

packages/http-client-java/generator/http-client-generator-test/Generate.ps1

@@ -107,6 +107,9 @@ $generateScript = {
     $tspOptions += " --option ""@typespec/http-client-java.generate-tests=false"""
     # add customization code
     $tspOptions += " --option ""@typespec/http-client-java.customization-class=../../customization/src/main/java/KeyVaultCustomization.java"""
+  } elseif ($tspFile -match "tsp[\\/]arm-versioned.tsp") {
+    # enable advanced versioning for resiliency test
+    $tspOptions += " --option ""@typespec/http-client-java.advanced-versioning=true"""
   } elseif ($tspFile -match "tsp[\\/]subclient.tsp") {
     $tspOptions += " --option ""@typespec/http-client-java.enable-subclient=true"""
     # test for include-api-view-properties

packages/http-client-java/generator/http-client-generator-test/package.json

@@ -31,7 +31,7 @@
     "@typespec/streams": "0.76.0",
     "@azure-tools/typespec-azure-core": "0.62.0",
     "@azure-tools/typespec-client-generator-core": "0.62.0",
-    "@azure-tools/typespec-azure-resource-manager": "0.62.0",
+    "@azure-tools/typespec-azure-resource-manager": "0.62.1",
     "@azure-tools/typespec-autorest": "0.62.0"
   },
   "private": true