Phase 1: Migrate to Email Notification System (with unit tests) #1082

stefanbinoj · 2025-11-08T15:38:52Z

This PR implements Phase 1 of #1075

Summary

Migrated cron jobs and trigger.
Added user preferences (allowDailyEmail, allowWeeklyEmail, allowVipMessageEmail) to frontend and added E2E and unit tests for same.
- Preferences default to enabled — emails are sent unless explicitly set to false.
Added new UI components and integrated them into the settings page.
Updated concerned unit tests.
Wrote new unit test for jobs/notifyVipMessageEmail
Created a resend client lib/resend/client.ts inorder to follow DRY principle.
Manually tested by temporarily shortening scheduler intervals and verifying sent email results.

Changes

Jobs

Migrated jobs/generateDailyReports.ts , jobs/generateWeeklyReports.ts , jobs/notifyVipMessage.ts

User Preferences
Updated userProfiles.preferences (already JSON-capable) and TRPC schema to include:

allowDailyEmail?: boolean; // default enabled when undefined
allowWeeklyEmail?: boolean; // default enabled when undefined
allowVipMessageEmail?: boolean; // default enabled when undefined

Query pattern for recipients:

... WHERE preferences IS NULL OR preferences->>'allowDailyEmail' != 'false'

New UI Components (switches):

dailyEmailSetting.tsx
weeklyEmailSetting.tsx
vipMessageEmailSetting.tsx

Integrated these within preferencesSetting.tsx.

Tests

Updated tests/jobs/generateDailyReport.test.ts and tests/jobs/generateWeeklyReport.test.ts
Added test tests/jobs/notfiyVipMessageEmail.test.ts
For each of unit tests added new test for checking emails based on user preferences.
Added E2E tests for testing user preferences.

Email Templates

Daily: DailyEmailReportTemplate
Weekly: WeeklyEmailReportTemplate
VIP: VipNotificationEmailTemplate

Slack vs Gmail Comparison

Daily Report

Slack	Gmail

Weekly Report

Slack	Gmail

VIP Message Notification

Slack	Gmail

VIP Notification: when VIP replies VS when staff replies Vs when staff replies and closes

When VIP Replies	When Staff Replies	When Staff Replies And Closes

UI Changes :

Desktop	Mobile

Tests Passing

E2E	Unit Tests
	jobs/generateDailyReport.test.ts jobs/generateWeeklyReport.test.ts jobs/notifyVipNotification.test.ts

Proofs :

Email triggered when staff replies to vip

Screen.Recording.2025-11-12.at.4.05.59.PM.mov

Cron job running (Updated cron jobs to run every alternative minute for sake of demonstration)

Screen.Recording.2025-11-12.at.5.17.25.PM.mov

Notes

Some helper functions used in the migrated cron jobs had a "server-only" directive at the top of their files.
This caused import issues when used with React Email templates, since those templates require react and react-dom, which cannot be imported into "server-only" contexts.

Resulting error:

Error: react-dom/server is not supported in React Server Components

To resolve this, helper functions were inlined directly into the migrated job files. The inlined helper functions are 100% similar to that of original ones.

Affected helpers:

1. getMailBox()
2. determineVipStatus()
3. ensureCleanedUpText()

AI Usage

GPT-5 (Medium, via VS Code): Assisted in drafting email template structures, UI component scaffolds, and initial E2E and unit test drafts.
Clause 4.5 (Haiky, via VS Code): Helped with environment setup ngrok, Understanding Postgres job queues, Vercel function behavior.
GPT (Free, via chat.openai.com): Used for formatting this PR description.
Devin's PR : this PR was helpful for understanding the changes and desired outcome.

All AI-assisted code was manually reviewed and tested.

Live Stream Disclosure

I have watched all Antiwork live streams and followed the provided guidelines accordingly.

stefanbinoj · 2025-11-10T09:56:02Z

jobs/generateDailyReports.ts

