payment-kit 1.13.239 → 1.13.241

package/api/src/crons/base.ts

@@ -1,5 +1,5 @@
 import dayjs from 'dayjs';
-import { clone } from 'lodash';
+import clone from 'lodash/clone';
 import pAll from 'p-all';
 
 import { notificationCronConcurrency } from '../libs/env';
@@ -27,19 +27,21 @@ export abstract class BaseSubscriptionScheduleNotification<Options extends any>
   abstract getSubscriptions(): Promise<Subscription[]>;
 
   async run() {
-    const label: string = new Date().toISOString();
+    const { name } = this.constructor;
 
-    logger.info(`${label}: ${this.constructor.name}.run start`);
+    logger.info(`${name}.run start`, { start: dayjs(this.start).toISOString(), end: dayjs(this.end).toISOString() });
 
     const subscriptions = await this.getSubscriptions();
+    logger.info(`${name}.run.${subscriptions.length}`, subscriptions.length);
+
     const subscriptionForWillRenew = this.getSubscriptionsForWillRenew(subscriptions);
 
     await this.addTaskToQueue(subscriptionForWillRenew);
 
-    logger.info(`${label}: ${this.constructor.name}.run end`);
+    logger.info(`${name}.run end`);
   }
 
-  static DIFFS: Diff[] = [
+  static readonly DIFFS: Diff[] = [
     {
       value: 1,
       unit: 'M',
@@ -164,6 +166,7 @@ export abstract class BaseSubscriptionScheduleNotification<Options extends any>
             return;
           }
 
+          logger.info(`BaseSubscriptionScheduleNotification.addTaskToQueue.${this.eventType}`, x);
           notificationQueue.push(x);
         };
       }),

package/api/src/crons/subscription-will-canceled.ts

@@ -18,6 +18,10 @@ export class SubscriptionWillCanceledSchedule extends BaseSubscriptionScheduleNo
       raw: true,
     });
 
+    subscriptions.forEach((subscription) => {
+      subscription.current_period_end = subscription.cancel_at!;
+    });
+
     return subscriptions;
   }
 
@@ -37,7 +41,7 @@ export class SubscriptionWillCanceledSchedule extends BaseSubscriptionScheduleNo
           subscriptionId: subscription.id,
           willCancelValue: diff.value,
           willCancelUnit: diff.unit,
-          required: !!diff.required,
+          required: true,
         },
       },
       delay: dayjs(subscription.current_period_end * 1000)

package/api/src/crons/subscription-will-renew.ts

@@ -19,7 +19,6 @@ export class SubscriptionWillRenewSchedule extends BaseSubscriptionScheduleNotif
         current_period_end: {
           [Op.lt]: this.end / 1000,
         },
-        trial_start: 0,
         status: 'active',
       },
       attributes: ['id', 'current_period_start', 'current_period_end'],

package/api/src/index.ts

@@ -16,6 +16,7 @@ import { ensureWebhookRegistered } from './integrations/stripe/setup';
 import { handlers } from './libs/auth';
 import logger, { accessLogStream } from './libs/logger';
 import { ensureI18n } from './libs/middleware';
+import { initEventBroadcast } from './libs/ws';
 import { startCheckoutSessionQueue } from './queues/checkout-session';
 import { startEventQueue } from './queues/event';
 import { startInvoiceQueue } from './queues/invoice';
@@ -123,5 +124,7 @@ export const server = app.listen(port, (err?: any) => {
 
   crons.init();
 
+  initEventBroadcast();
+
   initResourceHandler();
 });

package/api/src/libs/env.ts

@@ -9,6 +9,7 @@ export const stripeInvoiceCronTime: string = process.env.STRIPE_INVOICE_CRON_TIM
 export const stripePaymentCronTime: string = process.env.STRIPE_PAYMENT_CRON_TIME || '0 */20 * * * *'; // 默认每 20min 执行一次
 export const stripeSubscriptionCronTime: string = process.env.STRIPE_SUBSCRIPTION_CRON_TIME || '0 10 */8 * * *'; // 默认每 8小时 执行一次
 export const revokeStakeCronTime: string = process.env.REVOKE_STAKE_CRON_TIME || '0 */5 * * * *'; // 默认每 5 min 行一次
