fix: delivery receipt parser (#31)

bin/cli.js

@@ -2,11 +2,17 @@
 
 import { program } from "commander";
 import { createLogger, format, transports } from "winston";
+import "@sentry/tracing";
+import * as Sentry from "@sentry/node";
 
 import SomlengClient from "../lib/somleng_client.js";
 import HTTPServer from "../lib/http_server/index.js";
 import { GoIPGateway, SMPPGateway, DummyGateway } from "../lib/gateways/index.js";
 
+Sentry.init({
+  dsn: "https://b4c80554595b4e75a9904318a8fe005d@o125014.ingest.sentry.io/4504756942864384",
+});
+
 async function main() {
   let options = {};
   let gateway;
@@ -143,5 +149,6 @@ async function main() {
 
 main().catch((error) => {
   console.error(error);
+  Sentry.captureException(error);
   process.exit(1);
 });

lib/gateways/dummy_gateway.js

@@ -4,8 +4,6 @@ class DummyGateway {
   #onSentCallback;
   #onReceivedCallback;
 
-  constructor() {}
-
   async connect() {
     await setTimeoutAsync(1000);
     console.log("DummyGateway.connect() was called");

lib/gateways/smpp_delivery_receipt.js

@@ -0,0 +1,34 @@
+const PATTERN = /^id:(?<messageId>[\w-]+)\ssub:(?<sub>\d+)\sdlvrd:(?<dlvrd>\d+).+stat:(?<stat>\w+)/;
+
+class InvalidMessageFormatError extends Error {}
+class UnsupportedDeliveryStatusError extends Error {}
+
+class SMPPDeliveryReceipt {
+  constructor(params) {
+    this.messageId = params.messageId;
+    this.status = params.status;
+  }
+
+  static parse(message) {
+    const matches = message.match(PATTERN);
+
+    if (matches === null) {
+      throw new InvalidMessageFormatError("Invalid Delivery Message Format");
+    }
+
+    let result = { messageId: matches.groups.messageId };
+    if (matches.groups.stat === "DELIVERED" || matches.groups.stat === "DELIVRD") {
+      result.status = "delivered";
+    } else if (matches.groups.stat === "ENROUTE" || matches.groups.stat === "ENROUTE") {
+      result.status = "sent";
+    } else if (matches.groups.stat === "UNDELIVERABLE" || matches.groups.stat === "UNDELIV") {
+      result.status = "failed";
+    } else {
+      throw new UnsupportedDeliveryStatusError("Unsupported Delivery Status Error");
+    }
+
+    return new SMPPDeliveryReceipt(result);
+  }
+}
+
+export { SMPPDeliveryReceipt, InvalidMessageFormatError, UnsupportedDeliveryStatusError };

lib/gateways/smpp_gateway.js

@@ -1,4 +1,10 @@
+import * as Sentry from "@sentry/node";
 import smpp from "smpp";
+import {
+  SMPPDeliveryReceipt,
+  InvalidMessageFormatError,
+  UnsupportedDeliveryStatusError,
+} from "./smpp_delivery_receipt.js";
 
 class SMPPGateway {
   #onSentCallback;
@@ -60,19 +66,27 @@ class SMPPGateway {
 
   #handleMessageDeliveryReceipt() {
     this.#session.on("deliver_sm", (pdu) => {
+      const rawMessage = pdu.short_message.message;
+
       if (pdu.esm_class === smpp.ESM_CLASS.MC_DELIVERY_RECEIPT) {
-        const matches = pdu.short_message.message.match(
-          /^id:(?<messageId>\d+)\ssub:(?<sub>\d+)\sdlvrd:(?<dlvrd>\d+)/
-        );
-        const deliveryReceipt = { messageId: matches.groups.messageId };
-        deliveryReceipt.status = Number(matches.groups.dlvrd) > 0 ? "sent" : "failed";
-        this.#onSentCallback && this.#onSentCallback(deliveryReceipt);
+        try {
+          const deliveryReceipt = SMPPDeliveryReceipt.parse(rawMessage);
+          this.#onSentCallback && this.#onSentCallback(deliveryReceipt);
+        } catch (error) {
+          if (
+            error instanceof InvalidMessageFormatError ||
+            error instanceof UnsupportedDeliveryStatusError
+          ) {
+            Sentry.captureException(error, { extra: { rawMessage: rawMessage } });
+            console.log("Unsupported delivery receipt message: ", rawMessage);
+          }
+        }
       } else {
         this.#onReceivedCallback &&
           this.#onReceivedCallback({
             source: pdu.source_addr,
             destination: pdu.destination_addr,
-            shortMessage: pdu.short_message.message,
+            shortMessage: rawMessage,
           });
       }
     });

package.json

@@ -16,6 +16,8 @@
   "license": "MIT",
   "dependencies": {
     "@anycable/core": "^0.5.7",
+    "@sentry/node": "^7.39.0",
+    "@sentry/tracing": "^7.39.0",
     "commander": "^9.4.1",
     "smpp": "^0.6.0-rc.4",
     "winston": "^3.8.2",