+export async function generateMailboxDailyEmailReport() {
+  const mailbox = await db.query.mailboxes.findFirst({
+    where: isNull(sql`${mailboxes.preferences}->>'disabled'`),
+  });


Inlined getMailbox() because it was imported from server-only file which would cause error while using react-email/components

stefanbinoj · 2025-11-10T09:58:19Z

jobs/generateDailyReports.ts

+    })
+    .from(userProfiles)
+    .innerJoin(authUsers, eq(userProfiles.id, authUsers.id))
+    .where(or(isNull(userProfiles.preferences), sql`${userProfiles.preferences}->>'allowDailyEmail' != 'false'`));


where(or(isNull(userProfiles.preferences), sql`${userProfiles.preferences}->>'allowDailyEmail' != 'false'`))

This condition checks for user preferences and doesn't sends email only if user have manually changed preference via UI.

stefanbinoj · 2025-11-10T09:59:48Z

jobs/generateWeeklyReports.ts

+export async function generateWeeklyEmailReports() {
+  const mailbox = await db.query.mailboxes.findFirst({
+    where: isNull(sql`${mailboxes.preferences}->>'disabled'`),
+  });


Again inlined getMailbox() due to same reason.

stefanbinoj · 2025-11-10T10:01:33Z

jobs/generateWeeklyReports.ts

+    })
+    .from(userProfiles)
+    .innerJoin(authUsers, eq(userProfiles.id, authUsers.id))
+    .where(or(isNull(userProfiles.preferences), sql`${userProfiles.preferences}->>'allowWeeklyEmail' != 'false'`));


Checking for user preference before sending email.

stefanbinoj · 2025-11-10T10:02:58Z

jobs/notifyVipMessage.ts

+  await db.update(conversationMessages).set({ cleanedUpText: cleaned }).where(eq(conversationMessages.id, m.id));
+  return cleaned;
+};
+


Inlined ensureCleanedUpText , generateCleanedUpText , determineVipStatus as they are imported from server-only file.

stefanbinoj · 2025-11-10T10:03:41Z

jobs/notifyVipMessage.ts

-  const mailbox = assertDefinedOrRaiseNonRetriableError(await getMailbox());
+  const mailbox = await db.query.mailboxes.findFirst({
+    where: isNull(sql`${mailboxes.preferences}->>'disabled'`),
+  });


Inlined getMailbox()

stefanbinoj · 2025-11-10T10:06:51Z

jobs/notifyVipMessage.ts

+  const conversationLink = `${getBaseUrl()}/conversations?id=${conversation.slug}`;
+  const customerLinks = platformCustomerRecord?.links
+    ? Object.entries(platformCustomerRecord.links).map(([key, value]) => ({ label: key, url: value }))
+    : undefined;


conversationLink and customerLinks are used for redirection and impersonation

stefanbinoj · 2025-11-10T10:09:53Z

lib/emails/dailyEmailReportTemplate.tsx

+                style={{ color: "#6b7280", textDecoration: "none" }}
+              >
+                <Img
+                  //src={`${baseUrl}/logo_mahogany_900_for_email.png`}


Sending an email using this as the src for the <img> tag doesn’t seem to work during local testing, but this is how it’s sent in other emails

stefanbinoj · 2025-11-12T10:47:27Z

lib/emails/dailyEmailReportTemplate.tsx

+              />
+              <SummaryRow label="Average reply time" value={avgReplyTime ?? "—"} />
+              <SummaryRow label="VIP average reply time" value={vipAvgReplyTime ?? "—"} />
+              <SummaryRow label="Average time existing open tickets have been open" value={avgWaitTime ?? "—"} last />


- is shown in above 3 cases, only when no mailbox message haven been replied

jobs/generateDailyReports.ts

…/helper into remove_slack/phase_1

stefanbinoj · 2025-11-13T04:10:20Z

jobs/generateDailyReports.ts

+      new Error(`Daily report: failed to send ${failures.length}/${emailResults.length} daily emails`),
+      { extra: { failures } },
+    );
+  }


Added better logging and sentry capturing when email sending fails. Usually happens when email is malformed, dns/tls error, resend rate limiting etc..

stefanbinoj · 2025-11-13T08:38:01Z

jobs/generateDailyReports.ts

+    captureExceptionAndLog(error);
+    throw error;
+  }
+}


Split the code into two function so that it is standardized and consistent with generateWeeklyReport.tsx . This also makes it easier for the importing function to run unit tests without explicitly setting the environment variables.

stefanbinoj · 2025-11-13T08:45:43Z

