added channel not supported error

Author: Bhupesh-mfsi

packages/backend/src/notifications.ts

@@ -4,7 +4,10 @@ import { normalizeEnsName } from '@dm3-org/dm3-lib-profile';
 import express from 'express';
 import { auth } from './utils';
 import { validateNotificationChannel } from './validation/notification/notificationChannelValidation';
-import { addNewNotificationChannel } from '@dm3-org/dm3-lib-delivery';
+import {
+    ChannelNotSupportedError,
+    addNewNotificationChannel,
+} from '@dm3-org/dm3-lib-delivery';
 import { getDeliveryServiceProperties } from './config/getDeliveryServiceProperties';
 import { IDatabase } from './persistance/getDatabase';
 
@@ -65,12 +68,12 @@ export default () => {
 
     // Defining a route to handle POST requests for adding an notification channel
     router.post('/:ensName', async (req, res, next) => {
+        // Extracting recipientValue & notificationChannelType from the request body
+        const { recipientValue, notificationChannelType } = req.body;
+
         try {
             const account = normalizeEnsName(req.params.ensName);
 
-            // Extracting recipientValue & notificationChannelType from the request body
-            const { recipientValue, notificationChannelType } = req.body;
-
             // Validate req.body data
             const { isValid, errorMessage } = validateNotificationChannel(
                 notificationChannelType,
@@ -106,9 +109,19 @@ export default () => {
                 // Sending a success response
                 res.sendStatus(200);
             }
-        } catch (e) {
-            // Passing the error to the next middleware
-            next(e);
+        } catch (e: any) {
+            if (
+                e instanceof ChannelNotSupportedError ||
+                e.message === 'Invalid config.yml'
+            ) {
+                // return the error for not supported channels
+                res.sendStatus(400).json({
+                    error: `Notification channel ${notificationChannelType} is currently not supported yet by the DS`,
+                });
+            } else {
+                // Passing the error to the next middleware
+                next(e);
+            }
         }
     });
 

packages/lib/delivery/src/Notification.ts

@@ -1,3 +1,4 @@
+import { ChannelNotSupportedError } from './errors/ChannelNotSupportedError';
 import {
     NotificationBroker,
     NotificationChannel,
@@ -42,7 +43,9 @@ export async function addNewNotificationChannel(
     );
 
     if (!channelUsed.length) {
-        throw Error('Notification channel not supported');
+        throw new ChannelNotSupportedError(
+            'Notification channel not supported',
+        );
     }
 
     // Adding a user's notification channel to the database
@@ -82,7 +85,7 @@ const getOtpContentForNotificationChannel = (
                 dm3ContactEmailID: notificationChannel.config.smtpEmail,
             };
         default:
-            throw Error(
+            throw new ChannelNotSupportedError(
                 `Invalid notification channel ${notificationChannel.type}`,
             );
     }

packages/lib/delivery/src/errors/ChannelNotSupportedError.ts

@@ -0,0 +1,7 @@
+// Error class for channels not supported by delivery services
+export class ChannelNotSupportedError extends Error {
+    constructor(msg: string) {
+        super(msg);
+        Object.setPrototypeOf(this, ChannelNotSupportedError.prototype);
+    }
+}

packages/lib/delivery/src/index.ts

@@ -18,3 +18,4 @@ export type { DeliveryServiceProperties } from './Delivery';
 export * from './notifications';
 export { NotificationChannelType } from './notifications';
 export { addNewNotificationChannel } from './Notification';
+export { ChannelNotSupportedError } from './errors/ChannelNotSupportedError';

packages/lib/delivery/src/notifications/broker/NotificationBroker.ts

@@ -8,6 +8,7 @@ import {
     INotificationChannel,
     NotificationType,
 } from '../types';
+import { ChannelNotSupportedError } from '../../errors/ChannelNotSupportedError';
 
 /**
  * Sets up the notification broker with supported notification channels.
@@ -35,7 +36,7 @@ export const _setupNotficationBroker = (
                     supportedChannels.find((c) => c.type === channel.type);
                 //User specified a channel that is not supported
                 if (!deliveryServiceNotificationChannel) {
-                    throw new Error(
+                    throw new ChannelNotSupportedError(
                         `Channel type ${channel.type} is not supported`,
                     );
                 }
@@ -73,7 +74,7 @@ export const _setupNotficationBroker = (
         );
 
         if (!deliveryServiceNotificationChannel) {
-            throw new Error(
+            throw new ChannelNotSupportedError(
                 `Channel type ${filteredChannel[0].type} is not supported`,
             );
         } else {
@@ -107,7 +108,7 @@ export const NotificationBroker = (
                     send: Email(channel.config).send,
                 };
             default:
-                throw new Error(
+                throw new ChannelNotSupportedError(
                     `Channel type ${channel.type} is not supported`,
                 );
         }