Renamed WelcomeEmailAutomation model to Automation

ghost/admin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ghost-admin",
-  "version": "6.36.1-rc.0",
+  "version": "6.37.0-rc.0",
   "description": "Ember.js admin client for Ghost",
   "author": "Ghost Foundation",
   "homepage": "http://ghost.org",

ghost/core/core/server/api/endpoints/automated-emails.js

@@ -9,7 +9,7 @@ const messages = {
 };
 
 // NOTE: This file is in a transitionary state. The `automated_emails` database table was split into
-// `welcome_email_automations` (automation metadata: status, name, slug) and
+// `automations` (automation metadata: status, name, slug) and
 // `welcome_email_automated_emails` (email content: subject, lexical, sender fields). This controller
 // acts as a facade that joins/splits data between those two models while preserving the original
 // `automated_emails` API shape externally.
@@ -51,7 +51,7 @@ const controller = {
         ],
         permissions: true,
         async query(frame) {
-            const result = await models.WelcomeEmailAutomation.findPage({
+            const result = await models.Automation.findPage({
                 ...frame.options,
                 withRelated: ['welcomeEmailAutomatedEmail']
             });
@@ -75,7 +75,7 @@ const controller = {
         ],
         permissions: true,
         async query(frame) {
-            const model = await models.WelcomeEmailAutomation.findOne(frame.data, {
+            const model = await models.Automation.findOne(frame.data, {
                 ...frame.options,
                 withRelated: ['welcomeEmailAutomatedEmail']
             });
@@ -102,7 +102,7 @@ const controller = {
             const automationData = _.pick(data, AUTOMATION_FIELDS);
 
             return models.Base.transaction(async (transacting) => {
-                const automation = await models.WelcomeEmailAutomation.add(automationData, {...frame.options, transacting});
+                const automation = await models.Automation.add(automationData, {...frame.options, transacting});
                 const email = await models.WelcomeEmailAutomatedEmail.add(
                     {
                         ...emailData,
@@ -139,7 +139,7 @@ const controller = {
             const automationData = _.pick(data, AUTOMATION_FIELDS);
 
             return models.Base.transaction(async (transacting) => {
-                let automation = await models.WelcomeEmailAutomation.findOne({id: frame.options.id}, {
+                let automation = await models.Automation.findOne({id: frame.options.id}, {
                     transacting,
                     withRelated: ['welcomeEmailAutomatedEmail']
                 });
@@ -159,7 +159,7 @@ const controller = {
                 }
 
                 if (Object.keys(automationData).length > 0) {
-                    automation = await models.WelcomeEmailAutomation.edit(automationData, {
+                    automation = await models.Automation.edit(automationData, {
                         ...frame.options,
                         transacting
                     });

ghost/core/core/server/api/endpoints/automations.js

@@ -12,7 +12,7 @@ const controller = {
         },
         permissions: true,
         async query() {
-            const automations = await models.WelcomeEmailAutomation.findAll();
+            const automations = await models.Automation.findAll();
             return {
                 data: automations.map(automation => ({
                     id: automation.get('id'),

ghost/core/core/server/data/exporter/table-lists.js

@@ -58,7 +58,7 @@ const BACKUP_TABLES = [
     'recommendation_subscribe_events',
     'outbox',
     'gifts',
-    'welcome_email_automations',
+    'automations',
     'welcome_email_automation_runs',
     'welcome_email_automated_emails'
 ];

ghost/core/core/server/data/migrations/versions/6.37/2026-05-04-13-46-58-rename-welcome-email-automations-table-to-automations.js

@@ -0,0 +1,42 @@
+const logging = require('@tryghost/logging');
+const {createNonTransactionalMigration} = require('../../utils');
+
+const FROM_TABLE = 'welcome_email_automations';
+const TO_TABLE = 'automations';
+
+module.exports = createNonTransactionalMigration(
+    async function up(connection) {
+        const fromExists = await connection.schema.hasTable(FROM_TABLE);
+        const toExists = await connection.schema.hasTable(TO_TABLE);
+
+        if (toExists) {
+            logging.warn(`Skipping renaming table: ${TO_TABLE} already exists`);
+            return;
+        }
+
+        if (!fromExists) {
+            logging.warn(`Skipping renaming table: ${FROM_TABLE} does not exist`);
+            return;
+        }
+
+        logging.info(`Renaming table: ${FROM_TABLE} -> ${TO_TABLE}`);
+        await connection.schema.renameTable(FROM_TABLE, TO_TABLE);
+    },
+    async function down(connection) {
+        const fromExists = await connection.schema.hasTable(FROM_TABLE);
+        const toExists = await connection.schema.hasTable(TO_TABLE);
+
+        if (fromExists) {
+            logging.warn(`Skipping renaming table: ${FROM_TABLE} already exists`);
+            return;
+        }
+
+        if (!toExists) {
+            logging.warn(`Skipping renaming table: ${TO_TABLE} does not exist`);
+            return;
+        }
+
+        logging.info(`Renaming table: ${TO_TABLE} -> ${FROM_TABLE}`);
+        await connection.schema.renameTable(TO_TABLE, FROM_TABLE);
+    }
+);

ghost/core/core/server/data/schema/schema.js

@@ -1170,7 +1170,7 @@ module.exports = {
         created_at: {type: 'dateTime', nullable: false},
         updated_at: {type: 'dateTime', nullable: true}
     },
-    welcome_email_automations: {
+    automations: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
         status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'inactive', validations: {isIn: [['active', 'inactive']]}},
         name: {type: 'string', maxlength: 191, nullable: false, unique: true},
@@ -1180,7 +1180,7 @@ module.exports = {
     },
     welcome_email_automated_emails: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-        welcome_email_automation_id: {type: 'string', maxlength: 24, nullable: false, references: 'welcome_email_automations.id', constraintName: 'weae_automation_id_foreign', cascadeDelete: true},
+        welcome_email_automation_id: {type: 'string', maxlength: 24, nullable: false, references: 'automations.id', constraintName: 'weae_automation_id_foreign', cascadeDelete: true},
         next_welcome_email_automated_email_id: {type: 'string', maxlength: 24, nullable: true, references: 'welcome_email_automated_emails.id', constraintName: 'weae_next_email_id_foreign', cascadeDelete: false},
         delay_days: {type: 'integer', nullable: false, unsigned: true},
         subject: {type: 'string', maxlength: 300, nullable: false},
@@ -1194,7 +1194,7 @@ module.exports = {
     },
     welcome_email_automation_runs: {
         id: {type: 'string', maxlength: 24, nullable: false, primary: true},
-        welcome_email_automation_id: {type: 'string', maxlength: 24, nullable: false, references: 'welcome_email_automations.id', constraintName: 'wear_automation_id_foreign', cascadeDelete: true},
+        welcome_email_automation_id: {type: 'string', maxlength: 24, nullable: false, references: 'automations.id', constraintName: 'wear_automation_id_foreign', cascadeDelete: true},
         member_id: {type: 'string', maxlength: 24, nullable: false, references: 'members.id', constraintName: 'wear_member_id_foreign', cascadeDelete: true},
         next_welcome_email_automated_email_id: {type: 'string', maxlength: 24, nullable: true, references: 'welcome_email_automated_emails.id', constraintName: 'wear_next_email_id_foreign', cascadeDelete: false},
         ready_at: {type: 'dateTime', nullable: true},

ghost/core/core/server/models/welcome-email-automation.js → ghost/core/core/server/models/automation.js

@@ -4,8 +4,8 @@ const {MEMBER_WELCOME_EMAIL_SLUGS} = require('../services/member-welcome-emails/
 
 const MEMBER_WELCOME_EMAIL_SLUG_SET = new Set(Object.values(MEMBER_WELCOME_EMAIL_SLUGS));
 
-const WelcomeEmailAutomation = ghostBookshelf.Model.extend({
-    tableName: 'welcome_email_automations',
+const Automation = ghostBookshelf.Model.extend({
+    tableName: 'automations',
 
     defaults() {
         return {
@@ -57,5 +57,5 @@ const WelcomeEmailAutomation = ghostBookshelf.Model.extend({
 });
 
 module.exports = {
-    WelcomeEmailAutomation: ghostBookshelf.model('WelcomeEmailAutomation', WelcomeEmailAutomation)
+    Automation: ghostBookshelf.model('Automation', Automation)
 };

ghost/core/core/server/models/index.js

@@ -9,6 +9,7 @@ const {Action} = require('./action');
 const {ApiKey, ApiKeys} = require('./api-key');
 const {Author, Authors} = require('./author');
 const {AutomatedEmailRecipient, AutomatedEmailRecipients} = require('./automated-email-recipient');
+const {Automation} = require('./automation');
 const {Benefit, Benefits} = require('./benefit');
 const {CollectionPost} = require('./collection-post');
 const {Collection} = require('./collection');
@@ -75,7 +76,6 @@ const {User, Users} = require('./user');
 const {Webhook, Webhooks} = require('./webhook');
 const {WelcomeEmailAutomatedEmail} = require('./welcome-email-automated-email');
 const {WelcomeEmailAutomationRun} = require('./welcome-email-automation-run');
-const {WelcomeEmailAutomation} = require('./welcome-email-automation');
 
 // enable event listeners
 require('./base/listeners');
@@ -91,6 +91,7 @@ exports.Author = Author;
 exports.Authors = Authors;
 exports.AutomatedEmailRecipient = AutomatedEmailRecipient;
 exports.AutomatedEmailRecipients = AutomatedEmailRecipients;
+exports.Automation = Automation;
 exports.Benefit = Benefit;
 exports.Benefits = Benefits;
 exports.CollectionPost = CollectionPost;
@@ -188,7 +189,6 @@ exports.Webhook = Webhook;
 exports.Webhooks = Webhooks;
 exports.WelcomeEmailAutomatedEmail = WelcomeEmailAutomatedEmail;
 exports.WelcomeEmailAutomationRun = WelcomeEmailAutomationRun;
-exports.WelcomeEmailAutomation = WelcomeEmailAutomation;
 
 function init() {
     // `init` used to be a necessary call, but now it's unnecessary.

ghost/core/core/server/models/welcome-email-automated-email.js

@@ -14,8 +14,8 @@ const WelcomeEmailAutomatedEmail = ghostBookshelf.Model.extend({
         return this.belongsTo('EmailDesignSetting', 'email_design_setting_id', 'id');
     },
 
-    welcomeEmailAutomation() {
-        return this.belongsTo('WelcomeEmailAutomation', 'welcome_email_automation_id', 'id');
+    automation() {
+        return this.belongsTo('Automation', 'welcome_email_automation_id', 'id');
     },
 
     nextWelcomeEmailAutomatedEmail() {

ghost/core/core/server/models/welcome-email-automation-run.js

@@ -9,8 +9,8 @@ const WelcomeEmailAutomationRun = ghostBookshelf.Model.extend({
         };
     },
 
-    welcomeEmailAutomation() {
-        return this.belongsTo('WelcomeEmailAutomation', 'welcome_email_automation_id', 'id');
+    automation() {
+        return this.belongsTo('Automation', 'welcome_email_automation_id', 'id');
     },
 
     member() {

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

@@ -10,7 +10,7 @@ const settingsHelpers = require('../settings-helpers');
 const EmailAddressParser = require('../email-address/email-address-parser');
 const mail = require('../mail');
 // @ts-expect-error type checker has trouble with the dynamic exporting in models
-const {WelcomeEmailAutomation, WelcomeEmailAutomatedEmail, Newsletter} = require('../../models');
+const {Automation, WelcomeEmailAutomatedEmail, Newsletter} = require('../../models');
 const MemberWelcomeEmailRenderer = require('./member-welcome-email-renderer');
 const {MEMBER_WELCOME_EMAIL_LOG_KEY, MEMBER_WELCOME_EMAIL_TAG, MEMBER_WELCOME_EMAIL_SLUGS, MESSAGES} = require('./constants');
 
@@ -179,7 +179,7 @@ class MemberWelcomeEmailService {
     }
 
     async #loadWelcomeEmailsCollection() {
-        return WelcomeEmailAutomation.findAll({
+        return Automation.findAll({
             filter: WELCOME_EMAIL_FILTER,
             withRelated: ['welcomeEmailAutomatedEmail']
         });
@@ -337,7 +337,7 @@ class MemberWelcomeEmailService {
         this.#defaultNewsletterSenderOptions = await this.#getDefaultNewsletterSenderOptions();
 
         for (const [memberStatus, slug] of Object.entries(MEMBER_WELCOME_EMAIL_SLUGS)) {
-            const row = await WelcomeEmailAutomation.findOne({slug}, {
+            const row = await Automation.findOne({slug}, {
                 withRelated: ['welcomeEmailAutomatedEmail', 'welcomeEmailAutomatedEmail.emailDesignSetting']
             });
 
@@ -428,7 +428,7 @@ class MemberWelcomeEmailService {
             return false;
         }
 
-        const row = await WelcomeEmailAutomation.findOne({slug}, {withRelated: ['welcomeEmailAutomatedEmail']});
+        const row = await Automation.findOne({slug}, {withRelated: ['welcomeEmailAutomatedEmail']});
         if (!row) {
             return false;
         }
@@ -438,7 +438,7 @@ class MemberWelcomeEmailService {
 
     async #renderWelcomeEmailPreview({automatedEmailId, subject, lexical, memberEmail = 'jamie@example.com'}) {
         // Still validate the automated email exists (for permission purposes)
-        const automation = await WelcomeEmailAutomation.findOne({id: automatedEmailId}, {
+        const automation = await Automation.findOne({id: automatedEmailId}, {
             withRelated: ['welcomeEmailAutomatedEmail', 'welcomeEmailAutomatedEmail.emailDesignSetting']
         });
         const automatedEmail = automation?.related('welcomeEmailAutomatedEmail');

ghost/core/core/server/services/members/api.js

@@ -242,7 +242,7 @@ function createApiInstance(config) {
             MemberFeedback: models.MemberFeedback,
             EmailSpamComplaintEvent: models.EmailSpamComplaintEvent,
             Outbox: models.Outbox,
-            WelcomeEmailAutomation: models.WelcomeEmailAutomation,
+            Automation: models.Automation,
             WelcomeEmailAutomationRun: models.WelcomeEmailAutomationRun,
             AutomatedEmailRecipient: models.AutomatedEmailRecipient,
             Gift: models.Gift

ghost/core/core/server/services/members/members-api/members-api.js

@@ -65,7 +65,7 @@ module.exports = function MembersAPI({
         Comment,
         MemberFeedback,
         Outbox,
-        WelcomeEmailAutomation,
+        Automation,
         WelcomeEmailAutomationRun,
         AutomatedEmailRecipient,
         Gift
@@ -104,7 +104,7 @@ module.exports = function MembersAPI({
         tokenService,
         newslettersService,
         productRepository,
-        WelcomeEmailAutomation,
+        Automation,
         WelcomeEmailAutomationRun,
         Member,
         MemberNewsletter,

ghost/core/core/server/services/members/members-api/repositories/event-repository.js

@@ -1019,7 +1019,7 @@ module.exports = class EventRepository {
     async getAutomatedEmailSentEvents(options = {}, filter) {
         options = {
             ...options,
-            withRelated: ['member', 'automatedEmail.welcomeEmailAutomation'],
+            withRelated: ['member', 'automatedEmail.automation'],
             filter: 'custom:true',
             useBasicCount: true,
             mongoTransformer: chainTransformers(
@@ -1035,10 +1035,10 @@ module.exports = class EventRepository {
 
         const data = models.map((model) => {
             const automatedEmail = model.related('automatedEmail');
-            const automation = automatedEmail.related('welcomeEmailAutomation');
+            const automation = automatedEmail.related('automation');
             if (!automation || !automation.id) {
                 throw new errors.InternalServerError({
-                    message: `Automated email recipient ${model.id} has no associated welcome email automation`
+                    message: `Automated email recipient ${model.id} has no associated automation`
                 });
             }
 

ghost/core/core/server/services/members/members-api/repositories/member-repository.js

@@ -66,7 +66,7 @@ module.exports = class MemberRepository {
      * @param {any} deps.offersAPI
      * @param {ITokenService} deps.tokenService
      * @param {any} deps.newslettersService
-     * @param {any} deps.WelcomeEmailAutomation
+     * @param {any} deps.Automation
      * @param {any} deps.WelcomeEmailAutomationRun
      */
     constructor({
@@ -87,7 +87,7 @@ module.exports = class MemberRepository {
         offersAPI,
         tokenService,
         newslettersService,
-        WelcomeEmailAutomation,
+        Automation,
         WelcomeEmailAutomationRun
     }) {
         this._Member = Member;
@@ -107,7 +107,7 @@ module.exports = class MemberRepository {
         this._offersAPI = offersAPI;
         this.tokenService = tokenService;
         this._newslettersService = newslettersService;
-        this._WelcomeEmailAutomation = WelcomeEmailAutomation;
+        this._Automation = Automation;
         this._WelcomeEmailAutomationRun = WelcomeEmailAutomationRun;
 
         DomainEvents.subscribe(OfferRedemptionEvent, async function (event) {
@@ -385,9 +385,9 @@ module.exports = class MemberRepository {
         const isGiftSignup = !stripeCustomer && memberData.status === 'gift';
         let welcomeEmailToEnqueue = null;
 
-        if (this._WelcomeEmailAutomation && WELCOME_EMAIL_SOURCES.includes(source)) {
+        if (this._Automation && WELCOME_EMAIL_SOURCES.includes(source)) {
             const getActiveWelcomeEmailToEnqueue = async (slug) => {
-                const automation = await this._WelcomeEmailAutomation.findOne(
+                const automation = await this._Automation.findOne(
                     {slug},
                     {...options, withRelated: ['welcomeEmailAutomatedEmail']}
                 );
@@ -1520,8 +1520,8 @@ module.exports = class MemberRepository {
             let isPaidWelcomeEmailActive = false;
             let paidWelcomeAutomation = null;
             let paidWelcomeEmail = null;
-            if (shouldSendPaidWelcomeEmail && this._WelcomeEmailAutomation) {
-                paidWelcomeAutomation = await this._WelcomeEmailAutomation.findOne(
+            if (shouldSendPaidWelcomeEmail && this._Automation) {
+                paidWelcomeAutomation = await this._Automation.findOne(
                     {slug: MEMBER_WELCOME_EMAIL_SLUGS.paid},
                     {...options, withRelated: ['welcomeEmailAutomatedEmail']}
                 );

ghost/core/core/server/services/outbox/handlers/member-created.js

@@ -1,7 +1,7 @@
 const {OUTBOX_LOG_KEY} = require('../jobs/lib/constants');
 const memberWelcomeEmailService = require('../../member-welcome-emails/service');
 const logging = require('@tryghost/logging');
-const {WelcomeEmailAutomation, AutomatedEmailRecipient} = require('../../../models');
+const {Automation, AutomatedEmailRecipient} = require('../../../models');
 const {MEMBER_WELCOME_EMAIL_SLUGS} = require('../../member-welcome-emails/constants');
 
 const LOG_KEY = `${OUTBOX_LOG_KEY}[MEMBER-WELCOME-EMAIL]`;
@@ -21,7 +21,7 @@ async function handle({payload}) {
             return;
         }
 
-        const automation = await WelcomeEmailAutomation.findOne({slug}, {withRelated: ['welcomeEmailAutomatedEmail']});
+        const automation = await Automation.findOne({slug}, {withRelated: ['welcomeEmailAutomatedEmail']});
         if (!automation) {
             logging.warn({
                 system: {

ghost/core/core/server/services/welcome-email-automations/poll.js

@@ -55,7 +55,7 @@ async function fetchAndLockRuns() {
     return await db.knex.transaction(async (trx) => {
         /** @type {Run[]} */
         const runs = await trx('welcome_email_automation_runs as r')
-            .join('welcome_email_automations as a', 'r.welcome_email_automation_id', 'a.id')
+            .join('automations as a', 'r.welcome_email_automation_id', 'a.id')
             .join('welcome_email_automated_emails as e', 'r.next_welcome_email_automated_email_id', 'e.id')
             .whereNotNull('r.next_welcome_email_automated_email_id')
             .where('r.ready_at', '<=', now)