cds-error-outbox 1.0.0 → 1.0.2

package/providers/o365.js

@@ -1,164 +1,164 @@
-'use strict';
-
-const https    = require('https');
-const qs       = require('querystring');
-
-/**
- * Obtain an OAuth 2.0 access token using the client credentials grant.
- * Endpoint: POST https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
- *
- * @param {object} mailConfig - { tenantId, clientId, clientSecret }
- * @returns {Promise<string>} Bearer access token
- */
-function getAccessToken(mailConfig) {
-  // Values from config take precedence; env variables are the fallback.
-  // Supported env variables:
-  //   CDS_REQUIRES_ERROROUTBOX_MAIL_TENANTID
-  //   CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTID
-  //   CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTSECRET
-  const tenantId     = mailConfig.tenantId     || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_TENANTID     || process.env.ERROR_OUTBOX_TENANT_ID;
-  const clientId     = mailConfig.clientId     || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTID     || process.env.ERROR_OUTBOX_CLIENT_ID;
-  const clientSecret = mailConfig.clientSecret || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTSECRET || process.env.ERROR_OUTBOX_CLIENT_SECRET;
-
-  if (!tenantId || !clientId || !clientSecret) {
-    return Promise.reject(
-      new Error(
-        '[cds-error-outbox][o365] tenantId, clientId, and clientSecret are required. ' +
-        'Set them in cds.requires.errorOutbox.mail or via env variables: ' +
-        'CDS_REQUIRES_ERROROUTBOX_MAIL_TENANTID, CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTID, CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTSECRET'
-      )
-    );
-  }
-
-  const body = qs.stringify({
-    grant_type:    'client_credentials',
-    client_id:     clientId,
-    client_secret: clientSecret,
-    scope:         'https://graph.microsoft.com/.default'
-  });
-
-  return new Promise((resolve, reject) => {
-    const options = {
-      hostname: 'login.microsoftonline.com',
-      path:     `/${encodeURIComponent(tenantId)}/oauth2/v2.0/token`,
-      method:   'POST',
-      headers: {
-        'Content-Type':   'application/x-www-form-urlencoded',
-        'Content-Length': Buffer.byteLength(body)
-      }
-    };
-
-    const req = https.request(options, (res) => {
-      let data = '';
-      res.on('data', (chunk) => { data += chunk; });
-      res.on('end', () => {
-        try {
-          const parsed = JSON.parse(data);
-          if (parsed.access_token) {
-            resolve(parsed.access_token);
-          } else {
-            reject(
-              new Error(
-                `[cds-error-outbox][o365] Token request failed: ` +
-                (parsed.error_description || parsed.error || `HTTP ${res.statusCode}`)
-              )
-            );
-          }
-        } catch (e) {
-          reject(new Error(`[cds-error-outbox][o365] Failed to parse token response: ${e.message}`));
-        }
-      });
-    });
-
-    req.on('error', (err) =>
-      reject(new Error(`[cds-error-outbox][o365] Token HTTPS request error: ${err.message}`))
-    );
-
-    req.write(body);
-    req.end();
-  });
-}
-
-/**
- * Send an email via Microsoft Graph API (POST /users/{from}/sendMail).
- *
- * Required Azure AD app permission: Mail.Send (application, not delegated).
- * The `from` address must be a licensed Exchange Online mailbox.
- *
- * @param {object} mailConfig - { tenantId, clientId, clientSecret, from, to }
- * @param {string} subject
- * @param {string} html
- */
-async function send(mailConfig, subject, html) {
-  const from = mailConfig.from || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_FROM || process.env.ERROR_OUTBOX_FROM;
-  const to   = mailConfig.to   || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_TO   || process.env.ERROR_OUTBOX_TO;
-
-  if (!from || !to) {
-    throw new Error(
-      '[cds-error-outbox][o365] mail.from and mail.to are required. ' +
-      'Set them in cds.requires.errorOutbox.mail or via env variables: ' +
-      'CDS_REQUIRES_ERROROUTBOX_MAIL_FROM, CDS_REQUIRES_ERROROUTBOX_MAIL_TO'
-    );
-  }
-
-  const accessToken = await getAccessToken(mailConfig);
-
-  // Support comma-separated recipient list
-  const toRecipients = String(to)
-    .split(',')
-    .map((addr) => ({ emailAddress: { address: addr.trim() } }));
-
-  const payload = JSON.stringify({
-    message: {
-      subject,
-      body: {
-        contentType: 'HTML',
-        content: html
-      },
-      from: {
-        emailAddress: { address: from }
-      },
-      toRecipients
-    },
-    saveToSentItems: false
-  });
-
-  return new Promise((resolve, reject) => {
-    const options = {
-      hostname: 'graph.microsoft.com',
-      path:     `/v1.0/users/${encodeURIComponent(from)}/sendMail`,
-      method:   'POST',
-      headers: {
-        'Authorization': `Bearer ${accessToken}`,
-        'Content-Type':  'application/json',
-        'Content-Length': Buffer.byteLength(payload)
-      }
-    };
-
-    const req = https.request(options, (res) => {
-      let data = '';
-      res.on('data', (chunk) => { data += chunk; });
-      res.on('end', () => {
-        // Graph API returns 202 Accepted on success (no body)
-        if (res.statusCode >= 200 && res.statusCode < 300) {
-          resolve();
-        } else {
-          reject(
-            new Error(
-              `[cds-error-outbox][o365] sendMail failed — HTTP ${res.statusCode}: ${data}`
-            )
-          );
-        }
-      });
-    });
-
-    req.on('error', (err) =>
-      reject(new Error(`[cds-error-outbox][o365] sendMail HTTPS request error: ${err.message}`))
-    );
-
-    req.write(payload);
-    req.end();
-  });
-}
-
-module.exports = { send, getAccessToken };
+'use strict';
+
+const https    = require('https');
+const qs       = require('querystring');
+
+/**
+ * Obtain an OAuth 2.0 access token using the client credentials grant.
+ * Endpoint: POST https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
+ *
+ * @param {object} mailConfig - { tenantId, clientId, clientSecret }
+ * @returns {Promise<string>} Bearer access token
+ */
+function getAccessToken(mailConfig) {
+  // Values from config take precedence; env variables are the fallback.
+  // Supported env variables:
+  //   CDS_REQUIRES_ERROROUTBOX_MAIL_TENANTID
+  //   CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTID
+  //   CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTSECRET
+  const tenantId     = mailConfig.tenantId     || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_TENANTID     || process.env.ERROR_OUTBOX_TENANT_ID;
+  const clientId     = mailConfig.clientId     || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTID     || process.env.ERROR_OUTBOX_CLIENT_ID;
+  const clientSecret = mailConfig.clientSecret || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTSECRET || process.env.ERROR_OUTBOX_CLIENT_SECRET;
+
+  if (!tenantId || !clientId || !clientSecret) {
+    return Promise.reject(
+      new Error(
+        '[cds-error-outbox][o365] tenantId, clientId, and clientSecret are required. ' +
+        'Set them in cds.requires.errorOutbox.mail or via env variables: ' +
+        'CDS_REQUIRES_ERROROUTBOX_MAIL_TENANTID, CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTID, CDS_REQUIRES_ERROROUTBOX_MAIL_CLIENTSECRET'
+      )
+    );
+  }
+
+  const body = qs.stringify({
+    grant_type:    'client_credentials',
+    client_id:     clientId,
+    client_secret: clientSecret,
+    scope:         'https://graph.microsoft.com/.default'
+  });
+
+  return new Promise((resolve, reject) => {
+    const options = {
+      hostname: 'login.microsoftonline.com',
+      path:     `/${encodeURIComponent(tenantId)}/oauth2/v2.0/token`,
+      method:   'POST',
+      headers: {
+        'Content-Type':   'application/x-www-form-urlencoded',
+        'Content-Length': Buffer.byteLength(body)
+      }
+    };
+
+    const req = https.request(options, (res) => {
+      let data = '';
+      res.on('data', (chunk) => { data += chunk; });
+      res.on('end', () => {
+        try {
+          const parsed = JSON.parse(data);
+          if (parsed.access_token) {
+            resolve(parsed.access_token);
+          } else {
+            reject(
+              new Error(
+                `[cds-error-outbox][o365] Token request failed: ` +
+                (parsed.error_description || parsed.error || `HTTP ${res.statusCode}`)
+              )
+            );
+          }
+        } catch (e) {
+          reject(new Error(`[cds-error-outbox][o365] Failed to parse token response: ${e.message}`));
+        }
+      });
+    });
+
+    req.on('error', (err) =>
+      reject(new Error(`[cds-error-outbox][o365] Token HTTPS request error: ${err.message}`))
+    );
+
+    req.write(body);
+    req.end();
+  });
+}
+
+/**
+ * Send an email via Microsoft Graph API (POST /users/{from}/sendMail).
+ *
+ * Required Azure AD app permission: Mail.Send (application, not delegated).
+ * The `from` address must be a licensed Exchange Online mailbox.
+ *
+ * @param {object} mailConfig - { tenantId, clientId, clientSecret, from, to }
+ * @param {string} subject
+ * @param {string} html
+ */
+async function send(mailConfig, subject, html) {
+  const from = mailConfig.from || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_FROM || process.env.ERROR_OUTBOX_FROM;
+  const to   = mailConfig.to   || process.env.CDS_REQUIRES_ERROROUTBOX_MAIL_TO   || process.env.ERROR_OUTBOX_TO;
+
+  if (!from || !to) {
+    throw new Error(
+      '[cds-error-outbox][o365] mail.from and mail.to are required. ' +
+      'Set them in cds.requires.errorOutbox.mail or via env variables: ' +
+      'CDS_REQUIRES_ERROROUTBOX_MAIL_FROM, CDS_REQUIRES_ERROROUTBOX_MAIL_TO'
+    );
+  }
+
+  const accessToken = await getAccessToken(mailConfig);
+
+  // Support comma-separated recipient list
+  const toRecipients = String(to)
+    .split(',')
+    .map((addr) => ({ emailAddress: { address: addr.trim() } }));
+
+  const payload = JSON.stringify({
+    message: {
+      subject,
+      body: {
+        contentType: 'HTML',
+        content: html
+      },
+      from: {
+        emailAddress: { address: from }
+      },
+      toRecipients
+    },
+    saveToSentItems: false
+  });
+
+  return new Promise((resolve, reject) => {
+    const options = {
+      hostname: 'graph.microsoft.com',
+      path:     `/v1.0/users/${encodeURIComponent(from)}/sendMail`,
+      method:   'POST',
+      headers: {
+        'Authorization': `Bearer ${accessToken}`,
+        'Content-Type':  'application/json',
+        'Content-Length': Buffer.byteLength(payload)
+      }
+    };
+
+    const req = https.request(options, (res) => {
+      let data = '';
+      res.on('data', (chunk) => { data += chunk; });
+      res.on('end', () => {
+        // Graph API returns 202 Accepted on success (no body)
+        if (res.statusCode >= 200 && res.statusCode < 300) {
+          resolve();
+        } else {
+          reject(
+            new Error(
+              `[cds-error-outbox][o365] sendMail failed — HTTP ${res.statusCode}: ${data}`
+            )
+          );
+        }
+      });
+    });
+
+    req.on('error', (err) =>
+      reject(new Error(`[cds-error-outbox][o365] sendMail HTTPS request error: ${err.message}`))
+    );
+
+    req.write(payload);
+    req.end();
+  });
+}
+
+module.exports = { send, getAccessToken };

