payment-kit 1.13.71 → 1.13.73

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

@@ -2,7 +2,7 @@ import { mintNftForCheckoutSession } from '../integrations/blockchain/nft';
 import { ensurePassportIssued, ensurePassportRevoked } from '../integrations/blocklet/passport';
 import { events } from '../libs/event';
 import logger from '../libs/logger';
-import type { CheckoutSession, Subscription } from '../store/models';
+import { CheckoutSession, Price, Subscription } from '../store/models';
 
 // eslint-disable-next-line require-await
 export async function startCheckoutSessionQueue() {
@@ -13,6 +13,17 @@ export async function startCheckoutSessionQueue() {
     mintNftForCheckoutSession(checkoutSession.id).catch((err) => {
       logger.error('mintNftForCheckoutSession failed', { error: err, checkoutSession: checkoutSession.id });
     });
+
+    // lock prices used
+    Price.update(
+      { locked: true },
+      { where: { id: checkoutSession.line_items.map((x) => x.upsell_price_id || x.price_id) } }
+    ).catch((err) => {
+      logger.error('lock price on checkout session complete failed', {
+        error: err,
+        checkoutSession: checkoutSession.id,
+      });
+    });
   });
 
   events.on('customer.subscription.deleted', (subscription: Subscription) => {

package/api/src/jobs/payment.ts

@@ -6,7 +6,7 @@ import { events } from '../libs/event';
 import logger from '../libs/logger';
 import { getGasPayerExtra, isDelegationSufficientForPayment } from '../libs/payment';
 import createQueue from '../libs/queue';
-import { MAX_RETRY_COUNT, getNextRetry } from '../libs/util';
+import { MAX_RETRY_COUNT, MIN_RETRY_MAIL, getNextRetry } from '../libs/util';
 import { CheckoutSession } from '../store/models/checkout-session';
 import { Invoice } from '../store/models/invoice';
 import { PaymentCurrency } from '../store/models/payment-currency';
@@ -66,13 +66,7 @@ export const handlePaymentSucceed = async (paymentIntent: PaymentIntent) => {
       }
     }
 
-    const count: number = await Invoice.count({
-      where: {
-        subscription_id: invoice.subscription_id,
-        status: 'paid',
-      },
-    });
-    if (count >= 2) {
+    if (invoice.billing_reason === 'subscription_cycle') {
       events.emit('customer.subscription.renewed', subscription, invoice);
     }
   }
@@ -131,6 +125,7 @@ export const handlePayment = async (job: PaymentJob) => {
 
   // try payment capture and reschedule on error
   logger.info(`PaymentIntent capture attempt: ${paymentIntent.id}`);
+  let result;
   try {
     await paymentIntent.update({ status: 'processing', last_payment_error: null });
 
@@ -138,7 +133,7 @@ export const handlePayment = async (job: PaymentJob) => {
     const payer = paymentSettings?.payment_method_options.arcblock?.payer;
 
     // check balance before capture
-    const result = await isDelegationSufficientForPayment({
+    result = await isDelegationSufficientForPayment({
       paymentMethod,
       paymentCurrency,
       userDid: payer as string,
@@ -146,11 +141,6 @@ export const handlePayment = async (job: PaymentJob) => {
     });
     if (result.sufficient === false) {
       logger.error('PaymentIntent capture aborted on preCheck', { id: paymentIntent.id, result });
-      events.emit('customer.subscription.renew_failed', {
-        invoice,
-        result,
-      });
-      // FIXME: send email to customer, pause subscription
       throw new CustomError(result.reason, 'payer balance or delegation not sufficient for this payment');
     }
 
@@ -218,11 +208,19 @@ export const handlePayment = async (job: PaymentJob) => {
         });
       }
     } else if (invoice) {
+      const attemptCount = invoice.attempt_count + 1;
+      if (attemptCount >= MIN_RETRY_MAIL && invoice.billing_reason === 'subscription_cycle') {
+        events.emit('customer.subscription.renew_failed', {
+          invoice,
+          result: result || { sufficient: false, reason: 'TX_SEND_FAILED' },
+        });
+      }
+
       if (invoice.attempt_count > MAX_RETRY_COUNT) {
         await paymentIntent.update({ status: 'requires_action', last_payment_error: error });
         await invoice.update({
           status: 'uncollectible',
-          attempt_count: invoice.attempt_count + 1,
+          attempt_count: attemptCount,
           attempted: true,
           status_transitions: { ...invoice.status_transitions, marked_uncollectible_at: dayjs().unix() },
         });
@@ -230,11 +228,11 @@ export const handlePayment = async (job: PaymentJob) => {
         // FIXME: send email to customer, pause subscription
         logger.error('PaymentIntent capture failed after max retry', { id: paymentIntent.id });
       } else {
-        const retryAt = getNextRetry(invoice.attempt_count + 1);
+        const retryAt = getNextRetry(attemptCount);
 
         await paymentIntent.update({ status: 'requires_capture', last_payment_error: error });
         await invoice.update({
-          attempt_count: invoice.attempt_count + 1,
+          attempt_count: attemptCount,
           attempted: true,
           next_payment_attempt: retryAt,
         });

package/api/src/libs/payment.ts

@@ -8,7 +8,14 @@ import { BN, fromUnitToToken } from '@ocap/util';
 import cloneDeep from 'lodash/cloneDeep';
 import type { LiteralUnion } from 'type-fest';
 
-import { Invoice, PaymentCurrency, PaymentIntent, PaymentMethod } from '../store/models';
+import {
+  CheckoutSession,
+  Invoice,
+  PaymentCurrency,
+  PaymentIntent,
+  PaymentMethod,
+  TLineItemExpanded,
+} from '../store/models';
 import type { TPaymentCurrency } from '../store/models/payment-currency';
 import { blocklet, wallet } from './auth';
 import logger from './logger';
@@ -80,7 +87,7 @@ export async function isDelegationSufficientForPayment(args: {
 
       const requested = new BN(amount);
       const allowance = new BN(tokenLimit.txAllowance);
-      if (requested.gt(allowance)) {
+      if (tokenLimit.txAllowance !== '0' && requested.gt(allowance)) {
         return { sufficient: false, reason: 'NO_ENOUGH_ALLOWANCE' };
       }
     }
@@ -181,6 +188,7 @@ export async function getPaymentDetail(userDid: string, invoice: Invoice): Promi
 }
 
 export async function getTokenLimitsForDelegation(
+  checkoutSession: CheckoutSession,
   paymentMethod: PaymentMethod,
   paymentCurrency: PaymentCurrency,
   address: string,
@@ -189,11 +197,15 @@ export async function getTokenLimitsForDelegation(
   const client = paymentMethod.getOcapClient();
   const { state } = await client.getDelegateState({ address });
 
+  const items = checkoutSession.line_items as TLineItemExpanded[];
+  const hasMetered = items.some((x) => x.price.recurring?.usage_type === 'metered');
+  const allowance = hasMetered ? '0' : amount;
+
   // @ts-ignore
   const entry: TokenLimit = {
     address: paymentCurrency.contract as string,
     to: [wallet.address], // FIXME: may broken if we have vault, migrated
-    txAllowance: amount,
+    txAllowance: allowance,
     totalAllowance: '0',
     txCount: 0,
     validUntil: 0,
@@ -204,6 +216,11 @@ export async function getTokenLimitsForDelegation(
     return [entry];
   }
 
+  // If we have metered items, we should not limit tx allowance(set to 0)
+  if (hasMetered) {
+    return [entry];
+  }
+
   const op = (state as DelegateState).ops.find((x) => x.key === OCAP_PAYMENT_TX_TYPE);
   if (op && Array.isArray(op.value.limit?.tokens) && op.value.limit.tokens.length > 0) {
     const tokenLimits = cloneDeep(op.value.limit.tokens);
@@ -212,7 +229,8 @@ export async function getTokenLimitsForDelegation(
     if (index > -1) {
       const limit = op.value.limit.tokens[index] as TokenLimit;
       // If we have a previous delegation and the txAllowance is smaller than requested amount
-      if (new BN(limit.txAllowance).lt(new BN(amount))) {
+      // If txAllowance is 0 (unlimited), we should not update it
+      if (limit.txAllowance !== '0' && new BN(limit.txAllowance).lt(new BN(amount))) {
         tokenLimits[index] = entry;
       }
     } else {

package/api/src/libs/util.ts

@@ -10,6 +10,7 @@ import dayjs from './dayjs';
 export const OCAP_PAYMENT_TX_TYPE = 'fg:t:transfer_v2';
 
 export const MAX_RETRY_COUNT = 18; // 2^18 seconds ~~ 3 days, total retry time: 6 days
+export const MIN_RETRY_MAIL = 13; // total retry time before sending first mail: 6 hours
 export const STRIPE_API_VERSION = '2023-08-16';
 export const STRIPE_ENDPOINT: string = getUrl('/api/integrations/stripe/webhook');
 export const STRIPE_EVENTS: any[] = [

package/api/src/locales/en.ts

@@ -77,6 +77,7 @@ export default flat({
         noEnoughToken:
           'Your account token balance is {balance}, not enough for {price}, please replenish your tokens and renew your account',
         noSupported: 'Token renewal is not supported, please check your subscription',
+        txSendFailed: 'Failed to send transaction when try to collect payment.',
       },
     },
   },

package/api/src/locales/zh.ts

@@ -72,6 +72,7 @@ export default flat({
         noToken: '您的账户没有任何代币，请充值代币后重新续费',
         noEnoughToken: '您的账户代币余额为 {balance}，不足 {price}，请充值代币后重新续费',
         noSupported: '不支持使用代币续费，请检查您的套餐',
+        txSendFailed: '扣款交易发送失败',
       },
     },
   },

package/api/src/routes/checkout-sessions.ts

@@ -581,7 +581,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           payment_method_id: paymentMethod.id,
           last_setup_error: null,
         });
-        logger.info('setup intent for checkout session reset', {
+        logger.info('setupIntent reset on checkout session submit', {
           session: checkoutSession.id,
           intent: setupIntent.id,
         });
@@ -599,13 +599,13 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           usage: 'off_session',
           metadata: checkoutSession.metadata,
         });
+
+        // persist setup intent id
+        await checkoutSession.update({ setup_intent_id: setupIntent.id });
         logger.info('setupIntent created on checkout session submit', {
           session: checkoutSession.id,
           intent: setupIntent.id,
         });
-
-        // persist setup intent id
-        await checkoutSession.update({ setup_intent_id: setupIntent.id });
       }
     }
 
@@ -678,9 +678,6 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           items: items.map((x) => x.id),
         });
 
-        // lock prices used by this subscription
-        await Price.update({ locked: true }, { where: { id: lineItems.map((x) => x.upsell_price_id || x.price_id) } });
-
         // persist subscription id
         await checkoutSession.update({ subscription_id: subscription.id });
       }

package/api/src/routes/connect/setup.ts

@@ -38,7 +38,14 @@ export default {
         checkoutSession.mode,
         paymentCurrency
       );
-      const tokenLimits = await getTokenLimitsForDelegation(paymentMethod, paymentCurrency, address, amount);
+
+      const tokenLimits = await getTokenLimitsForDelegation(
+        checkoutSession,
+        paymentMethod,
+        paymentCurrency,
+        address,
+        amount
+      );
       const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
 
       return {

package/api/src/routes/connect/shared.ts

@@ -135,16 +135,16 @@ export async function ensureSetupIntent(checkoutSessionId: string, userDid?: str
   if (checkoutSession.setup_intent_id) {
     setupIntent = await SetupIntent.findByPk(checkoutSession.setup_intent_id);
     if (!setupIntent) {
-      throw new Error('Payment intent not found');
+      throw new Error('Setup intent not found');
     }
     if (setupIntent.status === 'succeeded') {
-      throw new Error('Payment intent completed');
+      throw new Error('Setup intent completed');
     }
     if (setupIntent.status === 'canceled') {
-      throw new Error('Payment intent canceled');
+      throw new Error('Setup intent canceled');
     }
     if (setupIntent.status === 'processing') {
-      throw new Error('Payment intent processing');
+      throw new Error('Setup intent processing');
     }
 
     customerId = setupIntent.customer_id;

package/api/src/routes/connect/subscribe.ts

@@ -40,7 +40,13 @@ export default {
         checkoutSession.mode,
         paymentCurrency
       );
-      const tokenLimits = await getTokenLimitsForDelegation(paymentMethod, paymentCurrency, address, amount);
+      const tokenLimits = await getTokenLimitsForDelegation(
+        checkoutSession,
+        paymentMethod,
+        paymentCurrency,
+        address,
+        amount
+      );
       const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
 
       return {

package/api/src/store/migrations/20231220-setup-intent.ts

@@ -0,0 +1,22 @@
+/* eslint-disable no-await-in-loop */
+import { DataTypes } from 'sequelize';
+
+import { Migration, safeApplyColumnChanges } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await safeApplyColumnChanges(context, {
+    checkout_sessions: [
+      {
+        name: 'setup_intent_id',
+        field: {
+          type: DataTypes.STRING(30),
+          allowNull: true,
+        },
+      },
+    ],
+  });
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('checkout_sessions', 'setup_intent_id');
+};

package/api/src/store/models/checkout-session.ts

@@ -413,6 +413,10 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
           type: DataTypes.ENUM('auto', 'required'),
           defaultValue: 'auto',
         },
+        setup_intent_id: {
+          type: DataTypes.STRING(30),
+          allowNull: true,
+        },
       },
       {
         sequelize,

package/blocklet.yml

@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/payment-kit.git
 specVersion: 1.2.8
-version: 1.13.71
+version: 1.13.73
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.71",
+  "version": "1.13.73",
   "scripts": {
     "dev": "COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev",
     "eject": "vite eject",
@@ -106,7 +106,7 @@
     "@abtnode/types": "^1.16.19",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.71",
+    "@did-pay/types": "1.13.73",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -143,5 +143,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "790a7f2f0e18c1631bf018ca5481b01ec25996e3"
+  "gitHead": "544382d01feaed289ddaf2066b701a6ecf253370"
 }