feature/email-reminders

.github/workflows/lint.yml

@@ -14,7 +14,9 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 20.18.0
+          # Read from .nvmrc (20.19.1) so CI matches local dev. The previous hardcoded
+          # 20.18.0 was below testcontainers' undici requirement (node >=20.18.1).
+          node-version-file: '.nvmrc'
           cache: yarn
           cache-dependency-path: './yarn.lock'
 

jest.config.ts

@@ -169,10 +169,8 @@ const config: Config = {
   //   "**/?(*.)+(spec|test).[tj]s?(x)"
   // ],
 
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
+  // Integration tests need a real Postgres and run via jest.integration.config.ts, not here.
+  testPathIgnorePatterns: ['/node_modules/', '\\.integration\\.test\\.ts$'],
 
   // The regexp pattern or array of patterns that Jest uses to detect test files
   // testRegex: [],

jest.integration.config.ts

@@ -0,0 +1,24 @@
+import type { Config } from 'jest'
+import nextJest from 'next/jest.js'
+
+const createJestConfig = nextJest({ dir: './' })
+
+// Real-Postgres integration tests. A testcontainer is booted once in globalSetup, migrated,
+// and torn down after. Kept separate from the default `jest` run, which has no DB.
+const config: Config = {
+  testEnvironment: 'node',
+  testMatch: ['**/*.integration.test.ts'],
+  globalSetup: '<rootDir>/test/integration/globalSetup.ts',
+  globalTeardown: '<rootDir>/test/integration/globalTeardown.ts',
+  setupFilesAfterEnv: ['<rootDir>/test/integration/setup-env.ts'],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+    '^@api/(.*)$': '<rootDir>/src/app/api/$1',
+  },
+  collectCoverage: false,
+  // One Postgres, shared serially: parallel workers would race truncateAll between tests.
+  maxWorkers: 1,
+  testTimeout: 30000,
+}
+
+export default createJestConfig(config)

package.json

@@ -63,6 +63,7 @@
     "@faker-js/faker": "^8.4.1",
     "@ngrok/ngrok": "^1.4.1",
     "@svgr/webpack": "^8.1.0",
+    "@testcontainers/postgresql": "^12.0.0",
     "@trigger.dev/build": "4.3.1",
     "@types/file-saver": "^2.0.7",
     "@types/jest": "^29.5.12",
@@ -81,6 +82,7 @@
     "prettier": "^3.1.1",
     "tailwind-merge": "^3.4.0",
     "tailwindcss": "^3.3.0",
+    "testcontainers": "^12.0.0",
     "text-table": "^0.2.0",
     "ts-node": "^10.9.2",
     "tsx": "^4.16.5",
@@ -144,6 +146,7 @@
     "seed:activity-logs": "tsx ./src/cmd/fill-activity-logs",
     "start": "next start",
     "test": "jest",
+    "test:integration": "jest --config jest.integration.config.ts --runInBand",
     "tsc": "tsc --noEmit",
     "trigger": "npx trigger.dev@latest",
     "trigger:deploy-staging": "yarn trigger deploy -e staging",

prisma/migrations/20260515091539_add_task_reminder_sents_table/migration.sql

