TypeScript
import * as Node from "@effect/platform-node/NodeMultipartParser"
import * as ByteSize from "effect/ByteSize"
import * as Multipart from "effect/http/MultipartParser"
import { assert, describe, expectTypeOf, test } from "vitest"
type Expected = Array<
| [type: "field", name: string, value: string, contentType: string]
| [
type: "file",
name: string,
bytesReceived: number,
filename: string,
contentType: string
]
>
interface MultipartCase {
readonly config?: Partial<Multipart.Config>
readonly name: string
readonly source: ReadonlyArray<string>
readonly boundary: string
readonly expected: Expected
readonly errors?: ReadonlyArray<Multipart.MultipartError["_tag"]>
}
const cases: ReadonlyArray<MultipartCase> = [
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_0\"",
"",
"super alpha file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_1\"",
"",
"super beta file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"1k_a.dat\"",
"Content-Type: application/octet-stream",
"",
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_1\"; filename=\"1k_b.dat\"",
"Content-Type: application/octet-stream",
"",
"BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
["field", "file_name_0", "super alpha file", "text/plain"],
["field", "file_name_1", "super beta file", "text/plain"],
["file", "upload_file_0", 1023, "1k_a.dat", "application/octet-stream"],
["file", "upload_file_1", 1023, "1k_b.dat", "application/octet-stream"]
],
name: "Fields and files"
},
{
source: [
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k\r\n",
`Content-Disposition: form-data; name="file_name_0"\r\n`,
"\r\n",
"super alpha file\r\n",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k\r\n",
"Content-Disposition: form-data; name=\"file_name_1\"\r\n",
"\r\n",
"super beta file\r\n",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k\r\n",
`Content-Disposition: form-data; name="upload_file_0"; filename="1k_a.dat"\r\n`,
"Content-Type: application/octet-stream\r\n",
"\r\n",
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"A".repeat(1024 * 1024),
"\r\n-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
["field", "file_name_0", "super alpha file", "text/plain"],
["field", "file_name_1", "super beta file", "text/plain"],
[
"file",
"upload_file_0",
1024 * 1024 * 10,
"1k_a.dat",
"application/octet-stream"
]
],
name: "Fields and large file"
},
{
source: [
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k\r\n",
"Content-Disposition: form-data; name=\"file_name_0\"\r\n",
"\r\n",
"super alpha file\r\n",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [["field", "file_name_0", "super alpha file", "text/plain"]],
name: "Headers over multiple chunks",
errors: []
},
{
source: [
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_0\"",
"",
"super alpha file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
]
.join("\r\n")
.split(""),
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [["field", "file_name_0", "super alpha file", "text/plain"]],
name: "Headers over single byte chunks",
errors: []
},
{
source: [
[
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"cont\"",
"",
"some random content",
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"pass\"",
"",
"some random pass",
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"bit\"",
"",
"2",
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY--"
].join("\r\n")
],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
expected: [
["field", "cont", "some random content", "text/plain"],
["field", "pass", "some random pass", "text/plain"],
["field", "bit", "2", "text/plain"]
],
name: "Fields only"
},
{
source: [
[
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"first\"",
"",
"A".repeat(32),
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"second\"",
"",
"B".repeat(32),
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY--"
].join("\r\n")
],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
config: {
maxPartSize: ByteSize.bytes(100)
},
expected: [
["field", "first", "A".repeat(32), "text/plain"],
["field", "second", "B".repeat(32), "text/plain"]
],
errors: [],
name: "Resets maxPartSize between field parts"
},
{
source: [],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
expected: [],
errors: ["EndNotReached"],
name: "No fields and no files"
},
{
source: [
"--boundary\r\ncontent-disposition: form-data; nam"
],
boundary: "boundary",
expected: [],
errors: ["EndNotReached"],
name: "Truncated mid-header"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_0\"",
"",
"super alpha file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"1k_a.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
config: {
maxFieldSize: ByteSize.bytes(5)
},
expected: [],
errors: ["ReachedLimit"],
name: "stops after maxFieldSize is exceeded"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"1k_a.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
config: {
maxPartSize: ByteSize.bytes(13)
},
expected: [],
errors: ["ReachedLimit"],
name: "stops after maxPartSize is exceeded"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_0\"",
"",
"super alpha file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"1k_a.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
config: {
maxParts: 0
},
expected: [],
errors: ["ReachedLimit"],
name: "stops before the first part when maxParts is 0"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_0\"",
"",
"super alpha file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file_name_1\"",
"",
"super beta file",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"1k_a.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
config: {
maxParts: 1
},
errors: ["ReachedLimit"],
expected: [["field", "file_name_0", "super alpha file", "text/plain"]],
name: "stops after maxParts is exceeded"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"/absolute/1k_a.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_1\"; filename=\"C:\\absolute\\1k_b.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_2\"; filename=\"relative/1k_c.dat\"",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
[
"file",
"upload_file_0",
26,
"/absolute/1k_a.dat",
"application/octet-stream"
],
[
"file",
"upload_file_1",
26,
"C:\\absolute\\1k_b.dat",
"application/octet-stream"
],
[
"file",
"upload_file_2",
26,
"relative/1k_c.dat",
"application/octet-stream"
]
],
name: "Paths to be preserved"
},
{
source: [
[
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"cont\"",
"Content-Type: ",
"",
"some random content",
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: ",
"",
"some random pass",
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY--"
].join("\r\n")
],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
expected: [
["field", "cont", "some random content", "text/plain"]
],
errors: ["InvalidDisposition"],
name: "Empty content-type and empty content-disposition"
},
{
config: {
isFile: (_) => _.name !== "upload_file_0"
},
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"blob\"",
"Content-Type: application/json",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
[
"field",
"upload_file_0",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"application/json"
]
],
name: "Blob uploads should be handled as fields if isFile is provided."
},
{
config: {
isFile: (_) => _.name !== "upload_file_0"
},
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"blob\"",
"Content-Type: application/json",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file\"; filename*=utf-8''n%C3%A4me.txt",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
[
"field",
"upload_file_0",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"application/json"
],
["file", "file", 26, "näme.txt", "application/octet-stream"]
],
name: "Blob uploads should be handled as fields if isFile is provided. Other parts should be files."
},
{
config: {
isFile: (_) => _.name === "upload_file_0"
},
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"upload_file_0\"; filename=\"blob\"",
"Content-Type: application/json",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file\"; filename*=utf-8''n%C3%A4me.txt",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
["file", "upload_file_0", 26, "blob", "application/json"],
[
"field",
"file",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"application/octet-stream"
]
],
name: "Blob uploads sould be handled as files if corresponding isFile is provided. Other parts should be fields."
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file\"; filename*=utf-8''n%C3%A4me.txt",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [["file", "file", 26, "näme.txt", "application/octet-stream"]],
name: "Unicode filenames"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"file\"; filename*=utf-8''%ZZ",
"Content-Type: application/octet-stream",
"",
"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [],
errors: ["InvalidDisposition"],
name: "Malformed encoded filenames"
},
{
source: [
[
"--asdasdasdasd\r\n",
"Content-Type: text/plain\r\n",
"Content-Disposition: form-data; name=\"foo\"\r\n",
"\r\n",
"asd\r\n",
"--asdasdasdasd--"
].join(":)")
],
boundary: "asdasdasdasd",
expected: [],
errors: ["BadHeaders", "EndNotReached"],
name: "Stopped mid-header"
},
{
source: [
[
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY",
"Content-Disposition: form-data; name=\"cont\"",
"Content-Type: application/json",
"",
"{}",
"------WebKitFormBoundaryTB2MiQ36fnSJlrhY--"
].join("\r\n")
],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
expected: [["field", "cont", "{}", "application/json"]],
name: "content-type for fields"
},
{
source: ["------WebKitFormBoundaryTB2MiQ36fnSJlrhY--\r\n"],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
expected: [],
name: "empty form"
},
{
source: [
[
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"field1\"",
"content-type: text/plain; charset=utf-8",
"",
"Aufklärung ist der Ausgang des Menschen aus seiner selbstverschuldeten Unmündigkeit.",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
"Content-Disposition: form-data; name=\"field2\"",
"content-type: text/plain; charset=iso-8859-1",
"",
"sapere aude!",
"-----------------------------paZqsnEHRufoShdX6fh0lUhXBP4k--"
].join("\r\n")
],
boundary: "---------------------------paZqsnEHRufoShdX6fh0lUhXBP4k",
expected: [
[
"field",
"field1",
"Aufklärung ist der Ausgang des Menschen aus seiner selbstverschuldeten Unmündigkeit.",
"text/plain"
],
["field", "field2", "sapere aude!", "text/plain"]
],
name: "Fields and files"
},
{
source: [
[
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"regsubmit\"",
"",
"yes",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"referer\"",
"",
"http://domainExample/./",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"activationauth\"",
"",
"",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"seccodemodid\"",
"",
"member::register",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7--"
].join("\r\n")
],
boundary: "----WebKitFormBoundaryzca7IDMnT6QwqBp7",
expected: [
["field", "regsubmit", "yes", "text/plain"],
["field", "referer", "http://domainExample/./", "text/plain"],
["field", "activationauth", "", "text/plain"],
["field", "seccodemodid", "member::register", "text/plain"]
],
name: "one empty part should get ignored"
},
{
source: [" ------WebKitFormBoundaryTB2MiQ36fnSJlrhY--\r\n"],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhY",
expected: [],
errors: ["EndNotReached"],
name: "empty form with preceding whitespace"
},
{
source: ["------WebKitFormBoundaryTB2MiQ36fnSJlrhY--\r\n"],
boundary: "----WebKitFormBoundaryTB2MiQ36fnSJlrhYY",
expected: [],
errors: ["EndNotReached"],
name: "empty form with wrong boundary (extra Y)"
},
{
source: [
[
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"regsubmit\"",
"",
"yes",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"referer\"",
"",
"http://domainExample/./",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"activationauth\"",
"",
"",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7",
"Content-Disposition: form-data; name=\"seccodemodid\"",
"",
"member::register",
"------WebKitFormBoundaryzca7IDMnT6QwqBp7--"
].join("\r\n")
],
boundary: "----WebKitFormBoundaryzca7IDMnT6QwqBp7",
expected: [
["field", "regsubmit", "yes", "text/plain"],
["field", "referer", "http://domainExample/./", "text/plain"],
["field", "activationauth", "", "text/plain"],
["field", "seccodemodid", "member::register", "text/plain"]
],
name: "multiple empty parts should get ignored"
}
]
describe("multipart", () => {
test.each(cases)("$name", (opts) => {
const parts: Expected = []
const errors: Array<Multipart.MultipartError["_tag"]> = []
const parser = Multipart.make({
...opts.config,
headers: {
"content-type": "multipart/form-data; boundary=" + opts.boundary
},
onFile: (info) => {
let size = 0
return (chunk) => {
if (chunk) {
size += chunk.length
} else {
parts.push([
"file",
info.name,
size,
info.filename!,
info.contentType
])
}
}
},
onField: (info, value) => {
parts.push([
"field",
info.name,
Multipart.decodeField(info, value),
info.contentType
])
},
onError: (error) => {
errors.push(error._tag)
},
onDone: () => {}
})
opts.source.forEach((chunk) => {
parser.write(new TextEncoder().encode(chunk))
})
parser.end()
assert.deepStrictEqual(opts.expected, parts)
if (opts.errors) {
assert.deepEqual(opts.errors, errors)
}
})
})
describe("node api", () => {
test("exposes missing filenames as undefined", () => {
const parser = Node.make({
headers: {
"content-type": "multipart/form-data; boundary=boundary"
}
})
let emitted = false
parser.on("file", (file) => {
emitted = true
expectTypeOf(file.filename).toEqualTypeOf<string | undefined>()
assert.strictEqual(file.filename, undefined)
file.resume()
})
parser.write(
new TextEncoder().encode(
"--boundary\r\nContent-Disposition: form-data; name=\"file\"\r\nContent-Type: application/octet-stream\r\n\r\ncontent\r\n--boundary--"
)
)
parser.end()
assert.isTrue(emitted)
parser.destroy()
})
test("stops sending file chunks after an error", () => {
const parser = Node.make({
headers: {
"content-type": "multipart/form-data; boundary=boundary"
},
maxPartSize: ByteSize.bytes(100)
})
let file: Node.FileStream | undefined
parser.on("file", (part) => {
file = part
part.on("error", () => {})
})
parser.on("error", () => {})
parser.write(
new TextEncoder().encode(
"--boundary\r\nContent-Disposition: form-data; name=\"file\"; filename=\"a.txt\"\r\n\r\nA"
)
)
parser.write(new TextEncoder().encode("B".repeat(128)))
assert.strictEqual(file?.read().toString(), "A")
file?.destroy()
parser.destroy()
})
test.each(cases)("$name", (opts) => {
const parts: Expected = []
const errors: Array<Multipart.MultipartError["_tag"]> = []
const parser = Node.make({
...opts.config,
headers: {
"content-type": "multipart/form-data; boundary=" + opts.boundary
}
})
parser.on("field", (field) => {
parts.push([
"field",
field.info.name,
Multipart.decodeField(field.info, field.value),
field.info.contentType
])
})
parser.on("file", (file) => {
let size = 0
file.on("data", (chunk) => {
size += chunk.length
})
file.on("end", () => {
parts.push([
"file",
file.info.name,
size,
file.info.filename!,
file.info.contentType
])
})
})
parser.on("error", (error) => {
errors.push(error._tag)
})
parser.on("end", () => {
assert.deepStrictEqual(opts.expected, parts)
if (opts.errors) {
assert.deepEqual(opts.errors, errors)
}
})
opts.source.forEach((chunk) => {
parser.write(new TextEncoder().encode(chunk))
})
parser.end()
})
})
describe("node async-iterable api", () => {
test.each(cases)("$name", async (opts) => {
const parts: Expected = []
const parser = Node.make({
...opts.config,
headers: {
"content-type": "multipart/form-data; boundary=" + opts.boundary
}
})
async function read() {
for await (const part of parser) {
if (part._tag === "Field") {
parts.push([
"field",
part.info.name,
Multipart.decodeField(part.info, part.value),
part.info.contentType
])
} else {
let size = 0
for await (const chunk of part) {
size += chunk.length
}
parts.push([
"file",
part.info.name,
size,
part.info.filename!,
part.info.contentType
])
}
}
}
const readPromise = read()
opts.source.forEach((chunk) => {
parser.write(new TextEncoder().encode(chunk))
})
parser.end()
try {
await readPromise
assert.deepStrictEqual(opts.expected, parts)
} catch (err) {
if (opts.errors) {
assert.strictEqual((err as any)._tag, opts.errors[0])
}
}
})
})
// Synchronous parsing can starve the async suites.
describe("random data", { concurrent: false }, () => {
test("smoke test", () => {
const boundary = "------WebKitFormBoundaryTB2MiQ36fnSJlrhY--"
let seed = 0x9e3779b9
const random = () => {
seed ^= seed << 13
seed ^= seed >>> 17
seed ^= seed << 5
return (seed >>> 0) / 0x1_0000_0000
}
for (let i = 0; i < 100; i++) {
const size = Math.round(random() * 1024 * 1024)
// Fill bytes 0-99 include CR, LF and "-", which partially match the boundary.
const data = Buffer.alloc(size, i)
let success = false
let received = 0
const parser = Multipart.make({
headers: {
"content-type": `multipart/form-data; boundary=${boundary}`
},
onDone() {
success = true
},
onFile() {
return (chunk) => {
if (chunk) received += chunk.length
}
},
onField() {},
onError() {}
})
const buffer = Buffer.concat([
Buffer.from(`--${boundary}\r\n`),
Buffer.from(
"Content-Disposition: form-data; name=\"file\"; filename=\"blob\"\r\n"
),
Buffer.from("Content-Type: application/octet-stream\r\n"),
Buffer.from("\r\n"),
data,
Buffer.from(`\r\n--${boundary}--`)
])
let cursor = 0
while (cursor < buffer.length) {
const maxChunkSize = buffer.length - cursor
const chunkSize = Math.max(
1,
Math.min(
Math.round(random() * 1.28 * 1024 * 1024),
maxChunkSize
)
)
parser.write(buffer.subarray(cursor, cursor + chunkSize))
cursor += chunkSize
}
parser.end()
assert.isTrue(success)
assert.strictEqual(received, size)
}
})
})