package/providers/smtp.js

@@ -1,71 +1,71 @@
-'use strict';
-
-/**
- * SMTP email provider using nodemailer.
- *
- * nodemailer is an optional peer dependency — install it separately:
- *   npm install nodemailer
- *
- * Required config under mail.smtp:
- *   host, port, secure, auth.user, auth.pass
- *
- * @param {object} mailConfig
- * @param {string} subject
- * @param {string} html
- */
-async function send(mailConfig, subject, html) {
-  let nodemailer;
-  try {
-    nodemailer = require('nodemailer');
-  } catch (_) {
-    throw new Error(
-      '[cds-error-outbox][smtp] nodemailer is not installed. ' +
-      'Run: npm install nodemailer'
-    );
-  }
-
-  const { from, to, smtp } = mailConfig;
-
-  if (!from || !to) {
-    throw new Error(
-      '[cds-error-outbox][smtp] mail.from and mail.to must be configured.'
-    );
-  }
-
-  if (!smtp || !smtp.host) {
-    throw new Error(
-      '[cds-error-outbox][smtp] mail.smtp.host must be configured for the SMTP provider.'
-    );
-  }
-
-  const transportOptions = {
-    host:   smtp.host,
-    port:   smtp.port   !== undefined ? smtp.port   : 587,
-    secure: smtp.secure !== undefined ? smtp.secure : false
-  };
-
-  // Only set auth if credentials are provided (some internal SMTP relays don't require auth)
-  if (smtp.auth && smtp.auth.user) {
-    transportOptions.auth = {
-      user: smtp.auth.user,
-      pass: smtp.auth.pass
-    };
-  }
-
-  const transporter = nodemailer.createTransport(transportOptions);
-
-  // Normalise comma-separated recipients
-  const toAddresses = String(to)
-    .split(',')
-    .map((a) => a.trim())
-    .join(', ');
-
-  await transporter.sendMail({
-    from,
-    to: toAddresses,
-    subject,
-    html
-  });
-}
-
-module.exports = { send };
+'use strict';
+
+/**
+ * SMTP email provider using nodemailer.
+ *
+ * nodemailer is an optional peer dependency — install it separately:
+ *   npm install nodemailer
+ *
+ * Required config under mail.smtp:
+ *   host, port, secure, auth.user, auth.pass
+ *
+ * @param {object} mailConfig
+ * @param {string} subject
+ * @param {string} html
+ */
+async function send(mailConfig, subject, html) {
+  let nodemailer;
+  try {
+    nodemailer = require('nodemailer');
+  } catch (_) {
+    throw new Error(
+      '[cds-error-outbox][smtp] nodemailer is not installed. ' +
+      'Run: npm install nodemailer'
+    );
+  }
+
+  const { from, to, smtp } = mailConfig;
+
+  if (!from || !to) {
+    throw new Error(
+      '[cds-error-outbox][smtp] mail.from and mail.to must be configured.'
+    );
+  }
+
+  if (!smtp || !smtp.host) {
+    throw new Error(
+      '[cds-error-outbox][smtp] mail.smtp.host must be configured for the SMTP provider.'
+    );
+  }
+
+  const transportOptions = {
+    host:   smtp.host,
+    port:   smtp.port   !== undefined ? smtp.port   : 587,
+    secure: smtp.secure !== undefined ? smtp.secure : false
+  };
+
+  // Only set auth if credentials are provided (some internal SMTP relays don't require auth)
+  if (smtp.auth && smtp.auth.user) {
+    transportOptions.auth = {
+      user: smtp.auth.user,
+      pass: smtp.auth.pass
+    };
+  }
+
+  const transporter = nodemailer.createTransport(transportOptions);
+
+  // Normalise comma-separated recipients
+  const toAddresses = String(to)
+    .split(',')
+    .map((a) => a.trim())
+    .join(', ');
+
+  await transporter.sendMail({
+    from,
+    to: toAddresses,
+    subject,
+    html
+  });
+}
+
+module.exports = { send };