+export const daysUntilCancel: string | undefined = process.env.DAYS_UNTIL_CANCEL;
 
 export default {
   ...env,

package/api/src/libs/invoice.ts

@@ -1,7 +1,6 @@
-import querystring from 'querystring';
-
 import { component } from '@blocklet/sdk';
 import type { LiteralUnion } from 'type-fest';
+import { withQuery } from 'ufo';
 
 import { getConnectQueryParam } from './util';
 
@@ -17,8 +16,10 @@ export function getCustomerInvoicePageUrl({
   action?: LiteralUnion<'pay', string>;
 }) {
   return component.getUrl(
-    `customer/invoice/${invoiceId}?locale=${locale}&action=${action}&${querystring.stringify(
-      getConnectQueryParam({ userDid })
-    )}`
+    withQuery(`customer/invoice/${invoiceId}`, {
+      locale,
+      action,
+      ...getConnectQueryParam({ userDid }),
+    })
   );
 }

package/api/src/libs/notification/template/one-time-payment-succeeded.ts

@@ -104,7 +104,13 @@ export class OneTimePaymentSucceededEmailTemplate
 
     // @ts-expect-error
     const txHash: string | undefined = paymentIntent?.payment_details?.[paymentMethod.type]?.tx_hash;
-    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash as string, 'tx');
+    const viewTxHashLink: string | undefined =
+      txHash &&
+      getExplorerLink({
+        type: 'tx',
+        did: txHash,
+        chainHost,
+      });
 
     return {
       locale,
@@ -223,17 +229,17 @@ export class OneTimePaymentSucceededEmailTemplate
       // @ts-ignore
       actions: [
         viewSubscriptionLink && {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         viewInvoiceLink && {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewInvoice', locale),
           title: translate('notification.common.viewInvoice', locale),
           link: viewInvoiceLink,
         },
         viewTxHashLink && {
-          name: 'viewTxHash',
+          name: translate('notification.common.viewTxHash', locale),
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink as string,
         },

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

@@ -49,13 +49,17 @@ export class SubscriptionCanceledEmailTemplate implements BaseEmailTemplate<Subs
     if (subscription.status !== 'canceled') {
       throw new Error(`Subscription(${this.options.subscriptionId}) status(${subscription.status}) must be canceled`);
     }
-    if (subscription.cancelation_details?.reason !== 'payment_disputed') {
-      // 非管理员取消的订阅不需要发送邮件
+    if (['payment_failed', 'payment_disputed'].includes(subscription.cancelation_details?.reason as string) === false) {
+      // 只有没钱导致订阅被取消了，或者管理员取消了，才会发送通知
       logger.error(
-        `Subscription(${this.options.subscriptionId}) cancelation reason must be payment_disputed`,
-        subscription.cancelation_details
+        `Subscription(${this.options.subscriptionId}) cancelation reason must be payment_disputed or payment_failed`,
+        {
+          cancelation_details: subscription.cancelation_details,
+        }
+      );
+      throw new Error(
+        `Subscription(${this.options.subscriptionId}) cancelation reason must be payment_disputed or payment_failed`
       );
-      throw new Error(`Subscription(${this.options.subscriptionId}) cancelation reason must be payment_disputed`);
     }
 
     const customer = await Customer.findByPk(subscription.customer_id);
@@ -229,7 +233,7 @@ export class SubscriptionCanceledEmailTemplate implements BaseEmailTemplate<Subs
       // @ts-ignore
       actions: [
         viewSubscriptionLink && {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },

package/api/src/libs/notification/template/subscription-refund-succeeded.ts

@@ -115,7 +115,13 @@ export class SubscriptionRefundSucceededEmailTemplate
 
     // @ts-expect-error
     const txHash: string | undefined = refund?.payment_details?.[paymentMethod.type]?.tx_hash;
-    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash as string, 'tx');
+    const viewTxHashLink: string | undefined =
+      txHash &&
+      getExplorerLink({
+        type: 'tx',
+        did: txHash,
+        chainHost,
+      });
 
     return {
       locale,
@@ -269,12 +275,12 @@ export class SubscriptionRefundSucceededEmailTemplate
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         viewTxHashLink && {
-          name: 'viewTxHash',
+          name: translate('notification.common.viewTxHash', locale),
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink as string,
         },

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

@@ -136,7 +136,14 @@ export class SubscriptionRenewFailedEmailTemplate
     });
     const txHash: string | undefined =
       paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
-    const viewTxHashLink: string | undefined = hasNft && txHash ? getExplorerLink(chainHost, txHash, 'tx') : undefined;
+    const viewTxHashLink: string | undefined =
+      hasNft && txHash
+        ? getExplorerLink({
+            type: 'tx',
+            did: txHash,
+            chainHost,
+          })
+        : undefined;
 
     return {
       locale,
@@ -181,7 +188,7 @@ export class SubscriptionRenewFailedEmailTemplate
       body: `${translate('notification.subscriptionRenewFailed.body', locale, {
         at,
         productName,
-        reason: `${reason}`,
+        reason: `<span style="color: red;">${reason}</span>`,
       })}`,
       // @ts-expect-error
       attachments: [
@@ -269,17 +276,17 @@ export class SubscriptionRenewFailedEmailTemplate
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         {
-          name: 'viewInvoice',
-          title: translate('notification.subscriptionRenewFailed.renewNow', locale),
+          name: translate('notification.common.renewNow', locale),
+          title: translate('notification.common.renewNow', locale),
           link: viewInvoiceLink,
         },
         viewTxHashLink && {
-          name: 'viewTxHash',
+          name: translate('notification.common.viewTxHash', locale),
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink as string,
         },

package/api/src/libs/notification/template/subscription-renewed.ts

@@ -125,7 +125,14 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
     });
     const txHash: string | undefined =
       paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
-    const viewTxHashLink: string | undefined = hasNft && txHash ? getExplorerLink(chainHost, txHash, 'tx') : undefined;
+    const viewTxHashLink: string | undefined =
+      hasNft && txHash
+        ? getExplorerLink({
+            type: 'tx',
+            did: txHash,
+            chainHost,
+          })
+        : undefined;
 
     return {
       locale,
@@ -261,17 +268,17 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewInvoice', locale),
           title: translate('notification.common.viewInvoice', locale),
           link: viewInvoiceLink,
         },
         viewTxHashLink && {
-          name: 'viewTxHash',
+          name: translate('notification.common.viewTxHash', locale),
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink as string,
         },

package/api/src/libs/notification/template/subscription-succeeded.ts

@@ -145,7 +145,13 @@ export class SubscriptionSucceededEmailTemplate
     const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
     const txHash: string | undefined =
       paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
-    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash as string, 'tx');
+    const viewTxHashLink: string | undefined =
+      txHash &&
+      getExplorerLink({
+        type: 'tx',
+        did: txHash,
+        chainHost,
+      });
 
     return {
       locale,
@@ -270,17 +276,17 @@ export class SubscriptionSucceededEmailTemplate
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewInvoice', locale),
           title: translate('notification.common.viewInvoice', locale),
           link: viewInvoiceLink,
         },
         viewTxHashLink && {
-          name: 'viewTxHash',
+          name: translate('notification.common.viewTxHash', locale),
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink as string,
         },

package/api/src/libs/notification/template/subscription-trial-start.ts

@@ -262,12 +262,12 @@ export class SubscriptionTrialStartEmailTemplate
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewInvoice', locale),
           title: translate('notification.common.viewInvoice', locale),
           link: viewInvoiceLink,
         },

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

@@ -248,7 +248,7 @@ export class SubscriptionTrialWilEndEmailTemplate
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },

