ghost 5.50.4 → 5.51.1

package/core/server/services/segment/DomainEventsAnalytics.js

@@ -0,0 +1,83 @@
+const {MilestoneCreatedEvent} = require('@tryghost/milestones');
+
+/**
+ * @typedef {import('@tryghost/logging')} logging
+ */
+
+/**
+ * @typedef {import('analytics-node')} analytics
+ */
+
+/**
+ * @typedef {object} IExceptionHandler
+ * @prop {(err: Error) => void} captureException
+ */
+
+/**
+ * @typedef {import('@tryghost/domain-events')} DomainEvents
+ */
+
+/**
+ * @typedef {object} IDomainEventsAnalytics
+ * @param {analytics} analytics
+ * @param {logging} logging
+ * @param {object} trackDefaults
+ * @param {string} prefix
+ * @param {IExceptionHandler} exceptionHandler
+ * @param {DomainEvents} DomainEvents
+ * @prop {} subscribeToEvents
+ */
+
+module.exports = class DomainEventsAnalytics {
+    /** @type {analytics} */
+    #analytics;
+    /** @type {object} */
+    #trackDefaults;
+    /** @type {string} */
+    #prefix;
+    /** @type {IExceptionHandler} */
+    #exceptionHandler;
+    /** @type {logging} */
+    #logging;
+    /** @type {DomainEvents} */
+    #DomainEvents;
+
+    constructor(deps) {
+        this.#analytics = deps.analytics;
+        this.#trackDefaults = deps.trackDefaults;
+        this.#prefix = deps.prefix;
+        this.#exceptionHandler = deps.exceptionHandler;
+        this.#logging = deps.logging;
+        this.#DomainEvents = deps.DomainEvents;
+    }
+
+    /**
+     *
+     * @param {object} event
+     * @param {object} event.data
+     * @param {object} event.data.milestone
+     * @param {number} event.data.milestone.value
+     * @param {string} event.data.milestone.type
+     * @returns {Promise<void>}
+     */
+    async #handleMilestoneCreatedEvent(event) {
+        if (event.data.milestone
+            && event.data.milestone.value === 100
+        ) {
+            const eventName = event.data.milestone.type === 'arr' ? '$100 MRR reached' : '100 Members reached';
+
+            try {
+                this.#analytics.track(Object.assign(this.#trackDefaults, {}, {event: this.#prefix + eventName}));
+            } catch (err) {
+                this.#logging.error(err);
+                this.#exceptionHandler.captureException(err);
+            }
+        }
+    }
+
+    subscribeToEvents() {
+        this.#DomainEvents.subscribe(MilestoneCreatedEvent, async (event) => {
+            await this.#handleMilestoneCreatedEvent(event);
+        });
+    }
+};

package/core/server/services/segment/ModelEventsAnalytics.js

@@ -0,0 +1,108 @@
+const _ = require('lodash');
+
+/**
+ * @typedef {import('@tryghost/logging')} logging
+ */
+
+/**
+ * @typedef {import('analytics-node')} analytics
+ */
+
+/**
+ * @typedef {object} IExceptionHandler
+ * @prop {(err: Error) => void} captureException
+ */
+
+/**
+ * @typedef {import('../../lib/common/events')} events
+ */
+
+/**
+ * @typedef {object} IModelEventsAnalytics
+ * @param {analytics} analytics
+ * @param {logging} logging
+ * @param {object} trackDefaults
+ * @param {string} prefix
+ * @param {IExceptionHandler} exceptionHandler
+ * @param {events} events
+ * @prop {} subscribeToEvents
+ */
+
+/**
+ * Listens to model events to layer on analytics - also uses the "fake" theme.uploaded
+ * event from the theme API
+ */
+module.exports = class ModelEventsAnalytics {
+    /** @type {analytics} */
+    #analytics;
+    /** @type {object} */
+    #trackDefaults;
+    /** @type {string} */
+    #prefix;
+    /** @type {IExceptionHandler} */
+    #exceptionHandler;
+    /** @type {events} */
+    #events;
+    /** @type {logging} */
+    #logging;
+
+    /**
+     * @type {Array<{event: string, name: string, data?: object}>}
+     */
+    #toTrack = [
+        {
+            event: 'post.published',
+            name: 'Post Published'
+        },
+        {
+            event: 'page.published',
+            name: 'Page Published'
+        },
+        {
+            event: 'theme.uploaded',
+            name: 'Theme Uploaded',
+            // {keyOnSuppliedEventData: keyOnTrackedEventData}
+            // - used to extract specific properties from event data and give them meaningful names
+            data: {name: 'name'}
+        },
+        {
+            event: 'integration.added',
+            name: 'Custom Integration Added'
+        }
+    ];
+
+    constructor(deps) {
+        this.#analytics = deps.analytics;
+        this.#trackDefaults = deps.trackDefaults;
+        this.#prefix = deps.prefix;
+        this.#exceptionHandler = deps.exceptionHandler;
+        this.#events = deps.events;
+        this.#logging = deps.logging;
+    }
+
+    async #handleEvent(event) {
+        try {
+            this.#analytics.track(event);
+        } catch (err) {
+            this.#logging.error(err);
+            this.#exceptionHandler.captureException(err);
+        }
+    }
+
+    subscribeToEvents() {
+        this.#toTrack.forEach(({event, name, data = {}}) => {
+            this.#events.on(event, async (eventData = {}) => {
+                // extract desired properties from eventData and rename keys if necessary
+                const mappedData = _.mapValues(data || {}, v => eventData[v]);
+
+                const eventToTrack = {
+                    ...this.#trackDefaults,
+                    event: this.#prefix + name,
+                    ...mappedData
+                };
+
+                await this.#handleEvent(eventToTrack);
+            });
+        });
+    }
+};

