feat(emails): Handle abandoned carts and send recovery emails when enabled

Author: leomp12

packages/apps/emails/src/cron-cart-emails.ts

@@ -0,0 +1,104 @@
+import type { ApiError } from '@cloudcommerce/api';
+import { logger } from '@cloudcommerce/firebase/lib/config';
+import api from '@cloudcommerce/api';
+import getAppData from '@cloudcommerce/firebase/lib/helpers/get-app-data';
+import { sendEmail } from '@cloudcommerce/emails';
+import { getStore, getMailRender } from './util/emails-utils';
+import getMailTempl from './util/get-mail-templ';
+
+const sendCartEmails = async () => {
+  const appData = await getAppData('emails', ['data']);
+  const mailOptions = appData.abandoned_cart || {};
+  if (mailOptions.disable_customer === true) {
+    return;
+  }
+  const daysDelay = parseInt(appData.is_abandoned_after_days, 10) || 1;
+  const d = new Date();
+  d.setDate(d.getDate() - daysDelay);
+  const {
+    data: { result: abandonedCarts },
+  } = await api.get('carts', {
+    params: {
+      'completed': false,
+      'available': true,
+      'flags': 'open-checkout',
+      'updated_at<': d.toISOString(),
+    },
+    fields: ['_id', 'flags', 'completed', 'customers'] as const,
+    sort: ['-updated_at'],
+    limit: 100,
+  });
+  if (!abandonedCarts.length) {
+    return;
+  }
+  const store = getStore();
+  const lang = appData.lang === 'Inglês' ? 'en_us' : (store.lang || 'pt_br');
+  const mailTempl = getMailTempl('abandoned_cart')!;
+  const subject = mailTempl.subject[lang as 'pt_br'];
+  const customMessage = mailOptions.custom_message;
+  const render = await getMailRender(mailTempl?.templ);
+  for (let i = 0; i < abandonedCarts.length; i++) {
+    const cart = abandonedCarts[i];
+    if (cart.completed || !cart.flags?.includes('open-checkout')) {
+      logger.warn(`Invalid cart ${cart._id}`, { cart });
+      continue;
+    }
+    const customerId = cart.customers?.[0];
+    const flags: string[] = [];
+    if (!customerId) {
+      logger.info(`Cart ${cart._id} skipped without customer ID`);
+      flags.push('email-skipped');
+    } else {
+      try {
+        // eslint-disable-next-line no-await-in-loop
+        const { data: customer } = await api.get(`customers/${customerId}`);
+        // eslint-disable-next-line no-await-in-loop
+        const html = await render(
+          store,
+          customer,
+          {
+            ...cart,
+            permalink: `https://${store.domain}/app/#/cart/`
+             + '?utm_source=ecomplus&utm_medium=email&utm_campaign=abandoned_cart'
+             + `#/cart/${cart._id}`,
+          },
+          lang,
+          customMessage,
+        );
+        if (html) {
+          // eslint-disable-next-line no-await-in-loop
+          await sendEmail(
+            {
+              to: [{
+                name: customer.display_name,
+                email: customer.main_email,
+              }],
+              subject,
+              html,
+              templateId: mailOptions.template_id,
+              templateData: {
+                store,
+                customer,
+                cart,
+                lang,
+                customMessage,
+              },
+            },
+          );
+          flags.push('email-sent');
+        }
+      } catch (err: any) {
+        const error: ApiError = err;
+        if (error.statusCode === 404) {
+          logger.warn(`Customer not found by id ${customerId}`, { cart });
+        } else {
+          logger.error(err);
+          continue;
+        }
+      }
+    }
+    api.patch(`carts/${cart._id}`, { flags });
+  }
+};
+
+export default sendCartEmails;

packages/apps/emails/src/cron-points-emails.ts

@@ -0,0 +1,7 @@
+import { logger } from '@cloudcommerce/firebase/lib/config';
+
+const sendPointsEmails = async () => {
+  logger.info('@TODO');
+};
+
+export default sendPointsEmails;

packages/apps/emails/src/transactional-emails.ts

@@ -4,7 +4,8 @@ import config from '@cloudcommerce/firebase/lib/config';
 import functions from 'firebase-functions/v1';
 import { createAppEventsFunction } from '@cloudcommerce/firebase/lib/helpers/pubsub';
 import handleApiEvent from './event-to-emails';
-// import handleAbandonedCarts from './functios-lib/abandoned-carts';
+import sendCartEmails from './cron-cart-emails';
+import sendPointsEmails from './cron-points-emails';
 
 const { httpsFunctionOptions: { region } } = config.get();
 
@@ -14,7 +15,12 @@ export const emails = {
   cronAbandonedCarts: functions.region(region).pubsub
     .schedule(process.env.CRONTAB_EMAILS_ABANDONED_CARTS || '25 */3 * * *')
     .onRun(() => {
-      // TODO: Refactor abandoned carts handler
-      functions.logger.info('// TODO');
+      return sendCartEmails();
+    }),
+
+  cronExpiringPoints: functions.region(region).pubsub
+    .schedule(process.env.CRONTAB_EMAILS_EXPIRING_POINTS || '37 14 * * 1,4')
+    .onRun(() => {
+      return sendPointsEmails();
     }),
 };

packages/apps/loyalty-points/package.json

@@ -32,7 +32,6 @@
   "dependencies": {
     "@cloudcommerce/api": "workspace:*",
     "@cloudcommerce/firebase": "workspace:*",
-    "@ecomplus/transactional-mails": "^2.2.1",
     "@ecomplus/utils": "1.5.0-rc.6"
   },
   "devDependencies": {

packages/emails/src/index.ts

@@ -120,7 +120,6 @@ const sendEmail = (
 const sendGrid = {
   send: sendEmailSendGrid,
   setConfig: setApiKeySendGrid,
-
 };
 
 const smtp = {