Add destination field (#102)

* Add new WebhookRequestBody type

To handle 'destination' field.

* Fix middleware tests to handle 'destination' field

* Update docs to mention of 'destination' field

* Make originalError of HTTPError public

Also make it any.

* [kitchensink] Add console.log for destination

* Use valid destintion for tests

* Make destination a required field

Author: Hyunje Jun

docs/api-reference/middleware.md

@@ -37,7 +37,8 @@ app.use(middleware(config))
 
 // or directly with handler
 app.post('/webhook', middleware(config), (req, res) => {
-  req.body.events // will include webhook events
+  req.body.events // webhook event objects
+  req.body.destination // user ID of the bot (optional)
   ...
 })
 ```

docs/guide/webhook.md

@@ -67,7 +67,9 @@ const config = {
 }
 
 app.post('/webhook', middleware(config), (req, res) => {
-  res.json(req.body.events) // req.body will be webhook event object
+  req.body.events // webhook event objects
+  req.body.destination // user ID of the bot (optional)
+  ...
 })
 
 app.listen(8080)

examples/kitchensink/index.js

@@ -31,6 +31,10 @@ app.get('/callback', (req, res) => res.end(`I'm listening. Please access with PO
 
 // webhook callback
 app.post('/callback', line.middleware(config), (req, res) => {
+  if (req.body.destination) {
+    console.log("Destination User ID: " + req.body.destination);
+  }
+
   // req.body.events should be an array of events
   if (!Array.isArray(req.body.events)) {
     return res.status(500).end();

lib/exceptions.ts

@@ -31,7 +31,7 @@ export class HTTPError extends Error {
     message: string,
     public statusCode: number,
     public statusMessage: string,
-    private originalError: Error,
+    public originalError: any,
   ) {
     super(message);
   }

lib/types.ts

@@ -18,6 +18,23 @@ export type Profile = {
   statusMessage: string;
 };
 
+/**
+ * Request body which is sent by webhook.
+ *
+ * @see [Request body](https://developers.line.me/en/reference/messaging-api/#request-body)
+ */
+export type WebhookRequestBody = {
+  /**
+   * User ID of a bot that should receive webhook events. The user ID value is a string that matches the regular expression, U[0-9a-f]{32}.
+   */
+  destination: string;
+
+  /**
+   * Information about the event
+   */
+  events: Array<WebhookEvent>;
+};
+
 /**
  * JSON objects which contain events generated on the LINE Platform.
  *

test/middleware.spec.ts

@@ -11,13 +11,13 @@ const TEST_PORT = parseInt(process.env.TEST_PORT, 10);
 
 const m = middleware({ channelSecret: "test_channel_secret" });
 
-const getRecentReq = (): any =>
+const getRecentReq = (): { body: Types.WebhookRequestBody } =>
   JSON.parse(readFileSync(join(__dirname, "helpers/request.json")).toString());
 
 describe("middleware", () => {
   const http = (
     headers: any = {
-      "X-Line-Signature": "qeDy61PbQK+aO97Bs8zjaFgYjQxFruGd13pfXPQoBRU=",
+      "X-Line-Signature": "wqJD7WAIZhWcXThMCf8jZnwG3Hmn7EF36plkQGkj48w=",
     },
   ) => new HTTPClient(`http://localhost:${TEST_PORT}`, headers);
 
@@ -43,9 +43,11 @@ describe("middleware", () => {
     return http()
       .post(`/webhook`, {
         events: [webhook],
+        destination: "Uaaaabbbbccccddddeeeeffff",
       })
       .then(() => {
         const req = getRecentReq();
+        deepEqual(req.body.destination, "Uaaaabbbbccccddddeeeeffff");
         deepEqual(req.body.events, [webhook]);
       });
   });
@@ -54,9 +56,11 @@ describe("middleware", () => {
     return http()
       .post(`/mid-text`, {
         events: [webhook],
+        destination: "Uaaaabbbbccccddddeeeeffff",
       })
       .then(() => {
         const req = getRecentReq();
+        deepEqual(req.body.destination, "Uaaaabbbbccccddddeeeeffff");
         deepEqual(req.body.events, [webhook]);
       });
   });
@@ -65,9 +69,11 @@ describe("middleware", () => {
     return http()
       .post(`/mid-buffer`, {
         events: [webhook],
+        destination: "Uaaaabbbbccccddddeeeeffff",
       })
       .then(() => {
         const req = getRecentReq();
+        deepEqual(req.body.destination, "Uaaaabbbbccccddddeeeeffff");
         deepEqual(req.body.events, [webhook]);
       });
   });
@@ -76,19 +82,22 @@ describe("middleware", () => {
     return http()
       .post(`/mid-rawbody`, {
         events: [webhook],
+        destination: "Uaaaabbbbccccddddeeeeffff",
       })
       .then(() => {
         const req = getRecentReq();
+        deepEqual(req.body.destination, "Uaaaabbbbccccddddeeeeffff");
         deepEqual(req.body.events, [webhook]);
       });
   });
 
   it("fails on wrong signature", () => {
     return http({
-      "X-Line-Signature": "qeDy61PbQK+aO97Bs8zjbFgYjQxFruGd13pfXPQoBRU=",
+      "X-Line-Signature": "WqJD7WAIZhWcXThMCf8jZnwG3Hmn7EF36plkQGkj48w=",
     })
       .post(`/webhook`, {
         events: [webhook],
+        destination: "Uaaaabbbbccccddddeeeeffff",
       })
       .catch((err: HTTPError) => {
         equal(err.statusCode, 401);
@@ -107,7 +116,10 @@ describe("middleware", () => {
 
   it("fails on empty signature", () => {
     return http({})
-      .post(`/webhook`, { events: [webhook] })
+      .post(`/webhook`, {
+        events: [webhook],
+        destination: "Uaaaabbbbccccddddeeeeffff",
+      })
       .then((res: any) => {
         throw new Error();
       })