Go to file
Kevin Ansfield 474e6c4c45 Refactor mega service to use stored email content and batch/recipient records
no issue

- store raw content in email record
  - keep any replacement strings in the html/plaintext content so that it can be used when sending email rather than needing to re-serialize the post content which may have changed
- split post email serializer into separate serialization and replacement parsing functions
  - serialization now returns any email content that is derived from the post content (subject/html/plaintext) rather than post content plus replacements
  - `parseReplacements` has been split out so that it can be run against email content rather than a post, this allows mega and the email preview service to work with the stored email content
- move mailgun-specific functionality into the mailgun provider
  - previously mailgun-specific behaviour was spread across the post email serializer, mega, and bulk-email service
  - the per-batch `send` functionality was moved from the `bulk-email` service to the mailgun provider and updated to take email content, recipient info, and replacement info so that all mailgun-specific headers and replacement formatting can be handled in one place
  - exposes the `BATCH_SIZE` constant because batch sizes are limited to what the provider allows
- `bulk-email` service split into three methods
  - `send` responsible for taking email content and recipients, parsing replacement info from the email content and using that to collate a recipient data object, and finally coordinating the send via the mailgun provider. Usable directly for use-cases such as test emails
  - `processEmail` takes an email ID, loads it and coordinates sending related batches concurrently
  - `processEmailBatch` takes an email_batch ID, loads it along with associated email_recipient records and passes the data through to the `send` function, updating the batch status as it's processed
  - `processEmail` and `processEmailBatch` take IDs rather than objects ready for future use by job-queues, it's best to keep job parameters as minimal as possible
- refactored `mega` service
  - modified `getEmailData` to collate email content (from/reply-to/subject/html/plaintext) rather than being responsible for dealing with replacements and mailgun-specific replacement formats
    - used for generating email content before storing in the email table, and when sending test emails
    - from/reply-to calculation moved out of the post-email-serializer into mega and extracted into separate functions used by `getEmailData`
  - `sendTestEmail` updated to generate `EmailRecipient`-like objects for each email address so that appropriate data can be supplied to the updated `bulk-email.send` method
  - `sendEmailJob` updated to create `email_batches` and associated `email_recipients` records then hand over processing to the `bulk-email` service
  - member row fetching extracted into a separate function and used by `createEmailBatches`
  - moved updating of email status from `mega` to the `bulk-email` service, keeps concept of Successful/FailedBatch internal to the `bulk-email` service
2020-09-29 17:17:54 +01:00
.github Updated test labelling in GitHub Action workflow 2020-08-18 13:10:34 +01:00
content Updated Casper to v3.1.0 2020-08-04 11:23:40 +01:00
core Refactor mega service to use stored email content and batch/recipient records 2020-09-29 17:17:54 +01:00
test 🐛 Fixed CSV import json-schema email validation (#12239) 2020-09-29 12:51:35 +01:00
.editorconfig Removed Makefile settings from .editorconfig 2019-07-31 17:21:16 +08:00
.eslintignore Moved grunt-eslint to npm script executing eslint (#10474) 2019-02-11 13:26:06 +01:00
.eslintrc.json Updated var declarations to const/let and no lists 2020-04-29 16:51:13 +01:00
.gitattributes Enforced unix line endings (#9871) 2018-10-23 10:59:09 +02:00
.gitignore Move tests from core to root (#11700) 2020-03-30 16:26:47 +01:00
.gitmodules Switched to using relative urls for submodules 2018-12-10 16:56:35 +00:00
.npmignore Added changelog.md to .npmignore 2020-04-07 11:53:40 +01:00
config.development.json Fixed indentation in config.development.json 2020-05-04 16:41:02 +02:00
Gruntfile.js Prevent grunt from exiting without letting express stop 2020-08-09 17:40:38 +01:00
index.js Moved core/server/lib/common/logging to core/shared/logging (#11857) 2020-05-28 19:30:23 +01:00
LICENSE 2020 2020-01-06 10:51:18 +01:00
MigratorConfig.js Moved config from server to shared (#11850) 2020-05-27 18:47:53 +01:00
package.json Update dependency knex to v0.21.6 2020-09-28 02:07:06 +00:00
PRIVACY.md Updated PRIVACY.md 2020-06-02 12:01:48 +01:00
README.md Remove sponsor 2020-08-31 19:00:19 +07:00
renovate.json Updated Renovate config 2020-07-21 16:51:59 +01:00
SECURITY.md Updated links to docs (#10941) 2019-07-22 18:17:50 +08:00
yarn.lock Update dependency knex to v0.21.6 2020-09-28 02:07:06 +00:00

Ghost

Ghost.org | Features | Showcase | Forum | Docs | Contributing | Twitter

Downloads Latest release Build status Contributors

Love open source? We're hiring Node.js Engineers to work on Ghost full-time

 

Fiercely independent, professional publishing. Ghost is the most popular open source, headless Node.js CMS which already works with all the tools you know and love.

Ghost(Pro)

The easiest way to get a production instance deployed is with our official Ghost(Pro) managed service. It takes about 2 minutes to launch a new site with worldwide CDN, backups, security and maintenance all done for you.

For most people this ends up being the best value option cause of how much time it saves — and 100% of revenue goes to the Ghost Foundation; funding the maintenance and further development of the project itself. So youll be supporting open source software and getting a great service!

If you prefer to run on your own infrastructure, we also offer official 1-off installs and managed support and maintenance plans via Ghost(Valet) - which can save a substantial amount of developer time and resources.

 

Quickstart Install

If you want to run your own instance of Ghost, in most cases the best way is to use our CLI tool

npm install ghost-cli -g

 

Then, if installing locally add the local flag to get up and running in under a minute - Local install docs

ghost install local

 

or on a server run the full install, including automatic SSL setup using LetsEncrypt - Production install docs

ghost install

 

Check out our official documentation for more information about our recommended hosting stack & properly upgrading Ghost, plus everything you need to develop your own Ghost themes or work with our API.

Contributors & Advanced Developers

For anyone wishing to contribute to Ghost or to hack/customise core files we recommend following our full development setup guides: Contributor Guide | Developer Setup | Admin Client Dev Guide

 

Ghost Sponsors

We'd like to extend big thanks to our sponsors and partners who make Ghost possible. If you're interested in sponsoring Ghost and supporting the project, please check out our profile on GitHub Sponsors ❤️

DigitalOcean | Cloudflare

 

Getting Help

You can find answers to a huge variety of questions, along with a large community of helpful developers over on the Ghost forum - replies are generally very quick. Ghost(Pro) customers also have access to 24/7 email support.

To stay up to date with all the latest news and product updates, make sure you subscribe to our blog — or you can always follow us on Twitter, if you prefer your updates bite-sized and facetious. 🎷🐢

 

Copyright & License

Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license. Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our trademark policy for info on acceptable usage.