tsp, multipart file field can have no filename; update filename encod…

…ing (#2544)
Azure · Feb 9, 2024 · 730e7d4 · 730e7d4
1 parent d938a13
commit 730e7d4
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 72 deletions.
diff --git a/javagen/src/main/resources/MultipartFormDataHelper.java b/javagen/src/main/resources/MultipartFormDataHelper.java
@@ -3,15 +3,13 @@
 import com.azure.core.util.BinaryData;
 import com.azure.core.util.CoreUtils;
 
-import java.text.Normalizer;
 import java.io.ByteArrayInputStream;
 import java.io.InputStream;
 import java.io.SequenceInputStream;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.UUID;
-import java.util.regex.Pattern;
 
 // DO NOT modify this helper class
 
@@ -85,8 +83,8 @@ public BinaryData getRequestBody() {
     public MultipartFormDataHelper serializeTextField(String fieldName, String value) {
         if (value != null) {
             String serialized = partSeparator
-                    + CRLF + "Content-Disposition: form-data; name=\""
-                    + fieldName + "\"" + CRLF + CRLF
+                    + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\""
+                    + CRLF + CRLF
                     + value
                     + CRLF;
             byte[] data = serialized.getBytes(encoderCharset);
@@ -105,7 +103,8 @@ public MultipartFormDataHelper serializeTextField(String fieldName, String value
      */
     public MultipartFormDataHelper serializeJsonField(String fieldName, Object jsonObject) {
         if (jsonObject != null) {
-            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName + "\""
+            String serialized = partSeparator + CRLF
+                    + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\""
                     + CRLF + "Content-Type: application/json"
                     + CRLF + CRLF + BinaryData.fromObject(jsonObject) + CRLF;
             byte[] data = serialized.getBytes(encoderCharset);
@@ -132,11 +131,6 @@ public MultipartFormDataHelper serializeFileField(
             if (CoreUtils.isNullOrEmpty(contentType)) {
                 contentType = APPLICATION_OCTET_STREAM;
             }
-            if (CoreUtils.isNullOrEmpty(filename)) {
-                filename = fieldName;
-            }
-            filename = normalizeAscii(filename);
-
             writeFileField(fieldName, file, contentType, filename);
         }
         return this;
@@ -164,11 +158,6 @@ public MultipartFormDataHelper serializeFileFields(
                     contentType = APPLICATION_OCTET_STREAM;
                 }
                 String filename = filenames.get(i);
-                if (CoreUtils.isNullOrEmpty(filename)) {
-                    filename = fieldName + String.valueOf(i + 1);
-                }
-                filename = normalizeAscii(filename);
-
                 writeFileField(fieldName, file, contentType, filename);
             }
         }
@@ -194,10 +183,14 @@ public MultipartFormDataHelper end() {
     }
 
     private void writeFileField(String fieldName, BinaryData file, String contentType, String filename) {
+        String contentDispositionFilename = "";
+        if (!CoreUtils.isNullOrEmpty(filename)) {
+            contentDispositionFilename = "; filename=\"" + escapeName(filename) + "\"";
+        }
+
         // Multipart preamble
         String fileFieldPreamble = partSeparator
-                + CRLF + "Content-Disposition: form-data; name=\"" + fieldName
-                + "\"; filename=\"" + filename + "\""
+                + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\"" + contentDispositionFilename
                 + CRLF + "Content-Type: " + contentType + CRLF + CRLF;
         byte[] data = fileFieldPreamble.getBytes(encoderCharset);
         appendBytes(data);
@@ -216,9 +209,7 @@ private void appendBytes(byte[] bytes) {
         requestDataStream = new SequenceInputStream(requestDataStream, new ByteArrayInputStream(bytes));
     }
 
-    private static final Pattern REDACT_FILENAME = Pattern.compile("[^\\x20-\\x7E]|\"");
-
-    private static String normalizeAscii(String text) {
-        return REDACT_FILENAME.matcher(Normalizer.normalize(text, Normalizer.Form.NFD)).replaceAll("");
+    private static String escapeName(String name) {
+        return name.replace("\n", "%0A").replace("\r", "%0D").replace("\"", "%22");
     }
 }
diff --git a/typespec-extension/changelog.md b/typespec-extension/changelog.md
@@ -1,6 +1,12 @@
 # Release History
 
-## 0.13.3 (2024-02-07)
+## 0.13.5 (2024-02-09)
+
+Compatible with compiler 0.53.
+
+- Behavior changed on "multipart/form-data" request. If `filename` is not provided, implementation will no longer provide a default filename to `Content-Disposition` line.
+
+## 0.13.4 (2024-02-07)
 
 Compatible with compiler 0.53.
 

diff --git a/typespec-extension/package-lock.json b/typespec-extension/package-lock.json
diff --git a/typespec-extension/package.json b/typespec-extension/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-java",
-  "version": "0.13.4",
+  "version": "0.13.5",
   "description": "TypeSpec library for emitting Java client from the TypeSpec REST protocol binding",
   "keywords": [
     "TypeSpec"

diff --git a/typespec-tests/package.json b/typespec-tests/package.json
@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "@azure-tools/cadl-ranch-specs": "0.29.0",
-    "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.13.4.tgz"
+    "@azure-tools/typespec-java": "file:/../typespec-extension/azure-tools-typespec-java-0.13.5.tgz"
   },
   "devDependencies": {
     "@typespec/prettier-plugin-typespec": "~0.53.0",

diff --git a/typespec-tests/src/main/java/com/cadl/multipart/implementation/MultipartFormDataHelper.java b/typespec-tests/src/main/java/com/cadl/multipart/implementation/MultipartFormDataHelper.java
@@ -13,10 +13,8 @@
 import java.io.SequenceInputStream;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
-import java.text.Normalizer;
 import java.util.List;
 import java.util.UUID;
-import java.util.regex.Pattern;
 
 // DO NOT modify this helper class
 
@@ -89,8 +87,8 @@ public BinaryData getRequestBody() {
      */
     public MultipartFormDataHelper serializeTextField(String fieldName, String value) {
         if (value != null) {
-            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName + "\""
-                + CRLF + CRLF + value + CRLF;
+            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName)
+                + "\"" + CRLF + CRLF + value + CRLF;
             byte[] data = serialized.getBytes(encoderCharset);
             appendBytes(data);
         }
@@ -107,8 +105,9 @@ public MultipartFormDataHelper serializeTextField(String fieldName, String value
      */
     public MultipartFormDataHelper serializeJsonField(String fieldName, Object jsonObject) {
         if (jsonObject != null) {
-            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName + "\""
-                + CRLF + "Content-Type: application/json" + CRLF + CRLF + BinaryData.fromObject(jsonObject) + CRLF;
+            String serialized
+                = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\"" + CRLF
+                    + "Content-Type: application/json" + CRLF + CRLF + BinaryData.fromObject(jsonObject) + CRLF;
             byte[] data = serialized.getBytes(encoderCharset);
             appendBytes(data);
         }
@@ -130,11 +129,6 @@ public MultipartFormDataHelper serializeFileField(String fieldName, BinaryData f
             if (CoreUtils.isNullOrEmpty(contentType)) {
                 contentType = APPLICATION_OCTET_STREAM;
             }
-            if (CoreUtils.isNullOrEmpty(filename)) {
-                filename = fieldName;
-            }
-            filename = normalizeAscii(filename);
-
             writeFileField(fieldName, file, contentType, filename);
         }
         return this;
@@ -159,11 +153,6 @@ public MultipartFormDataHelper serializeFileFields(String fieldName, List<Binary
                     contentType = APPLICATION_OCTET_STREAM;
                 }
                 String filename = filenames.get(i);
-                if (CoreUtils.isNullOrEmpty(filename)) {
-                    filename = fieldName + String.valueOf(i + 1);
-                }
-                filename = normalizeAscii(filename);
-
                 writeFileField(fieldName, file, contentType, filename);
             }
         }
@@ -188,9 +177,15 @@ public MultipartFormDataHelper end() {
     }
 
     private void writeFileField(String fieldName, BinaryData file, String contentType, String filename) {
+        String contentDispositionFilename = "";
+        if (!CoreUtils.isNullOrEmpty(filename)) {
+            contentDispositionFilename = "; filename=\"" + escapeName(filename) + "\"";
+        }
+
         // Multipart preamble
-        String fileFieldPreamble = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName
-            + "\"; filename=\"" + filename + "\"" + CRLF + "Content-Type: " + contentType + CRLF + CRLF;
+        String fileFieldPreamble
+            = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\""
+                + contentDispositionFilename + CRLF + "Content-Type: " + contentType + CRLF + CRLF;
         byte[] data = fileFieldPreamble.getBytes(encoderCharset);
         appendBytes(data);
 
@@ -208,9 +203,7 @@ private void appendBytes(byte[] bytes) {
         requestDataStream = new SequenceInputStream(requestDataStream, new ByteArrayInputStream(bytes));
     }
 
-    private static final Pattern REDACT_FILENAME = Pattern.compile("[^\\x20-\\x7E]|\"");
-
-    private static String normalizeAscii(String text) {
-        return REDACT_FILENAME.matcher(Normalizer.normalize(text, Normalizer.Form.NFD)).replaceAll("");
+    private static String escapeName(String name) {
+        return name.replace("\n", "%0A").replace("\r", "%0D").replace("\"", "%22");
     }
 }
diff --git a/...pec-tests/src/main/java/com/payload/multipart/implementation/MultipartFormDataHelper.java b/...pec-tests/src/main/java/com/payload/multipart/implementation/MultipartFormDataHelper.java
@@ -13,10 +13,8 @@
 import java.io.SequenceInputStream;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
-import java.text.Normalizer;
 import java.util.List;
 import java.util.UUID;
-import java.util.regex.Pattern;
 
 // DO NOT modify this helper class
 
@@ -89,8 +87,8 @@ public BinaryData getRequestBody() {
      */
     public MultipartFormDataHelper serializeTextField(String fieldName, String value) {
         if (value != null) {
-            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName + "\""
-                + CRLF + CRLF + value + CRLF;
+            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName)
+                + "\"" + CRLF + CRLF + value + CRLF;
             byte[] data = serialized.getBytes(encoderCharset);
             appendBytes(data);
         }
@@ -107,8 +105,9 @@ public MultipartFormDataHelper serializeTextField(String fieldName, String value
      */
     public MultipartFormDataHelper serializeJsonField(String fieldName, Object jsonObject) {
         if (jsonObject != null) {
-            String serialized = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName + "\""
-                + CRLF + "Content-Type: application/json" + CRLF + CRLF + BinaryData.fromObject(jsonObject) + CRLF;
+            String serialized
+                = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\"" + CRLF
+                    + "Content-Type: application/json" + CRLF + CRLF + BinaryData.fromObject(jsonObject) + CRLF;
             byte[] data = serialized.getBytes(encoderCharset);
             appendBytes(data);
         }
@@ -130,11 +129,6 @@ public MultipartFormDataHelper serializeFileField(String fieldName, BinaryData f
             if (CoreUtils.isNullOrEmpty(contentType)) {
                 contentType = APPLICATION_OCTET_STREAM;
             }
-            if (CoreUtils.isNullOrEmpty(filename)) {
-                filename = fieldName;
-            }
-            filename = normalizeAscii(filename);
-
             writeFileField(fieldName, file, contentType, filename);
         }
         return this;
@@ -159,11 +153,6 @@ public MultipartFormDataHelper serializeFileFields(String fieldName, List<Binary
                     contentType = APPLICATION_OCTET_STREAM;
                 }
                 String filename = filenames.get(i);
-                if (CoreUtils.isNullOrEmpty(filename)) {
-                    filename = fieldName + String.valueOf(i + 1);
-                }
-                filename = normalizeAscii(filename);
-
                 writeFileField(fieldName, file, contentType, filename);
             }
         }
@@ -188,9 +177,15 @@ public MultipartFormDataHelper end() {
     }
 
     private void writeFileField(String fieldName, BinaryData file, String contentType, String filename) {
+        String contentDispositionFilename = "";
+        if (!CoreUtils.isNullOrEmpty(filename)) {
+            contentDispositionFilename = "; filename=\"" + escapeName(filename) + "\"";
+        }
+
         // Multipart preamble
-        String fileFieldPreamble = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + fieldName
-            + "\"; filename=\"" + filename + "\"" + CRLF + "Content-Type: " + contentType + CRLF + CRLF;
+        String fileFieldPreamble
+            = partSeparator + CRLF + "Content-Disposition: form-data; name=\"" + escapeName(fieldName) + "\""
+                + contentDispositionFilename + CRLF + "Content-Type: " + contentType + CRLF + CRLF;
         byte[] data = fileFieldPreamble.getBytes(encoderCharset);
         appendBytes(data);
 
@@ -208,9 +203,7 @@ private void appendBytes(byte[] bytes) {
         requestDataStream = new SequenceInputStream(requestDataStream, new ByteArrayInputStream(bytes));
     }
 
-    private static final Pattern REDACT_FILENAME = Pattern.compile("[^\\x20-\\x7E]|\"");
-
-    private static String normalizeAscii(String text) {
-        return REDACT_FILENAME.matcher(Normalizer.normalize(text, Normalizer.Form.NFD)).replaceAll("");
+    private static String escapeName(String name) {
+        return name.replace("\n", "%0A").replace("\r", "%0D").replace("\"", "%22");
     }
 }
diff --git a/typespec-tests/src/test/java/com/payload/multipart/MultipartTests.java b/typespec-tests/src/test/java/com/payload/multipart/MultipartTests.java
@@ -204,10 +204,10 @@ public void testFileArray() {
                 "123",
                 Arrays.asList(
                         new PicturesFileDetails(BinaryData.fromFile(PNG_FILE)).setFilename("voilà.png"),
-                        new PicturesFileDetails(BinaryData.fromFile(PNG_FILE)).setFilename("ima\"\nge2.png")
+                        new PicturesFileDetails(BinaryData.fromFile(PNG_FILE)).setFilename("ima\"\n\rge2.png")
                 ))).block();
 
-        validationPolicy.validateFilenames("voila.png", "image2.png");
+        validationPolicy.validateFilenames("voilà.png", "ima%22%0A%0Dge2.png");
     }
 
     @Test