cds-error-outbox 1.0.0 → 1.0.2

package/lib/scheduler.js

@@ -1,125 +1,125 @@
-'use strict';
-
-const cds = require('@sap/cds');
-const { formatHtmlEmail } = require('./formatter');
-
-const ENTITY = 'error.outbox.Errors';
-
-let _handle = null;
-
-/**
- * Start the interval-based batch scheduler.
- *
- * @param {object} config   - merged plugin config
- * @param {object} provider - email provider instance ({ send: Function })
- * @returns {NodeJS.Timeout} interval handle (can be passed to stop())
- */
-function start(config, provider) {
-  if (_handle) {
-    clearInterval(_handle);
-    _handle = null;
-  }
-
-  _handle = setInterval(() => {
-    runBatch(config, provider).catch((err) => {
-      // runBatch already guards internally; this is a last-resort safety net.
-      console.error('[cds-error-outbox] Unhandled error in runBatch:', err.message);
-    });
-  }, config.interval);
-
-  // Allow Node.js process to exit gracefully even if the interval is active.
-  if (typeof _handle.unref === 'function') _handle.unref();
-
-  console.info(
-    `[cds-error-outbox] Scheduler started — ` +
-    `interval: ${config.interval}ms, batchSize: ${config.batchSize}`
-  );
-
-  return _handle;
-}
-
-/**
- * Stop the scheduler. Safe to call even if not started.
- */
-function stop() {
-  if (_handle) {
-    clearInterval(_handle);
-    _handle = null;
-    console.info('[cds-error-outbox] Scheduler stopped.');
-  }
-}
-
-/**
- * Core batch routine:
- *   1. Fetch unsent errors from DB (up to batchSize, oldest first).
- *   2. Format them into an HTML email.
- *   3. Send via the configured email provider.
- *   4. Mark successfully sent records as sent=true.
- *
- * Each step is independently guarded so a failure in one step does not
- * prevent the scheduler from running again on the next interval.
- *
- * @param {object} config
- * @param {object} provider
- */
-async function runBatch(config, provider) {
-  // ── 1. Obtain DB connection ──────────────────────────────────────────────
-  let db;
-  try {
-    db = await cds.connect.to('db');
-  } catch (err) {
-    console.error('[cds-error-outbox] Cannot connect to DB — skipping batch:', err.message);
-    return;
-  }
-
-  // ── 2. Fetch unsent errors ───────────────────────────────────────────────
-  let errors;
-  try {
-    errors = await db.run(
-      SELECT.from(ENTITY)
-        .where({ sent: false })
-        .orderBy('lastSeen asc')
-        .limit(config.batchSize)
-    );
-  } catch (err) {
-    console.error('[cds-error-outbox] Failed to query unsent errors:', err.message);
-    return;
-  }
-
-  if (!errors || errors.length === 0) return;
-
-  // ── 3. Format email ──────────────────────────────────────────────────────
-  let subject, html;
-  try {
-    ({ subject, html } = formatHtmlEmail(errors));
-  } catch (err) {
-    console.error('[cds-error-outbox] Failed to format email body:', err.message);
-    return;
-  }
-
-  // ── 4. Send email ────────────────────────────────────────────────────────
-  try {
-    await provider.send(config.mail, subject, html);
-  } catch (err) {
-    // Do NOT mark as sent — will be retried on the next interval.
-    console.error(
-      `[cds-error-outbox] Email delivery failed (will retry on next interval): ${err.message}`
-    );
-    return;
-  }
-
-  // ── 5. Mark as sent (only after confirmed delivery) ──────────────────────
-  const ids = errors.map((e) => e.ID);
-  try {
-    await db.run(
-      UPDATE(ENTITY)
-        .set({ sent: true })
-        .where({ ID: { in: ids } })
-    );
-    console.info(`[cds-error-outbox] Batch complete — marked ${ids.length} error(s) as sent.`);
-  } catch (err) {
-    console.error('[cds-error-outbox] Failed to mark errors as sent:', err.message);
-  }
-}
-
-module.exports = { start, stop, runBatch };
+'use strict';
+
+const cds = require('@sap/cds');
+const { formatHtmlEmail } = require('./formatter');
+
+const ENTITY = 'error.outbox.Errors';
+
+let _handle = null;
+
+/**
+ * Start the interval-based batch scheduler.
+ *
+ * @param {object} config   - merged plugin config
+ * @param {object} provider - email provider instance ({ send: Function })
+ * @returns {NodeJS.Timeout} interval handle (can be passed to stop())
+ */
+function start(config, provider) {
+  if (_handle) {
+    clearInterval(_handle);
+    _handle = null;
+  }
+
+  _handle = setInterval(() => {
+    runBatch(config, provider).catch((err) => {
+      // runBatch already guards internally; this is a last-resort safety net.
+      console.error('[cds-error-outbox] Unhandled error in runBatch:', err.message);
+    });
+  }, config.interval);
+
+  // Allow Node.js process to exit gracefully even if the interval is active.
+  if (typeof _handle.unref === 'function') _handle.unref();
+
+  console.info(
+    `[cds-error-outbox] Scheduler started — ` +
+    `interval: ${config.interval}ms, batchSize: ${config.batchSize}`
+  );
+
+  return _handle;
+}
+
+/**
+ * Stop the scheduler. Safe to call even if not started.
+ */
+function stop() {
+  if (_handle) {
+    clearInterval(_handle);
+    _handle = null;
+    console.info('[cds-error-outbox] Scheduler stopped.');
+  }
+}
+
+/**
+ * Core batch routine:
+ *   1. Fetch unsent errors from DB (up to batchSize, oldest first).
+ *   2. Format them into an HTML email.
+ *   3. Send via the configured email provider.
+ *   4. Mark successfully sent records as sent=true.
+ *
+ * Each step is independently guarded so a failure in one step does not
+ * prevent the scheduler from running again on the next interval.
+ *
+ * @param {object} config
+ * @param {object} provider
+ */
+async function runBatch(config, provider) {
+  // ── 1. Obtain DB connection ──────────────────────────────────────────────
+  let db;
+  try {
+    db = await cds.connect.to('db');
+  } catch (err) {
+    console.error('[cds-error-outbox] Cannot connect to DB — skipping batch:', err.message);
+    return;
+  }
+
+  // ── 2. Fetch unsent errors ───────────────────────────────────────────────
+  let errors;
+  try {
+    errors = await db.run(
+      SELECT.from(ENTITY)
+        .where({ sent: false })
+        .orderBy('lastSeen asc')
+        .limit(config.batchSize)
+    );
+  } catch (err) {
+    console.error('[cds-error-outbox] Failed to query unsent errors:', err.message);
+    return;
+  }
+
+  if (!errors || errors.length === 0) return;
+
+  // ── 3. Format email ──────────────────────────────────────────────────────
+  let subject, html;
+  try {
+    ({ subject, html } = formatHtmlEmail(errors));
+  } catch (err) {
+    console.error('[cds-error-outbox] Failed to format email body:', err.message);
+    return;
+  }
+
+  // ── 4. Send email ────────────────────────────────────────────────────────
+  try {
+    await provider.send(config.mail, subject, html);
+  } catch (err) {
+    // Do NOT mark as sent — will be retried on the next interval.
+    console.error(
+      `[cds-error-outbox] Email delivery failed (will retry on next interval): ${err.message}`
+    );
+    return;
+  }
+
+  // ── 5. Mark as sent (only after confirmed delivery) ──────────────────────
+  const ids = errors.map((e) => e.ID);
+  try {
+    await db.run(
+      UPDATE(ENTITY)
+        .set({ sent: true })
+        .where({ ID: { in: ids } })
+    );
+    console.info(`[cds-error-outbox] Batch complete — marked ${ids.length} error(s) as sent.`);
+  } catch (err) {
+    console.error('[cds-error-outbox] Failed to mark errors as sent:', err.message);
+  }
+}
+
+module.exports = { start, stop, runBatch };

