Merge branch 'main' into MI-753

.infra/common.ts

@@ -35,6 +35,10 @@ export const workers: Worker[] = [
     topic: 'user-updated',
     subscription: 'api.user-updated-plus-subscribed-custom-feed',
   },
+  {
+    topic: 'user-updated',
+    subscription: 'api.user-gifted-plus-notification',
+  },
   {
     topic: 'user-deleted',
     subscription: 'api.user-deleted-cio',
@@ -328,7 +332,7 @@ export const workers: Worker[] = [
   {
     topic: 'kvasir.v1.post-translated',
     subscription: 'api.post-translated',
-  },
+  }
 ];
 
 export const personalizedDigestWorkers: Worker[] = [

__tests__/notifications/index.ts

@@ -6,6 +6,7 @@ import {
   NotificationCommentContext,
   NotificationCommenterContext,
   NotificationDoneByContext,
+  NotificationGiftPlusContext,
   NotificationPostContext,
   NotificationPostModerationContext,
   NotificationSourceContext,
@@ -15,9 +16,9 @@ import {
   NotificationSubmissionContext,
   NotificationUpvotersContext,
   NotificationUserContext,
+  type NotificationUserTopReaderContext,
   Reference,
   storeNotificationBundleV2,
-  type NotificationUserTopReaderContext,
 } from '../../src/notifications';
 import { postsFixture } from '../fixture/post';
 import {
@@ -1513,3 +1514,28 @@ describe('storeNotificationBundle', () => {
     expect(actual.attachments!.length).toEqual(0);
   });
 });
+
+describe('plus notifications', () => {
+  it('should notify user when they are gifted a subscription', async () => {
+    const type = NotificationType.UserGiftedPlus;
+    const gifter = usersFixture[1] as Reference<User>;
+    const recipient = usersFixture[0] as Reference<User>;
+    const squad = sourcesFixture[5] as Reference<SquadSource>;
+    const ctx: NotificationGiftPlusContext = {
+      userIds: [recipient.id],
+      gifter,
+      recipient,
+      squad,
+    };
+    const actual = generateNotificationV2(type, ctx);
+
+    expect(actual.notification.type).toEqual(type);
+    expect(actual.userIds).toEqual([recipient.id]);
+    expect(actual.notification.public).toEqual(true);
+    expect(actual.notification.referenceId).toBe('squad');
+    expect(actual.notification.description).toBeFalsy();
+    expect(actual.notification.targetUrl).toContain(`/squads/${squad.handle}`);
+    expect(actual.avatars?.[0]?.image).toEqual(gifter.image);
+    expect(actual.attachments!.length).toEqual(0);
+  });
+});

__tests__/workers/cdc/primary.ts

@@ -149,6 +149,8 @@ import {
 } from '../../../src/entity/SourcePostModeration';
 import { NotificationType } from '../../../src/notifications/common';
 import type { UserReport } from '../../../src/entity/UserReport';
+import { SubscriptionCycles } from '../../../src/paddle';
+import { addYears } from 'date-fns';
 
 jest.mock('../../../src/common', () => ({
   ...(jest.requireActual('../../../src/common') as Record<string, unknown>),
@@ -894,6 +896,30 @@ describe('user', () => {
       [after],
     );
   });
+
+  it('should notify on gift plus subscription', async () => {
+    const after: ChangeObject<ObjectType> = {
+      ...base,
+      subscriptionFlags: JSON.stringify({
+        cycle: SubscriptionCycles.Yearly,
+        gifterId: '2',
+        giftExpirationDate: addYears(new Date(), 1),
+      }),
+    };
+    await expectSuccessfulBackground(
+      worker,
+      mockChangeMessage<ObjectType>({
+        after,
+        before: base,
+        table: 'user',
+        op: 'u',
+      }),
+    );
+    expectTypedEvent('user-updated', {
+      user: base,
+      newProfile: after,
+    } as unknown as PubSubSchema['user-updated']);
+  });
 });
 
 describe('user_state', () => {

__tests__/workers/notifications/userGiftedPlusNotification.ts

@@ -0,0 +1,94 @@
+import createOrGetConnection from '../../../src/db';
+import { DataSource } from 'typeorm';
+import { ChangeObject } from '../../../src/types';
+import { usersFixture } from '../../fixture';
+import { SubscriptionCycles } from '../../../src/paddle';
+import { addYears } from 'date-fns';
+import { invokeNotificationWorker, saveFixtures } from '../../helpers';
+import { PLUS_MEMBER_SQUAD_ID } from '../../../src/workers/userUpdatedPlusSubscriptionSquad';
+import { SourceType, User, Source } from '../../../src/entity';
+import { NotificationGiftPlusContext } from '../../../src/notifications';
+import { NotificationType } from '../../../src/notifications/common';
+
+let con: DataSource;
+
+beforeAll(async () => {
+  con = await createOrGetConnection();
+});
+
+type ObjectType = Partial<User>;
+const base: ChangeObject<ObjectType> = {
+  ...usersFixture[0],
+  subscriptionFlags: JSON.stringify({}),
+  createdAt: new Date().getTime(),
+  updatedAt: new Date().getTime(),
+  flags: JSON.stringify({}),
+};
+const plusUser = {
+  ...base,
+  subscriptionFlags: JSON.stringify({ cycle: SubscriptionCycles.Yearly }),
+};
+const giftedPlusUser = {
+  ...base,
+  subscriptionFlags: JSON.stringify({
+    cycle: SubscriptionCycles.Yearly,
+    gifterId: 2,
+    giftExpirationDate: addYears(new Date(), 1),
+  }),
+};
+
+beforeEach(async () => {
+  jest.resetAllMocks();
+  await saveFixtures(con, User, usersFixture);
+  await saveFixtures(con, Source, [
+    {
+      id: PLUS_MEMBER_SQUAD_ID,
+      name: 'Plus Squad',
+      image: 'http://image.com/a',
+      handle: 'plus-squad-notify',
+      type: SourceType.Squad,
+    },
+  ]);
+});
+
+const WORKER_RELATIVE_PATH =
+  '../../../src/workers/notifications/userGiftedPlusNotification';
+
+describe('plus subscription gift', () => {
+  it('should early return for currently non plus user', async () => {
+    const worker = await import(WORKER_RELATIVE_PATH);
+    const actual = await invokeNotificationWorker(worker.default, {
+      user: base,
+      newProfile: base,
+    });
+    expect(actual).toBeUndefined();
+  });
+
+  it('should not return anything plus user since before', async () => {
+    const worker = await import(WORKER_RELATIVE_PATH);
+    const actual = await invokeNotificationWorker(worker.default, {
+      user: plusUser,
+      newProfile: plusUser,
+    });
+    expect(actual).toBeUndefined();
+  });
+
+  it('should return notification for gifted plus user', async () => {
+    const worker = await import(WORKER_RELATIVE_PATH);
+    const actual = (await invokeNotificationWorker(worker.default, {
+      user: base,
+      newProfile: giftedPlusUser,
+    })) as Array<{
+      type: string;
+      ctx: NotificationGiftPlusContext;
+    }>;
+    expect(actual).toBeTruthy();
+    expect(actual.length).toEqual(1);
+    expect(actual[0].type).toEqual(NotificationType.UserGiftedPlus);
+
+    const notification = actual[0].ctx;
+    expect(notification.recipient.id).toEqual(base.id);
+    expect(notification.gifter.id).toEqual('2');
+    expect(notification.squad.id).toEqual(PLUS_MEMBER_SQUAD_ID);
+  });
+});

package.json

@@ -41,7 +41,6 @@
     "@fastify/helmet": "^13.0.1",
     "@fastify/http-proxy": "^11.0.0",
     "@fastify/rate-limit": "^10.2.1",
-    "@fastify/websocket": "^11.0.1",
     "@google-cloud/bigquery": "^7.9.1",
     "@google-cloud/opentelemetry-resource-util": "^2.4.0",
     "@google-cloud/pubsub": "^4.9.0",

src/common/mailing.ts

@@ -32,6 +32,8 @@ export enum CioUnsubscribeTopic {
 export enum CioTransactionalMessageTemplateId {
   VerifyCompany = '51',
   UserGivenTopReader = '52',
+  UserSentPlusGift = '65',
+  UserReceivedPlusGift = '66',
 }
 
 export const cioApi = new APIClient(process.env.CIO_APP_KEY);

src/index.ts

@@ -14,7 +14,6 @@ import MercuriusGQLUpload from 'mercurius-upload';
 import MercuriusCache from 'mercurius-cache';
 import proxy, { type FastifyHttpProxyOptions } from '@fastify/http-proxy';
 import { NoSchemaIntrospectionCustomRule } from 'graphql';
-// import fastifyWebsocket from '@fastify/websocket';
 
 import './config';
 
@@ -151,13 +150,6 @@ export default async function app(
     res.send(stringifyHealthCheck({ status: 'ok' }));
   });
 
-  // app.register(fastifyWebsocket, {
-  //   options: {
-  //     maxPayload: 1048576,
-  //     verifyClient: (info, next) => next(true),
-  //   },
-  // });
-
   app.register(MercuriusGQLUpload, {
     maxFileSize: 1024 * 1024 * 20,
     maxFiles: 1,

src/notifications/common.ts

@@ -60,6 +60,7 @@ export enum NotificationType {
   StreakResetRestore = 'streak_reset_restore',
   UserPostAdded = 'user_post_added',
   UserTopReaderBadge = 'user_given_top_reader',
+  UserGiftedPlus = 'user_gifted_plus',
 }
 
 export enum NotificationPreferenceType {

src/notifications/generate.ts

@@ -15,6 +15,7 @@ import {
   NotificationCommentContext,
   NotificationCommenterContext,
   NotificationDoneByContext,
+  NotificationGiftPlusContext,
   NotificationPostContext,
   NotificationPostModerationContext,
   NotificationSourceContext,
@@ -145,6 +146,8 @@ export const notificationTitleMap: Record<
   },
   source_post_submitted: (ctx: NotificationPostModerationContext) =>
     `${ctx.user.name} just posted in ${ctx.source.name}. This post is waiting for your review before it gets published on the squad.`,
+  user_gifted_plus: (ctx: NotificationGiftPlusContext) =>
+    `Surprise! 🎁 ${ctx.gifter.username} thought of you and gifted you a one-year daily.dev Plus membership! How’s that for a thoughtful surprise?`,
 };
 
 export const generateNotificationMap: Record<
@@ -430,4 +433,13 @@ export const generateNotificationMap: Record<
       .icon(NotificationIcon.Bell)
       .avatarUser(ctx.user)
       .objectPost(ctx.post, ctx.source, ctx.sharedPost!),
+  user_gifted_plus: (builder, ctx: NotificationGiftPlusContext) =>
+    builder
+      .uniqueKey(
+        `${ctx.gifter.id}-${ctx.recipient.id}-${new Date().toISOString()}`,
+      )
+      .icon(NotificationIcon.Bell)
+      .avatarUser(ctx.gifter)
+      .referenceSource(ctx.squad)
+      .targetSource(ctx.squad),
 };

src/notifications/types.ts

@@ -13,6 +13,7 @@ import {
   UserStreak,
   type Keyword,
   type UserTopReader,
+  SquadSource,
 } from '../entity';
 import { ChangeObject } from '../types';
 import { DeepPartial } from 'typeorm';
@@ -68,6 +69,12 @@ export type NotificationStreakContext = NotificationBaseContext & {
   };
 };
 
+export type NotificationGiftPlusContext = NotificationBaseContext & {
+  gifter: Reference<User>;
+  recipient: Reference<User>;
+  squad: Reference<SquadSource>;
+};
+
 export type NotificationCommenterContext = NotificationCommentContext & {
   commenter: Reference<User>;
 };

src/paddle.ts

@@ -1,3 +1,5 @@
+import { UserSubscriptionFlags } from './entity';
+
 export enum SubscriptionCycles {
   Monthly = 'monthly',
   Yearly = 'yearly',
@@ -8,3 +10,9 @@ export const subscriptionGiftDuration = 31557600000;
 
 export const isPlusMember = (cycle: SubscriptionCycles | undefined): boolean =>
   !!cycle?.length || false;
+
+export const isGiftedPlus = (
+  subscriptionFlags: UserSubscriptionFlags,
+): boolean =>
+  (!!subscriptionFlags?.gifterId || false) &&
+  isPlusMember(subscriptionFlags.cycle);

src/workers/newNotificationV2Mail.ts

@@ -91,6 +91,7 @@ export const notificationToTemplateId: Record<NotificationType, string> = {
   squad_featured: '56',
   user_post_added: '58',
   user_given_top_reader: CioTransactionalMessageTemplateId.UserGivenTopReader,
+  user_gifted_plus: CioTransactionalMessageTemplateId.UserReceivedPlusGift,
 };
 
 type TemplateData = Record<string, unknown>;
@@ -856,6 +857,29 @@ const notificationToTemplateData: Record<NotificationType, TemplateDataFunc> = {
       keyword: keyword?.flags?.title || keyword.value,
     };
   },
+  user_gifted_plus: async (con, user) => {
+    const { subscriptionFlags } = await con.getRepository(User).findOneOrFail({
+      where: {
+        id: user.id,
+      },
+      select: ['subscriptionFlags'],
+    });
+
+    if (!subscriptionFlags?.gifterId) {
+      throw new Error('Gifter user not found');
+    }
+
+    const gifter = await con.getRepository(User).findOneOrFail({
+      where: {
+        id: subscriptionFlags.gifterId,
+      },
+      select: ['name', 'image'],
+    });
+    return {
+      gifter_name: gifter.name,
+      gifter_image: gifter.image,
+    };
+  },
 };
 
 const formatTemplateDate = <T extends TemplateData>(data: T): T => {

src/workers/notifications/index.ts

@@ -22,6 +22,7 @@ import { collectionUpdated } from './collectionUpdated';
 import devCardUnlocked from './devCardUnlocked';
 import postBookmarkReminder from './postBookmarkReminder';
 import userStreakResetNotification from './userStreakResetNotification';
+import userGiftedPlusNotification from './userGiftedPlusNotification';
 import squadFeaturedUpdated from './squadFeaturedUpdated';
 import sourcePostModerationSubmittedNotification from './sourcePostModerationSubmittedNotification';
 import sourcePostModerationApprovedNotification from './sourcePostModerationApprovedNotification';
@@ -94,6 +95,7 @@ const notificationWorkers: NotificationWorker[] = [
   sourcePostModerationApprovedNotification,
   sourcePostModerationRejectedNotification,
   userTopReaderAdded,
+  userGiftedPlusNotification,
 ];
 
 export const workers = [...notificationWorkers.map(notificationWorkerToWorker)];