eng, sync feature binary data (#2967)

Author: weidongxu-microsoft

core

@@ -77,4 +77,5 @@ client-flattened-annotation-target: none
 null-byte-array-maps-to-empty-array: true
 graal-vm-config: true
 stream-style-serialization: true
+use-object-for-unknown: true
 ```

fluentgen/readme.md

@@ -55,6 +55,7 @@ public static class MockFluentGen extends FluentGen {
             DEFAULT_SETTINGS.put("generate-samples", true);
             DEFAULT_SETTINGS.put("generate-tests", true);
             DEFAULT_SETTINGS.put("client-flattened-annotation-target", "NONE");
+            DEFAULT_SETTINGS.put("use-object-for-unknown", true);
         }
 
         private Javagen javagen;

fluentgen/src/test/java/com/microsoft/typespec/http/client/generator/mgmt/TestUtils.java

@@ -14,6 +14,7 @@ enable-sync-stack: true
 required-fields-as-ctor-args: true
 enable-page-size: true
 use-key-credential: true
+use-object-for-unknown: true
 
 use-default-http-status-code-to-exception-type-mapping: true
 polling: {}

javagen/data-plane.md

@@ -48,6 +48,8 @@ modelerfour:
   flatten-models: true
   flatten-payloads: true
   group-parameters: true
+
+use-object-for-unknown: true
 ```
 
 ```yaml $(data-plane)

javagen/readme.md

@@ -14,6 +14,7 @@ enable-sync-stack: true
 required-fields-as-ctor-args: true
 enable-page-size: true
 use-key-credential: true
+use-object-for-unknown: true
 
 use-default-http-status-code-to-exception-type-mapping: true
 polling: {}

javagen/src/main/resources/data-plane.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 0.23.0 (2024-11-07)
+
+Compatible with compiler 0.61.
+
+- Changed to use Java class `BinaryData` for TypeSpec `unknown`.
+
 ## 0.22.1 (2024-10-21)
 
 Compatible with compiler 0.61.

typespec-extension/changelog.md

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-java",
-  "version": "0.22.1",
+  "version": "0.23.0",
   "description": "TypeSpec library for emitting Java client from the TypeSpec REST protocol binding",
   "keywords": [
     "TypeSpec"

typespec-extension/package-lock.json

@@ -58,6 +58,10 @@ $generateScript = {
     $tspOptions += " --option ""@azure-tools/typespec-java.api-version=2022-09-01"""
     # exclude preview from service versions
     $tspOptions += " --option ""@azure-tools/typespec-java.service-version-exclude-preview=true"""
+  } elseif ($tspFile -match "type[\\/]array" -or $tspFile -match "type[\\/]dictionary") {
+    # TODO https://github.com/Azure/autorest.java/issues/2964
+    # also serve as a test for "use-object-for-unknown" emitter option
+    $tspOptions += " --option ""@azure-tools/typespec-java.use-object-for-unknown=true"""
   } elseif ($tspFile -match "arm.tsp") {
     # for mgmt, do not generate tests due to random mock values
     $tspOptions += " --option ""@azure-tools/typespec-java.generate-tests=false"""

typespec-extension/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@azure-tools/cadl-ranch-specs": "0.38.0",
-    "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.22.1.tgz"
+    "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.23.0.tgz"
   },
   "devDependencies": {
     "@typespec/prettier-plugin-typespec": "~0.61.0",

typespec-tests/Generate.ps1

@@ -47,7 +47,7 @@ public final class ExtendsUnknownAsyncClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -75,7 +75,7 @@ public Mono<Response<BinaryData>> getWithResponse(RequestOptions requestOptions)
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/package.json

@@ -45,7 +45,7 @@ public final class ExtendsUnknownClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -73,7 +73,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/ExtendsUnknownAsyncClient.java

@@ -47,7 +47,7 @@ public final class ExtendsUnknownDerivedAsyncClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -77,7 +77,7 @@ public Mono<Response<BinaryData>> getWithResponse(RequestOptions requestOptions)
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)

typespec-tests/src/main/java/com/type/property/additionalproperties/ExtendsUnknownClient.java

@@ -45,7 +45,7 @@ public final class ExtendsUnknownDerivedClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -75,7 +75,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)

typespec-tests/src/main/java/com/type/property/additionalproperties/ExtendsUnknownDerivedAsyncClient.java

@@ -48,7 +48,7 @@ public final class ExtendsUnknownDiscriminatedAsyncClient {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -77,7 +77,7 @@ public Mono<Response<BinaryData>> getWithResponse(RequestOptions requestOptions)
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/ExtendsUnknownDerivedClient.java

@@ -46,7 +46,7 @@ public final class ExtendsUnknownDiscriminatedClient {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -75,7 +75,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/ExtendsUnknownDiscriminatedAsyncClient.java

@@ -47,7 +47,7 @@ public final class IsUnknownAsyncClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -75,7 +75,7 @@ public Mono<Response<BinaryData>> getWithResponse(RequestOptions requestOptions)
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/ExtendsUnknownDiscriminatedClient.java

@@ -45,7 +45,7 @@ public final class IsUnknownClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -73,7 +73,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/IsUnknownAsyncClient.java

@@ -47,7 +47,7 @@ public final class IsUnknownDerivedAsyncClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -77,7 +77,7 @@ public Mono<Response<BinaryData>> getWithResponse(RequestOptions requestOptions)
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)

typespec-tests/src/main/java/com/type/property/additionalproperties/IsUnknownClient.java

@@ -45,7 +45,7 @@ public final class IsUnknownDerivedClient {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -75,7 +75,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)

typespec-tests/src/main/java/com/type/property/additionalproperties/IsUnknownDerivedAsyncClient.java

@@ -48,7 +48,7 @@ public final class IsUnknownDiscriminatedAsyncClient {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -77,7 +77,7 @@ public Mono<Response<BinaryData>> getWithResponse(RequestOptions requestOptions)
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/IsUnknownDerivedClient.java

@@ -46,7 +46,7 @@ public final class IsUnknownDiscriminatedClient {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -75,7 +75,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }

typespec-tests/src/main/java/com/type/property/additionalproperties/IsUnknownDiscriminatedAsyncClient.java

@@ -106,7 +106,7 @@ Response<Void> putSync(@HostParam("endpoint") String endpoint, @HeaderParam("Con
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -136,7 +136,7 @@ public Mono<Response<BinaryData>> getWithResponseAsync(RequestOptions requestOpt
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -166,7 +166,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)
@@ -198,7 +198,7 @@ public Mono<Response<Void>> putWithResponseAsync(BinaryData body, RequestOptions
      * {
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      *     index: int (Required)
      *     age: Double (Optional)

typespec-tests/src/main/java/com/type/property/additionalproperties/IsUnknownDiscriminatedClient.java

@@ -107,7 +107,7 @@ Response<Void> putSync(@HostParam("endpoint") String endpoint, @HeaderParam("Con
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -136,7 +136,7 @@ public Mono<Response<BinaryData>> getWithResponseAsync(RequestOptions requestOpt
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -165,7 +165,7 @@ public Response<BinaryData> getWithResponse(RequestOptions requestOptions) {
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }
@@ -196,7 +196,7 @@ public Mono<Response<Void>> putWithResponseAsync(BinaryData body, RequestOptions
      *     kind: String (Required)
      *     name: String (Required)
      *      (Optional): {
-     *         String: Object (Required)
+     *         String: BinaryData (Required)
      *     }
      * }
      * }