fix: use secure: true instead of smtps:// in mailer (#1952)

* fix: use secure for ssl instead of smtps

* fix: add env var to disable ssl in self hosting compose

* chore: add doc for the function

* fix: make changes for PR

Author: spaenleh

docker/compose.yml

@@ -29,6 +29,8 @@ x-core_environment: &core_environment
 
   # the Mailer config is set by the "mailer" service below
   MAILER_CONNECTION: smtp://docker:docker@mailer:1025
+  # disable ssl for emails, in production the default is to enable SSL.
+  MAILER_USE_SSL: false
   # Redis
   REDIS_CONNECTION: redis://redis:6379
 

src/config/helpers.spec.ts

@@ -0,0 +1,21 @@
+import { describe, expect, it } from 'vitest';
+
+import { toBoolean } from './helpers';
+
+describe('toBoolean', () => {
+  it('undefined value', () => {
+    expect(toBoolean(undefined, { default: true })).toEqual(true);
+    expect(toBoolean(undefined, { default: false })).toEqual(false);
+    expect(toBoolean(undefined)).toEqual(false);
+  });
+  it('string boolean value', () => {
+    expect(toBoolean('true')).toEqual(true);
+    expect(toBoolean('false')).toEqual(false);
+    expect(toBoolean('toto')).toEqual(false);
+  });
+  it('number value', () => {
+    expect(toBoolean('1')).toEqual(true);
+    expect(toBoolean('0')).toEqual(false);
+    expect(toBoolean('4')).toEqual(false);
+  });
+});

src/config/helpers.ts

@@ -18,3 +18,23 @@ export function requiredEnvVar(name: string) {
   }
   return varValue;
 }
+
+/**
+ * Convert a string value to a boolean.
+ * Accepts `true` and `1` as true values.
+ *
+ * A default can be provided in the options. If not provided the value will be `false`.
+ * @param value the value to convert to a boolean, can be a string or undefined
+ * @param options an object containing a `default` key to be used when the value is not defined,
+ * default to `false`
+ * @returns the boolean value of the input
+ */
+export function toBoolean(value: string | undefined, options?: { default: boolean }) {
+  if (value == undefined) {
+    return options?.default ?? false;
+  }
+  if (value === 'true' || value === '1') {
+    return true;
+  }
+  return false;
+}

src/config/mailer.ts

@@ -1,8 +1,15 @@
-import { getEnv } from './env';
-import { requiredEnvVar } from './helpers';
+import { DEV, getEnv } from './env';
+import { requiredEnvVar, toBoolean } from './helpers';
 
 getEnv();
 
 export const MAILER_CONNECTION = requiredEnvVar('MAILER_CONNECTION');
+/**
+ * In Development we disable Mailer SSL
+ * In production we enable it by default, it can be disbaled by setting the MAILER_USE_SSL=false
+ */
+export const MAILER_USE_SSL = DEV
+  ? false
+  : toBoolean(process.env.MAILER_USE_SSL, { default: true });
 export const MAILER_CONFIG_FROM_EMAIL =
   process.env.MAILER_CONFIG_FROM_EMAIL ?? 'no-reply@graasp.org';

src/di/container.ts

@@ -5,7 +5,7 @@ import type { FastifyBaseLogger } from 'fastify';
 
 import Etherpad from '@graasp/etherpad-api';
 
-import { MAILER_CONFIG_FROM_EMAIL, MAILER_CONNECTION } from '../config/mailer';
+import { MAILER_CONFIG_FROM_EMAIL, MAILER_CONNECTION, MAILER_USE_SSL } from '../config/mailer';
 import { REDIS_CONNECTION } from '../config/redis';
 import { BaseLogger } from '../logger';
 import { MailerService } from '../plugins/mailer/mailer.service';
@@ -103,6 +103,7 @@ export const registerDependencies = (log: FastifyBaseLogger) => {
     MailerService,
     new MailerService({
       connection: MAILER_CONNECTION,
+      useSSL: MAILER_USE_SSL,
       fromEmail: MAILER_CONFIG_FROM_EMAIL,
     }),
   );

src/plugins/mailer/mailer.service.ts

@@ -12,6 +12,7 @@ export interface Mail {
 
 export interface MailerOptions {
   connection: string;
+  useSSL: boolean;
   fromEmail: string;
 }
 
@@ -20,9 +21,9 @@ export class MailerService {
   private readonly fromEmail: string;
   private readonly transporter: Transporter;
 
-  constructor({ connection, fromEmail }: MailerOptions) {
+  constructor({ connection, useSSL, fromEmail }: MailerOptions) {
     this.fromEmail = fromEmail;
-    this.transporter = createTransport(connection);
+    this.transporter = createTransport(connection, { secure: useSSL });
   }
 
   /**