package/tests/config.test.js

@@ -0,0 +1,92 @@
+'use strict';
+
+const { describe, it, beforeEach, afterEach } = require('node:test');
+const assert = require('node:assert/strict');
+
+// Mock cds before requiring config
+const cds = require('@sap/cds');
+
+const { deepMerge, loadConfig, resetConfig } = require('../lib/config');
+
+describe('deepMerge', () => {
+  it('merges flat objects', () => {
+    const result = deepMerge({ a: 1, b: 2 }, { b: 99, c: 3 });
+    assert.deepEqual(result, { a: 1, b: 99, c: 3 });
+  });
+
+  it('merges nested objects recursively', () => {
+    const result = deepMerge(
+      { mail: { provider: 'mock', port: 587 } },
+      { mail: { provider: 'smtp' } }
+    );
+    assert.deepEqual(result, { mail: { provider: 'smtp', port: 587 } });
+  });
+
+  it('replaces arrays (no element-wise merge)', () => {
+    const result = deepMerge({ arr: [1, 2, 3] }, { arr: [4, 5] });
+    assert.deepEqual(result, { arr: [4, 5] });
+  });
+
+  it('returns target unchanged when source is null', () => {
+    const target = { a: 1 };
+    const result = deepMerge(target, null);
+    assert.deepEqual(result, { a: 1 });
+  });
+
+  it('returns target unchanged when source is undefined', () => {
+    const target = { a: 1 };
+    const result = deepMerge(target, undefined);
+    assert.deepEqual(result, { a: 1 });
+  });
+
+  it('does not mutate the original target', () => {
+    const target = { a: 1 };
+    deepMerge(target, { a: 2 });
+    assert.equal(target.a, 1);
+  });
+});
+
+describe('loadConfig / resetConfig', () => {
+  beforeEach(() => {
+    resetConfig();
+  });
+
+  afterEach(() => {
+    resetConfig();
+    // Clean up any cds.env overrides
+    if (cds.env.requires) delete cds.env.requires.errorOutbox;
+  });
+
+  it('returns defaults when no user config is set', () => {
+    const config = loadConfig();
+    assert.equal(config.enabled, true);
+    assert.equal(config.interval, 300000);
+    assert.equal(config.batchSize, 50);
+    assert.equal(config.dedup.enabled, true);
+    assert.equal(config.dedup.windowMinutes, 10);
+    assert.equal(config.mail.provider, 'mock');
+  });
+
+  it('overrides defaults with user config', () => {
+    cds.env.requires = cds.env.requires || {};
+    cds.env.requires.errorOutbox = { interval: 60000, mail: { provider: 'smtp' } };
+    const config = loadConfig();
+    assert.equal(config.interval, 60000);
+    assert.equal(config.mail.provider, 'smtp');
+    // Defaults for untouched keys remain
+    assert.equal(config.batchSize, 50);
+  });
+
+  it('caches the result — second call returns same object', () => {
+    const a = loadConfig();
+    const b = loadConfig();
+    assert.equal(a, b);
+  });
+
+  it('resetConfig causes loadConfig to return a new instance', () => {
+    const a = loadConfig();
+    resetConfig();
+    const b = loadConfig();
+    assert.notEqual(a, b);
+  });
+});