Merge dev into production release without education
This commit is contained in:
commit
fc541f024d
50 files changed
+2986
-458
No files matched your search
@@ -0,0 +1,28 @@
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import sharp from 'sharp';
|
||||
import type { WeightReminder } from '../reminders/weightReminders.js';
|
||||
import { getS3ImageStorageConfig } from '../storage/imageStorageConfig.js';
|
||||
import { getSignedS3ObjectUrl } from '../storage/s3Client.js';
|
||||
|
||||
const asset = (name: string) => new URL(`../../assets/${name}`, import.meta.url);
|
||||
const thumbnail = (content: Buffer) => sharp(content).rotate().resize(192, 192, { fit: 'cover' }).jpeg({ quality: 80 }).toBuffer();
|
||||
|
||||
export const loadWeightReminderPortrait = async (bird: Pick<WeightReminder, 'bird_id' | 'photo_object_key' | 'photo_data_url'>): Promise<Buffer> => {
|
||||
try {
|
||||
if (bird.photo_object_key) {
|
||||
const config = getS3ImageStorageConfig();
|
||||
if (config) {
|
||||
const response = await fetch(getSignedS3ObjectUrl({ config, objectKey: bird.photo_object_key, expiresInSeconds: 300 }), {
|
||||
signal: AbortSignal.timeout(10_000),
|
||||
});
|
||||
if (!response.ok) throw new Error(`Photo storage returned ${response.status}`);
|
||||
return await thumbnail(Buffer.from(await response.arrayBuffer()));
|
||||
}
|
||||
}
|
||||
const match = bird.photo_data_url?.match(/^data:image\/(?:png|jpe?g|webp|gif);base64,(.+)$/);
|
||||
if (match) return await thumbnail(Buffer.from(match[1], 'base64'));
|
||||
} catch {
|
||||
console.warn(`Unable to load weight reminder portrait for bird ${bird.bird_id}; using default portrait.`);
|
||||
}
|
||||
return thumbnail(await readFile(asset('yoda-default.png')));
|
||||
};
|
||||
@@ -0,0 +1,36 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import { test } from 'node:test';
|
||||
import { buildEmailLayout } from './emailLayout.js';
|
||||
|
||||
test('shared layout escapes copy and embeds the app background and bird portrait', async () => {
|
||||
const mail = await buildEmailLayout({
|
||||
backgroundUrl: 'https://flockpal.test/email-background.png',
|
||||
eyebrow: 'Medication <reminder>', headline: 'Medication time for Kiwi & Peep',
|
||||
contentHtml: '<p>Morning at 8:00 AM</p>',
|
||||
action: { url: 'https://flockpal.test/?a=1&b=2', label: 'Open <FlockPal>' },
|
||||
bird: { id: 'bird-1', name: 'Kiwi & Peep', photo_data_url: null, photo_object_key: null },
|
||||
});
|
||||
const html = String(mail.html);
|
||||
assert.match(html, /Medication <reminder>/);
|
||||
assert.match(html, /Medication time for Kiwi & Peep/);
|
||||
assert.match(html, /a=1&b=2/);
|
||||
assert.match(html, /Open <FlockPal>/);
|
||||
assert.match(html, /Morning at 8:00 AM/);
|
||||
assert.match(html, /background="https:\/\/flockpal.test\/email-background.png"/);
|
||||
assert.match(html, /background-image:url\('https:\/\/flockpal.test\/email-background.png'\)/);
|
||||
assert.doesNotMatch(html, /flockpal-pattern|cid:flockpal-background/);
|
||||
assert.doesNotMatch(html, /48-hour|weights are overdue|data:image/);
|
||||
for (const attachment of mail.attachments ?? []) {
|
||||
assert.ok(html.includes(`cid:${attachment.cid}`));
|
||||
assert.equal(attachment.contentDisposition, 'inline');
|
||||
assert.ok(Buffer.isBuffer(attachment.content));
|
||||
}
|
||||
assert.equal((html.match(/<table\b/g) ?? []).length, (html.match(/<\/table>/g) ?? []).length);
|
||||
assert.equal((html.match(/<td\b/g) ?? []).length, (html.match(/<\/td>/g) ?? []).length);
|
||||
});
|
||||
|
||||
test('transactional layout omits optional portrait, action and reminder footer', async () => {
|
||||
const mail = await buildEmailLayout({ eyebrow: 'Rescue status', headline: 'Flock update', contentHtml: '<p>Status changed</p>' });
|
||||
assert.equal(mail.attachments?.length, 1);
|
||||
assert.doesNotMatch(String(mail.html), /bird-portrait|<a |48-hour/);
|
||||
});
|
||||
@@ -0,0 +1,48 @@
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import type { SendMailOptions } from 'nodemailer';
|
||||
import sharp from 'sharp';
|
||||
import { loadWeightReminderPortrait } from './birdPortrait.js';
|
||||
|
||||
export const escapeHtml = (value: string) => value.replace(/[&<>"']/g, char => ({
|
||||
'&': '&', '<': '<', '>': '>', '"': '"', "'": ''',
|
||||
})[char]!);
|
||||
const asset = (name: string) => new URL(`../../assets/${name}`, import.meta.url);
|
||||
|
||||
export const buildEmailLayout = async ({ eyebrow, headline, preheader = headline, contentHtml, action, footer, bird, backgroundUrl = process.env.EMAIL_BACKGROUND_URL || new URL('/email-background.png', process.env.FRONTEND_URL || 'http://localhost:3000').href }: {
|
||||
eyebrow: string;
|
||||
headline: string;
|
||||
preheader?: string;
|
||||
/** Trusted markup; escape all dynamic values before passing them. */
|
||||
contentHtml: string;
|
||||
action?: { url: string; label: string };
|
||||
footer?: string;
|
||||
backgroundUrl?: string;
|
||||
bird?: { id: string; name: string; photo_data_url: string | null; photo_object_key: string | null };
|
||||
}): Promise<Pick<SendMailOptions, 'html' | 'attachments'>> => ({
|
||||
attachments: [
|
||||
{ filename: 'flockpal-logo.png', cid: 'flockpal-logo', contentType: 'image/png', contentDisposition: 'inline', content: await sharp(await readFile(asset('flockpal-logo.png'))).resize({ width: 480 }).png().toBuffer() },
|
||||
...(bird ? [{ filename: 'bird-portrait.jpg', cid: 'bird-portrait', contentType: 'image/jpeg', contentDisposition: 'inline' as const, content: await loadWeightReminderPortrait({ bird_id: bird.id, photo_data_url: bird.photo_data_url, photo_object_key: bird.photo_object_key }) }] : []),
|
||||
],
|
||||
html: `<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"></head>
|
||||
<body style="margin:0;padding:0;background-color:#fef5e7;">
|
||||
<div style="display:none;max-height:0;overflow:hidden;mso-hide:all;">${escapeHtml(preheader)}</div>
|
||||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" style="width:100%;background-color:#fef5e7;font-family:Arial,sans-serif;color:#1f2a2a;line-height:1.5;">
|
||||
<tr><td align="center" background="${escapeHtml(backgroundUrl)}" style="padding:24px 12px;background-color:#fef5e7;background-image:url('${escapeHtml(backgroundUrl)}');background-position:center top;background-repeat:repeat;background-size:100% auto;">
|
||||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" style="max-width:600px;background-color:#edf8ef;border:1px solid #d3e5d8;border-radius:24px;">
|
||||
<tr><td align="center" style="padding:24px;border-bottom:1px solid #d3e5d8;">
|
||||
<img src="cid:flockpal-logo" width="220" alt="FlockPal" style="display:block;width:220px;max-width:100%;height:auto;border:0;" />
|
||||
</td></tr>
|
||||
<tr><td style="padding:24px;">
|
||||
<p style="margin:0 0 8px;font-size:12px;font-weight:bold;letter-spacing:1.5px;color:#238a5a;text-transform:uppercase;">${escapeHtml(eyebrow)}</p>
|
||||
<h1 style="margin:0 0 12px;font-size:26px;line-height:1.2;word-break:break-word;">${escapeHtml(headline)}</h1>
|
||||
${bird ? `<img src="cid:bird-portrait" width="76" height="76" alt="${escapeHtml(bird.name)}" style="display:block;border:0;border-radius:16px;margin:0 0 16px;" />` : ''}
|
||||
${contentHtml}
|
||||
${action ? `<table role="presentation" cellspacing="0" cellpadding="0" style="margin-top:24px;"><tr><td bgcolor="#238a5a" style="border-radius:24px;text-align:center;"><a href="${escapeHtml(action.url)}" style="display:inline-block;padding:13px 22px;border:1px solid #238a5a;border-radius:24px;color:#ffffff;font-size:16px;font-weight:bold;text-decoration:none;">${escapeHtml(action.label)}</a></td></tr></table>` : ''}
|
||||
${footer ? `<p style="margin:20px 0 0;font-size:13px;color:#52645b;">${escapeHtml(footer)}</p>` : ''}
|
||||
</td></tr>
|
||||
</table>
|
||||
<p style="margin:16px 0 0;color:#52645b;font-size:12px;">FlockPal · A little care, every day.</p>
|
||||
</td></tr>
|
||||
</table>
|
||||
</body></html>`,
|
||||
});
|
||||
@@ -0,0 +1,60 @@
|
||||
import assert from 'node:assert/strict';
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import { test } from 'node:test';
|
||||
import sharp from 'sharp';
|
||||
import { buildWeightReminderEmail, loadWeightReminderPortrait } from './weightReminderEmail.js';
|
||||
import type { WeightReminder } from '../reminders/weightReminders.js';
|
||||
|
||||
const bird: WeightReminder = {
|
||||
bird_id: 'bird-1', workspace_id: 1, bird_name: 'Kiwi & <Peep>', species: 'Cockatiel',
|
||||
workspace_name: 'Our <Flock>', activity_at: '2026-09-01T12:00:00Z', recipient: 'owner@example.test',
|
||||
photo_data_url: null, photo_object_key: null,
|
||||
};
|
||||
|
||||
test('branded grouped email embeds distinct portraits and escapes dynamic content', async () => {
|
||||
const mail = await buildWeightReminderEmail([bird, { ...bird, bird_id: 'bird-2', bird_name: 'Yoda' }], 'https://flockpal.test/?a=1&b=2');
|
||||
assert.equal(mail.attachments?.length, 3);
|
||||
assert.deepEqual(mail.attachments?.map(a => a.cid), ['flockpal-logo', 'weight-bird-0', 'weight-bird-1']);
|
||||
for (const attachment of mail.attachments ?? []) {
|
||||
assert.equal(attachment.contentDisposition, 'inline');
|
||||
assert.ok(Buffer.isBuffer(attachment.content));
|
||||
assert.ok(String(mail.html).includes(`cid:${attachment.cid}`));
|
||||
}
|
||||
assert.match(String(mail.html), /Kiwi & <Peep>/);
|
||||
assert.match(String(mail.html), /Our <Flock>/);
|
||||
assert.match(String(mail.html), /a=1&b=2/);
|
||||
assert.match(String(mail.text), /Kiwi & <Peep>/);
|
||||
});
|
||||
|
||||
test('database portrait is resized and invalid photos fall back to the default', async () => {
|
||||
const source = await readFile(new URL('../../assets/yoda.png', import.meta.url));
|
||||
const photo = await loadWeightReminderPortrait({ ...bird, photo_data_url: `data:image/png;base64,${source.toString('base64')}` });
|
||||
const metadata = await sharp(photo).metadata();
|
||||
assert.equal(metadata.width, 192);
|
||||
assert.equal(metadata.height, 192);
|
||||
assert.equal(metadata.format, 'jpeg');
|
||||
assert.deepEqual(await loadWeightReminderPortrait({ ...bird, photo_data_url: 'data:image/png;base64,broken' }), await loadWeightReminderPortrait(bird));
|
||||
});
|
||||
|
||||
test('private S3 portrait is downloaded and embedded rather than linked', async (t) => {
|
||||
const env = { IMAGE_STORAGE_PROVIDER: 's3', S3_ENDPOINT: 'https://storage.example.test', S3_REGION: 'us-east-1', S3_BUCKET: 'portraits', S3_ACCESS_KEY_ID: 'test', S3_SECRET_ACCESS_KEY: 'test' };
|
||||
const previous = Object.fromEntries(Object.keys(env).map(key => [key, process.env[key]]));
|
||||
Object.assign(process.env, env);
|
||||
try {
|
||||
const source = await readFile(new URL('../../assets/yoda.png', import.meta.url));
|
||||
t.mock.method(globalThis, 'fetch', async (url: string) => {
|
||||
assert.match(String(url), /private-bird.png/);
|
||||
return new Response(source);
|
||||
});
|
||||
const photo = await loadWeightReminderPortrait({ ...bird, photo_object_key: 'private-bird.png' });
|
||||
assert.equal((await sharp(photo).metadata()).width, 192);
|
||||
t.mock.restoreAll();
|
||||
t.mock.method(globalThis, 'fetch', async () => new Response('', { status: 404 }));
|
||||
assert.deepEqual(await loadWeightReminderPortrait({ ...bird, photo_object_key: 'missing.png' }), await loadWeightReminderPortrait(bird));
|
||||
} finally {
|
||||
for (const [key, value] of Object.entries(previous)) {
|
||||
if (value === undefined) delete process.env[key];
|
||||
else process.env[key] = value;
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,44 @@
|
||||
import { buildEmailLayout, escapeHtml } from './emailLayout.js';
|
||||
import type { SendMailOptions } from 'nodemailer';
|
||||
import type { WeightReminder } from '../reminders/weightReminders.js';
|
||||
import { loadWeightReminderPortrait } from './birdPortrait.js';
|
||||
export { loadWeightReminderPortrait } from './birdPortrait.js';
|
||||
|
||||
export const buildWeightReminderEmail = async (
|
||||
reminders: WeightReminder[],
|
||||
frontendUrl: string,
|
||||
loadPortrait = loadWeightReminderPortrait,
|
||||
): Promise<Pick<SendMailOptions, 'subject' | 'text' | 'html' | 'attachments'>> => {
|
||||
if (!reminders.length) throw new Error('A weight reminder email requires at least one bird');
|
||||
const flock = reminders[0].workspace_name;
|
||||
const attachments: NonNullable<SendMailOptions['attachments']> = [];
|
||||
const rows: string[] = [];
|
||||
for (const [index, bird] of reminders.entries()) {
|
||||
const cid = `weight-bird-${index}`;
|
||||
attachments.push({ filename: `${cid}.jpg`, cid, content: await loadPortrait(bird), contentType: 'image/jpeg', contentDisposition: 'inline' });
|
||||
rows.push(`<tr>
|
||||
<td width="88" style="padding:16px 12px 16px 0;border-bottom:1px solid #d3e5d8;vertical-align:middle;">
|
||||
<img src="cid:${cid}" width="76" height="76" alt="${escapeHtml(bird.bird_name)}" style="display:block;border:0;border-radius:16px;" />
|
||||
</td>
|
||||
<td style="padding:16px 0;border-bottom:1px solid #d3e5d8;vertical-align:middle;word-break:break-word;">
|
||||
<p style="margin:0 0 4px;font-size:18px;font-weight:bold;color:#1f2a2a;">${escapeHtml(bird.bird_name)}</p>
|
||||
<p style="margin:0;font-size:14px;color:#52645b;">${escapeHtml(bird.species)}</p>
|
||||
<p style="margin:6px 0 0;font-size:13px;color:#63562d;">Ready for a weight check</p>
|
||||
</td>
|
||||
</tr>`);
|
||||
}
|
||||
const layout = await buildEmailLayout({
|
||||
eyebrow: 'Daily weight reminder',
|
||||
headline: 'A little check-in for your flock',
|
||||
preheader: `A little check-in for ${flock}: it's time to log your birds' weights.`,
|
||||
contentHtml: `<p style="margin:0 0 16px;font-size:16px;">These birds in <strong>${escapeHtml(flock)}</strong> haven't had a new weight entry in at least 48 hours.</p><table role="presentation" width="100%" cellspacing="0" cellpadding="0" style="border-collapse:collapse;table-layout:fixed;">${rows.join('')}</table>`,
|
||||
action: { url: frontendUrl, label: 'Record their weights' },
|
||||
footer: "You'll receive a daily reminder while weights are overdue. A new weight entry restarts the 48-hour clock.",
|
||||
});
|
||||
return {
|
||||
subject: `Weight reminders for ${flock}`,
|
||||
text: `Daily weight reminder — ${flock}\n\nThese birds haven't had a new weight entry in at least 48 hours:\n\n${reminders.map(bird => `- ${bird.bird_name} (${bird.species})`).join('\n')}\n\nOpen FlockPal to record their weights: ${frontendUrl}\n\nYou'll receive a daily reminder while weights are overdue.`,
|
||||
...layout,
|
||||
attachments: [...(layout.attachments ?? []), ...attachments],
|
||||
};
|
||||
};
|
||||
Reference in new issue
Block a user