fix-default-byte-as-binary-payload-in-modular (#2088)

* fix-default-byte-as-binary-in-modular * fix ci * resolve comments and fix ci * add response case and fix isBinaryPayload * fix linter error * fix binary response
Azure · Oct 30, 2023 · da0589a · da0589a
1 parent d913c84
commit da0589a
Show file tree

Hide file tree

Showing 8 changed files with 460 additions and 22 deletions.
diff --git a/...st/loadtesting_modular/generated/typespec-ts/src/loadTestAdministration/api/operations.ts b/...st/loadtesting_modular/generated/typespec-ts/src/loadTestAdministration/api/operations.ts
@@ -44,7 +44,6 @@ import {
   StreamableMethod,
   operationOptionsToRequestParameters,
 } from "@azure-rest/core-client";
-import { uint8ArrayToString } from "@azure/core-util";
 import {
   CreateOrUpdateTestOptions,
   CreateOrUpdateAppComponentsOptions,
@@ -980,7 +979,7 @@ export function _uploadTestFileSend(
       ...operationOptionsToRequestParameters(options),
       contentType: (options.contentType as any) ?? "application/octet-stream",
       queryParameters: { fileType: options?.fileType },
-      body: uint8ArrayToString(body, "base64"),
+      body: body,
     });
 }
 

diff --git a/packages/typespec-ts/src/modular/buildCodeModel.ts b/packages/typespec-ts/src/modular/buildCodeModel.ts
@@ -93,6 +93,7 @@ import {
 import {
   getOperationGroupName,
   getOperationName,
+  isBinaryPayload,
   isIgnoredHeaderParam,
   isLongRunningOperation
 } from "../utils/operationUtil.js";
@@ -390,6 +391,7 @@ type BodyParameter = ParamBase & {
   restApiName: string;
   location: "body";
   defaultContentType: string;
+  isBinaryPayload: boolean;
 };
 
 function getBodyType(program: Program, route: HttpOperation): Type {
@@ -449,16 +451,18 @@ function emitBodyParameter(
     disableEffectiveModel: true
   });
 
+  const defaultContentType =
+    body.parameter?.default ?? contentTypes.includes("application/json")
+      ? "application/json"
+      : contentTypes[0]!;
   return {
     contentTypes,
     type,
     restApiName: body.parameter?.name ?? "body",
     location: "body",
     ...base,
-    defaultContentType:
-      body.parameter?.default ?? contentTypes.includes("application/json")
-        ? "application/json"
-        : contentTypes[0]!
+    defaultContentType,
+    isBinaryPayload: isBinaryPayload(context, body.type, defaultContentType)
   };
 }
 
@@ -612,7 +616,14 @@ function emitResponse(
     statusCodes: statusCodes ?? [],
     addedOn: getAddedOnVersion(context.program, response.type),
     discriminator: "basic",
-    type: type
+    type: type,
+    isBinaryPayload: innerResponse.body?.type
+      ? isBinaryPayload(
+          context,
+          innerResponse.body?.type,
+          innerResponse.body?.contentTypes![0] ?? "application/json"
+        )
+      : false
   };
 }
 

diff --git a/packages/typespec-ts/src/modular/helpers/operationHelpers.ts b/packages/typespec-ts/src/modular/helpers/operationHelpers.ts
@@ -144,7 +144,7 @@ export function getDeserializePrivateFunction(
     }
   }
 
-  if (response?.type?.type === "any") {
+  if (response?.type?.type === "any" || response.isBinaryPayload) {
     statements.push(`return result.body`);
   } else if (getAllProperties(response?.type).length > 0) {
     statements.push(
@@ -386,7 +386,7 @@ function buildBodyParameter(
 
   if (
     bodyParameter.type.type === "byte-array" &&
-    bodyParameter.type.format !== "binary"
+    !bodyParameter.isBinaryPayload
   ) {
     const coreUtilSet = importSet.get("@azure/core-util");
     if (!coreUtilSet) {
@@ -406,10 +406,7 @@ function buildBodyParameter(
       : `body: uint8ArrayToString(${
           bodyParameter.clientName
         }, "${getEncodingFormat(bodyParameter.type)}")`;
-  } else if (
-    bodyParameter.type.type === "byte-array" &&
-    bodyParameter.type.format === "binary"
-  ) {
+  } else if (bodyParameter.isBinaryPayload) {
     return `\nbody: ${bodyParameter.clientName},`;
   }
 

diff --git a/packages/typespec-ts/src/modular/modularCodeModel.ts b/packages/typespec-ts/src/modular/modularCodeModel.ts
@@ -40,6 +40,7 @@ export interface BodyParameter {
   clientName: string;
   inOverload: boolean;
   defaultContentType: string;
+  isBinaryPayload: boolean;
 }
 
 export interface OperationGroup {
@@ -144,6 +145,7 @@ export interface Response {
   discriminator: string;
   type: Type;
   addedOn?: string;
+  isBinaryPayload?: boolean;
 }
 
 export interface Operation {

diff --git a/packages/typespec-ts/src/utils/modelUtils.ts b/packages/typespec-ts/src/utils/modelUtils.ts
@@ -83,7 +83,10 @@ export function isByteOrByteUnion(dpgContext: SdkContext, type: Type) {
 }
 
 function isByteType(schema: any) {
-  return schema.type === "string" && schema.format === "byte";
+  return (
+    schema.type === "string" &&
+    (schema.format === "byte" || schema.format === "binary")
+  );
 }
 
 function isByteUnion(schema: any) {

diff --git a/packages/typespec-ts/test/modularIntegration/generated/encode/bytes/src/api/requestBody.ts b/packages/typespec-ts/test/modularIntegration/generated/encode/bytes/src/api/requestBody.ts
@@ -64,7 +64,7 @@ export function _requestBodyOctetStreamSend(
     .post({
       ...operationOptionsToRequestParameters(options),
       contentType: (options.contentType as any) ?? "application/octet-stream",
-      body: uint8ArrayToString(value, "base64"),
+      body: value,
     });
 }
 
@@ -97,7 +97,7 @@ export function _requestBodyCustomContentTypeSend(
     .post({
       ...operationOptionsToRequestParameters(options),
       contentType: (options.contentType as any) ?? "image/png",
-      body: uint8ArrayToString(value, "base64"),
+      body: value,
     });
 }
 

diff --git a/packages/typespec-ts/test/modularIntegration/generated/encode/bytes/src/api/responseBody.ts b/packages/typespec-ts/test/modularIntegration/generated/encode/bytes/src/api/responseBody.ts
@@ -67,9 +67,7 @@ export async function _responseBodyOctetStreamDeserialize(
     throw result.body;
   }
 
-  return typeof result.body === "string"
-    ? stringToUint8Array(result.body, "base64")
-    : result.body;
+  return result.body;
 }
 
 export async function responseBodyOctetStream(
@@ -96,9 +94,7 @@ export async function _responseBodyCustomContentTypeDeserialize(
     throw result.body;
   }
 
-  return typeof result.body === "string"
-    ? stringToUint8Array(result.body, "base64")
-    : result.body;
+  return result.body;
 }
 
 export async function responseBodyCustomContentType(