package/api/src/libs/notification/template/subscription-upgraded.ts

@@ -114,7 +114,13 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
 
     // @ts-expect-error
     const txHash: string | undefined = paymentIntent?.payment_details?.[paymentMethod.type]?.tx_hash;
-    const viewTxHashLink: string | undefined = txHash && getExplorerLink(chainHost, txHash, 'tx');
+    const viewTxHashLink: string | undefined =
+      txHash &&
+      getExplorerLink({
+        type: 'tx',
+        did: txHash,
+        chainHost,
+      });
 
     return {
       locale,
@@ -239,17 +245,17 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
       // @ts-ignore
       actions: [
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewInvoice', locale),
           title: translate('notification.common.viewInvoice', locale),
           link: viewInvoiceLink,
         },
         viewTxHashLink && {
-          name: 'viewTxHash',
+          name: translate('notification.common.viewTxHash', locale),
           title: translate('notification.common.viewTxHash', locale),
           link: viewTxHashLink,
         },

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

@@ -208,12 +208,12 @@ export class SubscriptionWillCanceledEmailTemplate
       // @ts-ignore
       actions: [
         viewSubscriptionLink && {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },
         viewInvoiceLink && {
-          name: 'viewInvoice',
+          name: translate('notification.common.renewNow', locale),
           title: translate('notification.common.renewNow', locale),
           link: viewInvoiceLink,
         },

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

@@ -7,12 +7,13 @@ import prettyMsI18n from 'pretty-ms-i18n';
 
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { Customer, Invoice, Subscription } from '../../../store/models';
+import { Customer, Invoice, PaymentMethod, Subscription } from '../../../store/models';
 import { PaymentCurrency } from '../../../store/models/payment-currency';
 import { PaymentDetail, getPaymentDetail } from '../../payment';
 import { getMainProductName } from '../../product';
 import { getCustomerSubscriptionPageUrl } from '../../subscription';
 import { formatTime, getPrettyMsI18nLocale } from '../../time';
+import { getExplorerLink } from '../../util';
 import type { BaseEmailTemplate, BaseEmailTemplateType } from './base';
 
 export interface SubscriptionWillRenewEmailTemplateOptions {
@@ -36,6 +37,7 @@ interface SubscriptionWillRenewEmailTemplateContext {
   duration: string;
 
   viewSubscriptionLink: string;
+  immediateRechargeLink: string;
 }
 
 export class SubscriptionWillRenewEmailTemplate
@@ -97,6 +99,17 @@ export class SubscriptionWillRenewEmailTemplate
       locale,
       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 immediateRechargeLink: string = getExplorerLink({
+      type: 'account',
+      did: userDid,
+      chainHost,
+      queryParams: {
+        action: 'recharge',
+      },
+    })!;
 
     return {
       locale,
@@ -112,6 +125,7 @@ export class SubscriptionWillRenewEmailTemplate
       duration,
 
       viewSubscriptionLink,
+      immediateRechargeLink,
     };
   }
 
@@ -171,6 +185,7 @@ export class SubscriptionWillRenewEmailTemplate
       paymentInfo,
 
       viewSubscriptionLink,
+      immediateRechargeLink,
     } = await this.getContext();
 
     const canPay: boolean = paymentDetail.balance >= paymentDetail.price;
@@ -189,6 +204,7 @@ export class SubscriptionWillRenewEmailTemplate
             at,
             productName,
             willRenewDuration,
+            balance: `${paymentDetail.balance} ${paymentDetail.symbol}`,
           })}`
         : `${translate('notification.subscriptionWillRenew.unableToPayBody', locale, {
             at,
@@ -252,8 +268,13 @@ export class SubscriptionWillRenewEmailTemplate
       ].filter(Boolean),
       // @ts-ignore
       actions: [
+        !canPay && {
+          name: translate('notification.common.immediateRecharge', locale),
+          title: translate('notification.common.immediateRecharge', locale),
+          link: immediateRechargeLink,
+        },
         {
-          name: 'viewSubscription',
+          name: translate('notification.common.viewSubscription', locale),
           title: translate('notification.common.viewSubscription', locale),
           link: viewSubscriptionLink,
         },

package/api/src/libs/payment.ts

@@ -181,6 +181,12 @@ export async function getPaymentDetail(userDid: string, invoice: Invoice): Promi
     symbol: '',
   };
 
+  const paymentCurrency = await PaymentCurrency.findByPk(invoice.currency_id);
+  if (!paymentCurrency) {
+    return defaultResult;
+  }
+  Object.assign(defaultResult, { symbol: paymentCurrency.symbol });
+
   const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
   if (!paymentIntent) {
     return defaultResult;
@@ -191,12 +197,7 @@ export async function getPaymentDetail(userDid: string, invoice: Invoice): Promi
     return defaultResult;
   }
 
-  const paymentCurrency = await PaymentCurrency.findByPk(paymentIntent.currency_id);
-  if (!paymentCurrency) {
-    return defaultResult;
-  }
-
-  if (paymentMethod.type === 'arcblock') {
+  if (['arcblock', 'ethereum'].includes(paymentMethod.type)) {
     // balance enough token for payment?
     const result = await isDelegationSufficientForPayment({
       paymentMethod,

package/api/src/libs/subscription.ts

@@ -1,8 +1,7 @@
-import querystring from 'querystring';
-
 import component from '@blocklet/sdk/lib/component';
 import { BN } from '@ocap/util';
 import type { LiteralUnion } from 'type-fest';
+import { withQuery } from 'ufo';
 
 import {
   Customer,
@@ -29,9 +28,10 @@ export function getCustomerSubscriptionPageUrl({
   userDid: string;
 }) {
   return component.getUrl(
-    `customer/subscription/${subscriptionId}?locale=${locale}&${querystring.stringify(
-      getConnectQueryParam({ userDid })
-    )}`
+    withQuery(`customer/subscription/${subscriptionId}`, {
+      locale,
+      ...getConnectQueryParam({ userDid }),
+    })
   );
 }
 

package/api/src/libs/util.ts

@@ -4,6 +4,7 @@ import { getUrl } from '@blocklet/sdk/lib/component';
 import env from '@blocklet/sdk/lib/env';
 import { customAlphabet } from 'nanoid';
 import type { LiteralUnion } from 'type-fest';
+import { withQuery } from 'ufo';
 
 import dayjs from './dayjs';
 
@@ -172,11 +173,17 @@ export function getDataObjectFromQuery(
 }
 
 // @FIXME: 这个应该封装在某个通用类库里面 @jianchao @wangshijun
-export function getExplorerLink(
-  chainHost: string | undefined,
-  did: string | undefined,
-  type: LiteralUnion<'asset' | 'account' | 'tx' | 'token' | 'factory' | ' bridge', string>
-) {
+export function getExplorerLink({
+  type,
+  did,
+  chainHost = undefined,
+  queryParams = {},
+}: {
+  chainHost: string | undefined;
+  did: string | undefined;
+  type: LiteralUnion<'asset' | 'account' | 'tx' | 'token' | 'factory' | ' bridge', string>;
+  queryParams?: Record<string, string>;
+}) {
   if (!chainHost) return undefined;
   try {
     const chainUrl = new URL(chainHost);
@@ -203,7 +210,7 @@ export function getExplorerLink(
         chainUrl.pathname = '/';
     }
 
-    return chainUrl.href;
+    return withQuery(chainUrl.href, queryParams);
   } catch {
     return undefined;
   }

package/api/src/libs/ws.ts

@@ -0,0 +1,25 @@
+import { sendToRelay } from '@blocklet/sdk/service/notification';
+
+import type { CheckoutSession, Invoice, PaymentIntent } from '../store/models';
+import { events } from './event';
+
+export function broadcast(channel: string, eventName: string, data: any) {
+  sendToRelay(channel, eventName, data).catch((err: any) => {
+    console.error(`Failed to broadcast info: ${channel}.${eventName}`, err);
+  });
+}
+
+export function initEventBroadcast() {
+  events.on('payment_intent.succeeded', (data: PaymentIntent) => {
+    broadcast('events', 'payment_intent.succeeded', data);
+  });
+  events.on('checkout.session.completed', (data: CheckoutSession) => {
+    broadcast('events', 'checkout.session.completed', data);
+  });
+  events.on('checkout.session.nft_minted', (data: CheckoutSession) => {
+    broadcast('events', 'checkout.session.nft_minted', data);
+  });
+  events.on('invoice.paid', (data: Invoice) => {
+    broadcast('events', 'invoice.paid', data);
+  });
+}