Updated member welcome email with automated_email content (#25626)

ref https://linear.app/ghost/issue/NY-773

- Updates member welcome emails so that they fetch content from
`automated_emails` instead of hard-coded
- Includes logic to check if the automated email is active
- Cleans up some of the boundaries between member welcome emails and the
outbox; outbox doesn't need to worry about the mail configuration
anymore

Author: troyciesco

e2e/data-factory/factories/automated-email-factory.ts

@@ -0,0 +1,60 @@
+import {Factory} from '@/data-factory';
+import {generateId} from '@/data-factory';
+
+export interface AutomatedEmail {
+    id: string;
+    status: 'active' | 'inactive';
+    name: string;
+    slug: string;
+    subject: string;
+    lexical: string;
+    sender_name: string | null;
+    sender_email: string | null;
+    sender_reply_to: string | null;
+    created_at: Date;
+    updated_at: Date | null;
+}
+
+export class AutomatedEmailFactory extends Factory<Partial<AutomatedEmail>, AutomatedEmail> {
+    entityType = 'automated_emails';
+
+    build(options: Partial<AutomatedEmail> = {}): AutomatedEmail {
+        const now = new Date();
+
+        const defaults: AutomatedEmail = {
+            id: generateId(),
+            status: 'active',
+            name: 'Welcome Email (Free)',
+            slug: 'member-welcome-email-free',
+            subject: 'Welcome to {{site.title}}!',
+            lexical: JSON.stringify(this.defaultLexicalContent()),
+            sender_name: null,
+            sender_email: null,
+            sender_reply_to: null,
+            created_at: now,
+            updated_at: null
+        };
+
+        return {...defaults, ...options} as AutomatedEmail;
+    }
+
+    private defaultLexicalContent() {
+        return {
+            root: {
+                children: [{
+                    type: 'paragraph',
+                    children: [{
+                        type: 'text',
+                        text: 'Welcome to {{site.title}}!'
+                    }]
+                }],
+                direction: null,
+                format: '',
+                indent: 0,
+                type: 'root',
+                version: 1
+            }
+        };
+    }
+}
+

e2e/data-factory/index.ts

@@ -6,6 +6,8 @@ export {TagFactory} from './factories/tag-factory';
 export type {Tag} from './factories/tag-factory';
 export {MemberFactory} from './factories/member-factory';
 export type {Member} from './factories/member-factory';
+export {AutomatedEmailFactory} from './factories/automated-email-factory';
+export type {AutomatedEmail} from './factories/automated-email-factory';
 export * from './factories/user-factory';
 
 // Persistence Adapters
@@ -22,3 +24,4 @@ export {generateId, generateUuid, generateSlug} from './utils';
 export {createPostFactory} from './setup';
 export {createTagFactory} from './setup';
 export {createMemberFactory} from './setup';
+export {createAutomatedEmailFactory} from './setup';

e2e/data-factory/setup.ts

@@ -1,3 +1,4 @@
+import {AutomatedEmailFactory} from './factories/automated-email-factory';
 import {GhostAdminApiAdapter} from './persistence/adapters/ghost-api';
 import {HttpClient} from './persistence/adapters/http-client';
 import {MemberFactory} from './factories/member-factory';
@@ -37,3 +38,11 @@ export function createMemberFactory(httpClient: HttpClient): MemberFactory {
     return new MemberFactory(adapter);
 }
 
+export function createAutomatedEmailFactory(httpClient: HttpClient): AutomatedEmailFactory {
+    const adapter = new GhostAdminApiAdapter(
+        httpClient,
+        'automated_emails'
+    );
+    return new AutomatedEmailFactory(adapter);
+}
+

e2e/tests/public/member-signup.test.ts

@@ -1,5 +1,6 @@
 import {EmailClient, MailPit} from '@/helpers/services/email/mail-pit';
 import {HomePage, PublicPage} from '@/public-pages';
+import {createAutomatedEmailFactory} from '@/data-factory';
 import {expect, test} from '@/helpers/playwright';
 import {extractMagicLink} from '@/helpers/services/email/utils';
 import {signupViaPortal} from '@/helpers/playwright/flows/signup';
@@ -48,6 +49,9 @@ test.describe('Ghost Public - Member Signup', () => {
     });
 
     test('received welcome email', async ({page, config}) => {
+        const automatedEmailFactory = createAutomatedEmailFactory(page.request);
+        await automatedEmailFactory.create();
+
         const emailInbox = config!.memberWelcomeEmailTestInbox;
         const homePage = new HomePage(page);
         await homePage.goto();

ghost/core/core/server/services/member-welcome-emails/MemberWelcomeEmailRenderer.js

@@ -0,0 +1,80 @@
+const fs = require('fs');
+const path = require('path');
+const htmlToPlaintext = require('@tryghost/html-to-plaintext');
+const juice = require('juice');
+const lexicalLib = require('../../lib/lexical');
+const errors = require('@tryghost/errors');
+const {MESSAGES} = require('./constants');
+
+class MemberWelcomeEmailRenderer {
+    #wrapperTemplate;
+
+    constructor() {
+        this.Handlebars = require('handlebars').create();
+        const wrapperSource = fs.readFileSync(
+            path.join(__dirname, './email-templates/wrapper.hbs'),
+            'utf8'
+        );
+        this.#wrapperTemplate = this.Handlebars.compile(wrapperSource);
+    }
+
+    /**
+     * Renders a member welcome email
+     * @param {Object} options
+     * @param {string} options.lexical - Lexical JSON string to render
+     * @param {string} options.subject - Email subject (may contain template variables)
+     * @param {Object} options.member - Member data (name, email)
+     * @param {Object} options.siteSettings - Site settings (title, url, accentColor)
+     * @returns {Promise<{html: string, text: string, subject: string}>}
+     */
+    async render({lexical, subject, member, siteSettings}) {
+        let content;
+        try {
+            content = await lexicalLib.render(lexical, {target: 'email'});
+        } catch (err) {
+            throw new errors.IncorrectUsageError({
+                message: MESSAGES.INVALID_LEXICAL_STRUCTURE,
+                context: err.message
+            });
+        }
+
+        const memberName = member.name || 'there';
+        const firstName = memberName.split(' ')[0];
+
+        const templateData = {
+            site: {
+                title: siteSettings.title,
+                url: siteSettings.url
+            },
+            member: {
+                name: memberName,
+                email: member.email || '',
+                firstname: firstName
+            },
+            siteTitle: siteSettings.title,
+            siteUrl: siteSettings.url,
+            accentColor: siteSettings.accentColor
+        };
+
+        const contentWithReplacements = this.Handlebars.compile(content)(templateData);
+        const subjectWithReplacements = this.Handlebars.compile(subject)(templateData);
+
+        const html = this.#wrapperTemplate({
+            ...templateData,
+            content: contentWithReplacements,
+            subject: subjectWithReplacements
+        });
+
+        const inlinedHtml = juice(html, {inlinePseudoElements: true, removeStyleTags: true});
+        const text = htmlToPlaintext.email(inlinedHtml);
+
+        return {
+            html: inlinedHtml,
+            text,
+            subject: subjectWithReplacements
+        };
+    }
+}
+
+module.exports = MemberWelcomeEmailRenderer;
+

ghost/core/core/server/services/member-welcome-emails/constants.js

@@ -1,5 +1,19 @@
 const MEMBER_WELCOME_EMAIL_LOG_KEY = '[MEMBER-WELCOME-EMAIL]';
 
+const MEMBER_WELCOME_EMAIL_SLUGS = {
+    free: 'member-welcome-email-free',
+    paid: 'member-welcome-email-paid'
+};
+
+const MESSAGES = {
+    NO_MEMBER_WELCOME_EMAIL: 'No member welcome email found',
+    INVALID_LEXICAL_STRUCTURE: 'Member welcome email has invalid content structure',
+    MISSING_TEST_INBOX_CONFIG: 'memberWelcomeEmailTestInbox config is required but not defined',
+    memberWelcomeEmailInactive: memberStatus => `Member welcome email for "${memberStatus}" members is inactive`
+};
+
 module.exports = {
-    MEMBER_WELCOME_EMAIL_LOG_KEY
-};
+    MEMBER_WELCOME_EMAIL_LOG_KEY,
+    MEMBER_WELCOME_EMAIL_SLUGS,
+    MESSAGES
+};