MailChimpProvider.mjs 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. import logger from '@overleaf/logger'
  2. import Settings from '@overleaf/settings'
  3. import crypto from 'node:crypto'
  4. import OError from '@overleaf/o-error'
  5. import { callbackify } from 'node:util'
  6. import MailChimpClient from './MailChimpClient.mjs'
  7. function mailchimpIsConfigured() {
  8. return Settings.mailchimp != null && Settings.mailchimp.api_key != null
  9. }
  10. function make(listName, listId) {
  11. let provider
  12. if (!mailchimpIsConfigured() || !listId) {
  13. logger.debug({ listName }, 'Using newsletter provider: none')
  14. provider = makeNullProvider(listName)
  15. } else {
  16. logger.debug({ listName }, 'Using newsletter provider: mailchimp')
  17. provider = makeMailchimpProvider(listName, listId)
  18. }
  19. return {
  20. subscribed: callbackify(provider.subscribed),
  21. subscribe: callbackify(provider.subscribe),
  22. unsubscribe: callbackify(provider.unsubscribe),
  23. changeEmail: callbackify(provider.changeEmail),
  24. tag: callbackify(provider.tag),
  25. removeTag: callbackify(provider.removeTag),
  26. promises: provider,
  27. }
  28. }
  29. export default {
  30. make,
  31. }
  32. class NonFatalEmailUpdateError extends OError {
  33. constructor(message, oldEmail, newEmail) {
  34. super(message, { oldEmail, newEmail })
  35. }
  36. }
  37. function makeMailchimpProvider(listName, listId) {
  38. const mailchimp = new MailChimpClient(Settings.mailchimp.api_key)
  39. const MAILCHIMP_LIST_ID = listId
  40. return {
  41. subscribed,
  42. subscribe,
  43. unsubscribe,
  44. changeEmail,
  45. tag,
  46. removeTag,
  47. }
  48. async function subscribed(user) {
  49. try {
  50. const path = getSubscriberPath(user.email)
  51. const result = await mailchimp.get(path)
  52. return result?.status === 'subscribed'
  53. } catch (err) {
  54. if (err?.response?.status === 404) {
  55. return false
  56. }
  57. throw OError.tag(err, 'error getting newsletter subscriptions status', {
  58. userId: user._id,
  59. listName,
  60. })
  61. }
  62. }
  63. async function subscribe(user) {
  64. try {
  65. const path = getSubscriberPath(user.email)
  66. await mailchimp.put(path, {
  67. email_address: user.email,
  68. status: 'subscribed',
  69. status_if_new: 'subscribed',
  70. merge_fields: getMergeFields(user),
  71. })
  72. logger.debug(
  73. { user, listName },
  74. 'finished subscribing user to newsletter'
  75. )
  76. } catch (err) {
  77. throw OError.tag(err, 'error subscribing user to newsletter', {
  78. userId: user._id,
  79. listName,
  80. })
  81. }
  82. }
  83. async function tag(user, tag) {
  84. try {
  85. const path = getMemberTagsPath(user.email)
  86. await mailchimp.post(path, {
  87. tags: [{ name: tag, status: 'active' }],
  88. })
  89. logger.debug({ user, listName }, `finished adding ${tag} to user`)
  90. } catch (err) {
  91. throw OError.tag(err, `error adding ${tag} to user`, {
  92. userId: user._id,
  93. listName,
  94. tag,
  95. })
  96. }
  97. }
  98. async function removeTag(user, tag) {
  99. try {
  100. const path = getMemberTagsPath(user.email)
  101. await mailchimp.post(path, {
  102. tags: [{ name: tag, status: 'inactive' }],
  103. })
  104. logger.debug({ user, listName }, `finished removing ${tag} from user`)
  105. } catch (err) {
  106. throw OError.tag(err, `error removing ${tag} from user`, {
  107. userId: user._id,
  108. listName,
  109. tag,
  110. })
  111. }
  112. }
  113. async function unsubscribe(user, options = {}) {
  114. try {
  115. const path = getSubscriberPath(user.email)
  116. if (options.delete) {
  117. await mailchimp.delete(path)
  118. } else {
  119. await mailchimp.patch(path, {
  120. status: 'unsubscribed',
  121. merge_fields: getMergeFields(user),
  122. })
  123. }
  124. logger.debug(
  125. { user, options, listName },
  126. 'finished unsubscribing user from newsletter'
  127. )
  128. } catch (err) {
  129. if ([404, 405].includes(err?.response?.status)) {
  130. // silently ignore users who were never subscribed (404) or previously deleted (405)
  131. return
  132. }
  133. if (err.message.includes('looks fake or invalid')) {
  134. logger.debug(
  135. { err, user, options, listName },
  136. 'Mailchimp declined to unsubscribe user because it finds the email looks fake'
  137. )
  138. return
  139. }
  140. throw OError.tag(err, 'error unsubscribing user from newsletter', {
  141. userId: user._id,
  142. listName,
  143. })
  144. }
  145. }
  146. async function changeEmail(user, newEmail) {
  147. const oldEmail = user.email
  148. try {
  149. await updateEmailInMailchimp(user, newEmail)
  150. } catch (updateError) {
  151. // if we failed to update the user, delete their old email address so that
  152. // we don't leave it stuck in mailchimp
  153. logger.debug(
  154. { oldEmail, newEmail, updateError, listName },
  155. 'unable to change email in newsletter, removing old mail'
  156. )
  157. try {
  158. await unsubscribe(user, { delete: true })
  159. } catch (unsubscribeError) {
  160. // something went wrong removing the user's address
  161. throw OError.tag(
  162. unsubscribeError,
  163. 'error unsubscribing old email in response to email change failure',
  164. { oldEmail, newEmail, updateError, listName }
  165. )
  166. }
  167. if (!(updateError instanceof NonFatalEmailUpdateError)) {
  168. throw updateError
  169. }
  170. }
  171. }
  172. async function updateEmailInMailchimp(user, newEmail) {
  173. const oldEmail = user.email
  174. // mailchimp doesn't give us error codes, so we have to parse the message :'(
  175. const errors = {
  176. 'merge fields were invalid': 'user has never subscribed',
  177. 'could not be validated':
  178. 'user has previously unsubscribed or new email already exist on list',
  179. 'is already a list member': 'new email is already on mailing list',
  180. 'looks fake or invalid': 'mail looks fake to mailchimp',
  181. }
  182. try {
  183. const path = getSubscriberPath(oldEmail)
  184. await mailchimp.patch(path, {
  185. email_address: newEmail,
  186. merge_fields: getMergeFields(user),
  187. })
  188. logger.debug(
  189. { newEmail, listName },
  190. 'finished changing email in the newsletter'
  191. )
  192. } catch (err) {
  193. // silently ignore users who were never subscribed
  194. if (err.status === 404) {
  195. return
  196. }
  197. // look through expected mailchimp errors and log if we find one
  198. Object.keys(errors).forEach(key => {
  199. if (err.message.includes(key)) {
  200. const message = `unable to change email in newsletter, ${errors[key]}`
  201. logger.debug({ oldEmail, newEmail, listName }, message)
  202. throw new NonFatalEmailUpdateError(
  203. message,
  204. oldEmail,
  205. newEmail
  206. ).withCause(err)
  207. }
  208. })
  209. // if we didn't find an expected error, generate something to throw
  210. throw OError.tag(err, 'error changing email in newsletter', {
  211. oldEmail,
  212. newEmail,
  213. listName,
  214. })
  215. }
  216. }
  217. function getSubscriberPath(email) {
  218. const emailHash = hashEmail(email)
  219. return `/lists/${MAILCHIMP_LIST_ID}/members/${emailHash}`
  220. }
  221. function getMemberTagsPath(email) {
  222. const emailHash = hashEmail(email)
  223. return `/lists/${MAILCHIMP_LIST_ID}/members/${emailHash}/tags`
  224. }
  225. function hashEmail(email) {
  226. return crypto.createHash('md5').update(email.toLowerCase()).digest('hex')
  227. }
  228. function getMergeFields(user) {
  229. return {
  230. FNAME: user.first_name,
  231. LNAME: user.last_name,
  232. MONGO_ID: user._id.toString(),
  233. }
  234. }
  235. }
  236. function makeNullProvider(listName) {
  237. return {
  238. subscribed,
  239. subscribe,
  240. unsubscribe,
  241. changeEmail,
  242. tag,
  243. removeTag,
  244. }
  245. async function subscribed(user) {
  246. logger.debug(
  247. { user, listName },
  248. 'Not checking user because no newsletter provider is configured'
  249. )
  250. return false
  251. }
  252. async function subscribe(user) {
  253. logger.debug(
  254. { user, listName },
  255. 'Not subscribing user to newsletter because no newsletter provider is configured'
  256. )
  257. }
  258. async function unsubscribe(user) {
  259. logger.debug(
  260. { user, listName },
  261. 'Not unsubscribing user from newsletter because no newsletter provider is configured'
  262. )
  263. }
  264. async function changeEmail(user, newEmail) {
  265. logger.debug(
  266. { userId: user._id, newEmail, listName },
  267. 'Not changing email in newsletter for user because no newsletter provider is configured'
  268. )
  269. }
  270. async function tag(user, tag) {
  271. logger.debug(
  272. { userId: user._id, tag, listName },
  273. 'Not tagging user because no newsletter provider is configured'
  274. )
  275. }
  276. async function removeTag(user, tag) {
  277. logger.debug(
  278. { userId: user._id, tag, listName },
  279. 'Not removing tag for user because no newsletter provider is configured'
  280. )
  281. }
  282. }