comi-logic/cfw-autumn
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add email reciept unit tests

Browse Source
This commit is contained in:
Charlie Lamb
2026-01-27 13:32:52 +00:00
parent 692a10833d
commit 49f6019798
3 changed files with 319 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

262
server/tests/unit/webhooks/invoice-paid/send-email-receipt.spec.ts Normal file
View File

@@ -0,0 +1,262 @@
/**
* Unit tests for sendEmailReceipt function.
*
* Tests the logic that sets receipt_email on PaymentIntent
* based on customer's should_send_email_receipts flag.
*/
import { describe, expect, test } from "bun:test";
import { AppEnv, type FullCustomer } from "@autumn/shared";
import { stripeClients } from "@tests/utils/fixtures/stripe/clients";
import chalk from "chalk";
import type { StripeInvoicePaidContext } from "@/external/stripe/webhookHandlers/handleStripeInvoicePaid/setupStripeInvoicePaidContext";
import { sendEmailReceipt } from "@/external/stripe/webhookHandlers/handleStripeInvoicePaid/tasks/sendEmailReceipt";
import type { StripeWebhookContext } from "@/external/stripe/webhookMiddlewares/stripeWebhookContext";
// ============ MOCK HELPERS ============
const createMockLogger = () => ({
debug: () => {},
info: () => {},
warn: () => {},
});
const createMockFullCustomer = (
overrides: Partial<FullCustomer> = {},
): FullCustomer => ({
id: "cus_test",
internal_id: "cus_internal_test",
name: "Test Customer",
email: "test@example.com",
fingerprint: null,
org_id: "org_test",
created_at: Date.now(),
env: AppEnv.Sandbox,
processor: { type: "stripe", id: "cus_stripe_test" },
processors: null,
metadata: {},
customer_products: [],
entities: [],
extra_customer_entitlements: [],
should_send_email_receipts: true,
...overrides,
});
const createMockInvoicePaidContext = (
paymentIntentId?: string,
): StripeInvoicePaidContext =>
({
stripeInvoice: {
id: "inv_test",
payments: paymentIntentId
? {
data: [
{
payment: { payment_intent: paymentIntentId },
},
],
}
: { data: [] },
},
}) as unknown as StripeInvoicePaidContext;
// ============ TESTS ============
describe(chalk.yellowBright("sendEmailReceipt"), () => {
describe(chalk.cyan("Early returns - no Stripe API calls"), () => {
test("returns when no fullCustomer", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient();
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: undefined,
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(0);
expect(mockCli._calls.update).toHaveLength(0);
});
test("returns when should_send_email_receipts is false", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient();
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer({
should_send_email_receipts: false,
}),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(0);
expect(mockCli._calls.update).toHaveLength(0);
});
test("returns when should_send_email_receipts is undefined", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient();
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer({
should_send_email_receipts: undefined as unknown as boolean,
}),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(0);
expect(mockCli._calls.update).toHaveLength(0);
});
test("returns when customer has no email", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient();
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer({
email: undefined as unknown as string,
}),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(0);
expect(mockCli._calls.update).toHaveLength(0);
});
test("returns when customer has empty string email", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient();
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer({ email: "" }),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(0);
expect(mockCli._calls.update).toHaveLength(0);
});
test("returns when invoice has no payments", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient();
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer(),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext(undefined),
});
expect(mockCli._calls.retrieve).toHaveLength(0);
expect(mockCli._calls.update).toHaveLength(0);
});
});
describe(chalk.cyan("PaymentIntent already has receipt_email"), () => {
test("returns without updating when receipt_email already set", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient({
retrieveResult: { receipt_email: "existing@example.com" },
});
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer(),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(1);
expect(mockCli._calls.update).toHaveLength(0);
});
});
describe(chalk.cyan("Success - sets receipt_email"), () => {
test("updates PaymentIntent with customer email when all conditions met", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient({
retrieveResult: { receipt_email: null },
});
const customerEmail = "customer@example.com";
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer({ email: customerEmail }),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(1);
expect(mockCli._calls.retrieve[0]).toBe("pi_123");
expect(mockCli._calls.update).toHaveLength(1);
expect(mockCli._calls.update[0].id).toBe("pi_123");
expect(mockCli._calls.update[0].params.receipt_email).toBe(customerEmail);
});
});
describe(chalk.cyan("Error handling"), () => {
test("does not throw when paymentIntents.retrieve fails", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient({
retrieveError: new Error("Stripe API error"),
});
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer(),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(1);
expect(mockCli._calls.update).toHaveLength(0);
});
test("does not throw when paymentIntents.update fails", async () => {
const mockCli = stripeClients.createMockPaymentIntentsClient({
retrieveResult: { receipt_email: null },
updateError: new Error("Stripe API error"),
});
const ctx = {
stripeCli: mockCli,
logger: createMockLogger(),
fullCustomer: createMockFullCustomer(),
} as unknown as StripeWebhookContext;
await sendEmailReceipt({
ctx,
invoicePaidContext: createMockInvoicePaidContext("pi_123"),
});
expect(mockCli._calls.retrieve).toHaveLength(1);
expect(mockCli._calls.update).toHaveLength(1);
});
});
});