@antelopejs/dms-mailing 0.3.3 → 0.4.0

package/src/routes/sends.ts

@@ -10,46 +10,91 @@ import {
 } from "@antelopejs/interface-api";
 import { assert, assertValidation } from "@antelopejs/interface-api-util";
 import { AuthUserWithPermission } from "@antelopejs/interface-dms/guards";
+import { ZodError } from "zod";
 import { getRequestTenantId } from "@antelopejs/interface-dms/request-tenant";
 import { TenantScopedModel } from "@antelopejs/interface-dms/tenant-scoped-model";
 import type { User } from "@antelopejs/interface-dms/auth/db";
+import type { SendTemplateResult } from "@antelopejs/interface-dms-mailing";
+import type {
+  BannerContent,
+  StatGroupItem,
+} from "@antelopejs/interface-dms/base";
 import {
   API_BASE_PATH,
+  HTTP_CONFLICT,
   HTTP_NOT_FOUND,
   HTTP_UNPROCESSABLE,
 } from "../constants";
 import {
   type MailingSend,
   type MailingSendEvent,
+  type MailingTemplate,
+  normalizeAddress,
   SendEventModel,
+  type SendSummary,
   SendModel,
   TemplateModel,
 } from "../db";
 import { resolveEmail } from "../engine";
-import type {
-  SendTemplateParams,
-  SendTemplateResult,
-} from "@antelopejs/interface-dms-mailing";
+import type { InterpolationMode } from "../engine/tokens";
 import { SendsPageController } from "../pages/sends";
+import { readCapabilities } from "../services/provider";
+import { buildProviderBanner } from "../services/provider-banner";
 import { renderEmailHtml } from "../services/render";
-import { SendError, sendTemplate } from "../services/send";
+import {
+  type CheckedSendParams,
+  sendUnlessSuppressed,
+} from "../services/checked-send";
+import { MANUAL_SEND_SOURCE, SendError, subjectFor } from "../services/send";
+import {
+  buildSendStats,
+  isProviderFailure,
+  isTransportFailure,
+  MAX_BULK_REPLAY,
+  type SendStats,
+  trackingOf,
+} from "../services/send-stats";
+import { buildSendStatItems } from "../services/send-stat-items";
+import type { DateRange } from "../services/metrics";
 import { assertSendPermission } from "../services/permissions";
 import { getSettings } from "../services/settings";
+import { findSuppression, suppressedSendIds } from "../services/suppressions";
 import {
+  contentOfVersion,
   localeContentOf,
-  parseContent,
   pickLocale,
+  publishedVersionOf,
+  requireTemplate,
 } from "../services/templates";
-import type { TemplateContent } from "../types";
-import { realSendSchema, testSendSchema } from "../validation/templates.schema";
+import type {
+  SendStatus,
+  SuppressionSummary,
+  TemplateContent,
+  TemplateStatus,
+} from "../types";
+import {
+  realSendSchema,
+  replayFailedSchema,
+  replaySchema,
+  testSendSchema,
+} from "../validation/templates.schema";
+import { comparisonRange, currentRange, isComparisonWanted } from "./period";
 
 const NOT_FOUND = "$dms_mailing.errors.send_not_found";
-const TEMPLATE_NOT_FOUND = "$dms_mailing.errors.template_not_found";
-const TEMPLATE_GONE = "$dms_mailing.errors.template_not_found";
 const INVALID_CONTENT = "$dms_mailing.errors.invalid_content";
+const INVALID_RECIPIENT = "$dms_mailing.errors.invalid_recipient";
+const REPLAY_PARTIAL = "$dms_mailing.sends.banner.replay_partial";
+const REPLAY_SKIPPED = "$dms_mailing.sends.banner.replay_skipped";
+const RECIPIENT_FIELD = "to";
+const NEEDS_NEW_ADDRESS = "$dms_mailing.errors.replay_needs_new_address";
+const NO_REPLAY_AFTER_SPAM = "$dms_mailing.errors.no_replay_after_spam";
 const TEST_SEND_SOURCE = "dms-mailing:test-send";
 const REPLAY_SOURCE = "dms-mailing:replay";
