Skip to content

Fix Array-type query parameter #1362

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
merged 2 commits into from
Aug 8, 2025
Merged

Fix Array-type query parameter #1362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8169b2b
Fix Array-type query parameter
habara-k Aug 7, 2025
de7c819
Add tests
habara-k Aug 7, 2025
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
4 changes: 4 additions & 0 deletions generator/src/main/resources/line-bot-sdk-nodejs-generator/apiBody/normal.pebble
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@
});
{% elseif op.hasQueryParams %}const queryParams = {
{% for param in op.queryParams -%}
{% if param.isArray -%}
"{{param.paramName}}": [...{{param.paramName}}].join(","),
{% else -%}
"{{param.paramName}}": {{param.paramName}},
{% endif -%}
{% endfor %}
};
Object.keys(queryParams).forEach((key: keyof typeof queryParams) => {
Expand Down
30 changes: 28 additions & 2 deletions generator/src/main/resources/line-bot-sdk-nodejs-generator/api_test.pebble
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,32 @@ function parseForm(
new Blob([]), // paramName={{ param.paramName }}
{% elseif param.isModel -%}
{} as unknown as {{ param.dataType }}, // paramName={{ param.paramName }}
{% elseif param.isArray -%}
new Set(["DUMMY1", "DUMMY2"]) as unknown as {{ param.dataType }},
{% elseif param.isEnum -%}
"DUMMY" as unknown as {{ param.dataType }}, // paramName={{ param.paramName }}(enum)
{% elseif param.isExplode -%}
"DUMMY" as unknown as {{ param.dataType}}, // paramName={{param.paramName}}(enum)
{% elseif param.isString -%}
"DUMMY", // {{param.paramName}}(string)
{% elseif param.isNumber or param.isInteger or param.isLong -%}
0, // paramName={{param.paramName}}(number or int or long)
{% elseif param.isBoolean -%}
true, // paramName={{param.paramName}}
{% else -%}
// UNKNOWN TYPE: paramName={{param.paramName}} {{ param.dataType }}
{% endif -%}
{% endmacro %}

{% macro paramDummyValueString(param) %}
{# @pebvariable name="param" type="org.openapitools.codegen.CodegenParameter" #}
// {{ param.paramName }}: {{ param.dataType }}
{% if param.isFile -%}
new Blob([]), // paramName={{ param.paramName }}
{% elseif param.isModel -%}
{} as unknown as {{ param.dataType }}, // paramName={{ param.paramName }}
{% elseif param.isArray -%}
"DUMMY1,DUMMY2" as unknown as {{ param.dataType }},
{% elseif param.isEnum -%}
"DUMMY" as unknown as {{ param.dataType }}, // paramName={{ param.paramName }}(enum)
{% elseif param.isExplode -%}
Expand Down Expand Up @@ -111,7 +137,7 @@ function parseForm(
// Query parameters
const queryParams = new URLSearchParams(reqUrl.search);
{% for param in op.queryParams -%}
equal(queryParams.get("{{param.paramName}}"), String({{ paramDummyValue(param) }}));
equal(queryParams.get("{{param.paramName}}"), String({{ paramDummyValueString(param) }}));
{% endfor %}
{% endif %}
{% if authMethods != null -%}
Expand Down Expand Up @@ -148,7 +174,7 @@ function parseForm(
// Form parameters
const formData = parseForm(arrayBuffer);
{% for param in op.formParams -%}
equal(formData["{{param.paramName}}"], String({{ paramDummyValue(param) }}));
equal(formData["{{param.paramName}}"], String({{ paramDummyValueString(param) }}));
{% endfor %}

res.writeHead(200, { "Content-Type": "application/json" });
Expand Down
2 changes: 1 addition & 1 deletion lib/messaging-api/api/messagingApiClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1583,7 +1583,7 @@ export class MessagingApiClient {
limit?: number,
): Promise<Types.ApiResponseType<MessagingApiPagerCouponListResponse>> {
const queryParams = {
status: status,
status: [...status].join(","),
start: start,
limit: limit,
};
Expand Down
12 changes: 8 additions & 4 deletions lib/messaging-api/tests/api/MessagingApiClientTest.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4242,7 +4242,7 @@ describe("MessagingApiClient", () => {
queryParams.get("status"),
String(
// status: Set<'DRAFT' | 'RUNNING' | 'CLOSED'>
"DUMMY" as unknown as Set<"DRAFT" | "RUNNING" | "CLOSED">, // paramName=status(enum)
"DUMMY1,DUMMY2" as unknown as Set<"DRAFT" | "RUNNING" | "CLOSED">,
),
);
equal(
Expand Down Expand Up @@ -4283,7 +4283,9 @@ describe("MessagingApiClient", () => {

const res = await client.listCouponWithHttpInfo(
// status: Set<'DRAFT' | 'RUNNING' | 'CLOSED'>
"DUMMY" as unknown as Set<"DRAFT" | "RUNNING" | "CLOSED">, // paramName=status(enum)
new Set(["DUMMY1", "DUMMY2"]) as unknown as Set<
"DRAFT" | "RUNNING" | "CLOSED"
>,

// start: string
"DUMMY" as unknown as string, // paramName=start(enum)
Expand Down Expand Up @@ -4317,7 +4319,7 @@ describe("MessagingApiClient", () => {
queryParams.get("status"),
String(
// status: Set<'DRAFT' | 'RUNNING' | 'CLOSED'>
"DUMMY" as unknown as Set<"DRAFT" | "RUNNING" | "CLOSED">, // paramName=status(enum)
"DUMMY1,DUMMY2" as unknown as Set<"DRAFT" | "RUNNING" | "CLOSED">,
),
);
equal(
Expand Down Expand Up @@ -4358,7 +4360,9 @@ describe("MessagingApiClient", () => {

const res = await client.listCoupon(
// status: Set<'DRAFT' | 'RUNNING' | 'CLOSED'>
"DUMMY" as unknown as Set<"DRAFT" | "RUNNING" | "CLOSED">, // paramName=status(enum)
new Set(["DUMMY1", "DUMMY2"]) as unknown as Set<
"DRAFT" | "RUNNING" | "CLOSED"
>,

// start: string
"DUMMY" as unknown as string, // paramName=start(enum)
Expand Down
49 changes: 49 additions & 0 deletions test/libs-messagingApi.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,55 @@ describe("messagingApi", () => {
});
});

it("get coupon list", async () => {
let requestCount = 0;
server.use(
http.get(
"https://api.line.me/v2/bot/coupon",
async ({ request, params, cookies }) => {
requestCount++;

equal(
request.headers.get("authorization"),
"Bearer test_channel_access_token",
);
equal(request.headers.get("User-Agent"), "@line/bot-sdk/1.0.0-test");

const url = new URL(request.url);
const searchParams = url.searchParams;
equal(searchParams.get("status"), "DRAFT,RUNNING,CLOSED");
equal(searchParams.get("start"), "xBQU2IB");
equal(searchParams.get("limit"), "100");

return HttpResponse.json({
items: [
{
couponId: "coupon_id_1",
title: "coupon 1",
},
],
next: "yANU9IA..",
});
},
),
);

const res = await client.listCoupon(
new Set(["DRAFT", "RUNNING", "CLOSED"]),
"xBQU2IB",
100,
);
deepEqual(res, {
items: [
{
couponId: "coupon_id_1",
title: "coupon 1",
},
],
next: "yANU9IA..",
});
});

it("config is not overrided", async () => {
const config = {
channelAccessToken: "token-token",
Expand Down