refactor: remove deprecated community picks granted notification (#3367)

Author: idoshamun

.infra/common.ts

@@ -169,10 +169,6 @@ export const workers: Worker[] = [
     topic: 'community-link-rejected',
     subscription: 'api.community-picks-failed-notification',
   },
-  {
-    topic: 'community-link-access',
-    subscription: 'api.community-picks-granted-notification',
-  },
   {
     topic: 'post-commented',
     subscription: 'api.article-new-comment-notification.post-commented',

__tests__/notifications/index.ts

@@ -1,7 +1,6 @@
 import {
   generateNotificationV2,
   type NotificationAwardContext,
-  NotificationBaseContext,
   NotificationBookmarkContext,
   NotificationBundleV2,
   type NotificationCampaignContext,
@@ -57,7 +56,6 @@ import {
   createSquadWelcomePost,
   emptyImage,
   notificationsLink,
-  scoutArticleLink,
   squadsFeaturedPage,
 } from '../../src/common';
 import { usersFixture } from '../fixture/user';
@@ -213,21 +211,6 @@ describe('generateNotification', () => {
     ]);
   });
 
-  it('should generate community_picks_granted notification', () => {
-    const type = NotificationType.CommunityPicksGranted;
-    const ctx: NotificationBaseContext = { userIds: [userId] };
-    const actual = generateNotificationV2(type, ctx);
-
-    expect(actual.notification.type).toEqual(type);
-    expect(actual.userIds).toEqual([userId]);
-    expect(actual.notification.public).toEqual(true);
-    expect(actual.notification.referenceId).toEqual('system');
-    expect(actual.notification.referenceType).toEqual('system');
-    expect(actual.notification.targetUrl).toEqual(scoutArticleLink);
-    expect(actual.avatars.length).toEqual(0);
-    expect(actual.attachments.length).toEqual(0);
-  });
-
   it('should generate article_picked notification', () => {
     const type = NotificationType.ArticlePicked;
     const ctx: NotificationPostContext = {

__tests__/workers/cdc/notifications.ts

@@ -22,7 +22,7 @@ describe('notification', () => {
   const id = randomUUID();
   const base: ChangeObject<ObjectType> = {
     id,
-    type: NotificationType.CommunityPicksGranted,
+    type: NotificationType.CommunityPicksSucceeded,
     title: 'hello',
     targetUrl: 'target',
     icon: 'icon',

__tests__/workers/cdc/primary.ts

@@ -60,8 +60,6 @@ import {
   UserMarketingCta,
   UserNotification,
   UserPost,
-  UserState,
-  UserStateKey,
   UserStreak,
   UserStreakAction,
   UserStreakActionType,
@@ -103,7 +101,6 @@ import {
   notifySourcePrivacyUpdated,
   notifySourceReport,
   notifySquadFeaturedUpdated,
-  notifySubmissionGrantedAccess,
   notifySubmissionRejected,
   notifyUsernameChanged,
   notifyUserReadmeUpdated,
@@ -131,7 +128,6 @@ import {
 import { randomUUID } from 'crypto';
 import { DataSource, Not } from 'typeorm';
 import createOrGetConnection from '../../../src/db';
-import { TypeOrmError } from '../../../src/errors';
 import { SourceMemberRoles } from '../../../src/roles';
 import { CommentReport } from '../../../src/entity/CommentReport';
 import { badUsersFixture, usersFixture } from '../../fixture/user';
@@ -216,7 +212,6 @@ jest.mock('../../../src/common', () => ({
   notifySourceFeedRemoved: jest.fn(),
   notifySettingsUpdated: jest.fn(),
   notifySubmissionRejected: jest.fn(),
-  notifySubmissionGrantedAccess: jest.fn(),
   notifyNewPostMention: jest.fn(),
   notifyNewCommentMention: jest.fn(),
   notifyNewNotification: jest.fn(),
@@ -843,52 +838,6 @@ describe('user', () => {
         table: 'user',
       }),
     );
-    const [state] = await con.getRepository(UserState).find();
-    expect(state?.key).toEqual(UserStateKey.CommunityLinkAccess);
-  });
-
-  it('should throw an error when creating user state and not related to duplicate entry', async () => {
-    const after: ChangeObject<ObjectType> = {
-      ...base,
-      reputation: submissionAccessThreshold,
-    };
-    after.id = '1234567890123456789012345678901234567'; // 37 characters - exceeds limit
-    try {
-      await expectSuccessfulBackground(
-        worker,
-        mockChangeMessage<ObjectType>({
-          after,
-          before: base,
-          op: 'u',
-          table: 'user',
-        }),
-      );
-      expect(true).toBeFalsy(); // ensure the worker threw an error and not reach this code
-    } catch (ex) {
-      const state = await con.getRepository(UserState).find();
-      expect(state.length).toEqual(0);
-      expect(ex.code).not.toEqual(TypeOrmError.DUPLICATE_ENTRY);
-    }
-  });
-
-  it('should handle the thrown error when user state already exists', async () => {
-    const after: ChangeObject<ObjectType> = {
-      ...base,
-      reputation: submissionAccessThreshold,
-    };
-    const repo = con.getRepository(UserState);
-    await repo.save({ userId: '1', key: UserStateKey.CommunityLinkAccess });
-    await expectSuccessfulBackground(
-      worker,
-      mockChangeMessage<ObjectType>({
-        after,
-        before: base,
-        op: 'u',
-        table: 'user',
-      }),
-    );
-    const state = await con.getRepository(UserState).find();
-    expect(state.length).toEqual(1);
   });
 
   it('should call notifyReputationIncrease when the user reputation has increased', async () => {
@@ -1134,28 +1083,6 @@ describe('user', () => {
   });
 });
 
-describe('user_state', () => {
-  type ObjectType = UserState;
-  it('should notify on user state is created with the right key', async () => {
-    await expectSuccessfulBackground(
-      worker,
-      mockChangeMessage<ObjectType>({
-        after: {
-          userId: defaultUser.id,
-          key: UserStateKey.CommunityLinkAccess,
-          value: false,
-        },
-        op: 'c',
-        table: 'user_state',
-      }),
-    );
-    expect(notifySubmissionGrantedAccess).toHaveBeenCalledTimes(1);
-    expect(
-      jest.mocked(notifySubmissionGrantedAccess).mock.calls[0].slice(1),
-    ).toEqual(['1']);
-  });
-});
-
 describe('comment mention', () => {
   type ObjectType = CommentMention;
   const base: ChangeObject<ObjectType> = {

__tests__/workers/newNotificationV2Mail.ts

@@ -49,7 +49,6 @@ import { usersFixture } from '../fixture/user';
 import { DataSource } from 'typeorm';
 import createOrGetConnection from '../../src/db';
 import {
-  NotificationBaseContext,
   NotificationCampaignContext,
   NotificationCollectionContext,
   NotificationCommentContext,
@@ -205,29 +204,6 @@ it('should set parameters for community_picks_succeeded email', async () => {
   expect(args.transactional_message_id).toEqual('27');
 });
 
-it('should set parameters for community_picks_granted email', async () => {
-  const ctx: NotificationBaseContext = {
-    userIds: ['1'],
-  };
-
-  const notificationId = await saveNotificationV2Fixture(
-    con,
-    NotificationType.CommunityPicksGranted,
-    ctx,
-  );
-  await expectSuccessfulBackground(worker, {
-    notification: {
-      id: notificationId,
-      userId: '1',
-    },
-  });
-  expect(sendEmail).toHaveBeenCalledTimes(1);
-  const args = jest.mocked(sendEmail).mock
-    .calls[0][0] as SendEmailRequestWithTemplate;
-  expect(args.message_data).toEqual({});
-  expect(args.transactional_message_id).toEqual('26');
-});
-
 it('should set parameters for article_picked email', async () => {
   const post = await con.getRepository(ArticlePost).save(postsFixture[0]);
   const ctx: NotificationPostContext = {

__tests__/workers/notifications.ts

@@ -76,7 +76,6 @@ import { commentReply } from '../../src/workers/notifications/commentReply';
 import { commentUpvoteMilestone } from '../../src/workers/notifications/commentUpvoteMilestone';
 import { communityPicksFailed } from '../../src/workers/notifications/communityPicksFailed';
 import { SubmissionFailErrorKeys } from '../../src/errors';
-import { communityPicksGranted } from '../../src/workers/notifications/communityPicksGranted';
 import { devCardUnlocked } from '../../src/workers/notifications/devCardUnlocked';
 import { postAdded } from '../../src/workers/notifications/postAdded';
 import { postMention } from '../../src/workers/notifications/postMention';
@@ -138,20 +137,6 @@ it('should add community picks failed notification', async () => {
   });
 });
 
-it('should add community picks granted notification', async () => {
-  const actual = await invokeTypedNotificationWorker<'community-link-access'>(
-    communityPicksGranted,
-    {
-      userId: '1',
-    },
-  );
-  expect(actual.length).toEqual(1);
-  expect(actual[0].type).toEqual('community_picks_granted');
-  expect(actual[0].ctx).toEqual({
-    userIds: ['1'],
-  });
-});
-
 it('should add devcard unlocked notification if user has reached the reputation threshold', async () => {
   const actual = await invokeTypedNotificationWorker<'user-reputation-updated'>(
     devCardUnlocked,

src/common/pubsub.ts

@@ -48,7 +48,6 @@ const viewsTopic = pubsub.topic('views');
 const postBannedOrRemovedTopic = pubsub.topic('post-banned-or-removed');
 const sourceFeedAddedTopic = pubsub.topic('source-feed-added');
 const sourceFeedRemovedTopic = pubsub.topic('source-feed-removed');
-const communityLinkAccessTopic = pubsub.topic('community-link-access');
 const communityLinkRejectedTopic = pubsub.topic('community-link-rejected');
 const newNotificationTopic = pubsub.topic('api.v1.new-notification');
 const newPostMentionTopic = pubsub.topic('api.v1.new-post-mention');
@@ -272,11 +271,6 @@ export const notifySubmissionRejected = async (
   submission: ChangeObject<Submission>,
 ): Promise<void> => publishEvent(log, communityLinkRejectedTopic, submission);
 
-export const notifySubmissionGrantedAccess = async (
-  log: EventLogger,
-  userId: string,
-): Promise<void> => publishEvent(log, communityLinkAccessTopic, { userId });
-
 export const notifySourceMemberRoleChanged = async (
   log: EventLogger,
   previousRole: SourceMemberRoles,

src/common/typedPubsub.ts

@@ -210,9 +210,6 @@ export type PubSubSchema = {
     commentMention: ChangeObject<CommentMention>;
   };
   'community-link-rejected': ChangeObject<Submission>;
-  'community-link-access': {
-    userId: string;
-  };
   'user-reputation-updated': {
     user: ChangeObject<User>;
     userAfter: ChangeObject<User>;

src/entity/user/UserState.ts

@@ -1,6 +1,5 @@
 export * from './User';
 export * from './UserPost';
-export * from './UserState';
 export * from './UserAction';
 export * from './UserStreak';
 export * from './UserStreakAction';