Refresh HiveGrid Cloud reference snapshot

This commit is contained in:
david committed 2026-08-03 15:31:14 +02:00
1 parent 5e99e14772
commit 7f88026f79
5955 files changed
+1177325 -188362

No files matched your search

@@ -4,8 +4,6 @@ import { sendEmailMailjet } from "./MailjetEmailService";
const emailLogger = createScopedLogger("email");
type EmailProvider = "mailjet";
export async function sendEmail({
request,
to,
@@ -68,6 +68,41 @@ describe("sendEmailMailjet", () => {
);
});
test("preserves portal tenant and source metadata for the final worker feature gate", async () => {
const queue = createQueueMock();
await sendEmailMailjet(
{
data: {
to: "customer@example.com",
subject: "Portal sign-in",
body: "<p>Sign in</p>",
alias: "magic-link",
source: "portal-auth-mail",
tenantId: "tenant_portal_1",
priorityOverride: "critical",
},
},
{ queue }
);
const descriptor = buildTransactionalMailJob({
to: ["customer@example.com"],
subject: "Portal sign-in",
html: "<p>Sign in</p>",
tenantId: "tenant_portal_1",
metadata: { alias: "magic-link", source: "portal-auth-mail" },
});
expect(queue.add).toHaveBeenCalledWith(
"send-transactional-email",
descriptor.payload,
expect.objectContaining({
...buildRetryJobOptions(descriptor),
priority: 1,
})
);
});
test("fails closed when Redis is missing without falling back to synchronous mail", async () => {
await expect(sendEmailMailjet(
{
@@ -8,7 +8,7 @@ import {
type RedisConnectionEnv,
type TypedQueue,
} from "@hivegrid/queue";
import { t as i18nT } from "i18next";
import { requestScopedT as i18nT } from "~/locale/request-scoped-t";
export type SendEmailMailjetDependencies = {
env?: RedisConnectionEnv;
@@ -23,7 +23,9 @@ export async function sendEmailMailjet(
to: string;
subject?: string;
body?: string;
text?: string;
alias?: string;
source?: string;
data?: {
[key: string]: any;
};
@@ -35,20 +37,26 @@ export async function sendEmailMailjet(
dependencies: SendEmailMailjetDependencies = {}
) {
const mailProvider = dependencies.queue
? createTransactionalQueueProvider(dependencies.queue, data.alias, data.data)
: createTransactionalQueueProviderFromEnv(dependencies.env, data.alias, data.data);
? createTransactionalQueueProvider(dependencies.queue, data.alias, data.data, data.source)
: createTransactionalQueueProviderFromEnv(dependencies.env, data.alias, data.data, data.source);
return await mailProvider.send({
to: [data.to],
subject: data.subject,
html: data.body,
text: data.text,
tenantId: data.tenantId,
priorityOverride: data.priorityOverride,
...(data.attachments && data.attachments.length > 0 ? { attachments: data.attachments } : {}),
});
}
function createTransactionalQueueProviderFromEnv(env?: RedisConnectionEnv, alias?: string, templateData?: Record<string, unknown>): MailProvider {
function createTransactionalQueueProviderFromEnv(
env?: RedisConnectionEnv,
alias?: string,
templateData?: Record<string, unknown>,
source?: string
): MailProvider {
const connection = env ? resolveRedisConnectionOptions({ env }) : resolveRedisConnectionOptionsFromProcessEnv();
if (!connection) {
@@ -72,7 +80,7 @@ function createTransactionalQueueProviderFromEnv(env?: RedisConnectionEnv, alias
const { createQueue } = (await import(/* @vite-ignore */ queueRuntimeModule)) as typeof import("@hivegrid/queue/runtime");
const queue = createQueue(queueNames.email, { connection });
try {
return await createTransactionalQueueProvider(queue, alias, templateData).send(input);
return await createTransactionalQueueProvider(queue, alias, templateData, source).send(input);
} finally {
await queue.close();
}
@@ -80,21 +88,31 @@ function createTransactionalQueueProviderFromEnv(env?: RedisConnectionEnv, alias
};
}
function createTransactionalQueueProvider(queue: TypedQueue<typeof queueNames.email>, alias?: string, templateData?: Record<string, unknown>): MailProvider {
function createTransactionalQueueProvider(
queue: TypedQueue<typeof queueNames.email>,
alias?: string,
templateData?: Record<string, unknown>,
source?: string
): MailProvider {
return {
id: "queue",
async send(input) {
const descriptor = buildTransactionalMailJob({
to: input.to.map((recipient) => (typeof recipient === "string" ? recipient : recipient.email)),
subject: input.subject,
text: input.text,
html: input.html,
templateData,
// Forward attachments (e.g. AK-P16b booking .ics) — the payload already
// supports them; only this provider hop was dropping the field.
...(input.attachments && input.attachments.length > 0 ? { attachments: input.attachments } : {}),
metadata: alias ? { alias } : undefined,
...(input.tenantId !== undefined && input.tenantId !== null ? { tenantId: input.tenantId } : {}),
metadata: alias || source ? { ...(alias ? { alias } : {}), ...(source ? { source } : {}) } : undefined,
});
const job = await enqueueJob(queue, descriptor, {
...(input.tenantId !== undefined ? { tenantId: input.tenantId } : {}),
...(input.priorityOverride !== undefined ? { priorityOverride: input.priorityOverride } : {}),
});
const job = await enqueueJob(queue, descriptor);
return {
provider: "queue",
@@ -56,6 +56,7 @@ describe("queueTransactionalEmail", () => {
to: "user@example.com",
subject: "Reset password",
body: "<p>Reset</p>",
text: "Reset",
alias: "password-reset",
tenantId: "tenant_1",
userId: "user_1",
@@ -71,6 +72,7 @@ describe("queueTransactionalEmail", () => {
const descriptor = buildTransactionalMailJob({
to: ["user@example.com"],
subject: "Reset password",
text: "Reset",
html: "<p>Reset</p>",
templateData: { action_url: "https://example.com/reset" },
tenantId: "tenant_1",
@@ -104,6 +106,36 @@ describe("queueTransactionalEmail", () => {
expect(runtimeQueue.close).toHaveBeenCalledOnce();
});
test("uses only an opaque verification idempotency key in BullMQ job identity and metadata", async () => {
const add = vi.fn(async () => ({ id: "job_opaque" }));
const queue = { add } as unknown as TypedQueue<typeof queueNames.email>;
const email = "ada@example.com";
const verificationToken = "raw-verification-capability";
const creationRequestKey = "d7077797-054b-497a-b1ce-8e4f36257a96";
const opaqueKey = "registration-verification:registration_1:184a82a6628ec5c7d863148d76f5598a";
await queueTransactionalEmail(
{
to: email,
subject: "Verify your email",
body: `<a href="https://example.test/verify/${verificationToken}">Verify</a>`,
alias: "email-verification",
idempotencyKey: opaqueKey,
},
{ queue }
);
const [, payload, options] = add.mock.calls[0] ?? [];
const serializedIdentity = JSON.stringify({
jobId: options?.jobId,
metadata: payload?.metadata,
});
expect(serializedIdentity).toContain(opaqueKey);
expect(serializedIdentity).not.toContain(email);
expect(serializedIdentity).not.toContain(verificationToken);
expect(serializedIdentity).not.toContain(creationRequestKey);
});
test("propagates enqueue failures without synchronous mail fallback", async () => {
const enqueueError = new Error("queue unavailable");
const add = vi.fn(async () => {
@@ -12,10 +12,13 @@ export type QueueTransactionalEmailInput = {
to: string;
subject?: string;
body?: string;
text?: string;
alias?: string;
tenantId?: string;
userId?: string;
data?: Record<string, unknown>;
/** Stable, non-PII key used to collapse ambiguous enqueue retries. */
idempotencyKey?: string;
/**
* Explicit BullMQ priority for this mail job. Use `"critical"` for
* auth-flow mails (password-reset, magic-link, invitation, verification)
@@ -24,11 +27,10 @@ export type QueueTransactionalEmailInput = {
priorityOverride?: "critical" | "high" | "normal" | "low";
};
export type QueueTransactionalEmailResult =
| {
enqueued: true;
jobId?: string;
};
export type QueueTransactionalEmailResult = {
enqueued: true;
jobId?: string;
};
type QueueTransactionalEmailDependencies = {
env?: RedisConnectionEnv;
@@ -67,17 +69,20 @@ export async function queueTransactionalEmail(
const descriptor = buildTransactionalMailJob({
to: [input.to],
subject: input.subject,
text: input.text,
html: input.body,
templateData: input.data,
tenantId: input.tenantId,
userId: input.userId,
metadata: {
alias: input.alias,
...(input.idempotencyKey ? { idempotencyKey: input.idempotencyKey } : {}),
},
});
const job = await enqueueJob(queue, descriptor, {
...(input.tenantId !== undefined ? { tenantId: input.tenantId } : {}),
...(input.priorityOverride !== undefined ? { priorityOverride: input.priorityOverride } : {}),
...(input.idempotencyKey ? { idempotencyKey: input.idempotencyKey } : {}),
});
return {
@@ -67,7 +67,7 @@ describe("TransactionalEmailSettings.server", () => {
const result = await updateMailjetSettings(form);
expect(result).toEqual({ success: false, error: "Only Mailjet is supported for transactional email." });
expect(result).toEqual({ success: false, errorKey: "settings.admin.transactionalEmails.errors.unsupportedProvider" });
expect(updateAppConfigurationMock).not.toHaveBeenCalled();
});
@@ -76,7 +76,7 @@ describe("TransactionalEmailSettings.server", () => {
const result = await updateMailjetSettings(form);
expect(result).toEqual({ success: false, error: "Mailjet API keys are configured through environment variables only." });
expect(result).toEqual({ success: false, errorKey: "settings.admin.transactionalEmails.errors.apiKeyEnvironmentOnly" });
expect(updateAppConfigurationMock).not.toHaveBeenCalled();
});
@@ -20,7 +20,12 @@ export type MailjetProviderStatus = {
export type UpdateMailjetSettingsResult =
| { success: true }
| { success: false; error: string };
| {
success: false;
errorKey:
| "settings.admin.transactionalEmails.errors.unsupportedProvider"
| "settings.admin.transactionalEmails.errors.apiKeyEnvironmentOnly";
};
export async function getMailjetProviderStatus({ request }: { request: Request }): Promise<MailjetProviderStatus> {
await getAppConfiguration({ request });
@@ -51,11 +56,11 @@ export async function getMailjetProviderStatus({ request }: { request: Request }
export async function updateMailjetSettings(form: FormData): Promise<UpdateMailjetSettingsResult> {
const provider = form.get("emailProvider")?.toString();
if (provider !== MAILJET_PROVIDER_ID) {
return { success: false, error: "Only Mailjet is supported for transactional email." };
return { success: false, errorKey: "settings.admin.transactionalEmails.errors.unsupportedProvider" };
}
if (form.get("apiKey")?.toString().trim()) {
return { success: false, error: "Mailjet API keys are configured through environment variables only." };
return { success: false, errorKey: "settings.admin.transactionalEmails.errors.apiKeyEnvironmentOnly" };
}
await updateAppConfiguration({