Merge pull request #19 from Giveth/f_746_add_editable_field_to_notificationType

Add isEmailEditable and isWebEditable to notificationType schema

Author: mohammadranjbarz

migrations/1660540253547-createNotificationType.ts

@@ -37,6 +37,30 @@ export class createNotificationType1660540253547 implements MigrationInterface {
             isNullable: false,
             default: false,
           },
+          {
+            name: 'webDefaultValue',
+            type: 'boolean',
+            isNullable: false,
+            default: true,
+          },
+          {
+            name: 'emailDefaultValue',
+            type: 'boolean',
+            isNullable: false,
+            default: false,
+          },
+          {
+            name: 'isWebEditable',
+            type: 'boolean',
+            isNullable: false,
+            default: true,
+          },
+          {
+            name: 'isEmailEditable',
+            type: 'boolean',
+            isNullable: false,
+            default: false,
+          },
           {
             name: 'categoryGroup',
             type: 'text',

migrations/1660716115917-seedNotificationType.ts

@@ -164,6 +164,7 @@ export const GivethNotificationTypes = {
     title: 'Project published',
     description: 'When Project has been published',
     showOnSettingPage: true,
+    isEmailEditable: true,
     category: NOTIFICATION_CATEGORY.PROJECT_RELATED,
     icon: 'IconPublish',
     microService: MICRO_SERVICES.givethio,
@@ -1758,6 +1759,8 @@ export const GivethNotificationTypes = {
     title: 'Project status',
     description: 'Your project status',
     showOnSettingPage: true,
+    isEmailEditable: true,
+    isWebEditable: false,
     microService: MICRO_SERVICES.givethio,
     schemaValidator: null,
     emailNotifierService: null,
@@ -1781,6 +1784,7 @@ export const GivethNotificationTypes = {
     description:
       'When someone donates to your project, when you donate to a project, donation success and failure.',
     showOnSettingPage: true,
+    isEmailEditable: true,
     microService: MICRO_SERVICES.givethio,
     schemaValidator: null,
     emailNotifierService: null,

src/controllers/v1/notificationSettingsController.ts

@@ -1,16 +1,23 @@
 import { Route, Tags, Body, Security, Inject, Get, Query, Put } from 'tsoa';
 import { logger } from '../../utils/logger';
 import {
+  findNotificationSettingById,
   getUserNotificationSettings,
   updateUserNotificationSetting,
 } from '../../repositories/notificationSettingRepository';
 import { UserAddress } from '../../entities/userAddress';
+import { errorMessages } from '../../utils/errorMessages';
+import {
+  sendNotificationValidator,
+  updateNotificationSettings,
+  updateOneNotificationSetting,
+  validateWithJoiSchema,
+} from '../../validators/schemaValidators';
 
 interface SettingParams {
   id: number;
-  allowNotifications?: string;
-  allowEmailNotification?: string;
-  allowDappPushNotification?: string;
+  allowEmailNotification: boolean;
+  allowDappPushNotification: boolean;
 }
 
 @Route('/v1/notification_settings')
@@ -32,19 +39,16 @@ export class NotificationSettingsController {
     const { settings } = body;
 
     try {
+      validateWithJoiSchema(body, updateNotificationSettings);
+
       const updatedNotifications = await Promise.all(
         settings.map(async setting => {
-          const {
-            id,
-            allowNotifications,
-            allowEmailNotification,
-            allowDappPushNotification,
-          } = setting;
+          const { id, allowEmailNotification, allowDappPushNotification } =
+            setting;
 
           const updatedNotification = await updateUserNotificationSetting({
             notificationSettingId: id,
             userAddressId: user.id,
-            allowNotifications,
             allowEmailNotification,
             allowDappPushNotification,
           });
@@ -66,32 +70,31 @@ export class NotificationSettingsController {
     @Body()
     body: {
       id: number;
-      allowNotifications?: string;
-      allowEmailNotification?: string;
-      allowDappPushNotification?: string;
+      allowEmailNotification: boolean;
+      allowDappPushNotification: boolean;
     },
     @Inject()
     params: {
       user: UserAddress;
     },
   ) {
     const { user } = params;
-    const {
-      id,
-      allowNotifications,
-      allowEmailNotification,
-      allowDappPushNotification,
-    } = body;
+    const { id, allowEmailNotification, allowDappPushNotification } = body;
     try {
-      const updatedNotification = await updateUserNotificationSetting({
+      validateWithJoiSchema(body, updateOneNotificationSetting);
+
+      const notificationSetting = await findNotificationSettingById(id);
+
+      if (!notificationSetting) {
+        throw new Error(errorMessages.NOTIFICATION_SETTING_NOT_FOUND);
+      }
+      const newSettingData = {
         notificationSettingId: id,
         userAddressId: user.id,
-        allowNotifications,
         allowEmailNotification,
         allowDappPushNotification,
-      });
-
-      return updatedNotification;
+      };
+      return await updateUserNotificationSetting(newSettingData);
     } catch (e) {
       logger.error('updateNotificationSetting() error', e);
       throw e;

src/entities/notificationType.ts

@@ -83,6 +83,19 @@ export class NotificationType extends BaseEntity {
   @Column('boolean', { default: false })
   showOnSettingPage?: boolean;
 
+  // https://github.com/Giveth/impact-graph/issues/746
+  @Column('boolean', { nullable: true, default: false })
+  isEmailEditable: boolean;
+
+  @Column('boolean', { nullable: true, default: true })
+  isWebEditable: boolean;
+
+  @Column('boolean', { nullable: true, default: false })
+  emailDefaultValue: boolean;
+
+  @Column('boolean', { nullable: true, default: false })
+  webDefaultValue: boolean;
+
   @Index()
   @Column('text', { nullable: true })
   categoryGroup?: string;

src/repositories/notificationSettingRepository.test.ts

@@ -103,26 +103,69 @@ function updateUserNotificationSettingTestCases() {
           userAddressId: userAddress.id,
         })
         .andWhere('notificationType.isGroupParent = false')
+        .andWhere('notificationType.isEmailEditable = true')
+        .andWhere('notificationType.isWebEditable = true')
         .getOne();
 
     assert.isTrue(userNotificationSetting?.userAddressId === userAddress.id);
 
     const updatedSetting = await updateUserNotificationSetting({
       notificationSettingId: userNotificationSetting!.id,
       userAddressId: userAddress.id,
-      allowNotifications: 'false',
-      allowEmailNotification: 'false',
-      allowDappPushNotification: 'false',
+      allowEmailNotification: false,
+      allowDappPushNotification: false,
     });
+    assert.isOk(updatedSetting);
+    assert.isFalse(updatedSetting?.allowEmailNotification);
+    assert.isFalse(updatedSetting?.allowDappPushNotification);
+  });
+  it('update user notification settings, cant change when isEmailEditable is false', async () => {
+    const userAddress = await createNewUserAddressIfNotExists(walletAddress);
 
+    const userNotificationSetting =
+      await NotificationSetting.createQueryBuilder('setting')
+        .leftJoinAndSelect('setting.notificationType', 'notificationType')
+        .where('setting."userAddressId" = :userAddressId', {
+          userAddressId: userAddress.id,
+        })
+        .andWhere('notificationType.isGroupParent = false')
+        .andWhere('notificationType.isEmailEditable = false')
+        .andWhere('notificationType.isWebEditable = true')
+        .getOne();
+
+    assert.isTrue(userNotificationSetting?.userAddressId === userAddress.id);
+
+    const updatedSetting = await updateUserNotificationSetting({
+      notificationSettingId: userNotificationSetting!.id,
+      userAddressId: userAddress.id,
+      allowEmailNotification: false,
+      allowDappPushNotification: false,
+    });
     assert.isOk(updatedSetting);
-    assert.isTrue(
-      userNotificationSetting!.allowNotifications !==
-        updatedSetting!.allowNotifications,
-    );
-    assert.equal(userNotificationSetting!.allowNotifications, true);
-    assert.equal(updatedSetting.allowNotifications, false);
-    assert.equal(updatedSetting.allowEmailNotification, false);
-    assert.equal(updatedSetting.allowDappPushNotification, false);
+    assert.isTrue(updatedSetting?.allowEmailNotification);
+    assert.isFalse(updatedSetting?.allowDappPushNotification);
+  });
+  it('update user notification settings, cant change when isWebEditable is false', async () => {
+    const userAddress = await createNewUserAddressIfNotExists(walletAddress);
+
+    const userNotificationSetting =
+      await NotificationSetting.createQueryBuilder('setting')
+        .leftJoinAndSelect('setting.notificationType', 'notificationType')
+        .where('setting."userAddressId" = :userAddressId', {
+          userAddressId: userAddress.id,
+        })
+        .andWhere('notificationType.isWebEditable = false')
+        .getOne();
+
+    assert.isTrue(userNotificationSetting?.userAddressId === userAddress.id);
+
+    const updatedSetting = await updateUserNotificationSetting({
+      notificationSettingId: userNotificationSetting!.id,
+      userAddressId: userAddress.id,
+      allowEmailNotification: false,
+      allowDappPushNotification: false,
+    });
+    assert.isOk(updatedSetting);
+    assert.isTrue(updatedSetting?.allowDappPushNotification);
   });
 }

src/repositories/notificationSettingRepository.ts

@@ -76,13 +76,34 @@ export const findNotificationSettingByNotificationTypeAndUserAddress =
     }
   };
 
+export const findNotificationSettingById = async (
+  id: number,
+): Promise<NotificationSetting | null> => {
+  try {
+    return await NotificationSetting.createQueryBuilder('notificationSetting')
+      .leftJoinAndSelect(
+        'notificationSetting.notificationType',
+        'notificationType',
+      )
+      .where('notificationSetting.id = :id', {
+        id,
+      })
+      .getOne();
+  } catch (e) {
+    logger.error(
+      'findNotificationSettingByNotificationTypeAndUserAddress() error',
+      e,
+    );
+    throw e;
+  }
+};
+
 export const updateUserNotificationSetting = async (params: {
   notificationSettingId: number;
   userAddressId: number;
-  allowNotifications?: string;
-  allowEmailNotification?: string;
-  allowDappPushNotification?: string;
-}) => {
+  allowEmailNotification: boolean;
+  allowDappPushNotification: boolean;
+}): Promise<NotificationSetting> => {
   const notificationSetting = await NotificationSetting.createQueryBuilder(
     'notificationSetting',
   )
@@ -102,15 +123,13 @@ export const updateUserNotificationSetting = async (params: {
   if (!notificationSetting)
     throw new Error(errorMessages.NOTIFICATION_SETTING_NOT_FOUND);
 
-  if (params.allowNotifications)
-    notificationSetting.allowNotifications =
-      params.allowNotifications === 'true';
-  if (params.allowEmailNotification)
-    notificationSetting.allowEmailNotification =
-      params.allowEmailNotification === 'true';
-  if (params.allowDappPushNotification)
+  if (notificationSetting.notificationType?.isEmailEditable) {
+    notificationSetting.allowEmailNotification = params.allowEmailNotification;
+  }
+  if (notificationSetting.notificationType?.isWebEditable) {
     notificationSetting.allowDappPushNotification =
-      params.allowDappPushNotification === 'true';
+      params.allowDappPushNotification;
+  }
 
   if (
     notificationSetting?.notificationType?.isGroupParent &&
@@ -119,7 +138,6 @@ export const updateUserNotificationSetting = async (params: {
     await updateChildNotificationSettings({
       categoryGroup: notificationSetting?.notificationType?.categoryGroup,
       userAddressId: params.userAddressId,
-      allowNotifications: notificationSetting.allowNotifications,
       allowEmailNotification: notificationSetting.allowEmailNotification,
       allowDappPushNotification: notificationSetting.allowDappPushNotification,
     });
@@ -131,9 +149,8 @@ export const updateUserNotificationSetting = async (params: {
 export const updateChildNotificationSettings = async (params: {
   categoryGroup: string;
   userAddressId: number;
-  allowNotifications?: boolean;
-  allowEmailNotification?: boolean;
-  allowDappPushNotification?: boolean;
+  allowEmailNotification: boolean;
+  allowDappPushNotification: boolean;
 }) => {
   // Grab type ids
   const notificationTypes = await NotificationType.createQueryBuilder(
@@ -153,14 +170,12 @@ export const updateChildNotificationSettings = async (params: {
   if (notificationTypeIds.length === 0) return;
 
   await NotificationSetting.query(`
-    UPDATE notification_setting
-    SET "allowNotifications" = ${
-      params.allowNotifications
-    }, "allowEmailNotification" = ${
-    params.allowEmailNotification
-  }, "allowDappPushNotification" = ${params.allowDappPushNotification}
-    WHERE "notificationTypeId" IN (${notificationTypeIds.join(
-      ',',
-    )}) AND "userAddressId" = ${params.userAddressId}
+        UPDATE notification_setting
+        SET "allowEmailNotification" = ${
+          params.allowEmailNotification
+        }, "allowDappPushNotification" = ${params.allowDappPushNotification}
+        WHERE "notificationTypeId" IN (${notificationTypeIds.join(
+          ',',
+        )}) AND "userAddressId" = ${params.userAddressId}
   `);
 };