feat(admin): track email delivery attempts

This commit is contained in:
Thomas Durieux committed 2026-11-14 12:51:32 +00:00
1 parent 104af7d261
commit 6400760fcb
24 files changed
+376 -44

No files matched your search

+60
View File
@@ -0,0 +1,60 @@
import { randomUUID } from "crypto";
import { mongo } from "mongoose";
import UserModel from "./model/users/users.model";
import { createLogger } from "./logger";
const logger = createLogger("email-history");
export const EMAIL_HISTORY = "email_delivery_history";
export interface EmailHistoryRecord {
_id: string;
kind: "repository-expiration" | "owner-access";
recipient: string;
ownerId: string;
resourceId: string;
resourceKind: string;
createdAt: Date;
completedAt?: Date;
state: "sending" | "accepted" | "rejected" | "unknown";
httpStatus?: number;
}
export const emailHistoryCollection = () => UserModel.db.collection(EMAIL_HISTORY) as unknown as mongo.Collection<EmailHistoryRecord>;
let indexed: Promise<unknown> | undefined;
export async function ensureEmailHistoryIndexes() {
if (!indexed) indexed = Promise.all([
emailHistoryCollection().createIndex({ createdAt: -1, _id: -1 }),
emailHistoryCollection().createIndex({ state: 1, createdAt: -1, _id: -1 }),
emailHistoryCollection().createIndex({ kind: 1, createdAt: -1, _id: -1 }),
]).catch(error => { indexed = undefined; throw error; });
await indexed;
}
/** Store metadata only: never API keys, message bodies, or provider error bodies. */
export async function sendTrackedEmail(metadata: Pick<EmailHistoryRecord, "kind" | "recipient" | "ownerId" | "resourceId" | "resourceKind">,
url: string, options: RequestInit): Promise<Response> {
const id = randomUUID(), createdAt = new Date();
let recorded = false;
const recording = (async () => {
try {
if (UserModel.db.readyState === 1) {
await ensureEmailHistoryIndexes();
await emailHistoryCollection().insertOne({ _id: id, ...metadata, createdAt, state: "sending" });
recorded = true;
}
} catch { logger.warn("email history write unavailable"); }
})();
// Start the provider request immediately after the caller commits dispatch.
// Auditing must not add a preparation gap to owner lifecycle fencing.
const complete = async (state: EmailHistoryRecord["state"], httpStatus?: number) => {
const completedAt = new Date();
await recording;
if (!recorded) return;
try {
await emailHistoryCollection().updateOne({ _id: id }, { $set: { state, completedAt, ...(httpStatus ? { httpStatus } : {}) } });
} catch { logger.warn("email history completion unavailable", { id }); }
};
let response: Response;
try { response = await fetch(url, options); }
catch (error) { await complete("unknown"); throw error; }
await complete(response.ok ? "accepted" : "rejected", response.status);
return response;
}
+3 -1
View File
@@ -1,3 +1,4 @@
import { sendTrackedEmail } from "./email-history";
import { createHash, randomUUID } from "crypto";
import { mongo, Types } from "mongoose";
import { isGitHubRateLimitError } from "./github-rate-limit";
@@ -577,7 +578,8 @@ export async function notifyOwnerAccessProblem(ownerId: string, error: unknown,
let httpStatus: number | undefined;
try {
providerStarted = true;
const response = await fetch("https://api.resend.com/emails", {
const response = await sendTrackedEmail({ kind: "owner-access", recipient: to, ownerId,
resourceId: resource.id, resourceKind: resource.kind }, "https://api.resend.com/emails", {
method: "POST",
headers: { Authorization: `Bearer ${config.RESEND_API_KEY}`, "Content-Type": "application/json",
"Idempotency-Key": `owner-access-alert/${attemptId}` },
+3 -1
View File
@@ -1,3 +1,4 @@
import { sendTrackedEmail } from "./email-history";
import config from "../config";
import RepositoryModel from "./model/anonymizedRepositories/anonymizedRepositories.model";
import UserModel from "./model/users/users.model";
@@ -27,7 +28,8 @@ export async function notifyRepositoryExpired(id: unknown): Promise<void> {
}, { $set: { expirationEmailClaimedFor: expirationDate } }).exec();
if (!claim.matchedCount) return;
// Keep the claim even after a timeout: the provider may have accepted the email.
const response = await fetch("https://api.resend.com/emails", {
const response = await sendTrackedEmail({ kind: "repository-expiration", recipient: to, ownerId: String(repo.owner),
resourceId: String(repo._id), resourceKind: "repository" }, "https://api.resend.com/emails", {
method: "POST",
headers: { Authorization: `Bearer ${config.RESEND_API_KEY}`, "Content-Type": "application/json",
"Idempotency-Key": `repository-expired/${repo._id}/${expirationDate.getTime()}` },
+42
View File
@@ -0,0 +1,42 @@
import { Router } from "express";
import { mongo } from "mongoose";
import { EmailHistoryRecord, emailHistoryCollection, ensureEmailHistoryIndexes } from "../../core/email-history";
const router = Router();
export function emailHistoryQuery(query: Record<string, unknown>) {
const filter: mongo.Filter<EmailHistoryRecord> = {};
if (query.state) {
if (typeof query.state !== "string" || !["sending", "accepted", "rejected", "unknown"].includes(String(query.state))) throw new Error("Invalid status");
filter.state = query.state as EmailHistoryRecord["state"];
}
if (query.kind) {
if (typeof query.kind !== "string" || !["repository-expiration", "owner-access"].includes(String(query.kind))) throw new Error("Invalid email type");
filter.kind = query.kind as EmailHistoryRecord["kind"];
}
if (query.before) {
if (typeof query.before !== "string" || query.before.length > 200) throw new Error("Invalid cursor");
const [date, id, extra] = query.before.split("|");
const time = new Date(date);
if (extra || !id || !/^[0-9a-f-]{36}$/.test(id) || !Number.isFinite(time.getTime())) throw new Error("Invalid cursor");
filter.$or = [{ createdAt: { $lt: time } }, { createdAt: time, _id: { $lt: id } }];
}
return filter;
}
// Mounted after the shared authentication and administrator checks.
router.get("/", async (req, res) => {
res.set("Cache-Control", "no-store");
let filter: mongo.Filter<EmailHistoryRecord>;
try { filter = emailHistoryQuery(req.query); }
catch { res.status(400).json({ error: "Invalid email history filters." }); return; }
try {
await ensureEmailHistoryIndexes();
const rows = await emailHistoryCollection().find(filter, { projection: {
_id: 1, kind: 1, recipient: 1, ownerId: 1, resourceId: 1, resourceKind: 1,
createdAt: 1, completedAt: 1, state: 1, httpStatus: 1,
} }).sort({ createdAt: -1, _id: -1 }).limit(51).toArray();
const entries = rows.slice(0, 50);
const last = entries.at(-1);
res.json({ entries, nextCursor: rows.length > 50 && last ? `${last.createdAt.toISOString()}|${last._id}` : null });
} catch { res.status(503).json({ error: "Email history is unavailable. Try again." }); }
});
export default router;
+2
View File
@@ -22,6 +22,7 @@ import { ensureAuthenticated } from "./connection";
import { handleError, getUser, isOwnerOrAdmin, getRepo } from "./route-utils";
import adminTokensRouter from "./admin-tokens";
import adminBillingRouter from "./admin-billing";
import adminEmailsRouter from "./admin-emails";
import { octokit, getToken } from "../../core/GitHubUtils";
import {
createLogger,
@@ -85,6 +86,7 @@ router.use(
router.use("/tokens", adminTokensRouter);
router.use("/billing", adminBillingRouter);
router.use("/emails", adminEmailsRouter);
router.get("/performance", async (req, res) => {
res.set("Cache-Control", "no-store");