Merge pull request #19914 from mozilla/chore/fxa-mailer-mock

chore(auth-server): Add shared fxaMailer mock

Author: nshirley

packages/fxa-auth-server/test/local/routes/password.js

@@ -17,28 +17,9 @@ const log = require('../../../lib/log');
 const random = require('../../../lib/crypto/random');
 const glean = mocks.mockGlean();
 const Container = require('typedi').Container;
-const { FxaMailer } = require('../../../lib/senders/fxa-mailer');
 
 const TEST_EMAIL = '[email protected]';
 
-function setupFxaMailerMock() {
-  const mockFxaMailer = {
-    sendRecoveryEmail: sinon.stub().resolves(),
-    sendPasswordForgotOtpEmail: sinon.stub().resolves(),
-    splitEmails: sinon.stub().returns({ to: TEST_EMAIL, cc: [] }),
-    helpers: {
-      constructLocalTimeString: sinon.stub().returns({
-        timeNow: '12:00:00 PM (UTC)',
-        dateNow: 'Monday, Jan 1, 2024',
-      }),
-    },
-  };
-
-  Container.set(FxaMailer, mockFxaMailer);
-
-  return mockFxaMailer;
-}
-
 function makeRoutes(options = {}) {
   const config = options.config || {
     verifierVersion: 0,
@@ -92,7 +73,7 @@ describe('/password', () => {
     // mailer mock must be done before route creation/require
     // otherwise it won't pickup the mock we define because
     // of module caching
-    mockFxaMailer = setupFxaMailerMock();
+    mockFxaMailer = mocks.mockFxaMailer();
     mockAccountEventsManager = mocks.mockAccountEventsManager();
     glean.resetPassword.emailSent.reset();
   });

packages/fxa-auth-server/test/mocks.js

@@ -20,6 +20,7 @@ const { AccountEventsManager } = require('../lib/account-events');
 const { gleanMetrics } = require('../lib/metrics/glean');
 const { PriceManager } = require('@fxa/payments/customer');
 const { ProductConfigurationManager } = require('@fxa/shared/cms');
+const { FxaMailer } = require('../lib/senders/fxa-mailer');
 
 const proxyquire = require('proxyquire');
 const amplitudeModule = proxyquire('../lib/metrics/amplitude', {
@@ -355,6 +356,7 @@ module.exports = {
   unMockAccountEventsManager,
   mockPriceManager,
   mockProductConfigurationManager,
+  mockFxaMailer,
 };
 
 function mockCustoms(errors) {
@@ -1125,3 +1127,38 @@ function mockProductConfigurationManager() {
   Container.set(ProductConfigurationManager, productConfigurationManager);
   return productConfigurationManager;
 }
+
+/**
+ * Used to mock the FxaMailer, injecting the mock into the Container. Be sure
+ * to call this before the code under test requests an FxaMailer instance from
+ * the Container.
+ *
+ * `canSend` is defaulted to a stub that resolves to `false`, so email
+ * sending is disabled by default in tests. Call mock setup with an override to enable
+ * sending for specific tests.
+ * ```
+ * const mockFxaMailer = mocks.mockFxaMailer({ canSend: sinon.stub().resolves(true) });
+ * // or, if you don't need to spy on the method:
+ * const mockFxaMailer = mocks.mockFxaMailer({ canSend: true });
+ * ```
+ * @param {*} overrides
+ * @returns {object} The mock FxaMailer instance for spy and assertion use.
+ * @usage
+ *
+ * ``` ts
+ * const mockFxaMailer = mocks.mockFxaMailer();
+ * // arrange, act, assert
+ * sinon.assert.calledOnce(mockFxaMailer.sendRecoveryEmail);
+ * ```
+ */
+function mockFxaMailer(overrides) {
+  const mockFxaMailer = {
+    // add new email methods here!
+    canSend: sinon.stub().resolves(false),
+    sendRecoveryEmail: sinon.stub().resolves(),
+    sendPasswordForgotOtpEmail: sinon.stub().resolves(),
+    ...overrides,
+  };
+  Container.set(FxaMailer, mockFxaMailer);
+  return mockFxaMailer;
+}