Skip sending header if headerParams is undefined or null (#587)

ec8f828#commitcomment-132344857

Author: tokuhirom

generator/src/main/resources/line-bot-sdk-nodejs-generator/apiBody/normal.pebble

@@ -21,7 +21,7 @@
     {% endif %}
     {% if op.hasHeaderParams %}const headerParams = {
         {% for param in op.headerParams -%}
-            "{{param.baseName}}": {{param.paramName}},
+            ...({{ param.paramName }} != null ? {"{{param.baseName}}": {{param.paramName}}} : {}),
         {% endfor %}
         };
     {% endif %}

lib/messaging-api/api/messagingApiClient.ts

@@ -129,7 +129,7 @@ export class MessagingApiClient {
     const params = broadcastRequest;
 
     const headerParams = {
-      "X-Line-Retry-Key": xLineRetryKey,
+      ...(xLineRetryKey != null ? { "X-Line-Retry-Key": xLineRetryKey } : {}),
     };
 
     const res = this.httpClient.post<object>(
@@ -784,7 +784,7 @@ export class MessagingApiClient {
     const params = multicastRequest;
 
     const headerParams = {
-      "X-Line-Retry-Key": xLineRetryKey,
+      ...(xLineRetryKey != null ? { "X-Line-Retry-Key": xLineRetryKey } : {}),
     };
 
     const res = this.httpClient.post<object>(
@@ -809,7 +809,7 @@ export class MessagingApiClient {
     const params = narrowcastRequest;
 
     const headerParams = {
-      "X-Line-Retry-Key": xLineRetryKey,
+      ...(xLineRetryKey != null ? { "X-Line-Retry-Key": xLineRetryKey } : {}),
     };
 
     const res = this.httpClient.post<object>(
@@ -834,7 +834,7 @@ export class MessagingApiClient {
     const params = pushMessageRequest;
 
     const headerParams = {
-      "X-Line-Retry-Key": xLineRetryKey,
+      ...(xLineRetryKey != null ? { "X-Line-Retry-Key": xLineRetryKey } : {}),
     };
 
     const res = this.httpClient.post<PushMessageResponse>(
@@ -859,7 +859,9 @@ export class MessagingApiClient {
     const params = pnpMessagesRequest;
 
     const headerParams = {
-      "X-Line-Delivery-Tag": xLineDeliveryTag,
+      ...(xLineDeliveryTag != null
+        ? { "X-Line-Delivery-Tag": xLineDeliveryTag }
+        : {}),
     };
 
     const res = this.httpClient.post(

test/libs-messagingApi.spec.ts

@@ -89,4 +89,35 @@ describe("messagingApi", () => {
     equal(requestCount, 1);
     deepEqual(res, {});
   });
+
+  it("pushMessage without xLineRetryKey", async () => {
+    let requestCount = 0;
+    server.use(
+      http.post(
+        "https://api.line.me/v2/bot/message/push",
+        ({ request, params, cookies }) => {
+          requestCount++;
+
+          equal(
+            request.headers.get("Authorization"),
+            "Bearer test_channel_access_token",
+          );
+          equal(
+            request.headers.get("User-Agent"),
+            `${pkg.name}/${pkg.version}`,
+          );
+          equal(request.headers.get("content-type"), "application/json");
+          equal(request.headers.get("x-line-retry-key"), undefined);
+          return HttpResponse.json({});
+        },
+      ),
+    );
+
+    const res = await client.pushMessage(
+      { to: "uAAAAAAAAAAAAAA", messages: [{ type: "text", text: "aaaaaa" }] },
+      undefined,
+    );
+    equal(requestCount, 1);
+    deepEqual(res, {});
+  });
 });

test/middleware.spec.ts

@@ -58,7 +58,6 @@ describe("middleware", () => {
     deepEqual(req.body.events, [webhook]);
   }).timeout(6000);
 
-
   it("succeed with pre-parsed string", async () => {
     await http().post(`/mid-text`, {
       events: [webhook],