http-client-java, support array encoded as CSV on property (#9218)

fix #9027

see
https://github.com/microsoft/typespec/pull/9218/files#diff-e8b978e5080675f7527d4beb363a9dde604493dbff1db49116ea56c94b2339e1
on difference on generated code.

Currently only supports element as String. (the convert from a subtype
to String need some refactor in existing code)

release PR is Azure/autorest.java#3242

Author: weidongxu-microsoft

packages/http-client-java/emitter/src/code-model-builder.ts

@@ -108,6 +108,7 @@ import { fail } from "assert";
 import pkg from "lodash";
 import {
   Client as CodeModelClient,
+  EncodedProperty,
   EncodedSchema,
   PageableContinuationToken,
   Serializable,
@@ -2865,6 +2866,18 @@ export class CodeModelBuilder {
       serializedName: getPropertySerializedName(modelProperty),
       extensions: extensions,
     });
+    if (modelProperty.encode) {
+      if (schema instanceof ArraySchema) {
+        const elementSchema = schema.elementType;
+        if (!(elementSchema instanceof StringSchema)) {
+          reportDiagnostic(this.program, {
+            code: "non-string-array-encoding-element-notsupported",
+            target: modelProperty.__raw ?? NoTarget,
+          });
+        }
+      }
+      (codeModelProperty as EncodedProperty).arrayEncoding = modelProperty.encode;
+    }
 
     // xml
     if (modelProperty.serializationOptions.xml) {

packages/http-client-java/emitter/src/common/client.ts

@@ -9,6 +9,7 @@ import {
   Security,
 } from "@autorest/codemodel";
 import { DeepPartial } from "@azure-tools/codegen";
+import { ArrayKnownEncoding } from "@azure-tools/typespec-client-generator-core";
 import { XmlSerializationFormat } from "./formats/xml.js";
 
 export interface Client extends Aspect {
@@ -103,6 +104,14 @@ export interface EncodedSchema {
   encode?: string;
 }
 
+export interface EncodedProperty {
+  /**
+   * The encoding of array items.
+   * The type for SDK would "SdkArrayType" with a "valueType", the type on wire be "string".
+   */
+  arrayEncoding?: ArrayKnownEncoding;
+}
+
 export class PageableContinuationToken {
   /**
    * The parameter of the operation as continuationToken in API request.

packages/http-client-java/emitter/src/lib.ts

@@ -119,6 +119,12 @@ export const $lib = createTypeSpecLibrary({
         default: paramMessage`Constant header '${"headerName"}' is removed from response headers.`,
       },
     },
+    "non-string-array-encoding-element-notsupported": {
+      severity: "error",
+      messages: {
+        default: "Element of type other than 'string' is not supported for 'ArrayEncoding'.",
+      },
+    },
   },
   emitter: {
     options: EmitterOptionsSchema,

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

@@ -20,7 +20,7 @@
     "@typespec/http-client-java-tests": "file:"
   },
   "overrides": {
-    "@typespec/compiler": "1.7.0",
+    "@typespec/compiler": "1.7.1",
     "@typespec/http": "1.7.0",
     "@typespec/rest": "0.77.0",
     "@typespec/versioning": "0.77.0",

packages/http-client-java/generator/http-client-generator-clientcore-test/src/main/java/encode/array/CommaDelimitedArrayProperty.java

@@ -7,7 +7,10 @@
 import io.clientcore.core.serialization.json.JsonToken;
 import io.clientcore.core.serialization.json.JsonWriter;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.LinkedList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * The CommaDelimitedArrayProperty model.
@@ -47,7 +50,10 @@ public List<String> getValue() {
     @Override
     public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeStartObject();
-        jsonWriter.writeArrayField("value", this.value, (writer, element) -> writer.writeString(element));
+        if (this.value != null) {
+            jsonWriter.writeStringField("value",
+                this.value.stream().map(element -> element == null ? "" : element).collect(Collectors.joining(",")));
+        }
         return jsonWriter.writeEndObject();
     }
 
@@ -69,7 +75,12 @@ public static CommaDelimitedArrayProperty fromJson(JsonReader jsonReader) throws
                 reader.nextToken();
 
                 if ("value".equals(fieldName)) {
-                    value = reader.readArray(reader1 -> reader1.getString());
+                    String valueEncodedAsString = reader.getString();
+                    value = valueEncodedAsString == null
+                        ? null
+                        : valueEncodedAsString.isEmpty()
+                            ? new LinkedList<>()
+                            : new LinkedList<>(Arrays.asList(valueEncodedAsString.split(",", -1)));
                 } else {
                     reader.skipChildren();
                 }

packages/http-client-java/generator/http-client-generator-clientcore-test/src/main/java/encode/array/NewlineDelimitedArrayProperty.java

@@ -7,7 +7,10 @@
 import io.clientcore.core.serialization.json.JsonToken;
 import io.clientcore.core.serialization.json.JsonWriter;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.LinkedList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * The NewlineDelimitedArrayProperty model.
@@ -47,7 +50,10 @@ public List<String> getValue() {
     @Override
     public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeStartObject();
-        jsonWriter.writeArrayField("value", this.value, (writer, element) -> writer.writeString(element));
+        if (this.value != null) {
+            jsonWriter.writeStringField("value",
+                this.value.stream().map(element -> element == null ? "" : element).collect(Collectors.joining("\n")));
+        }
         return jsonWriter.writeEndObject();
     }
 
@@ -69,7 +75,12 @@ public static NewlineDelimitedArrayProperty fromJson(JsonReader jsonReader) thro
                 reader.nextToken();
 
                 if ("value".equals(fieldName)) {
-                    value = reader.readArray(reader1 -> reader1.getString());
+                    String valueEncodedAsString = reader.getString();
+                    value = valueEncodedAsString == null
+                        ? null
+                        : valueEncodedAsString.isEmpty()
+                            ? new LinkedList<>()
+                            : new LinkedList<>(Arrays.asList(valueEncodedAsString.split("\n", -1)));
                 } else {
                     reader.skipChildren();
                 }

packages/http-client-java/generator/http-client-generator-clientcore-test/src/main/java/encode/array/PipeDelimitedArrayProperty.java

@@ -7,7 +7,10 @@
 import io.clientcore.core.serialization.json.JsonToken;
 import io.clientcore.core.serialization.json.JsonWriter;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.LinkedList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * The PipeDelimitedArrayProperty model.
@@ -47,7 +50,10 @@ public List<String> getValue() {
     @Override
     public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeStartObject();
-        jsonWriter.writeArrayField("value", this.value, (writer, element) -> writer.writeString(element));
+        if (this.value != null) {
+            jsonWriter.writeStringField("value",
+                this.value.stream().map(element -> element == null ? "" : element).collect(Collectors.joining("|")));
+        }
         return jsonWriter.writeEndObject();
     }
 
@@ -69,7 +75,12 @@ public static PipeDelimitedArrayProperty fromJson(JsonReader jsonReader) throws
                 reader.nextToken();
 
                 if ("value".equals(fieldName)) {
-                    value = reader.readArray(reader1 -> reader1.getString());
+                    String valueEncodedAsString = reader.getString();
+                    value = valueEncodedAsString == null
+                        ? null
+                        : valueEncodedAsString.isEmpty()
+                            ? new LinkedList<>()
+                            : new LinkedList<>(Arrays.asList(valueEncodedAsString.split("\\|", -1)));
                 } else {
                     reader.skipChildren();
                 }

packages/http-client-java/generator/http-client-generator-clientcore-test/src/main/java/encode/array/SpaceDelimitedArrayProperty.java

@@ -7,7 +7,10 @@
 import io.clientcore.core.serialization.json.JsonToken;
 import io.clientcore.core.serialization.json.JsonWriter;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.LinkedList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * The SpaceDelimitedArrayProperty model.
@@ -47,7 +50,10 @@ public List<String> getValue() {
     @Override
     public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeStartObject();
-        jsonWriter.writeArrayField("value", this.value, (writer, element) -> writer.writeString(element));
+        if (this.value != null) {
+            jsonWriter.writeStringField("value",
+                this.value.stream().map(element -> element == null ? "" : element).collect(Collectors.joining(" ")));
+        }
         return jsonWriter.writeEndObject();
     }
 
@@ -69,7 +75,12 @@ public static SpaceDelimitedArrayProperty fromJson(JsonReader jsonReader) throws
                 reader.nextToken();
 
                 if ("value".equals(fieldName)) {
-                    value = reader.readArray(reader1 -> reader1.getString());
+                    String valueEncodedAsString = reader.getString();
+                    value = valueEncodedAsString == null
+                        ? null
+                        : valueEncodedAsString.isEmpty()
+                            ? new LinkedList<>()
+                            : new LinkedList<>(Arrays.asList(valueEncodedAsString.split(" ", -1)));
                 } else {
                     reader.skipChildren();
                 }

packages/http-client-java/generator/http-client-generator-clientcore-test/src/test/java/encode/array/EncodeArrayTests.java

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package encode.array;
+
+import java.util.List;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public final class EncodeArrayTests {
+
+    private static final List<String> COLORS = List.of("blue", "red", "green");
+
+    private final ArrayClient client = new ArrayClientBuilder().buildArrayClient();
+
+    @Test
+    public void commaDelimitedProperty() {
+        CommaDelimitedArrayProperty response = client.commaDelimited(new CommaDelimitedArrayProperty(COLORS));
+        Assertions.assertEquals(COLORS, response.getValue());
+    }
+
+    @Test
+    public void spaceDelimitedProperty() {
+        SpaceDelimitedArrayProperty response = client.spaceDelimited(new SpaceDelimitedArrayProperty(COLORS));
+        Assertions.assertEquals(COLORS, response.getValue());
+    }
+
+    @Test
+    public void pipeDelimitedProperty() {
+        PipeDelimitedArrayProperty response = client.pipeDelimited(new PipeDelimitedArrayProperty(COLORS));
+        Assertions.assertEquals(COLORS, response.getValue());
+    }
+
+    @Test
+    public void newlineDelimitedProperty() {
+        NewlineDelimitedArrayProperty response = client.newlineDelimited(new NewlineDelimitedArrayProperty(COLORS));
+        Assertions.assertEquals(COLORS, response.getValue());
+    }
+}

packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/extension/model/codemodel/Property.java

@@ -18,6 +18,7 @@ public class Property extends Value {
     private String summary;
     // TypeSpec only
     private SerializationFormats serialization;
+    private String arrayEncoding;
     // internal use, not from modelerfour
     private ObjectSchema parentSchema;
 
@@ -161,6 +162,24 @@ public void setSerialization(SerializationFormats serialization) {
         this.serialization = serialization;
     }
 
+    /**
+     * Gets the array encoding style of this property.
+     *
+     * @return The array encoding style of this property.
+     */
+    public String getArrayEncoding() {
+        return arrayEncoding;
+    }
+
+    /**
+     * Sets the array encoding style of this property.
+     *
+     * @param arrayEncoding The array encoding style of this property.
+     */
+    public void setArrayEncoding(String arrayEncoding) {
+        this.arrayEncoding = arrayEncoding;
+    }
+
     @Override
     public String getSummary() {
         return summary;