cds-error-outbox 1.0.1 → 1.0.2

package/config/defaults.js

@@ -1,46 +1,46 @@
-'use strict';
-
-module.exports = {
-  enabled: true,
-
-  /** How often (ms) the batch job runs to send unsent errors. */
-  interval: 300000,
-
-  /** Maximum number of unsent errors to include per email batch. */
-  batchSize: 50,
-
-  dedup: {
-    /** Whether to deduplicate errors by hash within the rolling window. */
-    enabled: true,
-
-    /** Only deduplicate within this time window (minutes). */
-    windowMinutes: 10
-  },
-
-  mail: {
-    /** Email provider: 'o365' | 'smtp' | 'mock' */
-    provider: 'mock',
-
-    /** Sender address (required for o365 and smtp). */
-    from: '',
-
-    /** Recipient address(es) — comma-separated for multiple (required for o365 and smtp). */
-    to: '',
-
-    /** === O365 / Microsoft Graph API options === */
-    tenantId: '',
-    clientId: '',
-    clientSecret: '',
-
-    /** === SMTP options (used only when provider = 'smtp') === */
-    smtp: {
-      host: '',
-      port: 587,
-      secure: false,
-      auth: {
-        user: '',
-        pass: ''
-      }
-    }
-  }
-};
+'use strict';
+
+module.exports = {
+  enabled: true,
+
+  /** How often (ms) the batch job runs to send unsent errors. */
+  interval: 300000,
+
+  /** Maximum number of unsent errors to include per email batch. */
+  batchSize: 50,
+
+  dedup: {
+    /** Whether to deduplicate errors by hash within the rolling window. */
+    enabled: true,
+
+    /** Only deduplicate within this time window (minutes). */
+    windowMinutes: 10
+  },
+
+  mail: {
+    /** Email provider: 'o365' | 'smtp' | 'mock' */
+    provider: 'mock',
+
+    /** Sender address (required for o365 and smtp). */
+    from: '',
+
+    /** Recipient address(es) — comma-separated for multiple (required for o365 and smtp). */
+    to: '',
+
+    /** === O365 / Microsoft Graph API options === */
+    tenantId: '',
+    clientId: '',
+    clientSecret: '',
+
+    /** === SMTP options (used only when provider = 'smtp') === */
+    smtp: {
+      host: '',
+      port: 587,
+      secure: false,
+      auth: {
+        user: '',
+        pass: ''
+      }
+    }
+  }
+};

package/db/model.cds

@@ -1,18 +1,18 @@
-namespace error.outbox;
-
-entity Errors {
-  key ID        : UUID;
-
-      hash      : String(64);
-      service   : String;
-      action    : String;
-
-      message   : LargeString;
-      stack     : LargeString;
-
-      count     : Integer;
-      firstSeen : Timestamp;
-      lastSeen  : Timestamp;
-
-      sent      : Boolean default false;
-}
+namespace error.outbox;
+
+entity Errors {
+  key ID        : UUID;
+
+      hash      : String(64);
+      service   : String;
+      action    : String;
+
+      message   : LargeString;
+      stack     : LargeString;
+
+      count     : Integer;
+      firstSeen : Timestamp;
+      lastSeen  : Timestamp;
+
+      sent      : Boolean default false;
+}

package/index.cds

@@ -1 +1 @@
-using from './db/model';
+using from './db/model';

package/index.js

@@ -1,14 +1,14 @@
-'use strict';
-
-/**
- * cds-error-outbox — CAP plugin entry point.
- *
- * CAP automatically requires this file when the package is installed,
- * because package.json declares `"cds": { "plugin": true }`.
- *
- * The bootstrap.initialize() call registers CAP lifecycle listeners
- * (cds.on('serving') and cds.on('served')) so no blocking work happens here.
- */
-const { initialize } = require('./lib/bootstrap');
-
-initialize();
+'use strict';
+
+/**
+ * cds-error-outbox — CAP plugin entry point.
+ *
+ * CAP automatically requires this file when the package is installed,
+ * because package.json declares `"cds": { "plugin": true }`.
+ *
+ * The bootstrap.initialize() call registers CAP lifecycle listeners
+ * (cds.on('serving') and cds.on('served')) so no blocking work happens here.
+ */
+const { initialize } = require('./lib/bootstrap');
+
+initialize();

package/lib/bootstrap.js

