Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion backend/src/cron/runner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';

import { createCardFromTemplate, listTemplates, instantiateTemplate } from '../db/templates';
import { listCards } from '../db/cards';
import { createNotification } from '../db/notifications';
import { createDueTaskNotifications, createNotification } from '../db/notifications';
import { generateRecurringTasks } from '../db/recurring';
import { emitRecurringCronMetrics } from './recurringMetrics';
import { addCivilDays, moveWeekendToMonday, parseCronExpression, scheduleDatesOccurringOn } from './cronMatch';
Expand Down Expand Up @@ -376,6 +376,16 @@ async function runCron(
failures++;
calendarHoldFailures++;
}

const activeCardIds = new Set(allCards.filter((card) => card.status === 'active').map((card) => card.id));
const dueTaskError = await runStep(client, async () => {
await createDueTaskNotifications(client, { todayDate, activeCardIds });
}, (message) => ({
type: 'automation-failure',
message: `Due task notifications failed for ${todayDate}: ${message}`,
dueAt: todayDate,
}));
if (dueTaskError !== null) failures++;
await recordAutomationRun(client, 'calendar-hold-expiry', {
ok: calendarHoldFailures === 0,
summary: [
Expand Down
86 changes: 85 additions & 1 deletion backend/src/db/notifications.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
import { cleanItem as cleanDbItem } from './cleanItem';
import { TABLE_NOTIFICATIONS } from './tableNames';
import { readCollectionPage } from './collectionPage';
import { listTasksByStatus } from './tasks';
import { getCard } from './cards';
import { listTasksByDate, listTasksByStatus } from './tasks';
import type { Notification, Task } from '../types';

const cleanItem = cleanDbItem<Notification>;
Expand Down Expand Up @@ -92,6 +93,88 @@ async function createDueFollowUpNotifications(
return created;
}

export interface DueTaskNotificationCandidate {
type: 'task-due';
message: string;
taskId: string;
cardId?: string;
userId?: string;
dueAt: string;
}

function isDueTodoTask(task: Task, todayDate: string): boolean {
return (
task.status === 'todo' &&
typeof task.date === 'string' &&
task.date === todayDate &&
(!task.snoozedUntil || task.snoozedUntil <= todayDate)
);
}

/**
* Create one `task-due` notification for each open `todo` task whose due date
* matches `todayDate` (and is not snoozed past `todayDate` or on a non-active Card).
* Dismissed notifications still count as generated so dismissing a reminder does
* not recreate it for the same task and due date.
*/
async function createDueTaskNotifications(
client: DynamoDBDocumentClient,
options: {
todayDate: string;
activeCardIds?: ReadonlySet<string>;
dryRun?: boolean;
},
): Promise<{ created: Notification[]; candidates: DueTaskNotificationCandidate[] }> {
const { todayDate, activeCardIds, dryRun = false } = options;
const tasks = (await listTasksByDate(client, todayDate)).filter((task) => isDueTodoTask(task, todayDate));
if (tasks.length === 0) {
return { created: [], candidates: [] };
}

let resolvedActiveCardIds = activeCardIds;
if (!resolvedActiveCardIds) {
const uniqueCardIds = [...new Set(tasks.map((task) => task.cardId).filter((id): id is string => Boolean(id)))];
const cards = await Promise.all(uniqueCardIds.map((cardId) => getCard(client, cardId)));
resolvedActiveCardIds = new Set(
cards.filter((card): card is NonNullable<typeof card> => Boolean(card && card.status === 'active')).map((card) => card.id),
);
}

const existing = await listAllNotifications(client);
const existingKeys = new Set(
existing
.filter((notification) => notification.type === 'task-due' && notification.taskId && notification.dueAt)
.map((notification) => `task#${notification.taskId}#${notification.dueAt}`),
);

const candidates: DueTaskNotificationCandidate[] = [];
for (const task of tasks) {
if (task.cardId && !resolvedActiveCardIds.has(task.cardId)) continue;
const key = `task#${task.id}#${task.date}`;
if (existingKeys.has(key)) continue;

candidates.push({
type: 'task-due',
message: task.description,
taskId: task.id,
...(task.cardId ? { cardId: task.cardId } : {}),
...(task.assigneeId ? { userId: task.assigneeId } : {}),
dueAt: task.date!,
});
existingKeys.add(key);
}

if (dryRun) {
return { created: [], candidates };
}

const created: Notification[] = [];
for (const candidate of candidates) {
created.push(await createNotification(client, candidate as unknown as Record<string, unknown>));
}
return { created, candidates };
}

/**
* Get a notification by id.
*/
Expand Down Expand Up @@ -256,6 +339,7 @@ async function dismissAllNotifications(client: DynamoDBDocumentClient): Promise<
export {
createNotification,
createDueFollowUpNotifications,
createDueTaskNotifications,
getNotification,
dismissNotification,
listUndismissedNotifications,
Expand Down
49 changes: 48 additions & 1 deletion backend/src/routes/notifications.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
import { getClient } from '../db/client';
import {
createDueFollowUpNotifications,
createDueTaskNotifications,
getNotification,
dismissNotification,
listUndismissedNotifications,
Expand All @@ -10,6 +11,7 @@ import {
dismissAllNotifications,
} from '../db/notifications';
import { CollectionCursorError, encodeCollectionCursor } from '../db/collectionPagination';
import { berlinDate } from '../sponsorFinance/core';
import type { LambdaEvent, LambdaResponse } from '../types';
import { recordRequestError } from '../requestErrorLog';

Expand All @@ -22,7 +24,7 @@ const JSON_HEADERS: Record<string, string> = { 'Content-Type': 'application/json
* viewer id and whether it carries admin authority; `dismiss-all` clears
* every user's notifications and is therefore admin-only.
*/
async function handleNotificationRoutes(path: string, method: string, _rawBody: string | null, queryParams?: Record<string, string> | null, userId?: string, isAdmin?: boolean): Promise<LambdaResponse | null> {
async function handleNotificationRoutes(path: string, method: string, rawBody: string | null, queryParams?: Record<string, string> | null, userId?: string, isAdmin?: boolean): Promise<LambdaResponse | null> {
if (!path.startsWith('/api/notifications')) {
return null;
}
Expand Down Expand Up @@ -56,6 +58,51 @@ async function handleNotificationRoutes(path: string, method: string, _rawBody:
};
}

// Route: POST /api/notifications/due-tasks
if (suffix === '/due-tasks' && method === 'POST') {
let body: Record<string, unknown> = {};
if (rawBody) {
try {
body = JSON.parse(rawBody) as Record<string, unknown>;
} catch {
return {
statusCode: 400,
headers: JSON_HEADERS,
body: JSON.stringify({ error: 'Invalid JSON body' }),
};
}
}
const dryRun = body.dryRun === true;
if (!dryRun && !isAdmin) {
return {
statusCode: 403,
headers: JSON_HEADERS,
body: JSON.stringify({ error: 'Creating due task notifications requires an admin' }),
};
}
const requestedDate = typeof body.date === 'string' ? body.date.trim() : '';
if (requestedDate && !/^\d{4}-\d{2}-\d{2}$/.test(requestedDate)) {
return {
statusCode: 400,
headers: JSON_HEADERS,
body: JSON.stringify({ error: 'date must be YYYY-MM-DD' }),
};
}
const todayDate = requestedDate || berlinDate(new Date());
const result = await createDueTaskNotifications(client, { todayDate, dryRun });
const items = dryRun ? result.candidates : result.created;
return {
statusCode: 200,
headers: JSON_HEADERS,
body: JSON.stringify({
date: todayDate,
dryRun,
count: items.length,
items,
}),
};
}

// Route: PUT /api/notifications/dismiss-all
if (suffix === '/dismiss-all' && method === 'PUT') {
if (!isAdmin) {
Expand Down
3 changes: 2 additions & 1 deletion backend/tests/cron-runner.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,8 @@ describe('Cron runner', () => {

assert.ok(recurringScanFailed, 'the recurring step must have failed');
assert.equal(result.recurring.failures, 1);
assert.equal(result.failures, 1);
// Both recurring and due-task-notifications fail under the injected TABLE_NOTIFICATIONS outage.
assert.equal(result.failures, 2);
assert.ok(logs.some((line) => line.startsWith(
'Cron failure notification failed: Recurring task generation failed for 2045-03-07: injected recurring failure',
)));
Expand Down
80 changes: 79 additions & 1 deletion backend/tests/notifications.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ import { createTables } from '../scripts/local-dynamodb';
import {
createNotification,
createDueFollowUpNotifications,
createDueTaskNotifications,
getNotification,
dismissNotification,
listUndismissedNotifications,
listAllNotifications,
dismissAllNotifications,
} from '../src/db/notifications';
import { createCard } from '../src/db/cards';
import { createCard, parkCard } from '../src/db/cards';
import { templateLink } from './helpers/cardTemplate';
import { createTask, updateTask } from '../src/db/tasks';

Expand Down Expand Up @@ -311,4 +312,81 @@ describe('Notifications data layer', () => {
const count = await dismissAllNotifications(client);
assert.strictEqual(count, 0);
});

it('createDueTaskNotifications creates user-scoped task-due notifications for active due todo tasks', async () => {
const orinId = '59fb73a3-7436-45df-a003-e1114721d830';
await createCard(client, {
...templateLink(),
id: 'card-task-due-active',
title: 'Course Launch Active',
anchorDate: '2098-04-01',
status: 'active',
});
const parkedCard = await createCard(client, {
...templateLink(),
id: 'card-task-due-parked',
title: 'Course Launch Parked',
anchorDate: '2098-04-01',
});
await parkCard(client, parkedCard.id, parkedCard.version);

const dueTask = await createTask(client, {
description: 'Review and update course emails/templates after pre-course Q&A',
date: '2098-04-01',
status: 'todo',
assigneeId: orinId,
cardId: 'card-task-due-active',
});
await createTask(client, {
description: 'Already done task should not notify',
date: '2098-04-01',
status: 'done',
assigneeId: orinId,
cardId: 'card-task-due-active',
});
const snoozedTask = await createTask(client, {
description: 'Snoozed task should not notify',
date: '2098-04-01',
status: 'todo',
assigneeId: orinId,
cardId: 'card-task-due-active',
});
await updateTask(client, snoozedTask.id, {
expectedVersion: snoozedTask.version,
patch: { snoozedUntil: '2098-04-05', snoozeReason: 'Waiting for cohort' },
});
await createTask(client, {
description: 'Parked card task should not notify',
date: '2098-04-01',
status: 'todo',
assigneeId: orinId,
cardId: 'card-task-due-parked',
});

const dryRunResult = await createDueTaskNotifications(client, {
todayDate: '2098-04-01',
dryRun: true,
});
assert.strictEqual(dryRunResult.created.length, 0);
assert.strictEqual(dryRunResult.candidates.length, 1);
assert.strictEqual(dryRunResult.candidates[0].type, 'task-due');
assert.strictEqual(dryRunResult.candidates[0].taskId, dueTask.id);
assert.strictEqual(dryRunResult.candidates[0].userId, orinId);

const first = await createDueTaskNotifications(client, { todayDate: '2098-04-01' });
assert.strictEqual(first.created.length, 1);
assert.strictEqual(first.created[0].type, 'task-due');
assert.strictEqual(first.created[0].taskId, dueTask.id);
assert.strictEqual(first.created[0].cardId, 'card-task-due-active');
assert.strictEqual(first.created[0].userId, orinId);
assert.strictEqual(first.created[0].dueAt, '2098-04-01');

// Idempotent on repeat runs and after dismissal
const second = await createDueTaskNotifications(client, { todayDate: '2098-04-01' });
assert.strictEqual(second.created.length, 0);

await dismissNotification(client, first.created[0].id);
const afterDismiss = await createDueTaskNotifications(client, { todayDate: '2098-04-01' });
assert.strictEqual(afterDismiss.created.length, 0);
});
});