Merge pull request #79 from Giveth/feature_add_super_tokens_email

Add superfluid tokens email
Giveth · Apr 1, 2024 · 440b665 · 440b665
2 parents cb6dc6d + bb67e9f
commit 440b665
Show file tree

Hide file tree

Showing 7 changed files with 194 additions and 0 deletions.
diff --git a/migrations/1711607882826-addSuperfluidNotifications.ts b/migrations/1711607882826-addSuperfluidNotifications.ts
@@ -0,0 +1,161 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+import { NOTIFICATION_CATEGORY_GROUPS } from '../src/entities/notificationSetting';
+import { NOTIFICATION_CATEGORY } from '../src/types/general';
+import { MICRO_SERVICES } from '../src/utils/utils';
+import {
+  NotificationType,
+  SCHEMA_VALIDATORS_NAMES,
+} from '../src/entities/notificationType';
+
+export const superFluidNotificationTypes = [
+  {
+    name: 'One month left in stream balance',
+    description: 'Stream balance of underlying token will run out in 1 month',
+    microService: MICRO_SERVICES.givethio,
+    category: NOTIFICATION_CATEGORY.GIV_ECONOMY,
+    icon: '',
+    schemaValidator: SCHEMA_VALIDATORS_NAMES.SUPERFLUID,
+    emailNotifierService: null,
+    emailNotificationId: null,
+    pushNotifierService: null,
+    categoryGroup: NOTIFICATION_CATEGORY_GROUPS.SUPERFLUID,
+    title: 'One Month Left in Stream Balance',
+    htmlTemplate: [
+      {
+        type: 'p',
+        content: 'Your Stream Balance of ',
+      },
+      {
+        type: 'a',
+        content: '{underlyingTokenSymbol}',
+        href: '#', // Placeholder for dynamic token symbol link
+      },
+      {
+        type: 'p',
+        content: ' on ',
+      },
+      {
+        type: 'a',
+        content: '{network}',
+        href: '#', // Placeholder for dynamic network link
+      },
+      {
+        type: 'p',
+        content: ' will run out in 1 month, ',
+      },
+      {
+        type: 'a',
+        content: 'top-up here.',
+        href: 'Link to my recurring donations tab', // Actual link goes here
+      },
+    ],
+    content:
+      'Your Stream Balance of {underlyingTokenSymbol} on {network} will run out in 1 month, top-up here.',
+  },
+  {
+    name: 'One week left in stream balance',
+    description: 'Stream balance of underlying token will run out in 1 week',
+    microService: MICRO_SERVICES.givethio,
+    category: NOTIFICATION_CATEGORY.GIV_ECONOMY,
+    icon: '',
+    schemaValidator: SCHEMA_VALIDATORS_NAMES.SUPERFLUID,
+    emailNotifierService: null,
+    emailNotificationId: null,
+    pushNotifierService: null,
+    categoryGroup: NOTIFICATION_CATEGORY_GROUPS.SUPERFLUID,
+    title: 'One Week Left in Stream Balance',
+    htmlTemplate: [
+      {
+        type: 'p',
+        content: 'Your Stream Balance of ',
+      },
+      {
+        type: 'a',
+        content: '{underlyingTokenSymbol}',
+        href: '#', // Placeholder for dynamic token symbol link
+      },
+      {
+        type: 'p',
+        content: ' on ',
+      },
+      {
+        type: 'a',
+        content: '{network}',
+        href: '#', // Placeholder for dynamic network link
+      },
+      {
+        type: 'p',
+        content: ' will run out in 1 week, ',
+      },
+      {
+        type: 'a',
+        content: 'top-up here.',
+        href: 'Link to my recurring donations tab', // Actual link goes here
+      },
+    ],
+    content:
+      'Your Stream Balance of {underlyingTokenSymbol} on {network} will run out in 1 week, top-up here.',
+  },
+  {
+    name: 'Stream balance depleted',
+    description: 'Stream balance in token has run out of funds',
+    microService: MICRO_SERVICES.givethio,
+    category: NOTIFICATION_CATEGORY.GIV_ECONOMY,
+    icon: '',
+    schemaValidator: SCHEMA_VALIDATORS_NAMES.SUPERFLUID,
+    emailNotifierService: null,
+    emailNotificationId: null,
+    pushNotifierService: null,
+    categoryGroup: NOTIFICATION_CATEGORY_GROUPS.SUPERFLUID,
+    title: 'Stream Balance Depleted',
+    htmlTemplate: [
+      {
+        type: 'p',
+        content: 'Your Stream Balance in ',
+      },
+      {
+        type: 'a',
+        content: '{tokenSymbol}',
+        href: '#', // Placeholder for dynamic token symbol link
+      },
+      {
+        type: 'p',
+        content: ' on ',
+      },
+      {
+        type: 'a',
+        content: '{network}',
+        href: '#', // Placeholder for dynamic network link
+      },
+      {
+        type: 'p',
+        content:
+          ' has run out of funds, subsequently some of your recurring donations have ended. ',
+      },
+      {
+        type: 'a',
+        content: 'Manage your Recurring Donations',
+        href: 'Link to manage recurring donations', // Actual link goes here
+      },
+    ],
+    content:
+      'Your Stream Balance in {tokenSymbol} on {network} has run out of funds, subsequently some of your recurring donations have ended. Manage your Recurring Donations',
+  },
+];
+
+export class addSuperfluidNotifications1711607882826
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.manager.save(
+      NotificationType,
+      superFluidNotificationTypes,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DELETE FROM notification_type WHERE "categoryGroup" = 'superfluid';`,
+    );
+  }
+}
diff --git a/src/entities/notificationSetting.ts b/src/entities/notificationSetting.ts
@@ -13,6 +13,7 @@ import { NotificationType } from './notificationType';
 import { UserAddress } from './userAddress';
 
 export const NOTIFICATION_CATEGORY_GROUPS = {
+  SUPERFLUID: 'superfluid',
   GIVPOWER_ALLOCATIONS: 'givPowerAllocations',
   PROJECT_BOOSTING_STATUS: 'projectBoostStatus',
   SELF_BOOSTING_STATUS: 'yourBoostStatus',

diff --git a/src/entities/notificationType.ts b/src/entities/notificationType.ts
@@ -16,6 +16,7 @@ import { NotificationSetting } from './notificationSetting';
 
 // Export Object with Schemas to N1 lookup
 export const SCHEMA_VALIDATORS_NAMES = {
+  SUPERFLUID: 'superFluidTokenTrackerSchema',
   ADMIN_MESSAGE: 'adminMessage',
   RAW_HTML_BROADCAST: 'rawHtmlBroadcast',
   DRAFTED_PROJECT_SAVED: 'draftedProjectSavedValidator',

diff --git a/src/services/notificationService.ts b/src/services/notificationService.ts
@@ -24,8 +24,18 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES
   }
   let attributes;
   switch (orttoEventName) {
+    case NOTIFICATIONS_EVENT_NAMES.USER_SUPER_TOKENS_CRITICAL:
+      attributes = {
+        "str:cm:tokensymbol": payload.tokenSymbol,
+        "str:cm:email": payload.email,
+        "str:cm:userId": payload.userId?.toString(),
+        "str:cm:criticalDate": payload.criticalDate,
+        "bol:cm:isended": payload.isEnded,
+      }
+      break;
     case NOTIFICATIONS_EVENT_NAMES.DONATION_RECEIVED:
       attributes = {
+        "bol:cm:isrecurringdonation": !!payload.isRecurringDonation,
         "str:cm:projecttitle": payload.title,
         "str:cm:donationamount": payload.amount.toString(),
         "str:cm:donationtoken": payload.token,

diff --git a/src/types/notifications.ts b/src/types/notifications.ts
@@ -1,4 +1,5 @@
 export enum NOTIFICATIONS_EVENT_NAMES {
+  USER_SUPER_TOKENS_CRITICAL = 'Supertokens critical',
   DRAFTED_PROJECT_ACTIVATED = 'Draft published',
   PROJECT_LISTED = 'Project listed',
   PROJECT_UNLISTED = 'Project unlisted',
@@ -47,6 +48,7 @@ export enum NOTIFICATIONS_EVENT_NAMES {
 }
 
 export const ORTTO_EVENT_NAMES = {
+  [NOTIFICATIONS_EVENT_NAMES.USER_SUPER_TOKENS_CRITICAL]: 'superfluid-balance-warning',
   [NOTIFICATIONS_EVENT_NAMES.DONATION_RECEIVED]: 'testing-donation-received',
   [NOTIFICATIONS_EVENT_NAMES.DRAFTED_PROJECT_ACTIVATED]: 'project-created',
   [NOTIFICATIONS_EVENT_NAMES.PROJECT_LISTED]: 'project-listed',

diff --git a/src/utils/validators/segmentAndMetadataValidators.ts b/src/utils/validators/segmentAndMetadataValidators.ts
@@ -92,6 +92,7 @@ const donationTrackerSchema = Joi.object({
   donationValueEth: Joi.number().greater(0).allow(null),
   verified: Joi.boolean().allow(null),
   transakStatus: Joi.string().allow(null),
+  isRecurringDonation: Joi.boolean().allow(null),
 });
 
 const projectTitleProjectLinkSchema = Joi.object({
@@ -141,12 +142,24 @@ const givBackReadyClaimSchema = Joi.object({
   amount: Joi.string().required(),
 });
 
+const superFluidTokenTrackerSchema = Joi.object({
+  tokenSymbol: Joi.string().required(),
+  email: Joi.string().required(),
+  userId: Joi.number().required(),
+  criticalDate: Joi.string().required(),
+  isEnded: Joi.boolean(),
+});
+
 export const SEGMENT_METADATA_SCHEMA_VALIDATOR: {
   [key: string]: {
     segment: ObjectSchema | null;
     metadata: ObjectSchema | null;
   };
 } = {
+  userSuperTokensCritical: {
+    metadata: superFluidTokenTrackerSchema,
+    segment: superFluidTokenTrackerSchema,
+  },
   draftedProjectSavedValidator: {
     metadata: projectTitleProjectLinkSchema,
     segment: projectRelatedTrackerSchema,

diff --git a/src/validators/schemaValidators.ts b/src/validators/schemaValidators.ts
@@ -75,6 +75,12 @@ export const sendNotificationValidator = Joi.object({
       donationValueEth: Joi.number().allow(null),
       verified: Joi.boolean(),
       transakStatus: Joi.string().allow(null).allow(''),
+      isRecurringDonation: Joi.boolean().allow(null),
+
+      //Super token critical attributes
+      criticalDate: Joi.string(),
+      isEnded: Joi.boolean(),
+      tokenSymbol: Joi.string(),
 
       //Project related attributes
       lastName: Joi.string().allow(null).allow(''),