@@ -1,71 +1,71 @@
-'use strict';
-
-const cds = require('@sap/cds');
-const { loadConfig } = require('./config');
-const { attach }     = require('./interceptor');
-const { start }      = require('./scheduler');
-const { getProvider } = require('../providers');
-
-/**
- * Initialize the cds-error-outbox plugin.
- *
- * Called once at plugin load time (from index.js).
- * Uses CAP lifecycle events to ensure initialization order:
- *
- *   cds.on('serving') → attach error interceptor to each served service
- *   cds.on('served')  → start scheduler (DB is fully connected at this point)
- */
-function initialize() {
-  // ── Load and validate config ─────────────────────────────────────────────
-  let config;
-  try {
-    config = loadConfig();
-  } catch (err) {
-    console.error('[cds-error-outbox] Failed to load config — plugin disabled:', err.message);
-    return;
-  }
-
-  if (!config.enabled) {
-    console.info('[cds-error-outbox] Plugin is disabled (config.enabled = false).');
-    return;
-  }
-
-  // ── Resolve email provider ───────────────────────────────────────────────
-  let provider;
-  try {
-    provider = getProvider(config);
-  } catch (err) {
-    console.error('[cds-error-outbox] Failed to load email provider — plugin disabled:', err.message);
-    return;
-  }
-
-  // ── Attach interceptor to every served service ───────────────────────────
-  cds.on('serving', (srv) => {
-    try {
-      attach(srv, config);
-    } catch (err) {
-      console.error(
-        `[cds-error-outbox] Failed to attach interceptor to service "${srv.name}":`,
-        err.message
-      );
-    }
-  });
-
-  // ── Start scheduler after all services + DB are ready ───────────────────
-  // cds.on('served') fires once after ALL services have been bootstrapped
-  // and cds.db is guaranteed to be available.
-  cds.on('served', () => {
-    try {
-      start(config, provider);
-    } catch (err) {
-      console.error('[cds-error-outbox] Failed to start scheduler:', err.message);
-    }
-  });
-
-  console.info(
-    `[cds-error-outbox] Plugin initialized — ` +
-    `provider: ${config.mail.provider}, interval: ${config.interval}ms`
-  );
-}
-
-module.exports = { initialize };
+'use strict';
+
+const cds = require('@sap/cds');
+const { loadConfig } = require('./config');
+const { attach }     = require('./interceptor');
+const { start }      = require('./scheduler');
+const { getProvider } = require('../providers');
+
+/**
+ * Initialize the cds-error-outbox plugin.
+ *
+ * Called once at plugin load time (from index.js).
+ * Uses CAP lifecycle events to ensure initialization order:
+ *
+ *   cds.on('serving') → attach error interceptor to each served service
+ *   cds.on('served')  → start scheduler (DB is fully connected at this point)
+ */
+function initialize() {
+  // ── Load and validate config ─────────────────────────────────────────────
+  let config;
+  try {
+    config = loadConfig();
+  } catch (err) {
+    console.error('[cds-error-outbox] Failed to load config — plugin disabled:', err.message);
+    return;
+  }
+
+  if (!config.enabled) {
+    console.info('[cds-error-outbox] Plugin is disabled (config.enabled = false).');
+    return;
+  }
+
+  // ── Resolve email provider ───────────────────────────────────────────────
+  let provider;
+  try {
+    provider = getProvider(config);
+  } catch (err) {
+    console.error('[cds-error-outbox] Failed to load email provider — plugin disabled:', err.message);
+    return;
+  }
+
+  // ── Attach interceptor to every served service ───────────────────────────
+  cds.on('serving', (srv) => {
+    try {
+      attach(srv, config);
+    } catch (err) {
+      console.error(
+        `[cds-error-outbox] Failed to attach interceptor to service "${srv.name}":`,
+        err.message
+      );
+    }
+  });
+
+  // ── Start scheduler after all services + DB are ready ───────────────────
+  // cds.on('served') fires once after ALL services have been bootstrapped
+  // and cds.db is guaranteed to be available.
+  cds.on('served', () => {
+    try {
+      start(config, provider);
+    } catch (err) {
+      console.error('[cds-error-outbox] Failed to start scheduler:', err.message);
+    }
+  });
+
+  console.info(
+    `[cds-error-outbox] Plugin initialized — ` +
+    `provider: ${config.mail.provider}, interval: ${config.interval}ms`
+  );
+}
+
+module.exports = { initialize };

package/lib/config.js