package/package.json

@@ -1,34 +1,40 @@
-{
-  "name": "cds-error-outbox",
-  "version": "1.0.0",
-  "description": "A reusable CAP plugin that captures service errors, deduplicates them, and sends batched email notifications.",
-  "main": "index.js",
-  "cds": {
-    "plugin": true,
-    "requires": {
-      "cds-error-outbox": {
-        "model": "cds-error-outbox"
-      }
-    }
-  },
-  "keywords": [
-    "sap-cap",
-    "cds",
-    "plugin",
-    "error",
-    "outbox",
-    "email"
-  ],
-  "license": "MIT",
-  "engines": {
-    "node": ">=18"
-  },
-  "peerDependencies": {
-    "@sap/cds": ">=7"
-  },
-  "peerDependenciesMeta": {
-    "nodemailer": {
-      "optional": true
-    }
-  }
-}
+{
+  "name": "cds-error-outbox",
+  "version": "1.0.2",
+  "description": "A reusable CAP plugin that captures service errors, deduplicates them, and sends batched email notifications.",
+  "main": "index.js",
+  "cds": {
+    "plugin": true,
+    "requires": {
+      "cds-error-outbox": {
+        "model": "cds-error-outbox"
+      }
+    }
+  },
+  "keywords": [
+    "sap-cap",
+    "cds",
+    "plugin",
+    "error",
+    "outbox",
+    "email"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "test": "node --test tests/**/*.test.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "@sap/cds": ">=7"
+  },
+  "peerDependenciesMeta": {
+    "nodemailer": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@sap/cds": "^9.9.1"
+  }
+}

