Merge pull request #94 from Giveth/release-may-2024

Release: May 2024

migrations/1714582062587-seedNotificationTypeForCreateOrttoUser.ts

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import { NOTIFICATION_CATEGORY, NOTIFICATION_TYPE_NAMES } from '../src/types/general';
+import { MICRO_SERVICES } from '../src/utils/utils';
+import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType';
+
+const OrttoUserNotificationType = [
+    {
+        name: NOTIFICATION_TYPE_NAMES.CREATE_ORTTO_PROFILE,
+        description: NOTIFICATION_TYPE_NAMES.CREATE_ORTTO_PROFILE,
+        microService: MICRO_SERVICES.givethio,
+        category: NOTIFICATION_CATEGORY.ORTTO,
+        schemaValidator: SCHEMA_VALIDATORS_NAMES.CREATE_ORTTO_PROFILE,
+    }
+]
+
+export class seedNotificationTypeForCreateOrttoUser1714582062587 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.manager.save(NotificationType, OrttoUserNotificationType);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+          `DELETE FROM notification_type WHERE "name" = 'Create Ortto profile';`,
+        );
+    }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "notification-venter",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "",
   "main": "index.js",
   "scripts": {

src/entities/notificationType.ts

@@ -16,6 +16,7 @@ import { NotificationSetting } from './notificationSetting';
 
 // Export Object with Schemas to N1 lookup
 export const SCHEMA_VALIDATORS_NAMES = {
+  CREATE_ORTTO_PROFILE: 'createOrttoProfile',
   SUPERFLUID: 'userSuperTokensCritical',
   ADMIN_MESSAGE: 'adminMessage',
   RAW_HTML_BROADCAST: 'rawHtmlBroadcast',

src/routes/v1/notificationRouter.test.ts

@@ -1387,7 +1387,6 @@ function sendNotificationTestCases() {
           email: '[email protected]',
           title: 'How many photos is too many photos?',
           firstName: 'firstName',
-          projectOwnerId: '68',
           slug: 'how-many-photos-is-too-many-photos',
           amount: 0.0001,
           transactionId: generateRandomTxHash(),
@@ -1428,7 +1427,6 @@ function sendNotificationTestCases() {
           email: '[email protected]',
           title: 'How many photos is too many photos?',
           firstName: 'firstName',
-          projectOwnerId: '68',
           slug: 'how-many-photos-is-too-many-photos',
           amount: 0.0001,
           transactionId: generateRandomTxHash(),
@@ -1497,7 +1495,6 @@ function sendNotificationTestCases() {
           email: '[email protected]',
           title: 'How many photos is too many photos?',
           firstName: 'firstName',
-          projectOwnerId: '68',
           slug: 'how-many-photos-is-too-many-photos',
           amount: 0.0001,
           transactionId: generateRandomTxHash(),
@@ -1538,7 +1535,6 @@ function sendNotificationTestCases() {
           email: '[email protected]',
           title: 'How many photos is too many photos?',
           firstName: 'firstName',
-          projectOwnerId: '68',
           slug: 'how-many-photos-is-too-many-photos',
           amount: 0.0001,
           transactionId: generateRandomTxHash(),

src/services/notificationService.ts

@@ -1,7 +1,4 @@
-import {
-  createNotification,
-  findNotificationByTrackId,
-} from '../repositories/notificationRepository';
+import { createNotification, findNotificationByTrackId } from '../repositories/notificationRepository';
 import { errorMessages } from '../utils/errorMessages';
 import { createNewUserAddressIfNotExists } from '../repositories/userAddressRepository';
 import { getNotificationTypeByEventNameAndMicroservice } from '../repositories/notificationTypeRepository';
@@ -13,7 +10,8 @@ import { validateWithJoiSchema } from '../validators/schemaValidators';
 import { SendNotificationRequest } from '../types/requestResponses';
 import { StandardError } from '../types/StandardError';
 import { NOTIFICATIONS_EVENT_NAMES, ORTTO_EVENT_NAMES } from '../types/notifications';
-import {getEmailAdapter} from "../adapters/adapterFactory";
+import { getEmailAdapter } from '../adapters/adapterFactory';
+import { NOTIFICATION_CATEGORY } from '../types/general';
 
 const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES) : any=> {
   const fields = {
@@ -24,6 +22,14 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES
   }
   let attributes;
   switch (orttoEventName) {
+    case NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE:
+      attributes = {
+        "str:cm:email": payload.email,
+        "str:cm:firstname": payload.firstName,
+        "str:cm:lastname": payload.lastName,
+        "str:cm:userid": payload.userId?.toString(),
+      }
+      break;
     case NOTIFICATIONS_EVENT_NAMES.SUPER_TOKENS_BALANCE_DEPLETED:
       attributes = {
         "str:cm:tokensymbol": payload.tokenSymbol,
@@ -212,7 +218,10 @@ export const sendNotification = async (
       httpStatusCode: 400,
     });
   }
-  const notificationSetting =
+
+  const isOrttoSpecific = notificationType.category === NOTIFICATION_CATEGORY.ORTTO
+
+  const notificationSetting = isOrttoSpecific ? null :
     await findNotificationSettingByNotificationTypeAndUserAddress({
       notificationTypeId: notificationType.id,
       userAddressId: userAddress.id,
@@ -249,7 +258,7 @@ export const sendNotification = async (
     eventName: body.eventName,
   });
 
-  if (shouldSendEmail && body.sendSegment && segmentValidator) {
+  if (((shouldSendEmail && body.sendSegment) || isOrttoSpecific) && segmentValidator) {
     const emailData = body.segment?.payload;
     validateWithJoiSchema(emailData, segmentValidator);
     const data = activityCreator(emailData, body.eventName as NOTIFICATIONS_EVENT_NAMES);
@@ -259,6 +268,13 @@ export const sendNotification = async (
     emailStatus = EMAIL_STATUSES.SENT;
   }
 
+  if (isOrttoSpecific) {
+    return {
+      success: true,
+      message: errorMessages.ORTTO_SPECIFIC,
+    }
+  }
+
   const metadataValidator =
     SEGMENT_METADATA_SCHEMA_VALIDATOR[
       notificationType?.schemaValidator as string

src/types/general.ts

@@ -11,6 +11,7 @@ export enum NOTIFICATION_CATEGORY {
   GIV_ECONOMY = 'givEconomy',
   SUPPORTED_PROJECTS = 'supportedProjects',
   GIV_POWER = 'givPower',
+  ORTTO = 'ortto'
 }
 
 export enum NOTIFICATION_TYPE_NAMES {
@@ -50,4 +51,5 @@ export enum NOTIFICATION_TYPE_NAMES {
   PROJECT_HAS_A_NEW_RANK = 'Your project has a new rank',
   PROJECT_HAS_RISEN_IN_THE_RANK = 'Your Project has risen in the rank',
   YOUR_PROJECT_GOT_A_RANK = 'Your project got a rank',
+  CREATE_ORTTO_PROFILE = 'Create Ortto profile',
 }

src/types/notifications.ts

@@ -47,6 +47,7 @@ export enum NOTIFICATIONS_EVENT_NAMES {
   SUPER_TOKENS_BALANCE_WEEK = 'One week left in stream balance',
   SUPER_TOKENS_BALANCE_MONTH = 'One month left in stream balance',
   SUPER_TOKENS_BALANCE_DEPLETED = 'Stream balance depleted',
+  CREATE_ORTTO_PROFILE = 'Create Ortto profile',
 }
 
 export const ORTTO_EVENT_NAMES = {
@@ -65,4 +66,5 @@ export const ORTTO_EVENT_NAMES = {
   [NOTIFICATIONS_EVENT_NAMES.VERIFICATION_FORM_REJECTED]: 'project-verification',
   [NOTIFICATIONS_EVENT_NAMES.PROJECT_BADGE_REVOKE_WARNING]: 'first-update-warning',
   [NOTIFICATIONS_EVENT_NAMES.PROJECT_BADGE_REVOKE_LAST_WARNING]: 'second-update-warning',
+  [NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE]: 'created-profile'
 }

src/utils/errorMessages.ts

@@ -183,4 +183,5 @@ export const errorMessages = {
     'You are not the owner of social profile',
   ERROR_IN_GETTING_ACCESS_TOKEN_BY_AUTHORIZATION_CODE:
     'Error in getting accessToken by authorization code',
+  ORTTO_SPECIFIC: 'Ortto specific notification'
 };

src/utils/validators/segmentAndMetadataValidators.ts

@@ -67,7 +67,6 @@ const donationTrackerSchema = Joi.object({
   firstName: Joi.string().allow(null, ''),
   lastName: Joi.string().allow(null, ''),
   userId: Joi.number(),
-  projectOwnerId: Joi.string().allow(null, ''),
   slug: Joi.string().allow(null, ''),
   projectLink: Joi.string().allow(null, ''),
   amount: Joi.number()?.greater(0).required(),
@@ -160,12 +159,23 @@ const superFluidTokenSegmentSchema = Joi.object({
   isEnded: Joi.boolean(),
 });
 
+const createOrttoProfileSegmentSchema = Joi.object({
+  email: Joi.string().required(),
+  firstName: Joi.string().required(),
+  lastName: Joi.string().required(),
+  userId: Joi.number().required()
+})
+
 export const SEGMENT_METADATA_SCHEMA_VALIDATOR: {
   [key: string]: {
     segment: ObjectSchema | null;
     metadata: ObjectSchema | null;
   };
 } = {
+  createOrttoProfile: {
+    segment: createOrttoProfileSegmentSchema,
+    metadata: null
+  },
   userSuperTokensCritical: {
     metadata: superFluidTokenMetadataSchema,
     segment: superFluidTokenSegmentSchema,

src/validators/schemaValidators.ts

@@ -61,7 +61,6 @@ export const sendNotificationValidator = Joi.object({
       projectLink: Joi.string().allow(null).allow(''),
 
       // Donation related attributes
-      projectOwnerId: Joi.string(),
       amount: Joi.number(),
       token: Joi.string().allow(null, ''),
       transactionId: Joi.string(),