Skip to content

Add missing multipart test coverage for wire names and optional parts #3692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
v-jiaodi merged 8 commits into from
Jan 29, 2026
Merged

Add missing multipart test coverage for wire names and optional parts #3692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fe43a53
Initial plan
Copilot Jan 21, 2026
2066e36
Initial commit - exploring the repository structure
Copilot Jan 21, 2026
8402d40
Add missing multipart test cases for withWireName and optionalParts
Copilot Jan 21, 2026
84293d5
Fix wire name test and verify all new multipart tests pass
Copilot Jan 21, 2026
6fbf5cb
Add comments explaining type assertions per code review
Copilot Jan 21, 2026
331be4c
Revert accidental deletion of generated type definition files
Copilot Jan 21, 2026
92e0610
Merge branch 'main' into copilot/improve-multipart-payload-case
v-jiaodi Jan 27, 2026
93ecf32
Merge branch 'main' into copilot/improve-multipart-payload-case
MaryGao Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions packages/typespec-ts/test/azureIntegration/multipart.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ describe("MultiPartClient Rest Client", () => {
assert.strictEqual(result.status, "204");
});

it("should support wire name", async () => {
const file = await readFile(imgPath);
const result = await client
.path("/multipart/form-data/mixed-parts-with-wire-name")
.post({
contentType: "multipart/form-data",
body: [
// Using 'as any' because generated types use TypeSpec property names ('identifier', 'image')
// but runtime expects wire names ('id', 'profileImage') per TypeSpec @name annotation
{ name: "id" as any, body: "123" },
{
name: "profileImage" as any,
body: file,
filename: "profileImage.jpg"
}
]
});
assert.strictEqual(result.status, "204");
});

it("supports anonymous model file upload", async () => {
const result = await client
.path("/multipart/form-data/anonymous-model")
Expand All @@ -50,6 +70,45 @@ describe("MultiPartClient Rest Client", () => {
});
});

describe("optional parts", () => {
it("should support id only", async () => {
const result = await client
.path("/multipart/form-data/optional-parts")
.post({
contentType: "multipart/form-data",
body: [{ name: "id", body: "123" }]
});
assert.strictEqual(result.status, "204");
});

it("should support profileImage only", async () => {
const file = await readFile(imgPath);
const result = await client
.path("/multipart/form-data/optional-parts")
.post({
contentType: "multipart/form-data",
body: [
{ name: "profileImage", body: file, filename: "profileImage.jpg" }
]
});
assert.strictEqual(result.status, "204");
});

it("should support both id and profileImage", async () => {
const file = await readFile(imgPath);
const result = await client
.path("/multipart/form-data/optional-parts")
.post({
contentType: "multipart/form-data",
body: [
{ name: "id", body: "123" },
{ name: "profileImage", body: file, filename: "profileImage.jpg" }
]
});
assert.strictEqual(result.status, "204");
});
});

describe("custom content type + filename", () => {
it("raises 400 error when filename and MIME type unspecified", async () => {
const file = await readFile(imgPath);
Expand Down
35 changes: 35 additions & 0 deletions packages/typespec-ts/test/azureModularIntegration/payloadMultipart.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,41 @@ describe("Multipart Client", () => {
});
});

it("multipart request with wire name", async () => {
await client.formData.withWireName({
identifier: "123",
image: {
contents: fs.createReadStream(imgPath),
filename: "test.jpg"
}
});
});

it("optional parts - id only", async () => {
await client.formData.optionalParts({
id: "123"
});
});

it("optional parts - profileImage only", async () => {
await client.formData.optionalParts({
profileImage: {
contents: fs.createReadStream(imgPath),
filename: "test.jpg"
}
});
});

it("optional parts - both id and profileImage", async () => {
await client.formData.optionalParts({
id: "123",
profileImage: {
contents: fs.createReadStream(imgPath),
filename: "test.jpg"
}
});
});

// TODO not supported
it.skip("anonymous model", async () => {
// @ts-ignore - not supported yet
Expand Down
59 changes: 59 additions & 0 deletions packages/typespec-ts/test/integration/multipart.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,26 @@ describe("MultiPartClient Rest Client", () => {
assert.strictEqual(result.status, "204");
});

it("should support wire name", async () => {
const file = await readFile(imgPath);
const result = await client
.path("/multipart/form-data/mixed-parts-with-wire-name")
.post({
contentType: "multipart/form-data",
body: [
// Using 'as any' because generated types use TypeSpec property names ('identifier', 'image')
// but runtime expects wire names ('id', 'profileImage') per TypeSpec @name annotation
{ name: "id" as any, body: "123" },
{
name: "profileImage" as any,
body: file,
filename: "profileImage.jpg"
}
]
});
assert.strictEqual(result.status, "204");
});

it("supports anonymous model file upload", async () => {
const result = await client
.path("/multipart/form-data/anonymous-model")
Expand All @@ -51,6 +71,45 @@ describe("MultiPartClient Rest Client", () => {
});
});

describe("optional parts", () => {
it("should support id only", async () => {
const result = await client
.path("/multipart/form-data/optional-parts")
.post({
contentType: "multipart/form-data",
body: [{ name: "id", body: "123" }]
});
assert.strictEqual(result.status, "204");
});

it("should support profileImage only", async () => {
const file = await readFile(imgPath);
const result = await client
.path("/multipart/form-data/optional-parts")
.post({
contentType: "multipart/form-data",
body: [
{ name: "profileImage", body: file, filename: "profileImage.jpg" }
]
});
assert.strictEqual(result.status, "204");
});

it("should support both id and profileImage", async () => {
const file = await readFile(imgPath);
const result = await client
.path("/multipart/form-data/optional-parts")
.post({
contentType: "multipart/form-data",
body: [
{ name: "id", body: "123" },
{ name: "profileImage", body: file, filename: "profileImage.jpg" }
]
});
assert.strictEqual(result.status, "204");
});
});

describe("custom content type + filename", () => {
it("raises 400 error when filename and MIME type unspecified", async () => {
const file = await readFile(imgPath);
Expand Down
35 changes: 35 additions & 0 deletions packages/typespec-ts/test/modularIntegration/payloadMultipart.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,41 @@ describe("Multipart Client", () => {
});
});

it("multipart request with wire name", async () => {
await client.formData.withWireName({
identifier: "123",
image: {
contents: fs.createReadStream(imgPath),
filename: "test.jpg"
}
});
});

it("optional parts - id only", async () => {
await client.formData.optionalParts({
id: "123"
});
});

it("optional parts - profileImage only", async () => {
await client.formData.optionalParts({
profileImage: {
contents: fs.createReadStream(imgPath),
filename: "test.jpg"
}
});
});

it("optional parts - both id and profileImage", async () => {
await client.formData.optionalParts({
id: "123",
profileImage: {
contents: fs.createReadStream(imgPath),
filename: "test.jpg"
}
});
});

// TODO not supported
it.skip("anonymous model", async () => {
// @ts-ignore - not supported yet
Expand Down
Loading
⚡