tests/jobs/generateDailyReports.test.ts

+    "i",
+  );
+  expect(rx.test(html)).toBe(true);
+};


Because the daily email is sent as table element with each value inside <td> this makes it difficult for checking by this usual method

expect.toContain("Open tickets", 2);

stefanbinoj · 2025-11-13T09:05:59Z

@slavingia Just wanted to clarify, the description mentions migrations for Ticket response time alerts and Knowledge bank suggestion notifications, but Devin’s PR doesn’t seem to include any relevant changes for those.

Should I migrate those as well? If yes, would you prefer that I include them in this PR or create a separate one instead? (Considering the diffs in the current PR, creating a separate one might make it easier to review.)

stefanbinoj · 2025-11-15T14:07:23Z

jobs/generateDailyReports.ts

-  ];
+export async function generateMailboxDailyEmailReport(): Promise<MailboxDailyEmailReportResult> {
+  try {
+    const mailbox = await db.query.mailboxes.findFirst({


Inlined getMailbox() because it was imported from server-only file which would cause error while using react-email/components

added resend integration

f730b21

stefanbinoj changed the title ~~Phase 1: Build and Integrate the Email Notification System~~ [WIP] Phase 1: Build and Integrate the Email Notification System Nov 9, 2025

stefanbinoj marked this pull request as draft November 9, 2025 06:12

stefanbinoj and others added 5 commits November 10, 2025 11:20

updated design mockup

5839a7a

added e2e

2a0a4ee

copied contents

194862b

rename + delete

83abdeb

[autofix.ci] apply automated fixes

8d35550

stefanbinoj commented Nov 10, 2025

View reviewed changes

added fallback as 0 for email templates

9fae4e7

stefanbinoj commented Nov 12, 2025

View reviewed changes

feat: introduced standard client

c269846

stefanbinoj commented Nov 13, 2025

View reviewed changes

jobs/generateDailyReports.ts Outdated Show resolved Hide resolved

stefanbinoj and others added 3 commits November 13, 2025 09:34

sentry capture

1c5396e

[autofix.ci] apply automated fixes

4b2ce24

Merge branch 'remove_slack/phase_1' of https://github.com/stefanbinoj…

1514eb5

…/helper into remove_slack/phase_1

stefanbinoj commented Nov 13, 2025

View reviewed changes

stefanbinoj added 2 commits November 13, 2025 13:45

added unit tests

b5754e1

fix unit test

a7023f4

stefanbinoj commented Nov 13, 2025

View reviewed changes

remove unused var

9615ed7

stefanbinoj changed the title ~~[WIP] Phase 1: Build and Integrate the Email Notification System~~ Phase 1: Integrate Email Notification System (with unit tests) Nov 13, 2025

fix lints

fd12555

stefanbinoj changed the title ~~Phase 1: Integrate Email Notification System (with unit tests)~~ Phase 1: Migrate to Email Notification System (with unit tests) Nov 13, 2025

stefanbinoj marked this pull request as ready for review November 13, 2025 08:56

chore: tighten unit tests

b83cc42

stefanbinoj commented Nov 15, 2025

View reviewed changes

[autofix.ci] apply automated fixes

6801558

Phase 1: Migrate to Email Notification System (with unit tests) #1082

Are you sure you want to change the base?

Phase 1: Migrate to Email Notification System (with unit tests) #1082

Conversation

stefanbinoj commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Tests

Email Templates

Slack vs Gmail Comparison

Daily Report

Weekly Report

VIP Message Notification

VIP Notification: when VIP replies VS when staff replies Vs when staff replies and closes

UI Changes :

Tests Passing

Proofs :

Notes

AI Usage

Live Stream Disclosure

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanbinoj Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanbinoj Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stefanbinoj Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanbinoj Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanbinoj Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stefanbinoj commented Nov 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

stefanbinoj commented Nov 8, 2025 •

edited

Loading

stefanbinoj Nov 10, 2025 •

edited

Loading

stefanbinoj Nov 12, 2025 •

edited

Loading

stefanbinoj Nov 13, 2025 •

edited

Loading

stefanbinoj Nov 13, 2025 •

edited

Loading

stefanbinoj Nov 13, 2025 •

edited

Loading