feat(auth): Restore write-emails-to-disk script

Because:
* This script is sometimes useful for debugging emails and seeing true link output with UTM params etc.

This commit:
* Restores the script from the commit prior to a3c090, with one tweak on config import

Author: LZoog

packages/fxa-auth-server/package.json

@@ -34,6 +34,7 @@
     "install-ejs": "./scripts/install-ejs.sh",
     "gen-keys": "node -r esbuild-register ./scripts/gen_keys.js; node -r esbuild-register ./scripts/oauth_gen_keys.js; node -r esbuild-register ./scripts/gen_vapid_keys.js",
     "emails-scss": "node -r esbuild-register ./lib/senders/emails/sass-compile-files.ts",
+    "write-emails": "yarn emails-scss && node -r esbuild-register ./scripts/write-emails-to-disk.js",
     "format": "prettier --write --config ../../_dev/.prettierrc '**'",
     "start": "yarn check:mysql && pm2 start pm2.config.js && yarn check:url localhost:9000/__heartbeat__",
     "restart": "pm2 restart pm2.config.js",

packages/fxa-auth-server/scripts/write-emails-to-disk.js

@@ -0,0 +1,224 @@
+#!/usr/bin/env node -r esbuild-register
+
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/**
+ * Write all emails to disk. Output is written to ./.mail_output/<email type>.html
+ * and ./.mail_output/<email type>.txt
+ *
+ * Usage:
+ * ./scripts/write-to-disk.js
+ *
+ * Emails that are written to disk can be previewed in Firefox
+ * to give a rough idea of how they would render in real life.
+ */
+
+'use strict';
+
+// HACK: Prevent config falling over due to missing secrets
+process.env.NODE_ENV = 'dev';
+
+const config = require('../config').default.getProperties();
+const createSenders = require('../lib/senders');
+const fs = require('fs');
+const log = require('../lib/log')({});
+const path = require('path');
+
+const OUTPUT_DIRECTORY = path.join(__dirname, '..', '.mail_output');
+
+// Subscription emails are behind a feature flag, enable it
+config.subscriptions.transactionalEmails.enabled = true;
+
+const mailSender = {
+  sendMail: function (emailConfig, done) {
+    const templateName = emailConfig.headers['X-Template-Name'];
+    const htmlOutputPath = getEmailOutputPath(templateName, 'html');
+    fs.writeFileSync(htmlOutputPath, emailConfig.html);
+
+    const textOutputPath = getEmailOutputPath(templateName, 'txt');
+    fs.writeFileSync(textOutputPath, emailConfig.text);
+
+    done(null);
+  },
+
+  close: function () {},
+};
+
+if (require.main === module) {
+  Promise.resolve(
+    createSenders(
+      log,
+      config,
+      { check: () => Promise.resolve() },
+      {},
+      mailSender
+    )
+  )
+    .then((senders) => {
+      const mailer = senders.email._ungatedMailer;
+      checkMessageType(mailer);
+
+      ensureTargetDirectoryExists();
+
+      return sendMails(mailer, getMessageTypesToWrite(mailer));
+    })
+    .then(() => {
+      console.info('done');
+      process.exit(0);
+    })
+    .catch((err) => {
+      console.error(err.stack);
+      process.exit(1);
+    });
+}
+
+function getEmailOutputPath(subject, extension) {
+  const outputFilename = `${subject.replace(/\s+/g, '_')}.${extension}`;
+  return path.join(OUTPUT_DIRECTORY, outputFilename);
+}
+
+function sendMails(mailer, messagesToSend) {
+  return Promise.all(messagesToSend.map(sendMail.bind(null, mailer)));
+}
+
+function sendMail(mailer, messageToSend) {
+  const parts = messageToSend.split(':');
+  const messageType = parts[0];
+  const messageSubType = parts[1];
+
+  const planConfig = {
+    urls: {
+      termsOfServiceDownload:
+        'https://example.com/subscription-product/terms/download',
+      privacyNoticeDownload:
+        'https://example.com/subscription-product/privacy/download',
+      download: 'http://getfirefox.com/',
+      emailIcon: 'http://placekitten.com/512/512',
+    },
+  };
+
+  const productMetadata = {
+    'product:termsOfServiceDownloadURL': planConfig.urls.termsOfServiceDownload,
+    'product:privacyNoticeDownloadURL': planConfig.urls.privacyNoticeDownload,
+  };
+
+  const message = {
+    acceptLanguage: 'en;q=0.8,en-US;q=0.5,en;q=0.3"',
+    appStoreLink: 'https://example.com/app-store',
+    code: '123123',
+    email: '[email protected]',
+    ip: '10.246.67.38',
+    location: {
+      city: 'Madrid',
+      country: 'Spain',
+    },
+    locations: [],
+    mozillaSupportUrl: 'https://support.mozilla.org',
+    numberRemaining: 2,
+    productId: '0123456789abcdef',
+    planId: 'plan-example',
+    productName: 'Firefox Fortress',
+    planEmailIconURL: planConfig.urls.emailIcon,
+    planSuccessActionButtonURL: planConfig.urls.download,
+    planInterval: 'week',
+    planIntervalCount: 4,
+    playStoreLink: 'https://example.com/play-store',
+    invoiceNumber: '8675309',
+    cardType: 'MasterCard',
+    lastFour: '5309',
+    invoiceDate: new Date(),
+    nextInvoiceDate: new Date(Date.now() + 1000 * 3600 * 24 * 30),
+    serviceLastActiveDate: new Date(Date.now() + 1000 * 3600 * 24 * 60),
+    productIconURLNew: 'http://placekitten.com/512/512?image=2',
+    productIconURLOld: 'http://placekitten.com/512/512?image=1',
+    productNameOld: 'Product A',
+    productNameNew: 'Product B',
+    invoiceLink:
+      'https://pay.stripe.com/invoice/acct_1GCAr3BVqmGyQTMa/invst_GyHjTyIXBg8jj5yjt7Z0T4CCG3hfGtp',
+    invoiceTotalInCents: 999999.9,
+    invoiceTotalCurrency: 'eur',
+    paymentAmountOldInCents: 9999099.9,
+    paymentAmountOldCurrency: 'jpy',
+    paymentAmountNewInCents: 12312099.9,
+    paymentAmountNewCurrency: 'gbp',
+    paymentProratedInCents: 523099.9,
+    paymentProratedCurrency: 'usd',
+    productPaymentCycleNew: 'month',
+    productPaymentCycleOld: 'year',
+    redirectTo: 'https://redirect.com/',
+    reminderLength: 14,
+    resume:
+      'eyJjYW1wYWlnbiI6bnVsbCwiZW50cnlwb2ludCI6bnVsbCwiZmxvd0lkIjoiM2Q1ODZiNzY4Mzc2NGJhOWFiNzhkMzMxMTdjZDU4Y2RmYjk3Mzk5MWU5NTk0NjgxODBlMDUyMmY2MThhNmEyMSIsInJlc2V0UGFzc3dvcmRDb25maXJtIjp0cnVlLCJ1bmlxdWVVc2VySWQiOiI1ODNkOGFlYS00NzU3LTRiZTQtYWJlNC0wZWQ2NWZhY2Y2YWQiLCJ1dG1DYW1wYWlnbiI6bnVsbCwidXRtQ29udGVudCI6bnVsbCwidXRtTWVkaXVtIjpudWxsLCJ1dG1Tb3VyY2UiOm51bGwsInV0bVRlcm0iOm51bGx9',
+    secondaryEmail: 'secondary@email',
+    style: 'trailhead',
+    service: 'sync',
+    token: '47b22cd271963448cf36da95cccfcfb342b5693d66f58aa635f9a95579431002',
+    timeZone: 'Europe/Madrid',
+    type: messageSubType,
+    uaBrowser: 'Firefox',
+    uaBrowserVersion: '57',
+    uaOS: 'Mac OSX',
+    uaOSVersion: '10.11',
+    unblockCode: '1ILO0Z5P',
+    tokenCode: 'LIT12345',
+    uid: '6510cb04abd742c6b3e4abefc7e39c9f',
+    metricsEnabled: true,
+    productMetadata,
+    providerName: 'Google',
+    subscription: {
+      planSuccessActionButtonURL: 'http://getfirefox.com/',
+      planEmailIconURL: 'http://placekitten.com/512/512',
+      planId: 'plan-example',
+      productId: '0123456789abcdef',
+      productMetadata,
+      productName: 'Firefox Fortress',
+    },
+    subscriptions: [
+      {
+        planSuccessActionButtonURL: 'http://getfirefox.com/',
+        planEmailIconURL: 'http://placekitten.com/512/512',
+        planId: 'plan-example',
+        productId: '0123456789abcdef',
+        productMetadata,
+        productName: 'Firefox Fortress',
+      },
+    ],
+    planConfig,
+  };
+
+  return mailer[messageType](message);
+}
+
+function checkMessageType(mailer, messageToSend) {
+  const messageTypes = getMailerMessageTypes(mailer);
+  messageTypes.push('all');
+}
+
+function getMailerMessageTypes(mailer) {
+  const messageTypes = [];
+
+  for (const key in mailer) {
+    if (
+      typeof mailer[key] === 'function' &&
+      !/^_/.test(key) &&
+      !/^send/.test(key) &&
+      /Email$/.test(key)
+    ) {
+      messageTypes.push(key);
+    }
+  }
+
+  return messageTypes.sort();
+}
+
+function getMessageTypesToWrite(mailer) {
+  return getMailerMessageTypes(mailer);
+}
+
+function ensureTargetDirectoryExists() {
+  fs.mkdirSync(OUTPUT_DIRECTORY, { recursive: true });
+}
+
+module.exports.OUTPUT_DIRECTORY = OUTPUT_DIRECTORY;