tsp, multipart model naming (#2894)

* bump cadl-ranch

* multipart, do not rename File model, if it is not TypeSpec.Http.File

Author: weidongxu-microsoft

typespec-extension/changelog.md

@@ -1,6 +1,6 @@
 # Release History
 
-## 0.18.4 (Unreleased)
+## 0.18.4 (2024-08-07)
 
 Compatible with compiler 0.58.
 

typespec-extension/src/code-model-builder.ts

@@ -2085,7 +2085,7 @@ export class CodeModelBuilder {
       nullable = true;
       nonNullType = nonNullType.type;
     }
-    let schema = this.processSchemaFromSdkType(nonNullType, "");
+    let schema;
 
     let extensions: Record<string, any> | undefined = undefined;
     if (this.isSecret(prop)) {
@@ -2108,7 +2108,11 @@ export class CodeModelBuilder {
       // TODO: handle MultipartOptions.isMulti
       if (prop.multipartOptions.isFilePart) {
         schema = this.processMultipartFormDataFilePropertySchemaFromSdkType(prop);
+      } else {
+        schema = this.processSchemaFromSdkType(nonNullType, "");
       }
+    } else {
+      schema = this.processSchemaFromSdkType(nonNullType, "");
     }
 
     return new Property(prop.name, prop.details ?? "", schema, {

typespec-extension/src/external-schemas.ts

@@ -115,7 +115,12 @@ export function createPollOperationDetailsSchema(schemas: Schemas, stringSchema:
 
 const fileDetailsMap: Map<string, ObjectSchema> = new Map();
 
-function getFileSchemaName(baseName: string) {
+function getFileSchemaName(baseName: string, sdkModelType?: SdkModelType): string {
+  // If the TypeSpec Model exists and is not TypeSpec.Http.File, directly use its name
+  if (sdkModelType && sdkModelType.crossLanguageDefinitionId !== "TypeSpec.Http.File") {
+    return baseName;
+  }
+
   // make sure suffix "FileDetails"
   if (baseName.toLocaleLowerCase().endsWith("filedetails")) {
     return pascalCase(baseName);
@@ -232,7 +237,7 @@ export function getFileDetailsSchema(
      */
     const filePropertyName = property.name;
     const fileSchemaName = fileSdkType.name;
-    const schemaName = getFileSchemaName(fileSchemaName);
+    const schemaName = getFileSchemaName(fileSchemaName, fileSdkType);
     let fileDetailsSchema = fileDetailsMap.get(schemaName);
     if (!fileDetailsSchema) {
       const typeNamespace = getNamespace(property.type.__raw) ?? namespace;

typespec-tests/package.json

@@ -9,7 +9,7 @@
     "testserver-run": "npx cadl-ranch serve ./node_modules/@azure-tools/cadl-ranch-specs/http --coverageFile ./cadl-ranch-coverage-java.json"
   },
   "dependencies": {
-    "@azure-tools/cadl-ranch-specs": "0.34.10",
+    "@azure-tools/cadl-ranch-specs": "0.35.2",
     "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.18.4.tgz"
   },
   "devDependencies": {

typespec-tests/src/main/java/com/_specs_/azure/core/basic/BasicAsyncClient.java

@@ -6,8 +6,6 @@
 
 import com._specs_.azure.core.basic.implementation.BasicClientImpl;
 import com._specs_.azure.core.basic.implementation.JsonMergePatchHelper;
-import com._specs_.azure.core.basic.models.ListItemInputBody;
-import com._specs_.azure.core.basic.models.ListItemInputExtensibleEnum;
 import com._specs_.azure.core.basic.models.User;
 import com.azure.core.annotation.Generated;
 import com.azure.core.annotation.ReturnType;
@@ -240,119 +238,6 @@ public PagedFlux<BinaryData> list(RequestOptions requestOptions) {
         return this.serviceClient.listAsync(requestOptions);
     }
 
-    /**
-     * List with Azure.Core.Page&lt;&gt;.
-     * <p><strong>Response Body Schema</strong></p>
-     * 
-     * <pre>{@code
-     * {
-     *     id: int (Required)
-     *     name: String (Optional, Required on create)
-     *     orders (Optional): [
-     *          (Optional){
-     *             id: int (Required)
-     *             userId: int (Optional, Required on create)
-     *             detail: String (Optional, Required on create)
-     *         }
-     *     ]
-     *     etag: String (Required)
-     * }
-     * }</pre>
-     * 
-     * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @return paged collection of User items as paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<BinaryData> listWithPage(RequestOptions requestOptions) {
-        return this.serviceClient.listWithPageAsync(requestOptions);
-    }
-
-    /**
-     * List with extensible enum parameter Azure.Core.Page&lt;&gt;.
-     * <p><strong>Query Parameters</strong></p>
-     * <table border="1">
-     * <caption>Query Parameters</caption>
-     * <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr>
-     * <tr><td>another</td><td>String</td><td>No</td><td>Another query parameter. Allowed values: "First",
-     * "Second".</td></tr>
-     * </table>
-     * You can add these to a request with {@link RequestOptions#addQueryParam}
-     * <p><strong>Request Body Schema</strong></p>
-     * 
-     * <pre>{@code
-     * {
-     *     inputName: String (Required)
-     * }
-     * }</pre>
-     * 
-     * <p><strong>Response Body Schema</strong></p>
-     * 
-     * <pre>{@code
-     * {
-     *     id: int (Required)
-     *     name: String (Optional, Required on create)
-     *     orders (Optional): [
-     *          (Optional){
-     *             id: int (Required)
-     *             userId: int (Optional, Required on create)
-     *             detail: String (Optional, Required on create)
-     *         }
-     *     ]
-     *     etag: String (Required)
-     * }
-     * }</pre>
-     * 
-     * @param bodyInput The body of the input.
-     * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @return paged collection of User items as paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<BinaryData> listWithParameters(BinaryData bodyInput, RequestOptions requestOptions) {
-        return this.serviceClient.listWithParametersAsync(bodyInput, requestOptions);
-    }
-
-    /**
-     * List with custom page model.
-     * <p><strong>Response Body Schema</strong></p>
-     * 
-     * <pre>{@code
-     * {
-     *     id: int (Required)
-     *     name: String (Optional, Required on create)
-     *     orders (Optional): [
-     *          (Optional){
-     *             id: int (Required)
-     *             userId: int (Optional, Required on create)
-     *             detail: String (Optional, Required on create)
-     *         }
-     *     ]
-     *     etag: String (Required)
-     * }
-     * }</pre>
-     * 
-     * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @return the paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<BinaryData> listWithCustomPageModel(RequestOptions requestOptions) {
-        return this.serviceClient.listWithCustomPageModelAsync(requestOptions);
-    }
-
     /**
      * Deletes a user.
      * 
@@ -587,134 +472,6 @@ public PagedFlux<User> list() {
         });
     }
 
-    /**
-     * List with Azure.Core.Page&lt;&gt;.
-     * 
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
-     * @return paged collection of User items as paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<User> listWithPage() {
-        // Generated convenience method for listWithPage
-        RequestOptions requestOptions = new RequestOptions();
-        PagedFlux<BinaryData> pagedFluxResponse = listWithPage(requestOptions);
-        return PagedFlux.create(() -> (continuationTokenParam, pageSizeParam) -> {
-            Flux<PagedResponse<BinaryData>> flux = (continuationTokenParam == null)
-                ? pagedFluxResponse.byPage().take(1)
-                : pagedFluxResponse.byPage(continuationTokenParam).take(1);
-            return flux.map(pagedResponse -> new PagedResponseBase<Void, User>(pagedResponse.getRequest(),
-                pagedResponse.getStatusCode(), pagedResponse.getHeaders(),
-                pagedResponse.getValue()
-                    .stream()
-                    .map(protocolMethodData -> protocolMethodData.toObject(User.class))
-                    .collect(Collectors.toList()),
-                pagedResponse.getContinuationToken(), null));
-        });
-    }
-
-    /**
-     * List with extensible enum parameter Azure.Core.Page&lt;&gt;.
-     * 
-     * @param bodyInput The body of the input.
-     * @param another Another query parameter.
-     * @throws IllegalArgumentException thrown if parameters fail the validation.
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
-     * @return paged collection of User items as paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<User> listWithParameters(ListItemInputBody bodyInput, ListItemInputExtensibleEnum another) {
-        // Generated convenience method for listWithParameters
-        RequestOptions requestOptions = new RequestOptions();
-        if (another != null) {
-            requestOptions.addQueryParam("another", another.toString(), false);
-        }
-        PagedFlux<BinaryData> pagedFluxResponse = listWithParameters(BinaryData.fromObject(bodyInput), requestOptions);
-        return PagedFlux.create(() -> (continuationTokenParam, pageSizeParam) -> {
-            Flux<PagedResponse<BinaryData>> flux = (continuationTokenParam == null)
-                ? pagedFluxResponse.byPage().take(1)
-                : pagedFluxResponse.byPage(continuationTokenParam).take(1);
-            return flux.map(pagedResponse -> new PagedResponseBase<Void, User>(pagedResponse.getRequest(),
-                pagedResponse.getStatusCode(), pagedResponse.getHeaders(),
-                pagedResponse.getValue()
-                    .stream()
-                    .map(protocolMethodData -> protocolMethodData.toObject(User.class))
-                    .collect(Collectors.toList()),
-                pagedResponse.getContinuationToken(), null));
-        });
-    }
-
-    /**
-     * List with extensible enum parameter Azure.Core.Page&lt;&gt;.
-     * 
-     * @param bodyInput The body of the input.
-     * @throws IllegalArgumentException thrown if parameters fail the validation.
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
-     * @return paged collection of User items as paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<User> listWithParameters(ListItemInputBody bodyInput) {
-        // Generated convenience method for listWithParameters
-        RequestOptions requestOptions = new RequestOptions();
-        PagedFlux<BinaryData> pagedFluxResponse = listWithParameters(BinaryData.fromObject(bodyInput), requestOptions);
-        return PagedFlux.create(() -> (continuationTokenParam, pageSizeParam) -> {
-            Flux<PagedResponse<BinaryData>> flux = (continuationTokenParam == null)
-                ? pagedFluxResponse.byPage().take(1)
-                : pagedFluxResponse.byPage(continuationTokenParam).take(1);
-            return flux.map(pagedResponse -> new PagedResponseBase<Void, User>(pagedResponse.getRequest(),
-                pagedResponse.getStatusCode(), pagedResponse.getHeaders(),
-                pagedResponse.getValue()
-                    .stream()
-                    .map(protocolMethodData -> protocolMethodData.toObject(User.class))
-                    .collect(Collectors.toList()),
-                pagedResponse.getContinuationToken(), null));
-        });
-    }
-
-    /**
-     * List with custom page model.
-     * 
-     * @throws HttpResponseException thrown if the request is rejected by server.
-     * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
-     * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
-     * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
-     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
-     * @return the paginated response with {@link PagedFlux}.
-     */
-    @Generated
-    @ServiceMethod(returns = ReturnType.COLLECTION)
-    public PagedFlux<User> listWithCustomPageModel() {
-        // Generated convenience method for listWithCustomPageModel
-        RequestOptions requestOptions = new RequestOptions();
-        PagedFlux<BinaryData> pagedFluxResponse = listWithCustomPageModel(requestOptions);
-        return PagedFlux.create(() -> (continuationTokenParam, pageSizeParam) -> {
-            Flux<PagedResponse<BinaryData>> flux = (continuationTokenParam == null)
-                ? pagedFluxResponse.byPage().take(1)
-                : pagedFluxResponse.byPage(continuationTokenParam).take(1);
-            return flux.map(pagedResponse -> new PagedResponseBase<Void, User>(pagedResponse.getRequest(),
-                pagedResponse.getStatusCode(), pagedResponse.getHeaders(),
-                pagedResponse.getValue()
-                    .stream()
-                    .map(protocolMethodData -> protocolMethodData.toObject(User.class))
-                    .collect(Collectors.toList()),
-                pagedResponse.getContinuationToken(), null));
-        });
-    }
-
     /**
      * Deletes a user.
      *