Moved posts service to its own package

fixes https://github.com/TryGhost/Team/issues/2778

It is easier to add extra classes using the latest patterns if it has its own package.

Author: SimonBackx

ghost/core/core/server/services/posts/posts-service.js

@@ -1,123 +1,7 @@
-const nql = require('@tryghost/nql');
-const {BadRequestError} = require('@tryghost/errors');
-const tpl = require('@tryghost/tpl');
-
-const messages = {
-    invalidVisibilityFilter: 'Invalid visibility filter.',
-    invalidEmailSegment: 'The email segment parameter doesn\'t contain a valid filter'
-};
-
-class PostsService {
-    constructor({urlUtils, models, isSet, stats, emailService}) {
-        this.urlUtils = urlUtils;
-        this.models = models;
-        this.isSet = isSet;
-        this.stats = stats;
-        this.emailService = emailService;
-    }
-
-    async editPost(frame) {
-        // Make sure the newsletter is matching an active newsletter
-        // Note that this option is simply ignored if the post isn't published or scheduled
-        if (frame.options.newsletter && frame.options.email_segment) {
-            if (frame.options.email_segment !== 'all') {
-                // check filter is valid
-                try {
-                    await this.models.Member.findPage({filter: frame.options.email_segment, limit: 1});
-                } catch (err) {
-                    return Promise.reject(new BadRequestError({
-                        message: tpl(messages.invalidEmailSegment),
-                        context: err.message
-                    }));
-                }
-            }
-        }
-
-        const model = await this.models.Post.edit(frame.data.posts[0], frame.options);
-
-        /**Handle newsletter email */
-        if (model.get('newsletter_id')) {
-            const sendEmail = model.wasChanged() && this.shouldSendEmail(model.get('status'), model.previous('status'));
-
-            if (sendEmail) {
-                let postEmail = model.relations.email;
-                let email;
-
-                if (!postEmail) {
-                    email = await this.emailService.createEmail(model);
-                } else if (postEmail && postEmail.get('status') === 'failed') {
-                    email = await this.emailService.retryEmail(postEmail);
-                }
-                if (email) {
-                    model.set('email', email);
-                }
-            }
-        }
-
-        return model;
-    }
-
-    async getProductsFromVisibilityFilter(visibilityFilter) {
-        try {
-            const allProducts = await this.models.Product.findAll();
-            const visibilityFilterJson = nql(visibilityFilter).toJSON();
-            const productsData = (visibilityFilterJson.product ? [visibilityFilterJson] : visibilityFilterJson.$or) || [];
-            const tiers = productsData
-                .map((data) => {
-                    return allProducts.find((p) => {
-                        return p.get('slug') === data.product;
-                    });
-                }).filter(p => !!p).map((d) => {
-                    return d.toJSON();
-                });
-            return tiers;
-        } catch (err) {
-            return Promise.reject(new BadRequestError({
-                message: tpl(messages.invalidVisibilityFilter),
-                context: err.message
-            }));
-        }
-    }
-
-    /**
-     * Calculates if the email should be tried to be sent out
-     * @private
-     * @param {String} currentStatus current status from the post model
-     * @param {String} previousStatus previous status from the post model
-     * @returns {Boolean}
-     */
-    shouldSendEmail(currentStatus, previousStatus) {
-        return (['published', 'sent'].includes(currentStatus))
-            && (!['published', 'sent'].includes(previousStatus));
-    }
-
-    handleCacheInvalidation(model) {
-        let cacheInvalidate;
-
-        if (
-            model.get('status') === 'published' && model.wasChanged() ||
-            model.get('status') === 'draft' && model.previous('status') === 'published'
-        ) {
-            cacheInvalidate = true;
-        } else if (
-            model.get('status') === 'draft' && model.previous('status') !== 'published' ||
-            model.get('status') === 'scheduled' && model.wasChanged()
-        ) {
-            cacheInvalidate = {
-                value: this.urlUtils.urlFor({
-                    relativeUrl: this.urlUtils.urlJoin('/p', model.get('uuid'), '/')
-                })
-            };
-        } else {
-            cacheInvalidate = false;
-        }
-
-        return cacheInvalidate;
-    }
-}
+const {PostsService} = require('@tryghost/posts-service');
 
 /**
- * @returns {PostsService} instance of the PostsService
+ * @returns {InstanceType<PostsService>} instance of the PostsService
  */
 const getPostServiceInstance = () => {
     const urlUtils = require('../../../shared/url-utils');

ghost/core/test/unit/server/services/posts/posts-service.test.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: ['ghost'],
+    extends: [
+        'plugin:ghost/node'
+    ]
+};

ghost/posts-service/.eslintrc.js

@@ -0,0 +1,2 @@
+# Posts Service
+

ghost/posts-service/README.md

@@ -0,0 +1,3 @@
+module.exports = {
+    PostsService: require('./lib/PostsService')
+};

ghost/posts-service/index.js