package/core/server/services/segment/index.js

@@ -1,51 +1,39 @@
-const _ = require('lodash');
 const Analytics = require('analytics-node');
-const logging = require('@tryghost/logging');
-
 const config = require('../../../shared/config');
 const sentry = require('../../../shared/sentry');
-
-// Listens to model events to layer on analytics - also uses the "fake" theme.uploaded event from the theme API
+const logging = require('@tryghost/logging');
+const DomainEvents = require('@tryghost/domain-events');
 const events = require('../../lib/common/events');
 
+const ModelEventsAnalytics = require('./ModelEventsAnalytics');
+const DomainEventsAnalytics = require('./DomainEventsAnalytics');
+
 module.exports.init = function () {
     const analytics = new Analytics(config.get('segment:key'));
     const trackDefaults = config.get('segment:trackDefaults') || {};
     const prefix = config.get('segment:prefix') || '';
 
-    const toTrack = [
-        {
-            event: 'post.published',
-            name: 'Post Published'
-        },
-        {
-            event: 'page.published',
-            name: 'Page Published'
-        },
-        {
-            event: 'theme.uploaded',
-            name: 'Theme Uploaded',
-            // {keyOnSuppliedEventData: keyOnTrackedEventData}
-            // - used to extract specific properties from event data and give them meaningful names
-            data: {name: 'name'}
-        },
-        {
-            event: 'integration.added',
-            name: 'Custom Integration Added'
-        }
-    ];
-
-    _.each(toTrack, function (track) {
-        events.on(track.event, function (eventData = {}) {
-            // extract desired properties from eventData and rename keys if necessary
-            const data = _.mapValues(track.data || {}, v => eventData[v]);
+    const subscribeToDomainEvents = new DomainEventsAnalytics({
+        analytics,
+        trackDefaults,
+        prefix,
+        exceptionHandler: sentry,
+        DomainEvents,
+        logging
+    });
 
-            try {
-                analytics.track(_.extend(trackDefaults, data, {event: prefix + track.name}));
-            } catch (err) {
-                logging.error(err);
-                sentry.captureException(err);
-            }
-        });
+    const modelEventsAnalytics = new ModelEventsAnalytics({
+        analytics,
+        trackDefaults,
+        prefix,
+        exceptionHandler: sentry,
+        events,
+        logging
     });
+
+    // Listen to model events
+    modelEventsAnalytics.subscribeToEvents();
+
+    // Listen to domain events
+    subscribeToDomainEvents.subscribeToEvents();
 };

package/core/server/web/api/endpoints/admin/middleware.js

@@ -14,6 +14,10 @@ const notImplemented = function (req, res, next) {
         return next();
     }
 
+    if (req.query.god_mode === 'true' && process.env.NODE_ENV === 'development') {
+        return next();
+    }
+
     // @NOTE: integrations & staff tokens have limited access to the API
     const allowlisted = {
         site: ['GET'],

package/core/shared/config/defaults.json

@@ -202,7 +202,7 @@
     },
     "signupForm": {
         "url": "https://cdn.jsdelivr.net/ghost/signup-form@~{version}/umd/signup-form.min.js",
-        "version": "0"
+        "version": "0.1"
     },
     "tenor": {
         "googleApiKey": null,

package/core/shared/config/overrides.json

@@ -121,6 +121,7 @@
         },
         "internalImageSizes": {
             "icon": {"width": 256, "height": 256},
+            "signup-form-icon": {"width": 192, "height": 192},
             "email-header-image": {"width": 1200},
             "email-latest-posts-image": {"width": 200, "height": 200},
             "email-latest-posts-image-mobile": {"width": 1200, "height": 960}

package/core/shared/labs.js

@@ -18,7 +18,8 @@ const GA_FEATURES = [
     'audienceFeedback',
     'themeErrorsNotification',
     'outboundLinkTagging',
-    'announcementBar'
+    'announcementBar',
+    'signupForm'
 ];
 
 // NOTE: this allowlist is meant to be used to filter out any unexpected
@@ -38,8 +39,7 @@ const ALPHA_FEATURES = [
     'emailCustomization',
     'signupCard',
     'collections',
-    'adminXSettings',
-    'signupForm'
+    'adminXSettings'
 ];
 
 module.exports.GA_KEYS = [...GA_FEATURES];