Merge pull request #3375 from pierreb-devkit/fix/mailer-normalize-resend-response

PierreBrisorgueil · web-flow · commit c8bd3a0b97eb · 2026-04-02T09:55:11.000+02:00
fix(mailer): normalize provider response to nodemailer format
diff --git a/lib/app.js b/lib/app.js
@@ -87,9 +87,10 @@ const bootstrap = async () => {
 };
 
 /**
- * log server configuration
+ * @desc Log server configuration and SaaS readiness summary to console.
+ * @returns {Promise<void>}
  */
-const logConfiguration = () => {
+const logConfiguration = async () => {
   // Create server URL
   const server = `${(config.secure && config.secure.credentials ? 'https://' : 'http://') + config.api.host}:${config.api.port}`;
   // Logging initialization
@@ -99,6 +100,22 @@ const logConfiguration = () => {
   console.log(chalk.green(`Server:          ${server}`));
   console.log(chalk.green(`Database:        ${config.db.uri}`));
   if (config.cors.origin.length > 0) console.log(chalk.green(`Cors:            ${config.cors.origin}`));
+
+  // SaaS readiness summary (skip in test to keep output clean)
+  if (process.env.NODE_ENV !== 'test') {
+    try {
+      const { default: HomeService } = await import('../modules/home/services/home.service.js');
+      const checks = HomeService.getReadinessStatus();
+      console.log();
+      console.log(chalk.green('SaaS Readiness:'));
+      checks.forEach((c) => {
+        const icon = c.status === 'ok' ? chalk.green('OK') : chalk.yellow('WARN');
+        console.log(`  ${icon}  ${c.category.padEnd(12)} ${c.message}`);
+      });
+    } catch (err) {
+      console.log(chalk.yellow(`  SaaS readiness check failed: ${err.message}`));
+    }
+  }
 };
 
 // Boot up the server
@@ -118,7 +135,7 @@ const start = async () => {
     if (config.secure && config.secure.credentials)
       http = await nodeHttps.createServer(config.secure.credentials, app).setTimeout(config.api.timeout).listen(config.api.port, config.api.host);
     else http = await nodeHttp.createServer(app).setTimeout(config.api.timeout).listen(config.api.port, config.api.host);
-    logConfiguration();
+    await logConfiguration();
     return {
       db,
       orm,
diff --git a/lib/helpers/mailer/index.js b/lib/helpers/mailer/index.js
@@ -44,6 +44,9 @@ const isConfigured = () => !!(config.mailer && config.mailer.from && !String(con
  * @param {string} mail.subject - Email subject
  * @param {string} mail.template - Template name (without .html)
  * @param {Object} mail.params - Template parameters
+ * @param {Array} [mail.attachments] - Optional attachments array
+ * @param {string} mail.attachments[].filename - Attachment filename
+ * @param {string} mail.attachments[].content - Attachment content (string or Buffer)
  * @returns {Promise<Object|null>} The send result or null if not configured
  */
 const sendMail = async (mail) => {
@@ -54,12 +57,15 @@ const sendMail = async (mail) => {
   const template = handlebars.compile(file);
   const html = template(mail.params);
   try {
-    return await getProvider().send({
+    const result = await getProvider().send({
       from: config.mailer.from,
       to: mail.to,
       subject: mail.subject,
       html,
+      attachments: mail.attachments,
     });
+    if (!Array.isArray(result?.accepted)) return { ...result, accepted: [mail.to], rejected: [] };
+    return result;
   } catch (err) {
     console.error(`Mail send error: ${err.message}`);
     return null;
diff --git a/lib/helpers/mailer/provider.nodemailer.js b/lib/helpers/mailer/provider.nodemailer.js
@@ -5,7 +5,9 @@ export default class NodemailerProvider {
     this.transport = nodemailer.createTransport(options);
   }
 
-  async send({ from, to, subject, html }) {
-    return this.transport.sendMail({ from, to, subject, html });
+  async send({ from, to, subject, html, attachments }) {
+    const payload = { from, to, subject, html };
+    if (attachments?.length) payload.attachments = attachments;
+    return this.transport.sendMail(payload);
   }
 }
diff --git a/lib/helpers/mailer/provider.resend.js b/lib/helpers/mailer/provider.resend.js
@@ -19,10 +19,20 @@ export default class ResendProvider {
    * @param {string} mail.to - Recipient address
    * @param {string} mail.subject - Email subject
    * @param {string} mail.html - HTML body
+   * @param {Array} [mail.attachments] - Optional attachments array
+   * @param {string} mail.attachments[].filename - Attachment filename
+   * @param {string} mail.attachments[].content - Attachment content (string or Buffer)
    * @returns {Promise<Object>} Resend API response data
    */
-  async send({ from, to, subject, html }) {
-    const { data, error } = await this.client.emails.send({ from, to, subject, html });
+  async send({ from, to, subject, html, attachments }) {
+    const payload = { from, to, subject, html };
+    if (attachments?.length) {
+      payload.attachments = attachments.map((a) => ({
+        filename: a.filename,
+        content: Buffer.from(a.content).toString('base64'),
+      }));
+    }
+    const { data, error } = await this.client.emails.send(payload);
     if (error) throw new Error(error.message || 'Resend API error');
     return data;
   }
diff --git a/lib/helpers/mailer/tests/mailer.unit.tests.js b/lib/helpers/mailer/tests/mailer.unit.tests.js
@@ -20,7 +20,7 @@ jest.unstable_mockModule('../../files.js', () => ({
   },
 }));
 
-const mockSend = jest.fn().mockResolvedValue({ id: 'email_123' });
+const mockSend = jest.fn().mockResolvedValue({ id: 'email_123', accepted: ['user@example.com'], rejected: [] });
 jest.unstable_mockModule('../provider.resend.js', () => ({
   default: jest.fn().mockImplementation(() => ({ send: mockSend })),
 }));
@@ -40,7 +40,7 @@ describe('mailer index with resend provider unit tests:', () => {
     expect(mailer.isConfigured()).toBe(true);
   });
 
-  test('should send mail using the resend provider', async () => {
+  test('should send mail using the resend provider and normalize response', async () => {
     mockSend.mockResolvedValue({ id: 'email_456' });
 
     const result = await mailer.sendMail({
@@ -58,10 +58,42 @@ describe('mailer index with resend provider unit tests:', () => {
         html: '<p>Alice</p>',
       }),
     );
-    expect(result).toEqual({ id: 'email_456' });
+    expect(result).toEqual({ id: 'email_456', accepted: ['user@example.com'], rejected: [] });
   });
 
-  test('should return null on send error', async () => {
+  test('should pass through response unchanged when accepted is already an array', async () => {
+    mockSend.mockResolvedValue({ id: 'email_789', accepted: ['user@example.com'], rejected: [] });
+
+    const result = await mailer.sendMail({
+      to: 'user@example.com',
+      subject: 'Welcome',
+      template: 'welcome',
+      params: { name: 'Charlie' },
+    });
+
+    expect(result).toEqual({ id: 'email_789', accepted: ['user@example.com'], rejected: [] });
+  });
+
+  test('should forward attachments to the provider', async () => {
+    mockSend.mockResolvedValue({ id: 'email_attach', accepted: ['user@example.com'], rejected: [] });
+
+    const attachments = [{ filename: 'report.csv', content: 'a,b\n1,2' }];
+    await mailer.sendMail({
+      to: 'user@example.com',
+      subject: 'Report',
+      template: 'welcome',
+      params: { name: 'Carol' },
+      attachments,
+    });
+
+    expect(mockSend).toHaveBeenCalledWith(
+      expect.objectContaining({
+        attachments,
+      }),
+    );
+  });
+
+    test('should return null on send error', async () => {
     mockSend.mockRejectedValue(new Error('API failure'));
 
     const result = await mailer.sendMail({
diff --git a/lib/helpers/mailer/tests/provider.resend.unit.tests.js b/lib/helpers/mailer/tests/provider.resend.unit.tests.js
@@ -57,6 +57,33 @@ describe('ResendProvider unit tests:', () => {
     expect(result).toEqual(mockData);
   });
 
+  test('should send an email with attachments', async () => {
+    const mockData = { id: 'email_456' };
+    sendMock.mockResolvedValue({ data: mockData, error: null });
+
+    const result = await provider.send({
+      from: 'sender@example.com',
+      to: 'recipient@example.com',
+      subject: 'Test with attachment',
+      html: '<p>See attached</p>',
+      attachments: [{ filename: 'data.csv', content: 'col1,col2\nval1,val2' }],
+    });
+
+    expect(sendMock).toHaveBeenCalledWith({
+      from: 'sender@example.com',
+      to: 'recipient@example.com',
+      subject: 'Test with attachment',
+      html: '<p>See attached</p>',
+      attachments: [
+        {
+          filename: 'data.csv',
+          content: Buffer.from('col1,col2\nval1,val2').toString('base64'),
+        },
+      ],
+    });
+    expect(result).toEqual(mockData);
+  });
+
   test('should throw on Resend API error', async () => {
     sendMock.mockResolvedValue({ data: null, error: { message: 'Invalid API key' } });
 
diff --git a/lib/middlewares/policy.js b/lib/middlewares/policy.js
@@ -201,6 +201,7 @@ const deriveSubjectType = (routePath) => {
   if (routePath.startsWith('/api/tasks')) return 'Task';
   if (routePath.startsWith('/api/uploads')) return 'Upload';
   if (routePath.startsWith('/api/home')) return 'Home';
+  if (routePath === '/api/admin/readiness') return 'Readiness';
   if (routePath.startsWith('/api/admin/organizations')) return 'Organization';
   if (routePath.includes('/requests')) return 'Membership';
   if (routePath.includes('/members')) return 'Membership';
diff --git a/modules/home/controllers/home.controller.js b/modules/home/controllers/home.controller.js
@@ -96,11 +96,27 @@ const health = (req, res) => {
   responses.success(res, 'health check')(payload);
 };
 
+/**
+ * @desc Endpoint to return SaaS readiness checks (admin only).
+ * @param {Object} req - Express request object
+ * @param {Object} res - Express response object
+ * @returns {void}
+ */
+const readiness = (req, res) => {
+  try {
+    const data = HomeService.getReadinessStatus();
+    responses.success(res, 'readiness check')(data);
+  } catch (err) {
+    responses.error(res, 422, 'Unprocessable Entity', errors.getMessage(err))(err);
+  }
+};
+
 export default {
   releases,
   changelogs,
   team,
   page,
   pageByName,
   health,
+  readiness,
 };
diff --git a/modules/home/policies/home.policy.js b/modules/home/policies/home.policy.js
@@ -12,6 +12,9 @@
  */
 export function homeAbilities(user, membership, { can }) {
   can('read', 'Home');
+  if (Array.isArray(user?.roles) && user.roles.includes('admin')) {
+    can('manage', 'Readiness');
+  }
 }
 
 /**
diff --git a/modules/home/routes/home.route.js b/modules/home/routes/home.route.js
@@ -35,6 +35,8 @@ export default (app) => {
   app.route('/api/home/team').all(policy.isAllowed).get(home.team);
   // markdown files
   app.route('/api/home/pages/:name').all(policy.isAllowed).get(home.page);
+  // readiness check — admin only (JWT + CASL)
+  app.route('/api/admin/readiness').all(passport.authenticate('jwt', { session: false }), policy.isAllowed).get(home.readiness);
 
   // Finish by binding the task middleware
   app.param('name', home.pageByName);
diff --git a/modules/home/services/home.service.js b/modules/home/services/home.service.js
@@ -10,8 +10,16 @@ import mongoose from 'mongoose';
 
 import AuthService from '../../auth/services/auth.service.js';
 import config from '../../../config/index.js';
+import mailer from '../../../lib/helpers/mailer/index.js';
 import HomeRepository from '../repositories/home.repository.js';
 
+/**
+ * @desc Check whether a config value is meaningfully set (non-empty, not a DEVKIT placeholder).
+ * @param {*} value - Config value to check
+ * @returns {boolean} true when value is a non-empty string and not a DEVKIT_NODE_ placeholder
+ */
+const isSet = (value) => !!(value && typeof value === 'string' && value.trim() !== '' && !value.startsWith('DEVKIT_NODE_'));
+
 /**
  * @desc Function to get all admin users in db
  * @return {Promise} All users
@@ -102,10 +110,81 @@ const getHealthStatus = () => {
   };
 };
 
+/**
+ * @desc Run SaaS readiness checks against current configuration.
+ * Each check returns { category, status, message }.
+ * @returns {Array<{category: string, status: string, message: string}>}
+ */
+const getReadinessStatus = () => {
+  const checks = [];
+
+  // config — domain
+  const domainSet = isSet(config.domain);
+  checks.push({
+    category: 'config',
+    status: domainSet ? 'ok' : 'warning',
+    message: domainSet ? 'Domain configured' : 'Domain not configured',
+  });
+
+  // security — JWT secret
+  const jwtSecret = config.jwt?.secret;
+  const jwtInsecure = !jwtSecret || jwtSecret.trim() === '' || jwtSecret === 'WaosSecretKeyExampleToChnageAbsolutely';
+  checks.push({
+    category: 'security',
+    status: jwtInsecure ? 'warning' : 'ok',
+    message: jwtInsecure ? 'JWT secret is missing or default — change it before production' : 'JWT secret is custom',
+  });
+
+  // auth — OAuth providers
+  const oAuthProviders = [];
+  if (isSet(config.oAuth?.google?.clientID)) oAuthProviders.push('Google');
+  if (isSet(config.oAuth?.apple?.clientID)) oAuthProviders.push('Apple');
+  checks.push({
+    category: 'auth',
+    status: oAuthProviders.length > 0 ? 'ok' : 'warning',
+    message: oAuthProviders.length > 0 ? `OAuth configured (${oAuthProviders.join(', ')})` : 'No OAuth provider configured',
+  });
+
+  // mail — mailer
+  const mailConfigured = mailer.isConfigured();
+  checks.push({
+    category: 'mail',
+    status: mailConfigured ? 'ok' : 'warning',
+    message: mailConfigured ? 'Mail provider configured' : 'No mail provider configured',
+  });
+
+  // billing — Stripe
+  const stripeConfigured = isSet(config.stripe?.secretKey);
+  checks.push({
+    category: 'billing',
+    status: stripeConfigured ? 'ok' : 'warning',
+    message: stripeConfigured ? 'Stripe configured' : 'Stripe not configured',
+  });
+
+  // analytics — PostHog
+  const posthogConfigured = isSet(config.posthog?.apiKey);
+  checks.push({
+    category: 'analytics',
+    status: posthogConfigured ? 'ok' : 'warning',
+    message: posthogConfigured ? 'PostHog configured' : 'PostHog not configured',
+  });
+
+  // monitoring — Sentry
+  const sentryConfigured = isSet(config.sentry?.dsn);
+  checks.push({
+    category: 'monitoring',
+    status: sentryConfigured ? 'ok' : 'warning',
+    message: sentryConfigured ? 'Sentry configured' : 'Sentry not configured',
+  });
+
+  return checks;
+};
+
 export default {
   page,
   releases,
   changelogs,
   team,
   getHealthStatus,
+  getReadinessStatus,
 };
diff --git a/modules/home/tests/home.integration.tests.js b/modules/home/tests/home.integration.tests.js

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,9 @@ export default class NodemailerProvider {`
`5`	`5`	`this.transport = nodemailer.createTransport(options);`
`6`	`6`	`}`
`7`	`7`
`8`		`- async send({ from, to, subject, html }) {`
`9`		`- return this.transport.sendMail({ from, to, subject, html });`
	`8`	`+ async send({ from, to, subject, html, attachments }) {`
	`9`	`+ const payload = { from, to, subject, html };`
	`10`	`+ if (attachments?.length) payload.attachments = attachments;`
	`11`	`+ return this.transport.sendMail(payload);`
`10`	`12`	`}`
`11`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,9 @@`
`12`	`12`	`*/`
`13`	`13`	`export function homeAbilities(user, membership, { can }) {`
`14`	`14`	`can('read', 'Home');`
	`15`	`+ if (Array.isArray(user?.roles) && user.roles.includes('admin')) {`
	`16`	`+ can('manage', 'Readiness');`
	`17`	`+ }`
`15`	`18`	`}`
`16`	`19`
`17`	`20`	`/**`