@@ -0,0 +1,119 @@
+const nql = require('@tryghost/nql');
+const {BadRequestError} = require('@tryghost/errors');
+const tpl = require('@tryghost/tpl');
+
+const messages = {
+    invalidVisibilityFilter: 'Invalid visibility filter.',
+    invalidEmailSegment: 'The email segment parameter doesn\'t contain a valid filter'
+};
+
+class PostsService {
+    constructor({urlUtils, models, isSet, stats, emailService}) {
+        this.urlUtils = urlUtils;
+        this.models = models;
+        this.isSet = isSet;
+        this.stats = stats;
+        this.emailService = emailService;
+    }
+
+    async editPost(frame) {
+        // Make sure the newsletter is matching an active newsletter
+        // Note that this option is simply ignored if the post isn't published or scheduled
+        if (frame.options.newsletter && frame.options.email_segment) {
+            if (frame.options.email_segment !== 'all') {
+                // check filter is valid
+                try {
+                    await this.models.Member.findPage({filter: frame.options.email_segment, limit: 1});
+                } catch (err) {
+                    return Promise.reject(new BadRequestError({
+                        message: tpl(messages.invalidEmailSegment),
+                        context: err.message
+                    }));
+                }
+            }
+        }
+
+        const model = await this.models.Post.edit(frame.data.posts[0], frame.options);
+
+        /**Handle newsletter email */
+        if (model.get('newsletter_id')) {
+            const sendEmail = model.wasChanged() && this.shouldSendEmail(model.get('status'), model.previous('status'));
+
+            if (sendEmail) {
+                let postEmail = model.relations.email;
+                let email;
+
+                if (!postEmail) {
+                    email = await this.emailService.createEmail(model);
+                } else if (postEmail && postEmail.get('status') === 'failed') {
+                    email = await this.emailService.retryEmail(postEmail);
+                }
+                if (email) {
+                    model.set('email', email);
+                }
+            }
+        }
+
+        return model;
+    }
+
+    async getProductsFromVisibilityFilter(visibilityFilter) {
+        try {
+            const allProducts = await this.models.Product.findAll();
+            const visibilityFilterJson = nql(visibilityFilter).toJSON();
+            const productsData = (visibilityFilterJson.product ? [visibilityFilterJson] : visibilityFilterJson.$or) || [];
+            const tiers = productsData
+                .map((data) => {
+                    return allProducts.find((p) => {
+                        return p.get('slug') === data.product;
+                    });
+                }).filter(p => !!p).map((d) => {
+                    return d.toJSON();
+                });
+            return tiers;
+        } catch (err) {
+            return Promise.reject(new BadRequestError({
+                message: tpl(messages.invalidVisibilityFilter),
+                context: err.message
+            }));
+        }
+    }
+
+    /**
+     * Calculates if the email should be tried to be sent out
+     * @private
+     * @param {String} currentStatus current status from the post model
+     * @param {String} previousStatus previous status from the post model
+     * @returns {Boolean}
+     */
+    shouldSendEmail(currentStatus, previousStatus) {
+        return (['published', 'sent'].includes(currentStatus))
+            && (!['published', 'sent'].includes(previousStatus));
+    }
+
+    handleCacheInvalidation(model) {
+        let cacheInvalidate;
+
+        if (
+            model.get('status') === 'published' && model.wasChanged() ||
+            model.get('status') === 'draft' && model.previous('status') === 'published'
+        ) {
+            cacheInvalidate = true;
+        } else if (
+            model.get('status') === 'draft' && model.previous('status') !== 'published' ||
+            model.get('status') === 'scheduled' && model.wasChanged()
+        ) {
+            cacheInvalidate = {
+                value: this.urlUtils.urlFor({
+                    relativeUrl: this.urlUtils.urlJoin('/p', model.get('uuid'), '/')
+                })
+            };
+        } else {
+            cacheInvalidate = false;
+        }
+
+        return cacheInvalidate;
+    }
+}
+
+module.exports = PostsService;

ghost/posts-service/lib/PostsService.js

@@ -0,0 +1,30 @@
+{
+  "name": "@tryghost/posts-service",
+  "version": "0.0.0",
+  "repository": "https://github.com/TryGhost/Ghost/tree/main/packages/posts-service",
+  "author": "Ghost Foundation",
+  "private": true,
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test:unit": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "test": "yarn test:unit",
+    "lint:code": "eslint *.js lib/ --ext .js --cache",
+    "lint": "yarn lint:code && yarn lint:test",
+    "lint:test": "eslint -c test/.eslintrc.js test/ --ext .js --cache"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "devDependencies": {
+    "c8": "7.13.0",
+    "mocha": "10.2.0",
+    "sinon": "15.0.2"
+  },
+  "dependencies": {
+    "@tryghost/errors": "1.2.21",
+    "@tryghost/nql": "0.11.0",
+    "@tryghost/tpl": "0.1.22"
+  }
+}

ghost/posts-service/package.json

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: ['ghost'],
+    extends: [
+        'plugin:ghost/test'
+    ]
+};

ghost/posts-service/test/.eslintrc.js

@@ -0,0 +1,42 @@
+const {PostsService} = require('../index');
+const assert = require('assert');
+
+describe('Posts Service', function () {
+    it('Can construct class', function () {
+        new PostsService({});
+    });
+
+    describe('shouldSendEmail', function () {
+        it('calculates if an email should be sent', async function () {
+            const postsService = new PostsService({});
+
+            assert.deepEqual([
+                postsService.shouldSendEmail('published', 'draft'),
+                postsService.shouldSendEmail('published', 'scheduled'),
+                postsService.shouldSendEmail('sent', 'draft'),
+                postsService.shouldSendEmail('sent', 'scheduled'),
+
+                postsService.shouldSendEmail('published', 'published'),
+                postsService.shouldSendEmail('published', 'sent'),
+                postsService.shouldSendEmail('published', 'published'),
+                postsService.shouldSendEmail('published', 'sent'),
+                postsService.shouldSendEmail('sent', 'published'),
+                postsService.shouldSendEmail('sent', 'sent'),
+                postsService.shouldSendEmail()
+            ], [
+                true,
+                true,
+                true,
+                true,
+
+                false,
+                false,
+                false,
+                false,
+                false,
+                false,
+                false
+            ]);
+        });
+    });
+});