@@ -1,67 +1,67 @@
-'use strict';
-
-const cds = require('@sap/cds');
-const defaults = require('../config/defaults');
-
-let _config = null;
-
-/**
- * Recursively deep-merge source into target.
- * Arrays in source replace arrays in target (no merge).
- *
- * @param {Object} target
- * @param {Object} source
- * @returns {Object}
- */
-function deepMerge(target, source) {
-  if (!source || typeof source !== 'object') return target;
-
-  const result = Object.assign({}, target);
-
-  for (const key of Object.keys(source)) {
-    const srcVal = source[key];
-    const tgtVal = result[key];
-
-    if (
-      srcVal !== null &&
-      typeof srcVal === 'object' &&
-      !Array.isArray(srcVal) &&
-      tgtVal !== null &&
-      typeof tgtVal === 'object' &&
-      !Array.isArray(tgtVal)
-    ) {
-      result[key] = deepMerge(tgtVal, srcVal);
-    } else if (srcVal !== undefined) {
-      result[key] = srcVal;
-    }
-  }
-
-  return result;
-}
-
-/**
- * Load and cache the merged config (defaults + cds.env.requires.errorOutbox).
- * @returns {Object}
- */
-function loadConfig() {
-  if (_config) return _config;
-
-  const userConfig =
-    (cds.env &&
-      cds.env.requires &&
-      cds.env.requires.errorOutbox) ||
-    {};
-
-  _config = deepMerge(defaults, userConfig);
-  return _config;
-}
-
-/**
- * Reset the cached config singleton.
- * Useful in tests to reload config between test cases.
- */
-function resetConfig() {
-  _config = null;
-}
-
-module.exports = { loadConfig, resetConfig, deepMerge };
+'use strict';
+
+const cds = require('@sap/cds');
+const defaults = require('../config/defaults');
+
+let _config = null;
+
+/**
+ * Recursively deep-merge source into target.
+ * Arrays in source replace arrays in target (no merge).
+ *
+ * @param {Object} target
+ * @param {Object} source
+ * @returns {Object}
+ */
+function deepMerge(target, source) {
+  if (!source || typeof source !== 'object') return target;
+
+  const result = Object.assign({}, target);
+
+  for (const key of Object.keys(source)) {
+    const srcVal = source[key];
+    const tgtVal = result[key];
+
+    if (
+      srcVal !== null &&
+      typeof srcVal === 'object' &&
+      !Array.isArray(srcVal) &&
+      tgtVal !== null &&
+      typeof tgtVal === 'object' &&
+      !Array.isArray(tgtVal)
+    ) {
+      result[key] = deepMerge(tgtVal, srcVal);
+    } else if (srcVal !== undefined) {
+      result[key] = srcVal;
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Load and cache the merged config (defaults + cds.env.requires.errorOutbox).
+ * @returns {Object}
+ */
+function loadConfig() {
+  if (_config) return _config;
+
+  const userConfig =
+    (cds.env &&
+      cds.env.requires &&
+      cds.env.requires.errorOutbox) ||
+    {};
+
+  _config = deepMerge(defaults, userConfig);
+  return _config;
+}
+
+/**
+ * Reset the cached config singleton.
+ * Useful in tests to reload config between test cases.
+ */
+function resetConfig() {
+  _config = null;
+}
+
+module.exports = { loadConfig, resetConfig, deepMerge };

package/lib/dedup.js

@@ -1,91 +1,91 @@
-'use strict';
-
-const crypto = require('crypto');
-
-const ENTITY = 'error.outbox.Errors';
-
-// Truncation limits to prevent oversized DB entries
-const MAX_MESSAGE_LEN = 5000;
-const MAX_STACK_LEN = 10000;
-
-/**
- * Creates a deterministic SHA-256 hash from the error's message, service, and action.
- * Used as the dedup key.
- *
- * @param {string} message
- * @param {string} service
- * @param {string} action
- * @returns {string} 64-character hex string
- */
-function createHash(message, service, action) {
-  return crypto
-    .createHash('sha256')
-    .update(`${message}|${service}|${action}`)
-    .digest('hex');
-}
-
-/**
- * Find an existing unsent error record matching the given hash within the dedup window.
- *
- * @param {object} db  - connected cds.db instance
- * @param {string} hash
- * @param {number} windowMinutes
- * @returns {Promise<object|null>}
- */
-async function findExistingError(db, hash, windowMinutes) {
-  const cutoff = new Date(Date.now() - windowMinutes * 60 * 1000).toISOString();
-
-  const results = await db.run(
-    SELECT.from(ENTITY)
-      .where({ hash })
-      .and('lastSeen >', cutoff)
-      .and({ sent: false })
-      .limit(1)
-  );
-
-  return results && results.length > 0 ? results[0] : null;
-}
-
-/**
- * Insert a new error row or increment the count on an existing one.
- * Deduplication is based on the hash + dedup window + sent=false.
- *
- * @param {object} db      - connected cds.db instance
- * @param {object} errorData - { message, stack, service, action }
- * @param {object} config  - merged plugin config
- */
-async function upsertError(db, errorData, config) {
-  const { message, stack, service, action } = errorData;
-
-  const hash = createHash(message, service, action);
-  const now = new Date().toISOString();
-
-  const existing = config.dedup.enabled
-    ? await findExistingError(db, hash, config.dedup.windowMinutes)
-    : null;
-
-  if (existing) {
-    await db.run(
-      UPDATE(ENTITY)
-        .set({ count: existing.count + 1, lastSeen: now })
-        .where({ ID: existing.ID })
-    );
-  } else {
-    await db.run(
-      INSERT.into(ENTITY).entries({
-        ID: crypto.randomUUID(),
-        hash,
-        service: String(service || 'unknown'),
-        action: String(action || 'unknown'),
-        message: message ? String(message).substring(0, MAX_MESSAGE_LEN) : '',
-        stack: stack ? String(stack).substring(0, MAX_STACK_LEN) : '',
-        count: 1,
-        firstSeen: now,
-        lastSeen: now,
-        sent: false
-      })
-    );
-  }
-}
-
-module.exports = { createHash, findExistingError, upsertError };
+'use strict';
+
+const crypto = require('crypto');
+
+const ENTITY = 'error.outbox.Errors';
+
+// Truncation limits to prevent oversized DB entries
+const MAX_MESSAGE_LEN = 5000;
+const MAX_STACK_LEN = 10000;
+
+/**
+ * Creates a deterministic SHA-256 hash from the error's message, service, and action.
+ * Used as the dedup key.
+ *
+ * @param {string} message
+ * @param {string} service
+ * @param {string} action
+ * @returns {string} 64-character hex string
+ */
+function createHash(message, service, action) {
+  return crypto
+    .createHash('sha256')
+    .update(`${message}|${service}|${action}`)
+    .digest('hex');
+}
+
+/**
+ * Find an existing unsent error record matching the given hash within the dedup window.
+ *
+ * @param {object} db  - connected cds.db instance
+ * @param {string} hash
+ * @param {number} windowMinutes
+ * @returns {Promise<object|null>}
+ */
+async function findExistingError(db, hash, windowMinutes) {
+  const cutoff = new Date(Date.now() - windowMinutes * 60 * 1000).toISOString();
+
+  const results = await db.run(
+    SELECT.from(ENTITY)
+      .where({ hash })
+      .and('lastSeen >', cutoff)
+      .and({ sent: false })
+      .limit(1)
+  );
+
+  return results && results.length > 0 ? results[0] : null;
+}
+
+/**
+ * Insert a new error row or increment the count on an existing one.
+ * Deduplication is based on the hash + dedup window + sent=false.
+ *
+ * @param {object} db      - connected cds.db instance
+ * @param {object} errorData - { message, stack, service, action }
+ * @param {object} config  - merged plugin config
+ */
+async function upsertError(db, errorData, config) {
+  const { message, stack, service, action } = errorData;
+
+  const hash = createHash(message, service, action);
+  const now = new Date().toISOString();
+
+  const existing = config.dedup.enabled
+    ? await findExistingError(db, hash, config.dedup.windowMinutes)
+    : null;
+
+  if (existing) {
+    await db.run(
+      UPDATE(ENTITY)
+        .set({ count: existing.count + 1, lastSeen: now })
+        .where({ ID: existing.ID })
+    );
+  } else {
+    await db.run(
+      INSERT.into(ENTITY).entries({
+        ID: crypto.randomUUID(),
+        hash,
+        service: String(service || 'unknown'),
+        action: String(action || 'unknown'),
+        message: message ? String(message).substring(0, MAX_MESSAGE_LEN) : '',
+        stack: stack ? String(stack).substring(0, MAX_STACK_LEN) : '',
+        count: 1,
+        firstSeen: now,
+        lastSeen: now,
+        sent: false
+      })
+    );
+  }
+}
+
+module.exports = { createHash, findExistingError, upsertError };