package/providers/index.js

@@ -1,40 +1,40 @@
-'use strict';
-
-/**
- * Email provider factory.
- *
- * Returns a provider object with a `send(mailConfig, subject, html)` function
- * based on config.mail.provider. Falls back to 'mock' for unknown values.
- *
- * Supported providers:
- *   'o365'  — Microsoft Graph API (client credentials, no extra deps)
- *   'smtp'  — nodemailer (optional peer dep: npm install nodemailer)
- *   'mock'  — console.log only, safe for development/testing
- *
- * @param {object} config - merged plugin config
- * @returns {{ send: Function }}
- */
-function getProvider(config) {
-  const providerName = (config.mail && config.mail.provider)
-    ? String(config.mail.provider).toLowerCase()
-    : 'mock';
-
-  switch (providerName) {
-    case 'o365':
-      return require('./o365');
-
-    case 'smtp':
-      return require('./smtp');
-
-    case 'mock':
-      return require('./mock');
-
-    default:
-      console.warn(
-        `[cds-error-outbox] Unknown email provider "${providerName}". Falling back to mock.`
-      );
-      return require('./mock');
-  }
-}
-
-module.exports = { getProvider };
+'use strict';
+
+/**
+ * Email provider factory.
+ *
+ * Returns a provider object with a `send(mailConfig, subject, html)` function
+ * based on config.mail.provider. Falls back to 'mock' for unknown values.
+ *
+ * Supported providers:
+ *   'o365'  — Microsoft Graph API (client credentials, no extra deps)
+ *   'smtp'  — nodemailer (optional peer dep: npm install nodemailer)
+ *   'mock'  — console.log only, safe for development/testing
+ *
+ * @param {object} config - merged plugin config
+ * @returns {{ send: Function }}
+ */
+function getProvider(config) {
+  const providerName = (config.mail && config.mail.provider)
+    ? String(config.mail.provider).toLowerCase()
+    : 'mock';
+
+  switch (providerName) {
+    case 'o365':
+      return require('./o365');
+
+    case 'smtp':
+      return require('./smtp');
+
+    case 'mock':
+      return require('./mock');
+
+    default:
+      console.warn(
+        `[cds-error-outbox] Unknown email provider "${providerName}". Falling back to mock.`
+      );
+      return require('./mock');
+  }
+}
+
+module.exports = { getProvider };

package/providers/mock.js

@@ -1,23 +1,23 @@
-'use strict';
-
-/**
- * Mock email provider — logs to console only.
- * No external calls are made.
- *
- * Use this in development and test environments to verify the plugin
- * is capturing and formatting errors without needing real mail credentials.
- *
- * @param {object} mailConfig
- * @param {string} subject
- * @param {string} html
- */
-async function send(mailConfig, subject, html) {
-  console.log('[cds-error-outbox][mock] ──────────── Email (mock) ────────────');
-  console.log(`[cds-error-outbox][mock]  From   : ${mailConfig.from || '(not configured)'}`);
-  console.log(`[cds-error-outbox][mock]  To     : ${mailConfig.to   || '(not configured)'}`);
-  console.log(`[cds-error-outbox][mock]  Subject: ${subject}`);
-  console.log(`[cds-error-outbox][mock]  HTML   : ${html ? html.length : 0} chars`);
-  console.log('[cds-error-outbox][mock] ─────────────────────────────────────');
-}
-
-module.exports = { send };
+'use strict';
+
+/**
+ * Mock email provider — logs to console only.
+ * No external calls are made.
+ *
+ * Use this in development and test environments to verify the plugin
+ * is capturing and formatting errors without needing real mail credentials.
+ *
+ * @param {object} mailConfig
+ * @param {string} subject
+ * @param {string} html
+ */
+async function send(mailConfig, subject, html) {
+  console.log('[cds-error-outbox][mock] ──────────── Email (mock) ────────────');
+  console.log(`[cds-error-outbox][mock]  From   : ${mailConfig.from || '(not configured)'}`);
+  console.log(`[cds-error-outbox][mock]  To     : ${mailConfig.to   || '(not configured)'}`);
+  console.log(`[cds-error-outbox][mock]  Subject: ${subject}`);
+  console.log(`[cds-error-outbox][mock]  HTML   : ${html ? html.length : 0} chars`);
+  console.log('[cds-error-outbox][mock] ─────────────────────────────────────');
+}
+
+module.exports = { send };