NewsletterManager.js 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. const { callbackify } = require('util')
  2. const logger = require('logger-sharelatex')
  3. const Settings = require('settings-sharelatex')
  4. const crypto = require('crypto')
  5. const Mailchimp = require('mailchimp-api-v3')
  6. const OError = require('@overleaf/o-error')
  7. const provider = getProvider()
  8. module.exports = {
  9. subscribe: callbackify(provider.subscribe),
  10. unsubscribe: callbackify(provider.unsubscribe),
  11. changeEmail: callbackify(provider.changeEmail),
  12. promises: provider
  13. }
  14. function getProvider() {
  15. if (mailchimpIsConfigured()) {
  16. logger.info('Using newsletter provider: mailchimp')
  17. return makeMailchimpProvider()
  18. } else {
  19. logger.info('Using newsletter provider: none')
  20. return makeNullProvider()
  21. }
  22. }
  23. function mailchimpIsConfigured() {
  24. return Settings.mailchimp != null && Settings.mailchimp.api_key != null
  25. }
  26. function makeMailchimpProvider() {
  27. const mailchimp = new Mailchimp(Settings.mailchimp.api_key)
  28. const MAILCHIMP_LIST_ID = Settings.mailchimp.list_id
  29. return {
  30. subscribe,
  31. unsubscribe,
  32. changeEmail
  33. }
  34. async function subscribe(user) {
  35. try {
  36. const path = getSubscriberPath(user.email)
  37. await mailchimp.put(path, {
  38. email_address: user.email,
  39. status: 'subscribed',
  40. status_if_new: 'subscribed',
  41. merge_fields: getMergeFields(user)
  42. })
  43. logger.info({ user }, 'finished subscribing user to newsletter')
  44. } catch (err) {
  45. throw new OError({
  46. message: 'error subscribing user to newsletter',
  47. info: { userId: user._id }
  48. }).withCause(err)
  49. }
  50. }
  51. async function unsubscribe(user) {
  52. try {
  53. const path = getSubscriberPath(user.email)
  54. await mailchimp.put(path, {
  55. email_address: user.email,
  56. status: 'unsubscribed',
  57. status_if_new: 'unsubscribed',
  58. merge_fields: getMergeFields(user)
  59. })
  60. logger.info({ user }, 'finished unsubscribing user from newsletter')
  61. } catch (err) {
  62. if (err.message.includes('looks fake or invalid')) {
  63. logger.info(
  64. { err, user },
  65. 'Mailchimp declined to unsubscribe user because it finds the email looks fake'
  66. )
  67. } else {
  68. throw new OError({
  69. message: 'error unsubscribing user from newsletter',
  70. info: { userId: user._id }
  71. }).withCause(err)
  72. }
  73. }
  74. }
  75. async function changeEmail(oldEmail, newEmail) {
  76. try {
  77. const path = getSubscriberPath(oldEmail)
  78. await mailchimp.put(path, {
  79. email_address: newEmail,
  80. status_if_new: 'unsubscribed'
  81. })
  82. logger.info('finished changing email in the newsletter')
  83. } catch (err) {
  84. if (err.message.includes('merge fields were invalid')) {
  85. logger.info(
  86. { oldEmail, newEmail },
  87. 'unable to change email in newsletter, user has never subscribed'
  88. )
  89. } else if (err.message.includes('could not be validated')) {
  90. logger.info(
  91. { oldEmail, newEmail },
  92. 'unable to change email in newsletter, user has previously unsubscribed or new email already exist on list'
  93. )
  94. } else if (err.message.includes('is already a list member')) {
  95. logger.info(
  96. { oldEmail, newEmail },
  97. 'unable to change email in newsletter, new email is already on mailing list'
  98. )
  99. } else if (err.message.includes('looks fake or invalid')) {
  100. logger.info(
  101. { oldEmail, newEmail },
  102. 'unable to change email in newsletter, email looks fake to mailchimp'
  103. )
  104. } else {
  105. throw new OError({
  106. message: 'error changing email in newsletter',
  107. info: { oldEmail, newEmail }
  108. }).withCause(err)
  109. }
  110. }
  111. }
  112. function getSubscriberPath(email) {
  113. const emailHash = hashEmail(email)
  114. return `/lists/${MAILCHIMP_LIST_ID}/members/${emailHash}`
  115. }
  116. function hashEmail(email) {
  117. return crypto
  118. .createHash('md5')
  119. .update(email.toLowerCase())
  120. .digest('hex')
  121. }
  122. function getMergeFields(user) {
  123. return {
  124. FNAME: user.first_name,
  125. LNAME: user.last_name,
  126. MONGO_ID: user._id.toString()
  127. }
  128. }
  129. }
  130. function makeNullProvider() {
  131. return {
  132. subscribe,
  133. unsubscribe,
  134. changeEmail
  135. }
  136. async function subscribe(user) {
  137. logger.info(
  138. { user },
  139. 'Not subscribing user to newsletter because no newsletter provider is configured'
  140. )
  141. }
  142. async function unsubscribe(user) {
  143. logger.info(
  144. { user },
  145. 'Not unsubscribing user from newsletter because no newsletter provider is configured'
  146. )
  147. }
  148. async function changeEmail(oldEmail, newEmail) {
  149. logger.info(
  150. { oldEmail, newEmail },
  151. 'Not changing email in newsletter for user because no newsletter provider is configured'
  152. )
  153. }
  154. }