-const MANUAL_SEND_SOURCE = "dms-mailing:manual";
+const FIX_ADDRESS_SOURCE = "dms-mailing:fix-address";
+const HOUR_MS = 3_600_000;
+const DRAFT_VERSION = 0;
+/** Renders as the recipient got it, not as the editor previews it. */
+const SEND_MODE: InterpolationMode = "send";
 
 interface TestSendInput {
   locale: string;
@@ -57,9 +102,130 @@ interface TestSendInput {
   data?: Record<string, unknown>;
 }
 
+export interface SendTemplateSummary {
+  id: string;
+  name: string;
+  status: TemplateStatus;
+  /** Version customers receive today, to compare with the send's. */
+  publishedVersion: number;
+}
+
 export interface SendDetailResponse {
   send: MailingSend;
   events: MailingSendEvent[];
+  /** `null` when the template was deleted since. */
+  template: SendTemplateSummary | null;
+  /** The recipient's entry on the suppression list, `null` when it has none. */
+  suppression: SuppressionSummary | null;
+}
+
+/**
+ * What a test send did. A test to the editor's own address goes out even when
+ * the address is suppressed; `ownAddressSuppressed` says so.
+ */
+export interface TestSendResponse {
+  results: SendTemplateResult[];
+  ownAddressSuppressed?: SuppressionSummary;
+}
+
+export interface SendStatsResponse extends SendStats {
+  items: StatGroupItem[];
+}
+
+/**
+ * What a send again did. When the address is on the suppression list nothing
+ * left: `status` is `suppressed`, the original stays a problem, and `warning`
+ * carries the reason for the toast.
+ */
+export interface ReplayResponse extends SendTemplateResult {
+  warning?: string;
+}
+
+/**
+ * What "send the failures again" did: sent, failed to send again (could not
+ * start, or the address went on the suppression list meanwhile), and left out
+ * since the address is on the suppression list.
+ */
+export interface ReplayFailedResponse {
+  count: number;
+  failed: number;
+  skipped: number;
+  results: SendTemplateResult[];
+  /** Tells the toast some failures could not be sent again. */
+  warning?: string;
+}
+
+export interface SendHtmlResponse {
+  html: string;
+  subject: string;
+  locale: string;
+  version: number;
+  /**
+   * A draft test is rendered from today's draft, which may differ from what
+   * was sent.
+   */
+  approximate: boolean;
+  /** The sender of the settings today, not necessarily the one it went with. */
+  from: string;
+  fromName: string;
+}
+
+/** A failure someone else already sent again. */
+const CLAIMED_ELSEWHERE = "claimed-elsewhere";
+/** A failure whose send again could not start: it stays a problem. */
+const NOT_STARTED = "not-started";
+
+type ClaimedReplay =
+  | SendTemplateResult
+  | typeof CLAIMED_ELSEWHERE
+  | typeof NOT_STARTED;
+
+/** Problem statuses whose address is at fault: repeating the send cannot help. */
+const ADDRESS_PROBLEMS: SendStatus[] = ["bounced"];
+
+/** A permanent bounce only takes another address; a temporary one may retry. */
+function needsNewAddress(send: MailingSend): boolean {
+  return ADDRESS_PROBLEMS.includes(send.status) && !send.isSoftBounce;
+}
+
+const sameAddress = (left: string, right: string): boolean =>
+  normalizeAddress(left) === normalizeAddress(right);
+
+/** A bad address gets its own message; any other invalid field is the content's. */
+function sendInputError(error: unknown): string {
+  const isRecipient =
+    error instanceof ZodError &&
+    error.issues.some((issue) => issue.path[0] === RECIPIENT_FIELD);
+  return isRecipient ? INVALID_RECIPIENT : INVALID_CONTENT;
+}
+
+const isSuppressedResult = (result: SendTemplateResult): boolean =>
+  result.status === "suppressed";
+
+/** A suppressed send again carries its reason as a warning. */
+function replayResponse(result: SendTemplateResult): ReplayResponse {
+  return isSuppressedResult(result)
+    ? { ...result, warning: result.error }
+    : result;
+}
+
+function replayReport(
+  results: SendTemplateResult[],
+  notStarted: number,
+  skipped: number,
+): ReplayFailedResponse {
+  const suppressed = results.filter(isSuppressedResult).length;
+  const report: ReplayFailedResponse = {
+    count: results.length - suppressed,
+    failed: notStarted + suppressed,
+    skipped,
+    results,
+  };
+  const hasFailures =
+    report.failed > 0 || results.some((result) => result.status === "failed");
+  if (hasFailures) report.warning = REPLAY_PARTIAL;
+  else if (skipped > 0) report.warning = REPLAY_SKIPPED;
+  return report;
 }
 
 export class SendsController extends Controller(API_BASE_PATH) {
@@ -92,28 +258,42 @@ export class SendsController extends Controller(API_BASE_PATH) {
   async testSend(
     @Parameter("id", "param") id: string,
     @JSONBody() body: unknown,
-  ) {
+  ): Promise<TestSendResponse> {
     await assertSendPermission(this.user, this.tenantId);
     const input = assertValidation(
       body,
       (value) => testSendSchema.parse(value),
-      () => INVALID_CONTENT,
+      sendInputError,
     );
-    const template = await this.templates.get(id);
-    assert(template, HTTP_NOT_FOUND, TEMPLATE_NOT_FOUND);
+    const template = await requireTemplate(this.templates, id);
+    const ownAddressSuppressed = await this.ownSuppression(input.to);
     const result = await this.send(
       {
         tenantId: this.tenantId,
         to: input.to,
+        allowSuppressed: [this.user.email],
         locale: (input as TestSendInput).locale,
         variables: (input as TestSendInput).data,
         content: (input as TestSendInput).content,
+        version: requestedVersionOf(input.version),
         isTest: true,
         source: TEST_SEND_SOURCE,
       },
       template.slug,
     );
-    return { results: result.results ?? [result] };
+    return {
+      results: result.results ?? [result],
+      ...(ownAddressSuppressed && { ownAddressSuppressed }),
+    };
+  }
+
+  /** The editor's own entry on the suppression list, when a test goes to it. */
+  private async ownSuppression(
+    to: string[],
+  ): Promise<SuppressionSummary | undefined> {
+    const isOwn = (address: string) => sameAddress(address, this.user.email);
+    if (!to.some(isOwn)) return undefined;
+    return (await findSuppression(this.tenantId, this.user.email)) ?? undefined;
   }
 
   /**
@@ -129,10 +309,9 @@ export class SendsController extends Controller(API_BASE_PATH) {
     const input = assertValidation(
       body,
       (value) => realSendSchema.parse(value),
-      () => INVALID_CONTENT,
+      sendInputError,
     );
-    const template = await this.templates.get(id);
-    assert(template, HTTP_NOT_FOUND, TEMPLATE_NOT_FOUND);
+    const template = await requireTemplate(this.templates, id);
     const result = await this.send(
       {
         tenantId: this.tenantId,
@@ -147,6 +326,49 @@ export class SendsController extends Controller(API_BASE_PATH) {
     return { results: result.results ?? [result] };
   }
 
+  /**
+   * The stat strip of the send log, for the period the page selected: the
+   * figures, and the `StatGroup` items that word them.
+   */
+  @Get("/sends/stats")
+  async stats(): Promise<SendStatsResponse> {
+    const range = currentRange(this.ctx);
+    const [current, previous, capabilities] = await Promise.all([
+      this.sends.listBetween(range.from, range.to),
+      this.previousSends(range),
+      readCapabilities(),
+    ]);
+    const stats = buildSendStats(current, previous, trackingOf(capabilities));
+    return {
+      ...stats,
+      items: buildSendStatItems(stats, capabilities?.name ?? ""),
+    };
+  }
+
+  /**
+   * The provider banner of the send log: what is wrong with the provider and
+   * the failures of the last hour a send again may fix, or nothing.
+   */
+  @Get("/sends/banner")
+  async banner(): Promise<BannerContent | null> {
+    const since = new Date(Date.now() - HOUR_MS);
+    const [capabilities, recent] = await Promise.all([
+      readCapabilities(),
+      this.sends.listBetween(since, new Date()),
+    ]);
+    const failures = recent.filter(isProviderFailure);
+    const suppressed = await suppressedSendIds(this.tenantId, failures);
+    return buildProviderBanner({
+      providerName: capabilities?.name ?? "",
+      providerReachable: capabilities !== null,
+      recentFailures: failures.length,
+      transportFailures: recent.filter(isTransportFailure).length,
+      suppressedFailures: suppressed.size,
+      recentSends: recent.filter((send) => !send.isTest).length,
+      since,
+    });
+  }
+
   @Get("/sends/:id")
   async detail(
     @Parameter("id", "param") id: string,
@@ -154,54 +376,183 @@ export class SendsController extends Controller(API_BASE_PATH) {
     const send = await this.requireSend(id);
     const events = await this.events.getBySend(id);
     events.sort((left, right) => left.at.getTime() - right.at.getTime());
-    return { send, events };
+    const [template, suppression] = await Promise.all([
+      this.templates.get(send.templateId),
+      findSuppression(this.tenantId, send.recipientEmail),
+    ]);
+    return {
+      send,
+      events,
+      template: template ? summarize(template) : null,
+      suppression,
+    };
   }
 
+  /**
+   * What the recipient received: the version the send used, rendered with the
+   * variables it carried.
+   */
   @Get("/sends/:id/html")
-  async html(@Parameter("id", "param") id: string) {
+  async html(@Parameter("id", "param") id: string): Promise<SendHtmlResponse> {
     const send = await this.requireSend(id);
-    // There is no version history: this re-renders the template as it stands
-    // today, which may differ from what actually went out.
-    const template = await this.templates.get(send.templateId);
-    assert(template, HTTP_NOT_FOUND, TEMPLATE_GONE);
-    const content = parseContent(template);
+    const template = await requireTemplate(this.templates, send.templateId);
+    const content = await contentOfVersion(
+      this.tenantId,
+      template,
+      send.templateVersion,
+    );
     const settings = await getSettings(this.tenantId);
     const locale = pickLocale(content, send.locale, settings.fallbackLocale);
     const localeContent = localeContentOf(content, locale);
     assert(localeContent, HTTP_UNPROCESSABLE, INVALID_CONTENT);
-    const email = resolveEmail(
-      localeContent,
-      JSON.parse(send.json_variables || "{}") as Record<string, unknown>,
-    );
-    return { html: await renderEmailHtml(email, locale) };
+    const email = resolveEmail(localeContent, variablesOf(send), SEND_MODE);
+    const version = send.templateVersion;
+    return {
+      html: await renderEmailHtml(email, locale),
+      subject: subjectFor(email.subject, send.isTest),
+      locale,
+      version,
+      approximate: version === DRAFT_VERSION,
+      from: settings.senderEmail,
+      fromName: settings.senderName,
+    };
   }
 
+  /**
+   * Sends the same version and data again, and marks the original as dealt
+   * with. A permanent bounce only takes another address; a spam report is
+   * never answered with another e-mail.
+   */
   @Post("/sends/:id/replay")
-  async replay(@Parameter("id", "param") id: string) {
+  async replay(
+    @Parameter("id", "param") id: string,
+    @JSONBody() body: unknown,
+  ): Promise<ReplayResponse> {
     await assertSendPermission(this.user, this.tenantId);
+    const { to } = assertValidation(body ?? {}, (value) =>
+      replaySchema.parse(value),
+    );
     const send = await this.requireSend(id);
+    assert(send.status !== "spam", HTTP_CONFLICT, NO_REPLAY_AFTER_SPAM);
+    const isFix = needsNewAddress(send);
+    const isNewAddress = !!to && !sameAddress(to, send.recipientEmail);
+    assert(!isFix || isNewAddress, HTTP_CONFLICT, NEEDS_NEW_ADDRESS);
+    const result = await this.repeat(
+      send,
+      to,
+      isFix ? FIX_ADDRESS_SOURCE : REPLAY_SOURCE,
+    );
+    await this.recordReplay(send._id, result);
+    return replayResponse(result);
+  }
+
+  /**
+   * Sends again every provider failure since `since` (default: the last
+   * hour), the first {@link MAX_BULK_REPLAY}. Each one is claimed before it
+   * goes, so running it twice never sends a failure twice. A failure whose
+   * address is on the suppression list is left out: it stays a problem.
+   */
+  @Post("/sends/replay-failed")
+  async replayFailed(@JSONBody() body: unknown): Promise<ReplayFailedResponse> {
+    await assertSendPermission(this.user, this.tenantId);
+    const { since } = assertValidation(body ?? {}, (value) =>
+      replayFailedSchema.parse(value),
+    );
+    const from = since ?? new Date(Date.now() - HOUR_MS);
+    const rows = await this.sends.listBetween(from, new Date());
+    const failures = rows.filter(isProviderFailure);
+    const suppressed = await suppressedSendIds(this.tenantId, failures);
+    const sendable = failures
+      .filter((failure) => !suppressed.has(failure._id))
+      .slice(0, MAX_BULK_REPLAY);
+    const results: SendTemplateResult[] = [];
+    let failed = 0;
+    for (const failure of sendable) {
+      const outcome = await this.replayClaimed(failure._id);
+      if (outcome === CLAIMED_ELSEWHERE) continue;
+      if (outcome === NOT_STARTED) failed++;
+      else results.push(outcome);
+    }
+    return replayReport(results, failed, suppressed.size);
+  }
+
+  /** Sends one failure again unless someone already did. */
+  private async replayClaimed(sendId: string): Promise<ClaimedReplay> {
+    if (!(await this.sends.claimResolution(sendId, this.user._id)))
+      return CLAIMED_ELSEWHERE;
+    try {
+      const send = await this.requireSend(sendId);
+      const result = await this.repeat(send, undefined, REPLAY_SOURCE);
+      await this.recordReplay(sendId, result);
+      if (isSuppressedResult(result))
+        await this.sends.releaseResolution(sendId);
+      return result;
+    } catch {
+      await this.sends.releaseResolution(sendId);
+      return NOT_STARTED;
+    }
+  }
+
+  /**
+   * Links the original and the send that repeated it, both ways. A send again
+   * the suppression list stopped only points back: nothing left, so the
+   * original stays a problem.
+   */
+  private async recordReplay(
+    originalId: string,
+    result: SendTemplateResult,
+  ): Promise<void> {
+    if (!result.sendId) return;
+    if (isSuppressedResult(result)) {
+      await this.sends.linkReplayOf(result.sendId, originalId);
+      return;
+    }
+    await this.sends.markReplayed(originalId, {
+      replayedBy: result.sendId,
+      resolvedBy: this.user._id,
+    });
+    await this.sends.linkReplayOf(result.sendId, originalId);
+  }
+
+  private async repeat(
+    send: MailingSend,
+    to: string | undefined,
+    source: string,
+  ): Promise<SendTemplateResult> {
+    const template = await requireTemplate(this.templates, send.templateId);
+    const version = send.templateVersion;
+    const content =
+      version > DRAFT_VERSION
+        ? await contentOfVersion(this.tenantId, template, version)
+        : undefined;
     return this.send(
       {
         tenantId: this.tenantId,
-        to: send.recipientEmail,
-        locale: send.locale,
-        variables: JSON.parse(send.json_variables || "{}") as Record<
-          string,
-          unknown
-        >,
+        to: to ?? send.recipientEmail,
+        locale: send.requestedLocale || send.locale,
+        variables: variablesOf(send),
+        content,
+        version: content ? version : undefined,
         isTest: send.isTest,
-        source: REPLAY_SOURCE,
+        source,
       },
       send.templateSlug,
     );
   }
 
+  /** The sends the strip compares with; `null` when the user wants none. */
+  private previousSends(range: DateRange): Promise<SendSummary[] | null> {
+    if (!isComparisonWanted(this.ctx)) return Promise.resolve(null);
+    const previous = comparisonRange(this.ctx, range);
+    return this.sends.listBetween(previous.from, previous.to);
+  }
+
   private async send(
-    params: SendTemplateParams,
+    params: CheckedSendParams,
     slug: string,
   ): Promise<SendTemplateResult> {
     try {
-      return await sendTemplate(slug, params);
+      return await sendUnlessSuppressed(slug, params);
     } catch (error) {
       if (error instanceof SendError) {
         throw new HTTPResult(
@@ -213,3 +564,24 @@ export class SendsController extends Controller(API_BASE_PATH) {
     }
   }
 }
+
+/**
+ * The version a test of a published version records: a number names one,
+ * "draft" or "published" let the send decide.
+ */
+function requestedVersionOf(version: unknown): number | undefined {
+  return typeof version === "number" ? version : undefined;
+}
+
+function variablesOf(send: MailingSend): Record<string, unknown> {
+  return JSON.parse(send.json_variables || "{}") as Record<string, unknown>;
+}
+
+function summarize(template: MailingTemplate): SendTemplateSummary {
+  return {
+    id: template._id,
+    name: template.name,
+    status: template.status,
+    publishedVersion: publishedVersionOf(template),
+  };
+}