@@ -0,0 +1,20 @@
+-- CreateEnum
+CREATE TYPE "TaskReminderType" AS ENUM ('NO_DUE_DATE_3D', 'NO_DUE_DATE_7D', 'DUE_DATE_BEFORE_3D', 'DUE_DATE_TODAY', 'DUE_DATE_OVERDUE_3D', 'DUE_DATE_OVERDUE_7D');
+
+-- CreateTable
+CREATE TABLE "TaskReminderSents" (
+    "id" UUID NOT NULL DEFAULT gen_random_uuid(),
+    "taskId" UUID NOT NULL,
+    "workspaceId" VARCHAR(32) NOT NULL,
+    "recipientId" UUID NOT NULL,
+    "reminderType" "TaskReminderType" NOT NULL,
+    "sentAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+
+    CONSTRAINT "TaskReminderSents_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "TaskReminderSents_taskId_recipientId_reminderType_key" ON "TaskReminderSents"("taskId", "recipientId", "reminderType");
+
+-- AddForeignKey
+ALTER TABLE "TaskReminderSents" ADD CONSTRAINT "TaskReminderSents_taskId_fkey" FOREIGN KEY ("taskId") REFERENCES "Tasks"("id") ON DELETE CASCADE ON UPDATE CASCADE;

prisma/schema/task.prisma

@@ -57,6 +57,7 @@ model Task {
   deletedBy           String?       @db.Uuid
 
   taskUpdateBacklogs TaskUpdateBacklog[]
+  taskReminderSents  TaskReminderSent[]
 
   associations       Json        @db.JsonB @default("[]")
   isShared           Boolean     @default(false)

prisma/schema/taskReminderSent.prisma

@@ -0,0 +1,21 @@
+enum TaskReminderType {
+  NO_DUE_DATE_3D
+  NO_DUE_DATE_7D
+  DUE_DATE_BEFORE_3D
+  DUE_DATE_TODAY
+  DUE_DATE_OVERDUE_3D
+  DUE_DATE_OVERDUE_7D
+}
+
+model TaskReminderSent {
+  id           String           @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+  task         Task             @relation(fields: [taskId], references: [id], onDelete: Cascade)
+  taskId       String           @db.Uuid
+  workspaceId  String           @db.VarChar(32)
+  recipientId  String           @db.Uuid
+  reminderType TaskReminderType
+  sentAt       DateTime         @default(now())
+
+  @@unique([taskId, recipientId, reminderType])
+  @@map("TaskReminderSents")
+}

src/app/api/core/types/tasks.ts

@@ -8,6 +8,9 @@ export enum NotificationTaskActions {
   CompletedForCompanyByIU = 'completedForCompanyByIu',
   Completed = 'completed',
   CompletedByIU = 'completedByIu',
+  // Completion notifications for client users a task is *shared* with (viewers), not assignees
+  CompletedToSharedCU = 'completedToSharedCU',
+  CompletedToSharedCompany = 'completedToSharedCompany',
   Commented = 'commented',
   // these two comment actions below are sub actions of Commented.
   // Its used to handle the cases for CU vs IU being notified of comments appropriately

src/app/api/notification/__snapshots__/notification.helpers.test.ts.snap

@@ -0,0 +1,139 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getReminderEmailDetails matches snapshot for company recipient 1`] = `
+{
+  "DUE_DATE_BEFORE_3D": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ due in 3 days.
+
+Please make sure to complete this task by the due date.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to your company",
+    "subject": "[Due Soon] Task due in 3 days",
+    "title": "View task",
+  },
+  "DUE_DATE_OVERDUE_3D": {
+    "body": "This is a friendly reminder that the task ‘Submit timesheet’ is now overdue. It was due 3 days ago and is still pending completion.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to your company",
+    "subject": "[Overdue] Task was due 3 days ago",
+    "title": "View task",
+  },
+  "DUE_DATE_OVERDUE_7D": {
+    "body": "This is a friendly reminder that the task ‘Submit timesheet’ is now one week overdue.
+
+Please complete this task as soon as possible.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to your company",
+    "subject": "[Overdue] Task overdue by one week",
+    "title": "View task",
+  },
+  "DUE_DATE_TODAY": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ due today.
+
+Please complete this task as soon as possible.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to your company",
+    "subject": "[Due Soon] Task due today",
+    "title": "View task",
+  },
+  "NO_DUE_DATE_3D": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ assigned to you that's still pending completion.
+
+If you've already completed this task, please mark it as done in the portal.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to your company",
+    "subject": "[Reminder] You have a task to complete",
+    "title": "View task",
+  },
+  "NO_DUE_DATE_7D": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ that was assigned to you a week ago and is still pending.
+
+If you've already completed this task, please mark it as done in the portal.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to your company",
+    "subject": "[Reminder] Task still pending",
+    "title": "View task",
+  },
+}
+`;
+
+exports[`getReminderEmailDetails matches snapshot for individual recipient 1`] = `
+{
+  "DUE_DATE_BEFORE_3D": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ due in 3 days.
+
+Please make sure to complete this task by the due date.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to you",
+    "subject": "[Due Soon] Task due in 3 days",
+    "title": "View task",
+  },
+  "DUE_DATE_OVERDUE_3D": {
+    "body": "This is a friendly reminder that the task ‘Submit timesheet’ is now overdue. It was due 3 days ago and is still pending completion.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to you",
+    "subject": "[Overdue] Task was due 3 days ago",
+    "title": "View task",
+  },
+  "DUE_DATE_OVERDUE_7D": {
+    "body": "This is a friendly reminder that the task ‘Submit timesheet’ is now one week overdue.
+
+Please complete this task as soon as possible.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to you",
+    "subject": "[Overdue] Task overdue by one week",
+    "title": "View task",
+  },
+  "DUE_DATE_TODAY": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ due today.
+
+Please complete this task as soon as possible.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to you",
+    "subject": "[Due Soon] Task due today",
+    "title": "View task",
+  },
+  "NO_DUE_DATE_3D": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ assigned to you that's still pending completion.
+
+If you've already completed this task, please mark it as done in the portal.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to you",
+    "subject": "[Reminder] You have a task to complete",
+    "title": "View task",
+  },
+  "NO_DUE_DATE_7D": {
+    "body": "This is a friendly reminder that you have a task ‘Submit timesheet’ that was assigned to you a week ago and is still pending.
+
+If you've already completed this task, please mark it as done in the portal.",
+    "ctaParams": {
+      "taskId": "task_1",
+    },
+    "header": "A task was assigned to you",
+    "subject": "[Reminder] Task still pending",
+    "title": "View task",
+  },
+}
+`;

src/app/api/notification/notification.helpers.test.ts

@@ -0,0 +1,55 @@
+import { WorkspaceResponse } from '@/types/common'
+import { getReminderEmailDetails } from './notification.helpers'
+import { TaskReminderType } from '@prisma/client'
+
+const workspace: WorkspaceResponse = {
+  id: 'ws_1',
+  brandName: 'Acme',
+  labels: {
+    individualTerm: 'client',
+    individualTermPlural: 'clients',
+    groupTerm: 'company',
+    groupTermPlural: 'companies',
+  },
+}
+
+const task = { id: 'task_1', title: 'Submit timesheet' }
+
+describe('getReminderEmailDetails', () => {
+  it('returns a value for every TaskReminderType', () => {
+    const result = getReminderEmailDetails(workspace, task, false)
+    const expectedKeys = Object.values(TaskReminderType).sort()
+    expect(Object.keys(result).sort()).toEqual(expectedKeys)
+  })
+
+  it('matches snapshot for individual recipient', () => {
+    expect(getReminderEmailDetails(workspace, task, false)).toMatchSnapshot()
+  })
+
+  it('matches snapshot for company recipient', () => {
+    expect(getReminderEmailDetails(workspace, task, true)).toMatchSnapshot()
+  })
+
+  it('uses custom group term from workspace labels for company recipient', () => {
+    const customWorkspace: WorkspaceResponse = {
+      ...workspace,
+      labels: { ...workspace.labels, groupTerm: 'team' },
+    }
+    const result = getReminderEmailDetails(customWorkspace, task, true)
+    expect(result[TaskReminderType.NO_DUE_DATE_3D].header).toBe('A task was assigned to your team')
+  })
+
+  it('omits any `<brand> portal:` prefix from subjects (Copilot prepends it server-side)', () => {
+    const result = getReminderEmailDetails(workspace, task, false)
+    for (const variant of Object.values(TaskReminderType)) {
+      expect(result[variant].subject).not.toMatch(/portal:/i)
+    }
+  })
+
+  it('emits ctaParams with the task id for every variant', () => {
+    const result = getReminderEmailDetails(workspace, task, false)
+    for (const variant of Object.values(TaskReminderType)) {
+      expect(result[variant].ctaParams).toEqual({ taskId: 'task_1' })
+    }
+  })
+})