payment-kit 1.15.20 → 1.15.22

package/api/src/libs/notification/template/subscription-will-canceled.ts

@@ -12,7 +12,7 @@ import { getCustomerInvoicePageUrl } from '../../invoice';
 import logger from '../../logger';
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
-import { formatTime } from '../../time';
+import { formatTime, getSimplifyDuration } from '../../time';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 import { getSubscriptionNotificationCustomActions } from '../../util';
 
@@ -27,7 +27,8 @@ interface SubscriptionWillCanceledEmailTemplateContext {
   locale: string;
   productName: string;
   at: string;
-  willCancelDuration: string;
+  cancelReason: string;
+  body: string;
 
   userDid: string;
   paymentInfo: string;
@@ -35,6 +36,7 @@ interface SubscriptionWillCanceledEmailTemplateContext {
   viewSubscriptionLink: string;
   viewInvoiceLink: string;
   customActions: any[];
+  needRenew: boolean;
 }
 
 export class SubscriptionWillCanceledEmailTemplate
@@ -56,8 +58,19 @@ export class SubscriptionWillCanceledEmailTemplate
     if (!subscription) {
       throw new Error(`Subscription(${this.options.subscriptionId}) not found`);
     }
-    if (subscription.status !== 'past_due') {
-      throw new Error(`Subscription(${this.options.subscriptionId}) status(${subscription.status}) must be past_due`);
+    if (subscription.isImmutable()) {
+      throw new Error(`Subscription(${this.options.subscriptionId}) is immutable, no need to send notification`);
+    }
+
+    const now = dayjs().unix();
+    const cancelAt = subscription.cancel_at || subscription.current_period_end;
+    if (!subscription.cancel_at && !subscription.cancel_at_period_end) {
+      throw new Error(
+        `Subscription(${this.options.subscriptionId}) is not scheduled to cancel, no need to send notification`
+      );
+    }
+    if (cancelAt <= now) {
+      throw new Error(`Subscription(${this.options.subscriptionId}) is already canceled, no need to send notification`);
     }
 
     const customer = await Customer.findByPk(subscription.customer_id);
@@ -75,12 +88,39 @@ export class SubscriptionWillCanceledEmailTemplate
     const userDid = customer.did;
     const locale = await getUserLocale(userDid);
     const productName = await getMainProductName(subscription.id);
-    const at: string = formatTime(invoice.period_end * 1000);
-    const willCancelDuration: string =
-      locale === 'en' ? this.getWillCancelDuration(locale) : this.getWillCancelDuration(locale).split(' ').join('');
-
+    const at: string = formatTime(cancelAt * 1000);
+    const willCancelDuration: string = getSimplifyDuration((cancelAt - now) * 1000, locale);
     const paymentInfo: string = `${fromUnitToToken(+invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
 
+    let body: string = translate('notification.subscriptWillCanceled.body', locale, {
+      productName,
+      willCancelDuration,
+      at,
+    });
+
+    let needRenew = false;
+    const reasonMap = {
+      cancellation_requested: 'customerCanceled',
+      payment_failed: 'paymentFailed',
+      stake_revoked: 'stakeRevoked',
+    } as const;
+
+    const cancelReason = translate(
+      `notification.subscriptWillCanceled.${reasonMap[subscription.cancelation_details?.reason as keyof typeof reasonMap] || 'adminCanceled'}`,
+      locale,
+      {
+        canceled_at: formatTime(subscription.canceled_at ? subscription.canceled_at * 1000 : dayjs().unix()),
+      }
+    );
+    if (subscription.status === 'past_due' || subscription.cancelation_details?.reason === 'payment_failed') {
+      body = translate('notification.subscriptWillCanceled.pastDue', locale, {
+        productName,
+        willCancelDuration,
+        at,
+      });
+      needRenew = true;
+    }
+
     const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
       subscriptionId: subscription.id,
       locale,
@@ -102,7 +142,8 @@ export class SubscriptionWillCanceledEmailTemplate
       locale,
       productName,
       at,
-      willCancelDuration,
+      body,
+      cancelReason,
 
       userDid,
       paymentInfo,
@@ -110,41 +151,18 @@ export class SubscriptionWillCanceledEmailTemplate
       viewSubscriptionLink,
       viewInvoiceLink,
       customActions,
+      needRenew,
     };
   }
 
-  getWillCancelDuration(locale: string): string {
-    if (this.options.willCancelUnit === 'M') {
-      if (this.options.willCancelValue > 1) {
-        return `${this.options.willCancelValue} ${translate('notification.common.months', locale)}`;
-      }
-
-      return `${this.options.willCancelValue} ${translate('notification.common.month', locale)}`;
-    }
-    if (this.options.willCancelUnit === 'd') {
-      if (this.options.willCancelValue > 1) {
-        return `${this.options.willCancelValue} ${translate('notification.common.days', locale)}`;
-      }
-      return `${this.options.willCancelValue} ${translate('notification.common.day', locale)}`;
-    }
-
-    if (this.options.willCancelUnit === 'm') {
-      if (this.options.willCancelValue > 1) {
-        return `${this.options.willCancelValue} ${translate('notification.common.minutes', locale)}`;
-      }
-      return `${this.options.willCancelValue} ${translate('notification.common.minute', locale)}`;
-    }
-
-    return `${this.options.willCancelValue} ${this.options.willCancelUnit}`;
-  }
-
   async getTemplate(): Promise<BaseEmailTemplateType | null> {
     const {
       locale,
       productName,
       at,
-      willCancelDuration,
-
+      body,
+      cancelReason,
+      needRenew,
       userDid,
       paymentInfo,
 
@@ -162,11 +180,7 @@ export class SubscriptionWillCanceledEmailTemplate
       title: `${translate('notification.subscriptWillCanceled.title', locale, {
         productName,
       })}`,
-      body: translate('notification.subscriptWillCanceled.body', locale, {
-        productName,
-        willCancelDuration,
-        at,
-      }),
+      body,
       // @ts-expect-error
       attachments: [
         {
@@ -202,19 +216,38 @@ export class SubscriptionWillCanceledEmailTemplate
                 text: productName,
               },
             },
+            ...(needRenew
+              ? [
+                  {
+                    type: 'text',
+                    data: {
+                      type: 'plain',
+                      color: '#9397A1',
+                      text: translate('notification.common.paymentAmount', locale),
+                    },
+                  },
+                  {
+                    type: 'text',
+                    data: {
+                      type: 'plain',
+                      text: paymentInfo,
+                    },
+                  },
+                ]
+              : []),
             {
               type: 'text',
               data: {
                 type: 'plain',
                 color: '#9397A1',
-                text: translate('notification.common.paymentAmount', locale),
+                text: translate('notification.subscriptWillCanceled.cancelReason', locale),
               },
             },
             {
               type: 'text',
               data: {
                 type: 'plain',
-                text: paymentInfo,
+                text: cancelReason,
               },
             },
           ].filter(Boolean),
@@ -227,11 +260,12 @@ export class SubscriptionWillCanceledEmailTemplate
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
-        viewInvoiceLink && {
-          name: translate('notification.common.renewNow', locale),
-          title: translate('notification.common.renewNow', locale),
-          link: viewInvoiceLink,
-        },
+        viewInvoiceLink &&
+          needRenew && {
+            name: translate('notification.common.renewNow', locale),
+            title: translate('notification.common.renewNow', locale),
+            link: viewInvoiceLink,
+          },
         ...customActions,
       ].filter(Boolean),
     };

package/api/src/libs/notification/template/subscription-will-renew.ts

@@ -21,8 +21,8 @@ import {
 import { getPaymentAmountForCycleSubscription, type PaymentDetail } from '../../payment';
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
-import { formatTime, getPrettyMsI18nLocale } from '../../time';
-import { getExplorerLink, getSubscriptionNotificationCustomActions } from '../../util';
+import { formatTime, getPrettyMsI18nLocale, getSimplifyDuration } from '../../time';
+import { getCustomerRechargeLink, getSubscriptionNotificationCustomActions } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionWillRenewEmailTemplateOptions {
@@ -92,9 +92,7 @@ export class SubscriptionWillRenewEmailTemplate
     const locale = await getUserLocale(userDid);
     const productName = await getMainProductName(subscription.id);
     const at: string = formatTime(invoice.period_end * 1000);
-    const willRenewDuration: string =
-      locale === 'en' ? this.getWillRenewDuration(locale) : this.getWillRenewDuration(locale).split(' ').join('');
-
+    const willRenewDuration = getSimplifyDuration((invoice.period_end - dayjs().unix()) * 1000, locale);
     // const upcomingInvoiceAmount = await getUpcomingInvoiceAmount(subscription.id);
     // const amount: string = fromUnitToToken(+upcomingInvoiceAmount.amount, upcomingInvoiceAmount.currency?.decimal);
     // const paymentDetail: PaymentDetail = await getPaymentDetail(userDid, invoice, amount);
@@ -135,16 +133,12 @@ export class SubscriptionWillRenewEmailTemplate
       userDid,
     });
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(paymentCurrency.payment_method_id);
-    // @ts-ignore
-    const chainHost: string | undefined = paymentMethod?.settings?.[paymentMethod.type]?.api_host;
-    const addFundsLink: string = getExplorerLink({
-      type: 'account',
-      did: userDid,
-      chainHost,
-      queryParams: {
-        action: 'recharge',
-      },
-    })!;
+
+    const addFundsLink: string = getCustomerRechargeLink({
+      locale,
+      userDid,
+      subscriptionId: subscription.id,
+    });
 
     const customActions = getSubscriptionNotificationCustomActions(
       subscription,
@@ -213,31 +207,6 @@ export class SubscriptionWillRenewEmailTemplate
     return currentPeriodEnd > expectedCurrentPeriodEnd;
   }
 
-  getWillRenewDuration(locale: string): string {
-    if (this.options.willRenewUnit === 'M') {
-      if (this.options.willRenewValue > 1) {
-        return `${this.options.willRenewValue} ${translate('notification.common.months', locale)}`;
-      }
-
-      return `${this.options.willRenewValue} ${translate('notification.common.month', locale)}`;
-    }
-    if (this.options.willRenewUnit === 'd') {
-      if (this.options.willRenewValue > 1) {
-        return `${this.options.willRenewValue} ${translate('notification.common.days', locale)}`;
-      }
-      return `${this.options.willRenewValue} ${translate('notification.common.day', locale)}`;
-    }
-
-    if (this.options.willRenewUnit === 'm') {
-      if (this.options.willRenewValue > 1) {
-        return `${this.options.willRenewValue} ${translate('notification.common.minutes', locale)}`;
-      }
-      return `${this.options.willRenewValue} ${translate('notification.common.minute', locale)}`;
-    }
-
-    return `${this.options.willRenewValue} ${this.options.willRenewUnit}`;
-  }
-
   async getTemplate(): Promise<BaseEmailTemplateType | null> {
     const {
       locale,
@@ -421,11 +390,13 @@ export class SubscriptionWillRenewEmailTemplate
       ].filter(Boolean),
       // @ts-ignore
       actions: [
-        !canPay && {
-          name: translate('notification.common.addFunds', locale),
-          title: translate('notification.common.addFunds', locale),
-          link: addFundsLink,
-        },
+        !canPay &&
+          !isStripe &&
+          addFundsLink && {
+            name: translate('notification.common.addFunds', locale),
+            title: translate('notification.common.addFunds', locale),
+            link: addFundsLink,
+          },
         {
           name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),

package/api/src/libs/time.ts

@@ -1,5 +1,6 @@
 import type { LiteralUnion } from 'type-fest';
 
+import prettyMsI18n from 'pretty-ms-i18n';
 import dayjs from './dayjs';
 
 export function formatTime(time: dayjs.ConfigType): string {
@@ -15,3 +16,15 @@ export function getPrettyMsI18nLocale(
 
   return 'en';
 }
+
+export function getSimplifyDuration(ms: number, locale: string): string {
+  const options = {
+    locale: getPrettyMsI18nLocale(locale),
+    compact: true,
+    verbose: true,
+  };
+  if (ms < 1000 && ms >= 0) {
+    options.verbose = false;
+  }
+  return prettyMsI18n(ms, options);
+}

package/api/src/libs/util.ts

@@ -292,6 +292,23 @@ export function getCustomerProfileUrl({
   );
 }
 
+export function getCustomerRechargeLink({
+  locale = 'en',
+  userDid,
+  subscriptionId,
+}: {
+  locale: LiteralUnion<'en' | 'zh', string>;
+  userDid: string;
+  subscriptionId: string;
+}) {
+  return getUrl(
+    withQuery(`customer/subscription/${subscriptionId}/recharge`, {
+      locale,
+      ...getConnectQueryParam({ userDid }),
+    })
+  );
+}
+
 export async function getOwnerDid() {
   try {
     const { user } = await blocklet.getOwner();

package/api/src/locales/en.ts

@@ -153,9 +153,18 @@ export default flat({
     },
 
     subscriptWillCanceled: {
-      title: '{productName} subscription is about to be automatically cancelled ',
-      body: 'Your subscription {productName} will be automatically unsubscribed by the system after {at} (after {willCancelDuration}) due to a long period of failure to automatically complete the automatic payment. Please handle the problem of automatic payment manually in time, so as not to affect the use. If you have any questions, please feel free to contact us.',
+      title: '{productName} subscription is about to be cancelled ',
+      pastDue:
+        'Your subscription {productName} will be automatically unsubscribed by the system after {at} (after {willCancelDuration}) due to a long period of failure to automatically complete the automatic payment. Please handle the problem of automatic payment manually in time, so as not to affect the use. If you have any questions, please feel free to contact us.',
+      body: 'Your subscription to {productName} will be automatically canceled on {at} ({willCancelDuration} later). If you have any questions, please feel free to contact us.',
       renewAmount: 'deduction amount ',
+      cancelReason: 'Cancel reason',
+      revokeStake: 'Revoke stake',
+      adminCanceled: 'Admin canceled',
+      customerCanceled: 'User-initiated cancellation',
+      paymentDisputed: 'Payment disputed',
+      paymentFailed: 'Payment failed',
+      stakeRevoked: 'Stake revoked',
     },
 
     subscriptionCanceled: {
@@ -173,6 +182,7 @@ export default flat({
       customerCanceledAndStakeReturned:
         'User-initiated cancellation, the stake will be returned later, please check for the stake return email',
       paymentFailed: 'Payment failed',
+      stakeRevoked: 'Stake revoked',
     },
   },
 });

package/api/src/locales/zh.ts

@@ -150,9 +150,17 @@ export default flat({
     },
 
     subscriptWillCanceled: {
-      title: '{productName} 订阅即将自动取消',
-      body: '由于长时间未能自动完成扣费，您订阅的 {productName} 将于 {at} ({willCancelDuration}后) 被系统自动取消订阅。请您及时手动处理扣费问题，以免影响使用。如有任何疑问，请随时与我们联系。',
+      title: '{productName} 订阅即将取消',
+      pastDue:
+        '由于长时间未能自动完成扣费，您订阅的 {productName} 将于 {at} ({willCancelDuration}后) 被系统自动取消订阅。请您及时手动处理扣费问题，以免影响使用。如有任何疑问，请随时与我们联系。',
+      body: '您订阅的 {productName} 将于 {at} ({willCancelDuration}后) 被系统取消订阅，如有疑问，请随时与我们联系。',
       renewAmount: '扣费金额',
+      cancelReason: '取消原因',
+      adminCanceled: '管理员取消',
+      customerCanceled: '用户于 {canceled_at} 主动取消',
+      paymentDisputed: '扣费争议',
+      paymentFailed: '扣费失败',
+      stakeRevoked: '撤销质押',
     },
 
     subscriptionCanceled: {
@@ -168,6 +176,7 @@ export default flat({
       customerCanceled: '用户主动取消',
       customerCanceledAndStakeReturned: '用户主动取消, 押金会在稍后退还, 请留意后续的质押退还邮件',
       paymentFailed: '扣费失败',
+      stakeRevoked: '撤销质押',
     },
   },
 });

package/api/src/queues/checkout-session.ts

@@ -39,10 +39,15 @@ export const checkoutSessionQueue = createQueue<CheckoutSessionJob>({
 export async function handleCheckoutSessionJob(job: CheckoutSessionJob): Promise<void> {
   const checkoutSession = await CheckoutSession.findByPk(job.id);
   if (!checkoutSession) {
+    logger.warn('CheckoutSession not found', { id: job.id });
     return;
   }
   if (job.action === 'expire') {
     if (checkoutSession.status !== 'open') {
+      logger.info('Skip expire CheckoutSession since status is not open', {
+        checkoutSession: checkoutSession.id,
+        status: checkoutSession.status,
+      });
       return;
     }
     if (checkoutSession.payment_status === 'paid') {
@@ -257,15 +262,25 @@ events.on(
   async ({ checkoutSessionId, paymentIntentId }: { checkoutSessionId: string; paymentIntentId: string }) => {
     const checkoutSession = await CheckoutSession.findByPk(checkoutSessionId);
     if (!checkoutSession) {
+      logger.warn('CheckoutSession not found for pending invoice', { checkoutSessionId });
       return;
     }
     if (checkoutSession.invoice_id) {
+      logger.info('Invoice already exists for checkout session', {
+        checkoutSessionId,
+        invoiceId: checkoutSession.invoice_id,
+      });
       return;
     }
     if (checkoutSession.mode !== 'payment') {
+      logger.info('Skipping invoice creation for non-payment mode', {
+        checkoutSessionId,
+        mode: checkoutSession.mode,
+      });
       return;
     }
     if (!checkoutSession.invoice_creation?.enabled) {
+      logger.info('Invoice creation not enabled for checkout session', { checkoutSessionId });
       return;
     }
 

package/api/src/queues/event.ts

@@ -14,16 +14,16 @@ type EventJob = {
 };
 
 export const handleEvent = async (job: EventJob) => {
-  logger.info('handle event', job);
+  logger.info('Starting to handle event', job);
 
   const event = await Event.findByPk(job.eventId);
   if (!event) {
-    logger.warn('event not found', job);
+    logger.warn('Event not found', job);
     return;
   }
 
   if (!event.pending_webhooks) {
-    logger.warn('event already processed', job);
+    logger.warn('Event already processed', job);
     return;
   }
 
@@ -36,6 +36,8 @@ export const handleEvent = async (job: EventJob) => {
   }
 
   await event.update({ pending_webhooks: eventWebhooks.length });
+  logger.info(`Updated event ${event.id} with ${eventWebhooks.length} pending webhooks`);
+
   eventWebhooks.forEach(async (webhook) => {
     const attemptCount = await WebhookAttempt.count({
       where: {
@@ -53,7 +55,7 @@ export const handleEvent = async (job: EventJob) => {
       const jobId = getWebhookJobId(event.id, webhook.id);
       const exist = await webhookQueue.get(jobId);
       if (!exist) {
-        logger.info('schedule attempt for event', job);
+        logger.info(`Scheduling attempt for event ${event.id} and webhook ${webhook.id}`, job);
         webhookQueue.push({
           id: jobId,
           job: { eventId: event.id, webhookId: webhook.id },
@@ -61,6 +63,8 @@ export const handleEvent = async (job: EventJob) => {
       }
     }
   });
+
+  logger.info(`Finished handling event ${job.eventId}`);
 };
 
 export const eventQueue = createQueue<EventJob>({
@@ -80,12 +84,17 @@ export const startEventQueue = async () => {
     attributes: ['id'],
   });
 
+  logger.info(`Found ${docs.length} events with pending webhooks`);
+
   docs.forEach(async (x) => {
     const exist = await eventQueue.get(x.id);
     if (!exist) {
+      logger.info(`Pushing event ${x.id} to queue`);
       eventQueue.push({ id: x.id, job: { eventId: x.id } });
     }
   });
+
+  logger.info('Finished starting event queue');
 };
 
 eventQueue.on('failed', ({ id, job, error }) => {

package/api/src/queues/invoice.ts

@@ -57,6 +57,7 @@ export const handleInvoice = async (job: InvoiceJob) => {
       attempted: true,
       status_transitions: { ...invoice.status_transitions, paid_at: dayjs().unix() },
     });
+    logger.info('Invoice updated to paid status', { invoiceId: invoice.id });
 
     if (invoice.subscription_id) {
       const subscription = await Subscription.findByPk(invoice.subscription_id);
@@ -118,6 +119,11 @@ export const handleInvoice = async (job: InvoiceJob) => {
     paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
     if (paymentIntent && paymentIntent.isImmutable() === false) {
       await paymentIntent.update({ status: 'requires_capture', customer_id: invoice.customer_id });
+      logger.info('PaymentIntent updated for invoice', {
+        invoiceId: invoice.id,
+        paymentIntentId: paymentIntent.id,
+        newStatus: 'requires_capture',
+      });
     }
   } else {
     const descriptionMap: any = {
@@ -149,7 +155,11 @@ export const handleInvoice = async (job: InvoiceJob) => {
       metadata: {},
     });
     await invoice.update({ payment_intent_id: paymentIntent.id });
-    logger.info('PaymentIntent created for invoice', { invoice: invoice.id, paymentIntent: paymentIntent.id });
+    logger.info('PaymentIntent created for invoice', {
+      invoiceId: invoice.id,
+      paymentIntentId: paymentIntent.id,
+      amount: paymentIntent.amount,
+    });
 
     if (invoice.checkout_session_id) {
       const checkoutSession = await CheckoutSession.findByPk(invoice.checkout_session_id);
@@ -246,15 +256,23 @@ invoiceQueue.on('failed', ({ id, job, error }) => {
 events.on('invoice.paid', async ({ id: invoiceId }) => {
   const invoice = await Invoice.findByPk(invoiceId);
   if (!invoice) {
-    logger.error('Invoice not found', { invoiceId });
+    logger.error('Invoice not found for paid event', { invoiceId });
     return;
   }
+  logger.info('Processing paid invoice', { invoiceId, billingReason: invoice.billing_reason });
+
   const checkBillingReason = ['subscription_cycle', 'subscription_cancel'];
   if (checkBillingReason.includes(invoice.billing_reason)) {
     const shouldPayTotal = await getInvoiceShouldPayTotal(invoice);
     if (shouldPayTotal !== invoice.total) {
       createEvent('Invoice', 'billing.discrepancy', invoice);
-      logger.info('create billing discrepancy event', { invoiceId, shouldPayTotal, invoiceTotal: invoice.total });
+      logger.warn('Billing discrepancy detected', {
+        invoiceId,
+        shouldPayTotal,
+        invoiceTotal: invoice.total,
+      });
+    } else {
+      logger.info('Invoice paid successfully with correct amount', { invoiceId, total: invoice.total });
     }
   }
 });

package/api/src/queues/payment.ts

@@ -577,6 +577,9 @@ export const handlePayment = async (job: PaymentJob) => {
   let result;
   try {
     await paymentIntent.update({ status: 'processing', last_payment_error: null });
+    logger.info('PaymentIntent status updated to processing', {
+      paymentIntentId: paymentIntent.id,
+    });
     if (paymentMethod.type === 'arcblock') {
       if (invoice?.billing_reason === 'slash_stake') {
         await handleStakeSlash(invoice, paymentIntent, paymentMethod, customer, paymentCurrency);

package/api/src/queues/refund.ts

@@ -175,6 +175,7 @@ const handleRefundJob = async (
           },
         },
       });
+      logger.info('Refund status updated to succeeded', { id: refund.id, txHash });
     }
 
     if (paymentMethod.type === 'ethereum') {
@@ -376,6 +377,7 @@ const handleStakeReturnJob = async (
           },
         },
       });
+      logger.info('Stake return refund status updated to succeeded', { id: refund.id, txHash });
     }
   } catch (err: any) {
     logger.error('stake return failed', { error: err, id: refund.id });
@@ -423,6 +425,7 @@ export const startRefundQueue = async () => {
     const exist = await refundQueue.get(x.id);
     if (!exist) {
       refundQueue.push({ id: x.id, job: { refundId: x.id } });
+      logger.info('Re-queued pending refund', { id: x.id });
     }
   });
 };