@typespec/http-specs 0.1.0-alpha.9 → 0.1.0-dev.0

package/specs/payload/multipart/mockapi.ts

@@ -1,5 +1,6 @@
 import {
   MockRequest,
+  multipart,
   passOnSuccess,
   ScenarioMockApi,
   ValidationError,
@@ -29,7 +30,7 @@ function checkFile(
   fileName: string | undefined = undefined,
   mustCheckContentType: boolean = true,
 ) {
-  // cadl-ranch depends on multer, which sets the mimetype to "text/plain" if this part has no content-type header
+  // server depends on multer, which sets the mimetype to "text/plain" if this part has no content-type header
   if (mustCheckContentType || file.mimetype !== "text/plain") {
     req.expect.deepEqual(file.mimetype, contentType);
   }
@@ -181,29 +182,93 @@ function createMultiBinaryPartsHandler(req: MockRequest) {
   }
 }
 
+function createOptionalPartsHandler(req: MockRequest) {
+  const hasId = req.body.id !== undefined;
+  const hasProfileImage = req.files instanceof Array && req.files.length > 0;
+
+  if (hasId && hasProfileImage) {
+    checkId(req);
+    checkJpgFile(req, req.files[0]);
+    return { pass: "id,profileImage", status: 204 } as const;
+  } else if (hasId && !hasProfileImage) {
+    checkId(req);
+    return { pass: "id", status: 204 } as const;
+  } else if (!hasId && hasProfileImage) {
+    checkJpgFile(req, req.files[0]);
+    return { pass: "profileImage", status: 204 } as const;
+  } else {
+    throw new ValidationError(
+      "No id or profileImage found",
+      "At least one of id or profileImage is expected",
+      req.body,
+    );
+  }
+}
+
 Scenarios.Payload_MultiPart_FormData_basic = passOnSuccess({
   uri: "/multipart/form-data/mixed-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [files[0]],
+    body: multipart({ parts: { id: 123 }, files: [files[0]] }),
+  },
+  response: { status: 204 },
+  handler: (req: MockRequest) => createHandler(req, [checkId, checkProfileImage]),
+  kind: "MockApiDefinition",
+});
+Scenarios.Payload_MultiPart_FormData_withWireName = passOnSuccess({
+  uri: "/multipart/form-data/mixed-parts-with-wire-name",
+  method: "post",
+  request: {
+    body: multipart({ parts: { id: 123 }, files: [files[0]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkProfileImage]),
   kind: "MockApiDefinition",
 });
+Scenarios.Payload_MultiPart_FormData_optionalParts = withServiceKeys([
+  "id",
+  "profileImage",
+  "id,profileImage",
+]).pass([
+  {
+    uri: "/multipart/form-data/optional-parts",
+    method: "post",
+    request: {
+      body: multipart({ parts: { id: 123 } }),
+    },
+    response: { status: 204 },
+    handler: createOptionalPartsHandler,
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/multipart/form-data/optional-parts",
+    method: "post",
+    request: {
+      body: multipart({ files: [files[0]] }),
+    },
+    response: { status: 204 },
+    handler: createOptionalPartsHandler,
+    kind: "MockApiDefinition",
+  },
+  {
+    uri: "/multipart/form-data/optional-parts",
+    method: "post",
+    request: {
+      body: multipart({ parts: { id: 123 }, files: [files[0]] }),
+    },
+    response: { status: 204 },
+    handler: createOptionalPartsHandler,
+    kind: "MockApiDefinition",
+  },
+]);
 Scenarios.Payload_MultiPart_FormData_fileArrayAndBasic = passOnSuccess({
   uri: "/multipart/form-data/complex-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123, address: { city: "X" } },
-    files: [files[0], files[1], files[1]],
+    body: multipart({
+      parts: { id: 123, address: { city: "X" } },
+      files: [files[0], files[1], files[1]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkAddress, checkAllFiles]),
@@ -213,11 +278,7 @@ Scenarios.Payload_MultiPart_FormData_jsonPart = passOnSuccess({
   uri: "/multipart/form-data/json-part",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { address: { city: "X" } },
-    files: [files[0]],
+    body: multipart({ parts: { address: { city: "X" } }, files: [files[0]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkAddress, checkProfileImage]),
@@ -227,11 +288,7 @@ Scenarios.Payload_MultiPart_FormData_binaryArrayParts = passOnSuccess({
   uri: "/multipart/form-data/binary-array-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [files[1], files[1]],
+    body: multipart({ parts: { id: 123 }, files: [files[1], files[1]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkPictures]),
@@ -245,10 +302,9 @@ Scenarios.Payload_MultiPart_FormData_multiBinaryParts = withServiceKeys([
     uri: "/multipart/form-data/multi-binary-parts",
     method: "post",
     request: {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-      files: [files[0]],
+      body: multipart({
+        files: [files[0]],
+      }),
     },
     response: { status: 204 },
     handler: createMultiBinaryPartsHandler,
@@ -258,10 +314,9 @@ Scenarios.Payload_MultiPart_FormData_multiBinaryParts = withServiceKeys([
     uri: "/multipart/form-data/multi-binary-parts",
     method: "post",
     request: {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-      files: [files[0], { ...files[1], fieldname: "picture" }],
+      body: multipart({
+        files: [files[0], { ...files[1], fieldname: "picture" }],
+      }),
     },
     response: { status: 204 },
     handler: createMultiBinaryPartsHandler,
@@ -272,11 +327,10 @@ Scenarios.Payload_MultiPart_FormData_checkFileNameAndContentType = passOnSuccess
   uri: "/multipart/form-data/check-filename-and-content-type",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    body: multipart({
+      parts: { id: 123 },
+      files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkFileNameAndContentType]),
@@ -286,10 +340,9 @@ Scenarios.Payload_MultiPart_FormData_anonymousModel = passOnSuccess({
   uri: "/multipart/form-data/anonymous-model",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkProfileImage]),
@@ -299,10 +352,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_imageJpegContentType
   uri: "/multipart/form-data/check-filename-and-specific-content-type-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    body: multipart({
+      files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkFileNameAndContentType]),
@@ -312,10 +364,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_requiredContentType =
   uri: "/multipart/form-data/check-filename-and-required-content-type-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkProfileImage]),
@@ -325,10 +376,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_optionalContentType =
   uri: "/multipart/form-data/file-with-http-part-optional-content-type",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkOptionalContentType]),
@@ -338,11 +388,14 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_jsonArrayAndFileArray = passOnSuc
   uri: "/multipart/form-data/complex-parts-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123, address: { city: "X" }, previousAddresses: [{ city: "Y" }, { city: "Z" }] },
-    files: [files[0], files[1], files[1]],
+    body: multipart({
+      parts: {
+        id: 123,
+        address: { city: "X" },
+        previousAddresses: [{ city: "Y" }, { city: "Z" }],
+      },
+      files: [files[0], files[1], files[1]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) =>
@@ -353,12 +406,100 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_NonString_float = passOnSuccess({
   uri: "/multipart/form-data/non-string-float",
   method: "post",
   request: {
-    body: { temperature: 0.5 },
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
+    body: multipart({
+      parts: { temperature: 0.5 },
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkFloat]),
   kind: "MockApiDefinition",
 });
+
+// Helper function to check file in multipart for File type tests
+function checkMultipartFile(
+  req: MockRequest,
+  file: Record<string, any>,
+  expectedContent: Buffer,
+  expectedContentType: string,
+  fieldName: string = "file",
+  expectedFileName?: string,
+) {
+  req.expect.deepEqual(file.fieldname, fieldName);
+  req.expect.deepEqual(file.mimetype, expectedContentType);
+  req.expect.deepEqual(file.buffer, expectedContent);
+  if (expectedFileName) {
+    req.expect.deepEqual(file.originalname, expectedFileName);
+  }
+}
+
+// Multipart File type tests
+Scenarios.Payload_MultiPart_FormData_File_uploadFileSpecificContentType = passOnSuccess({
+  uri: "/multipart/form-data/file/specific-content-type",
+  method: "post",
+  request: {
+    headers: {
+      "content-type": "multipart/form-data",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    if (req.files instanceof Array && req.files.length === 1) {
+      const file = req.files[0];
+      checkMultipartFile(req, file, pngFile, "image/png", "file", "image.png");
+      return { status: 204 };
+    } else {
+      throw new ValidationError("Expected exactly one file", "1 file", req.files);
+    }
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_MultiPart_FormData_File_uploadFileRequiredFilename = passOnSuccess({
+  uri: "/multipart/form-data/file/required-filename",
+  method: "post",
+  request: {
+    headers: {
+      "content-type": "multipart/form-data",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    if (req.files instanceof Array && req.files.length === 1) {
+      const file = req.files[0];
+      checkMultipartFile(req, file, pngFile, "image/png", "file", "image.png");
+      return { status: 204 };
+    } else {
+      throw new ValidationError("Expected exactly one file", "1 file", req.files);
+    }
+  },
+  kind: "MockApiDefinition",
+});
+
+Scenarios.Payload_MultiPart_FormData_File_uploadFileArray = passOnSuccess({
+  uri: "/multipart/form-data/file/file-array",
+  method: "post",
+  request: {
+    headers: {
+      "content-type": "multipart/form-data",
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    if (req.files instanceof Array && req.files.length === 2) {
+      for (const file of req.files) {
+        req.expect.deepEqual(file.fieldname, "files");
+        checkMultipartFile(req, file, pngFile, "image/png", "files");
+      }
+      return { status: 204 };
+    } else {
+      throw new ValidationError("Expected exactly two files", "2 files", req.files);
+    }
+  },
+  kind: "MockApiDefinition",
+});