mail-time 3.0.0 → 4.0.0

package/adapters/postgres.js

@@ -0,0 +1,520 @@
+import {
+  debug,
+  logError,
+  isSendClaimUpdate,
+  isSendLeaseGuardedUpdate,
+  isAppendMailOptionUpdate,
+  stripInternalUpdateMeta,
+  isSendLeaseRemove,
+} from '../helpers.js';
+
+/**
+ * @typedef {object} PostgresQueryResult
+ * @property {number | null | undefined} [rowCount]
+ * @property {unknown[]} [rows]
+ */
+
+/**
+ * @typedef {object} PostgresClient
+ * @property {(queryText: string, values?: unknown[]) => Promise<PostgresQueryResult>} query
+ */
+
+/**
+ * @typedef {object} PostgresQueueOption
+ * @property {PostgresClient} client
+ * @property {string} [prefix]
+ */
+
+const DEFAULT_PREFIX = 'default';
+const setupLockId = 93824519;
+
+const fieldMap = {
+  to: 'to_address',
+  tries: 'tries',
+  sendAt: 'send_at',
+  isSent: 'is_sent',
+  isCancelled: 'is_cancelled',
+  isFailed: 'is_failed',
+  isSending: 'is_sending',
+  sendingAt: 'sending_at',
+  template: 'template',
+  transport: 'transport',
+  concatSubject: 'concat_subject',
+  mailOptions: 'mail_options',
+};
+
+const parseMailOptions = (mailOptions) => {
+  if (typeof mailOptions === 'string') {
+    return JSON.parse(mailOptions);
+  }
+  return mailOptions;
+};
+
+const normalizeRow = (row) => {
+  if (!row) {
+    return null;
+  }
+
+  return {
+    id: row.id,
+    uuid: row.uuid,
+    to: row.to_address,
+    tries: parseInt(row.tries, 10),
+    sendAt: parseInt(row.send_at, 10),
+    isSent: row.is_sent,
+    isCancelled: row.is_cancelled,
+    isFailed: row.is_failed,
+    isSending: row.is_sending === true,
+    sendingAt: row.sending_at !== null && row.sending_at !== undefined ? parseInt(row.sending_at, 10) : 0,
+    template: row.template || false,
+    transport: parseInt(row.transport, 10),
+    concatSubject: row.concat_subject || false,
+    mailOptions: parseMailOptions(row.mail_options),
+  };
+};
+
+/** Class representing PostgreSQL Queue for MailTime */
+class PostgresQueue {
+  /**
+   * Create a PostgresQueue instance
+   * @param {PostgresQueueOption} opts - configuration object
+   */
+  constructor(opts) {
+    this.name = 'postgres-queue';
+    if (!opts || typeof opts !== 'object') {
+      throw new TypeError('[mail-time] Configuration object must be passed into PostgresQueue constructor');
+    }
+
+    if (!opts.client || typeof opts.client.query !== 'function') {
+      throw new Error('[mail-time] [PostgresQueue] required {client} option is missing or does not expose a `query` method');
+    }
+
+    this.client = opts.client;
+    if (typeof opts.prefix === 'string' && opts.prefix.length > 0) {
+      this.__applyPrefix(opts.prefix);
+    }
+  }
+
+  /** @internal */
+  __applyPrefix(prefix) {
+    this.prefix = prefix;
+    this.__readyPromise = this.__setup();
+    this.__readyPromise.catch(() => void 0);
+  }
+
+  /** @internal */
+  __ensurePrefix() {
+    if (typeof this.prefix !== 'string') {
+      this.__applyPrefix(this.mailTimeInstance?.prefix || DEFAULT_PREFIX);
+    }
+  }
+
+  /** @internal */
+  __debug(...args) {
+    debug(this.mailTimeInstance?.debug === true, `[${this.name}]`, ...args);
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name ready
+   * @description Wait until PostgreSQL schema is ready
+   * @returns {Promise<void 0>}
+   */
+  async ready() {
+    this.__ensurePrefix();
+    this.__debug('[ready]');
+    await this.__readyPromise;
+  }
+
+  /** @internal */
+  async __setup() {
+    await this.client.query('SELECT pg_advisory_lock($1)', [setupLockId]);
+
+    try {
+      await this.client.query(`CREATE TABLE IF NOT EXISTS mail_time_queue (
+          id BIGSERIAL PRIMARY KEY,
+          prefix TEXT NOT NULL DEFAULT 'default',
+          uuid TEXT NOT NULL,
+          to_address TEXT,
+          tries INTEGER NOT NULL DEFAULT 0,
+          send_at BIGINT NOT NULL,
+          is_sent BOOLEAN NOT NULL DEFAULT false,
+          is_cancelled BOOLEAN NOT NULL DEFAULT false,
+          is_failed BOOLEAN NOT NULL DEFAULT false,
+          is_sending BOOLEAN NOT NULL DEFAULT false,
+          sending_at BIGINT NOT NULL DEFAULT 0,
+          template TEXT,
+          transport INTEGER NOT NULL DEFAULT 0,
+          concat_subject TEXT,
+          mail_options JSONB NOT NULL,
+          created_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP,
+          updated_at TIMESTAMPTZ DEFAULT CURRENT_TIMESTAMP
+        )`);
+      await this.client.query(`CREATE UNIQUE INDEX IF NOT EXISTS idx_mail_time_queue_prefix_uuid
+        ON mail_time_queue (prefix, uuid)`);
+
+      await this.client.query(`CREATE INDEX IF NOT EXISTS idx_mail_time_queue_due
+        ON mail_time_queue (prefix, is_sent, is_failed, is_cancelled, is_sending, sending_at, send_at, tries)`);
+
+      await this.client.query(`CREATE INDEX IF NOT EXISTS idx_mail_time_queue_pending_to
+        ON mail_time_queue (prefix, to_address, is_sent, is_failed, is_cancelled, send_at)`);
+    } finally {
+      await this.client.query('SELECT pg_advisory_unlock($1)', [setupLockId]);
+    }
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name ping
+   * @description Check connection to Storage
+   * @returns {Promise<object>}
+   */
+  async ping() {
+    this.__debug('[ping]');
+    if (!this.mailTimeInstance) {
+      return {
+        status: 'Service Unavailable',
+        code: 503,
+        statusCode: 503,
+        error: new Error('MailTime instance not yet assigned to {mailTimeInstance} of Queue Adapter context'),
+      };
+    }
+
+    try {
+      await this.ready();
+      const ping = await this.client.query('SELECT 1 as ping');
+      if (ping?.rows?.[0]?.ping === 1) {
+        return {
+          status: 'OK',
+          code: 200,
+          statusCode: 200,
+        };
+      }
+    } catch (pingError) {
+      return {
+        status: 'Internal Server Error',
+        code: 500,
+        statusCode: 500,
+        error: pingError,
+      };
+    }
+
+    return {
+      status: 'Service Unavailable',
+      code: 503,
+      statusCode: 503,
+      error: new Error('Service Unavailable'),
+    };
+  }
+
+  /**
+   * @memberOf PostgresQueue
+   * @name iterate
+   * @description iterate over queued tasks passing each to `mailTimeInstance.___dispatch` (the bounded send pool). Postgres reads buffer the full result, so each tick is bounded by `opts.limit` (or 1000 when caller passes `Infinity` / no limit) to keep memory predictable; high-throughput deployments should shard prefixes.
+   * @param {{ limit?: number, sendingTimeout?: number }} [opts] - iteration options
+   * @returns {Promise<void>}
+   */
+  async iterate(opts) {
+    this.__debug('[iterate]', opts);
+    if (!this.mailTimeInstance) {
+      return;
+    }
+    await this.ready();
+
+    const now = Date.now();
+    const sendingTimeout = (opts && typeof opts.sendingTimeout === 'number' && opts.sendingTimeout > 0)
+      ? opts.sendingTimeout
+      : 300000;
+    const limit = (opts && typeof opts.limit === 'number' && Number.isFinite(opts.limit) && opts.limit > 0)
+      ? Math.max(1, Math.floor(opts.limit))
+      : 1000;
+
+    try {
+      const res = await this.client.query(`SELECT id, uuid, to_address, tries, send_at, is_sent, is_cancelled, is_failed,
+               is_sending, sending_at, template, transport, concat_subject, mail_options
+        FROM mail_time_queue
+        WHERE prefix = $1
+          AND is_sent = false
+          AND is_failed = false
+          AND is_cancelled = false
+          AND send_at <= $2
+          AND tries < $3
+          AND (is_sending = false OR sending_at <= $4)
+        ORDER BY send_at ASC
+        LIMIT $5`, [this.prefix, now, this.mailTimeInstance.maxTries, now - sendingTimeout, limit]);
+
+      for (const row of res.rows || []) {
+        await this.mailTimeInstance.___dispatch(normalizeRow(row));
+      }
+    } catch (iterateError) {
+      logError('[PostgresQueue] [iterate] [iterateError]', iterateError);
+    }
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name getPendingTo
+   * @description get queued task by `to` field (addressee)
+   * @param to {string} - email address
+   * @param sendAt {number} - timestamp
+   * @returns {Promise<object|null>}
+   */
+  async getPendingTo(to, sendAt) {
+    this.__debug('[getPendingTo]', to, sendAt);
+    if (typeof to !== 'string' || typeof sendAt !== 'number') {
+      return null;
+    }
+
+    await this.ready();
+
+    const res = await this.client.query(`SELECT id, uuid, to_address, tries, send_at, is_sent, is_cancelled, is_failed,
+             is_sending, sending_at, template, transport, concat_subject, mail_options
+      FROM mail_time_queue
+      WHERE prefix = $1
+        AND to_address = $2
+        AND is_sent = false
+        AND is_failed = false
+        AND is_cancelled = false
+        AND is_sending = false
+        AND tries < $4
+        AND send_at <= $3
+      ORDER BY send_at DESC
+      LIMIT 1`, [this.prefix, to, sendAt, this.mailTimeInstance.maxTries]);
+
+    return normalizeRow(res.rows?.[0]);
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name push
+   * @description push task to the queue/storage
+   * @param task {object} - task's object
+   * @returns {Promise<void 0>}
+   */
+  async push(task) {
+    this.__debug('[push]', task?.uuid);
+    if (!task || typeof task !== 'object') {
+      return;
+    }
+
+    await this.ready();
+
+    if (task.sendAt instanceof Date) {
+      task.sendAt = +task.sendAt;
+    }
+
+    await this.client.query(`INSERT INTO mail_time_queue (
+        prefix, uuid, to_address, tries, send_at, is_sent, is_cancelled, is_failed,
+        is_sending, sending_at, template, transport, concat_subject, mail_options, created_at, updated_at
+      )
+      VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
+      ON CONFLICT (prefix, uuid) DO UPDATE SET
+        to_address = EXCLUDED.to_address,
+        tries = EXCLUDED.tries,
+        send_at = EXCLUDED.send_at,
+        is_sent = EXCLUDED.is_sent,
+        is_cancelled = EXCLUDED.is_cancelled,
+        is_failed = EXCLUDED.is_failed,
+        is_sending = EXCLUDED.is_sending,
+        sending_at = EXCLUDED.sending_at,
+        template = EXCLUDED.template,
+        transport = EXCLUDED.transport,
+        concat_subject = EXCLUDED.concat_subject,
+        mail_options = EXCLUDED.mail_options,
+        updated_at = CURRENT_TIMESTAMP`, [
+      this.prefix,
+      task.uuid,
+      typeof task.to === 'string' ? task.to : null,
+      task.tries,
+      task.sendAt,
+      task.isSent,
+      task.isCancelled,
+      task.isFailed,
+      task.isSending === true,
+      typeof task.sendingAt === 'number' ? task.sendingAt : 0,
+      task.template || null,
+      task.transport,
+      task.concatSubject || null,
+      JSON.stringify(task.mailOptions || []),
+    ]);
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name cancel
+   * @description cancel scheduled email
+   * @param uuid {string} - email's uuid
+   * @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found, was sent, or was cancelled previously
+   */
+  async cancel(uuid) {
+    this.__debug('[cancel]', uuid);
+    if (typeof uuid !== 'string') {
+      return false;
+    }
+
+    await this.ready();
+
+    const task = normalizeRow((await this.client.query(`SELECT id, uuid, to_address, tries, send_at, is_sent, is_cancelled, is_failed,
+             template, transport, concat_subject, mail_options
+      FROM mail_time_queue
+      WHERE prefix = $1
+        AND uuid = $2
+      LIMIT 1`, [this.prefix, uuid])).rows?.[0]);
+
+    if (!task || task.isSent === true || task.isCancelled === true) {
+      return false;
+    }
+
+    if (!this.mailTimeInstance.keepHistory) {
+      return await this.remove(task);
+    }
+
+    return await this.update(task, {
+      isCancelled: true,
+    });
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name remove
+   * @description remove task from queue
+   * @param task {object} - task's object
+   * @param {{ leaseTries: number, leaseSendingAt: number }} [opts] - lease guard: only remove if this worker still holds the lease (tries + sendingAt match, row not cancelled/failed)
+   * @returns {Promise<boolean>} returns `true` if removed or `false` if not found
+   */
+  async remove(task, opts) {
+    this.__debug('[remove]', task?.uuid);
+    if (!task || typeof task !== 'object') {
+      return false;
+    }
+
+    await this.ready();
+
+    const where = task.id ? 'id = $2' : 'uuid = $2';
+    const value = task.id || task.uuid;
+    let leaseWhere = '';
+    const params = [this.prefix, value];
+    if (isSendLeaseRemove(opts)) {
+      params.push(opts.leaseTries, opts.leaseSendingAt);
+      leaseWhere = ` AND tries = $3 AND is_sending = true AND sending_at = $4 AND is_cancelled = false AND is_failed = false`;
+    }
+
+    const res = await this.client.query(`DELETE FROM mail_time_queue
+      WHERE prefix = $1
+        AND ${where}${leaseWhere}`, params);
+    return (res.rowCount || 0) >= 1;
+  }
+
+  /**
+   * @async
+   * @memberOf PostgresQueue
+   * @name update
+   * @description update task in queue
+   * @param task {object} - task's object
+   * @param updateObj {object} - fields with new values to update
+   * @returns {Promise<boolean>} returns `true` if updated or `false` if not found or no changes was made
+   */
+  async update(task, updateObj) {
+    this.__debug('[update]', task?.uuid);
+    if (!task || typeof task !== 'object' || !updateObj || typeof updateObj !== 'object') {
+      return false;
+    }
+
+    await this.ready();
+
+    if (isAppendMailOptionUpdate(updateObj)) {
+      const where = task.id ? 'id = $3' : 'uuid = $3';
+      const value = task.id || task.uuid;
+      const res = await this.client.query(`UPDATE mail_time_queue
+        SET mail_options = mail_options || $1::jsonb,
+            updated_at = CURRENT_TIMESTAMP
+        WHERE prefix = $2
+          AND ${where}
+          AND is_sent = false
+          AND is_failed = false
+          AND is_cancelled = false
+          AND is_sending = false`, [
+        JSON.stringify([updateObj.appendMailOption]),
+        this.prefix,
+        value,
+      ]);
+      return (res.rowCount || 0) >= 1;
+    }
+
+    const persistObj = stripInternalUpdateMeta(updateObj);
+    const sets = [];
+    const values = [];
+    for (const key of Object.keys(persistObj)) {
+      if (!fieldMap[key]) {
+        continue;
+      }
+
+      let value = persistObj[key];
+      if (key === 'sendAt' && value instanceof Date) {
+        value = +value;
+      }
+      if (key === 'mailOptions') {
+        value = JSON.stringify(value);
+      }
+
+      values.push(value);
+      sets.push(`${fieldMap[key]} = $${values.length}`);
+    }
+
+    if (!sets.length) {
+      return false;
+    }
+
+    let claimWhere = '';
+    if (isSendClaimUpdate(updateObj)) {
+      const now = typeof updateObj.sendingAt === 'number' ? updateObj.sendingAt : Date.now();
+      const sendingTimeout = this.mailTimeInstance?.sendingTimeout || 300000;
+      values.push(task.tries);
+      const triesIndex = values.length;
+      values.push(now - sendingTimeout);
+      const staleIndex = values.length;
+      claimWhere = `
+        AND is_sent = false
+        AND is_failed = false
+        AND is_cancelled = false
+        AND tries = $${triesIndex}
+        AND (is_sending = false OR sending_at <= $${staleIndex})
+      `;
+    } else if (isSendLeaseGuardedUpdate(updateObj)) {
+      values.push(updateObj.leaseTries);
+      const triesIndex = values.length;
+      values.push(updateObj.leaseSendingAt);
+      const sendingAtIndex = values.length;
+      claimWhere = `
+        AND tries = $${triesIndex}
+        AND is_sending = true
+        AND sending_at = $${sendingAtIndex}
+        AND is_cancelled = false
+        AND is_failed = false
+      `;
+    }
+
+    values.push(this.prefix);
+    const prefixIndex = values.length;
+    values.push(task.id || task.uuid);
+    const taskIndex = values.length;
+    const where = task.id ? 'id' : 'uuid';
+
+    const res = await this.client.query(`UPDATE mail_time_queue
+      SET ${sets.join(', ')},
+          updated_at = CURRENT_TIMESTAMP
+      WHERE prefix = $${prefixIndex}
+        AND ${where} = $${taskIndex}
+        ${claimWhere}`, values);
+
+    return (res.rowCount || 0) >= 1;
+  }
+}
+
+export { PostgresQueue };

package/adapters/redis.d.ts

@@ -0,0 +1,105 @@
+export type RedisClient = {
+    exists: (key: string) => Promise<number>;
+    get: (key: string) => Promise<string | null>;
+    set: (key: string, value: string, options?: object) => Promise<unknown>;
+    del: (key: string | string[]) => Promise<number>;
+    ping: () => Promise<string>;
+    scanIterator: (options: object) => AsyncIterable<string | string[]>;
+    watch?: ((key: string) => Promise<unknown>) | undefined;
+    unwatch?: (() => Promise<unknown>) | undefined;
+    multi?: (() => object) | undefined;
+};
+export type RedisQueueOption = {
+    client: RedisClient;
+    prefix?: string | undefined;
+};
+/** Class representing Redis Queue for MailTime */
+export class RedisQueue {
+    /**
+     * Create a RedisQueue instance
+     * @param {RedisQueueOption} opts - configuration object
+     */
+    constructor(opts: RedisQueueOption);
+    name: string;
+    client: RedisClient;
+    prefix: any;
+    uniqueName: string | undefined;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name ready
+     * @description Storage adapter has no async setup
+     * @returns {Promise<void 0>}
+     */
+    ready(): Promise<void>;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name ping
+     * @description Check connection to Storage
+     * @returns {Promise<object>}
+     */
+    ping(): Promise<object>;
+    /**
+     * @memberOf RedisQueue
+     * @name iterate
+     * @description iterate over queued tasks passing each to `mailTimeInstance.___dispatch` (the bounded send pool)
+     * @param {{ limit?: number, sendingTimeout?: number }} [opts] - iteration options
+     * @returns {Promise<void>}
+     */
+    iterate(opts?: {
+        limit?: number;
+        sendingTimeout?: number;
+    }): Promise<void>;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name getPendingTo
+     * @description get queued task by `to` field (addressee)
+     * @param to {string} - email address
+     * @param sendAt {number} - timestamp
+     * @returns {Promise<object|null>}
+     */
+    getPendingTo(to: string, sendAt: number): Promise<object | null>;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name push
+     * @description push task to the queue/storage
+     * @param task {object} - task's object
+     * @returns {Promise<void 0>}
+     */
+    push(task: object): Promise<void>;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name cancel
+     * @description cancel scheduled email
+     * @param uuid {string} - email's uuid
+     * @returns {Promise<boolean>} returns `true` if cancelled or `false` if not found, was sent, or was cancelled previously
+     */
+    cancel(uuid: string): Promise<boolean>;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name remove
+     * @description remove task from queue
+     * @param task {object} - task's object
+     * @param {{ leaseTries: number, leaseSendingAt: number }} [opts] - lease guard: only remove if this worker still holds the lease (tries + sendingAt match, row not cancelled/failed)
+     * @returns {Promise<boolean>} returns `true` if removed or `false` if not found
+     */
+    remove(task: object, opts?: {
+        leaseTries: number;
+        leaseSendingAt: number;
+    }): Promise<boolean>;
+    /**
+     * @async
+     * @memberOf RedisQueue
+     * @name update
+     * @description update task in queue
+     * @param task {object} - task's object
+     * @param updateObj {object} - fields with new values to update
+     * @returns {Promise<boolean>} returns `true` if updated or `false` if not found or no changes was made
+     */
+    update(task: object, updateObj: object): Promise<boolean>;
+}