payment-kit 1.21.15 → 1.21.16

package/api/src/queues/vendors/return-processor.ts

@@ -4,6 +4,8 @@ import { VendorFulfillmentService } from '../../libs/vendor-util/fulfillment';
 import { CheckoutSession } from '../../store/models';
 import { VendorInfo } from './fulfillment-coordinator';
 
+export const MAX_RETURN_RETRY = 3;
+
 type ReturnProcessorJob = {
   checkoutSessionId: string;
 };
@@ -39,13 +41,14 @@ async function handleReturnProcessorJob(job: ReturnProcessorJob): Promise<void>
     let i = -1;
     for (const vendor of vendorInfoList) {
       i++;
-      // Only process vendors with 'completed' status
-      if (vendor.status !== 'completed') {
-        logger.info('Skipping vendor return because status is not completed', {
+      const returnRetry = vendor.returnRetry ? vendor.returnRetry + 1 : 1;
+      if (vendor.status === 'returned') {
+        logger.info('Skipping vendor return because status is returned', {
           checkoutSessionId,
           vendorId: vendor.vendor_id,
           orderId: vendor.order_id,
           status: vendor.status,
+          returnRetry,
         });
         // eslint-disable-next-line no-continue
         continue;
@@ -56,53 +59,51 @@ async function handleReturnProcessorJob(job: ReturnProcessorJob): Promise<void>
           checkoutSessionId,
           vendorId: vendor.vendor_id,
           orderId: vendor.order_id,
+          returnRetry,
         });
 
         // eslint-disable-next-line no-await-in-loop
-        const returnResult = await callVendorReturn(vendor, checkoutSession);
-
-        if (returnResult.success) {
-          // Return successful, update status to 'returned'
-          vendorInfoList[i] = {
-            ...vendor,
-            status: 'returned',
-            lastAttemptAt: new Date().toISOString(),
-          };
-          hasChanges = true;
-
-          logger.info('Vendor return successful', {
-            checkoutSessionId,
-            vendorId: vendor.vendor_id,
-            orderId: vendor.order_id,
-          });
-        } else {
-          // Return failed, keep 'completed' status for next scan retry
-          vendorInfoList[i] = {
-            ...vendor,
-            lastAttemptAt: new Date().toISOString(),
-            error_message: returnResult.message || 'Return request failed',
-          };
-
-          logger.warn('Vendor return failed', {
-            checkoutSessionId,
-            vendorId: vendor.vendor_id,
-            orderId: vendor.order_id,
-            error: returnResult.message,
-          });
-        }
+        await callVendorReturn(vendor, checkoutSession);
+
+        // Return successful, update status to 'returned'
+        vendorInfoList[i] = {
+          ...vendor,
+          status: 'returned',
+          lastAttemptAt: new Date().toISOString(),
+        };
+        hasChanges = true;
+
+        logger.info('Vendor return successful', {
+          checkoutSessionId,
+          vendorId: vendor.vendor_id,
+          orderId: vendor.order_id,
+          returnRetry,
+        });
       } catch (error: any) {
         logger.error('Error processing vendor return', {
           checkoutSessionId,
           vendorId: vendor.vendor_id,
           orderId: vendor.order_id,
-          error: error.message,
+          error,
+          returnRetry,
         });
 
+        if (returnRetry >= MAX_RETURN_RETRY) {
+          logger.warn('Skipping vendor return because return retry is greater than 5', {
+            checkoutSessionId,
+            vendorId: vendor.vendor_id,
+            orderId: vendor.order_id,
+            returnRetry,
+          });
+        }
+
         // Record error but keep status unchanged for retry
         vendorInfoList[i] = {
           ...vendor,
+          status: returnRetry >= MAX_RETURN_RETRY ? 'returned' : vendor.status,
           lastAttemptAt: new Date().toISOString(),
           error_message: error.message,
+          returnRetry,
         };
         hasChanges = true;
       }
@@ -110,14 +111,14 @@ async function handleReturnProcessorJob(job: ReturnProcessorJob): Promise<void>
 
     // Update vendor_info if there are changes
     if (hasChanges) {
-      await checkoutSession.update({ vendor_info: vendorInfoList });
+      await CheckoutSession.update({ vendor_info: vendorInfoList }, { where: { id: checkoutSessionId } });
     }
 
     // Check if all vendors have been returned
     const allReturned = vendorInfoList.every((vendor) => vendor.status === 'returned');
 
     if (allReturned && checkoutSession.fulfillment_status !== 'returned') {
-      await checkoutSession.update({ fulfillment_status: 'returned' });
+      await CheckoutSession.update({ fulfillment_status: 'returned' }, { where: { id: checkoutSessionId } });
 
       logger.info('All vendors returned, updated fulfillment status to returned', {
         checkoutSessionId,
@@ -140,44 +141,20 @@ async function handleReturnProcessorJob(job: ReturnProcessorJob): Promise<void>
   }
 }
 
-async function callVendorReturn(
-  vendor: VendorInfo,
-  checkoutSession: CheckoutSession
-): Promise<{ success: boolean; message?: string }> {
-  try {
-    const vendorAdapter = await VendorFulfillmentService.getVendorAdapter(vendor.vendor_key);
-
-    if (!vendorAdapter) {
-      return {
-        success: false,
-        message: `No adapter found for vendor: ${vendor.vendor_id}`,
-      };
-    }
+async function callVendorReturn(vendor: VendorInfo, checkoutSession: CheckoutSession) {
+  const vendorAdapter = await VendorFulfillmentService.getVendorAdapter(vendor.vendor_key);
 
-    const returnResult = await vendorAdapter.requestReturn({
-      orderId: vendor.order_id,
-      reason: 'Subscription canceled',
-      customParams: {
-        checkoutSessionId: checkoutSession.id,
-        subscriptionId: checkoutSession.subscription_id,
-        vendorKey: vendor.vendor_key,
-      },
-    });
-
-    return {
-      success: returnResult.success || false,
-      message: returnResult.message,
-    };
-  } catch (error: any) {
-    logger.error('Failed to call vendor return API', {
-      vendorId: vendor.vendor_id,
-      orderId: vendor.order_id,
-      error: error.message,
-    });
-
-    return {
-      success: false,
-      message: error.message,
-    };
+  if (!vendorAdapter) {
+    throw new Error(`No adapter found for vendor: ${vendor.vendor_id}`);
   }
+
+  return vendorAdapter.requestReturn({
+    orderId: vendor.order_id,
+    reason: 'Subscription canceled',
+    customParams: {
+      checkoutSessionId: checkoutSession.id,
+      subscriptionId: checkoutSession.subscription_id,
+      vendorKey: vendor.vendor_key,
+    },
+  });
 }

package/api/src/queues/vendors/return-scanner.ts

@@ -1,9 +1,11 @@
 import { Op } from 'sequelize';
+import dayjs from 'dayjs';
 import logger from '../../libs/logger';
 import createQueue from '../../libs/queue';
 import { CheckoutSession, Subscription } from '../../store/models';
 import { vendorReturnProcessorQueue } from './return-processor';
 import { VendorInfo } from './fulfillment-coordinator';
+import { events } from '../../libs/event';
 
 export const vendorReturnScannerQueue = createQueue({
   name: 'vendor-return-scanner',
@@ -52,8 +54,10 @@ async function handleReturnScannerJob(): Promise<void> {
 async function findSessionsNeedingVendorReturn(): Promise<CheckoutSession[]> {
   try {
     // First, find canceled subscriptions
+    const oneWeekAgo = dayjs().subtract(7, 'day').unix();
+
     const canceledSubscriptions = await Subscription.findAll({
-      where: { status: 'canceled' },
+      where: { status: 'canceled', canceled_at: { [Op.gt]: oneWeekAgo } },
       attributes: ['id'],
     });
 
@@ -62,7 +66,7 @@ async function findSessionsNeedingVendorReturn(): Promise<CheckoutSession[]> {
     // Find checkout sessions with completed fulfillment and canceled subscriptions
     const readyToReturnSessions = await CheckoutSession.findAll({
       where: {
-        fulfillment_status: 'completed',
+        fulfillment_status: { [Op.notIn]: ['returning', 'returned', 'failed'] },
         subscription_id: { [Op.in]: canceledSubscriptionIds },
       },
       order: [['updated_at', 'DESC']],
@@ -102,7 +106,10 @@ async function findSessionsNeedingVendorReturn(): Promise<CheckoutSession[]> {
       if (!vendorInfoList || vendorInfoList.length === 0) {
         return false;
       }
-      const hasVendorNeedingReturn = vendorInfoList.some((vendor) => vendor.status === 'completed');
+
+      const hasVendorNeedingReturn = vendorInfoList.some(
+        (vendor) => !['cancelled', 'return_requested', 'returned'].includes(vendor.status)
+      );
       return hasVendorNeedingReturn;
     });
 
@@ -117,3 +124,31 @@ export function scheduleVendorReturnScan(): void {
   const scanId = `scan-${Date.now()}`;
   vendorReturnScannerQueue.push({ id: scanId, job: {} });
 }
+
+events.on('customer.subscription.deleted', async (subscription: Subscription) => {
+  logger.info('Customer subscription deleted', { subscription });
+  if (subscription.status !== 'canceled') {
+    logger.info('Subscription is not canceled, skipping vendor return process[customer.subscription.deleted]', {
+      subscriptionId: subscription.id,
+    });
+    return;
+  }
+
+  const session = await CheckoutSession.findOne({
+    where: { subscription_id: subscription.id },
+  });
+
+  if (session) {
+    const id = `vendor-return-process-${session.id}`;
+    // eslint-disable-next-line no-await-in-loop
+    const exists = await vendorReturnProcessorQueue.get(id);
+    if (!exists) {
+      vendorReturnProcessorQueue.push({
+        id,
+        job: {
+          checkoutSessionId: session.id,
+        },
+      });
+    }
+  }
+});

package/api/src/routes/vendor.ts

@@ -5,6 +5,7 @@ import Joi from 'joi';
 
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { gte } from 'semver';
+import { Op } from 'sequelize';
 import { MetadataSchema } from '../libs/api';
 import { wallet } from '../libs/auth';
 import dayjs from '../libs/dayjs';
@@ -31,19 +32,15 @@ const createVendorSchema = Joi.object({
   name: Joi.string().max(255).required(),
   description: Joi.string().max(1000).allow('').optional(),
   app_url: Joi.string().uri().max(512).required(),
-  app_pid: Joi.string().max(255).allow('').optional(),
-  app_logo: Joi.string().max(512).allow('').optional(),
   status: Joi.string().valid('active', 'inactive').default('active'),
   metadata: MetadataSchema,
-}).unknown(false);
+}).unknown(true);
 
 const updateVendorSchema = Joi.object({
   vendor_type: Joi.string().valid('launcher', 'didnames').optional(),
   name: Joi.string().max(255).optional(),
   description: Joi.string().max(1000).allow('').optional(),
   app_url: Joi.string().uri().max(512).optional(),
-  app_pid: Joi.string().max(255).allow('').optional(),
-  app_logo: Joi.string().max(512).allow('').optional(),
   status: Joi.string().valid('active', 'inactive').optional(),
   metadata: MetadataSchema,
 }).unknown(true);
@@ -56,6 +53,10 @@ const sessionIdParamSchema = Joi.object({
   sessionId: Joi.string().max(100).required(),
 });
 
+const sessionIdsParamSchema = Joi.object({
+  sessionIds: Joi.array().items(Joi.string().max(100)).required(),
+});
+
 const subscriptionIdParamSchema = Joi.object({
   subscriptionId: Joi.string().max(100).required(),
 });
@@ -134,6 +135,51 @@ async function getVendorInfo(req: any, res: any) {
   }
 }
 
+async function prepareVendorData(appUrlInput: string, vendorType: 'launcher' | 'didnames', metadata: any = {}) {
+  let appUrl = '';
+  let blockletJson = null;
+  try {
+    appUrl = new URL(appUrlInput).origin;
+    blockletJson = await getBlockletJson(appUrl);
+  } catch (error) {
+    logger.error('Failed to get blocklet json', {
+      appUrlInput,
+      error,
+    });
+    return { error: `Invalid app URL: ${appUrlInput}, get blocklet json failed` as const };
+  }
+
+  if (!blockletJson?.appId || !blockletJson?.appPk) {
+    return { error: `Invalid app URL: ${appUrl}, the appId or appPk is required in the target app` as const };
+  }
+
+  const vendorDid = VENDOR_DID[vendorType];
+  const component = blockletJson?.componentMountPoints?.find((item: any) => item.did === vendorDid);
+
+  if (!component) {
+    return { error: `Invalid app URL: ${appUrl}, the ${vendorType} did is not found in the target server` as const };
+  }
+
+  const mountPoint = component.mountPoint || '/';
+  return {
+    vendor_did: vendorDid,
+    app_url: appUrl,
+    // Both appPid and appId can be used here for transfer purposes, with did being recommended.
+    // Keeping appPid for now due to extensive changes required
+    app_pid: blockletJson.appId,
+    app_logo: blockletJson.appLogo,
+    metadata: {
+      ...metadata,
+      mountPoint,
+    },
+    extends: {
+      mountPoint,
+      appId: blockletJson.appId,
+      appPk: blockletJson.appPk,
+    },
+  };
+}
+
 async function createVendor(req: any, res: any) {
   try {
     const { error, value } = createVendorSchema.validate(req.body);
@@ -144,26 +190,9 @@ async function createVendor(req: any, res: any) {
       });
     }
 
-    const {
-      vendor_key: vendorKey,
-      vendor_type: type,
-      name,
-      description,
-      metadata,
-      app_pid: appPid,
-      app_logo: appLogo,
-      status,
-    } = value;
-
-    let appUrl = '';
-    try {
-      appUrl = new URL(value.app_url).origin;
-    } catch {
-      return res.status(400).json({ error: 'Invalid app URL' });
-    }
+    const { vendor_key: vendorKey, vendor_type: type, name, description, metadata, status } = value;
 
     const vendorType = (type || 'launcher') as 'launcher' | 'didnames';
-    const vendorDid = VENDOR_DID[vendorType];
 
     const existingVendor = await ProductVendor.findOne({
       where: { vendor_key: vendorKey },
@@ -172,30 +201,18 @@ async function createVendor(req: any, res: any) {
       return res.status(400).json({ error: 'Vendor key already exists' });
     }
 
-    const blockletJson = await getBlockletJson(appUrl);
-
-    const mountPoint =
-      blockletJson?.componentMountPoints?.find((item: any) => item.did === vendorDid)?.mountPoint || '/';
+    const preparedData = await prepareVendorData(value.app_url, vendorType, metadata);
+    if ('error' in preparedData) {
+      return res.status(400).json({ error: preparedData.error });
+    }
 
     const vendor = await ProductVendor.create({
+      ...preparedData,
       vendor_key: vendorKey,
       vendor_type: vendorType,
       name,
       description,
-      app_url: appUrl,
-      vendor_did: vendorDid,
       status: status || 'active',
-      app_pid: appPid,
-      app_logo: appLogo,
-      metadata: {
-        ...metadata,
-        mountPoint,
-      },
-      extends: {
-        mountPoint,
-        appId: blockletJson?.appId,
-        appPk: blockletJson?.appPk,
-      },
       created_by: req.user?.did || 'admin',
     });
 
@@ -224,50 +241,30 @@ async function updateVendor(req: any, res: any) {
       });
     }
 
-    const { vendor_type: type, name, description, status, metadata, app_pid: appPid, app_logo: appLogo } = value;
-
-    let appUrl = '';
-    try {
-      appUrl = new URL(value.app_url).origin;
-    } catch {
-      return res.status(400).json({ error: 'Invalid app URL' });
-    }
-
-    const vendorType = (type || 'launcher') as 'launcher' | 'didnames';
-    const vendorDid = VENDOR_DID[vendorType];
-
-    const blockletJson = await getBlockletJson(appUrl);
-
-    const mountPoint =
-      blockletJson?.componentMountPoints?.find((item: any) => item.did === vendorDid)?.mountPoint || '/';
+    const { vendor_type: type, vendor_key: vendorKey, name, description, status, metadata } = value;
 
-    if (req.body.vendorKey && req.body.vendorKey !== vendor.vendor_key) {
+    if (vendorKey && vendorKey !== vendor.vendor_key) {
       const existingVendor = await ProductVendor.findOne({
-        where: { vendor_key: req.body.vendorKey },
+        where: { vendor_key: vendorKey },
       });
       if (existingVendor) {
         return res.status(400).json({ error: 'Vendor key already exists' });
       }
     }
+
+    const vendorType = (type || 'launcher') as 'launcher' | 'didnames';
+    const preparedData = await prepareVendorData(value.app_url, vendorType, metadata);
+    if ('error' in preparedData) {
+      return res.status(400).json({ error: preparedData.error });
+    }
+
     const updates = {
+      ...preparedData,
       vendor_type: vendorType,
+      vendor_key: vendorKey,
       name,
       description,
-      app_url: appUrl,
-      vendor_did: vendorDid,
       status,
-      metadata: {
-        ...metadata,
-        mountPoint,
-      },
-      app_pid: appPid,
-      app_logo: appLogo,
-      vendor_key: req.body.vendor_key,
-      extends: {
-        mountPoint,
-        appId: blockletJson?.appId,
-        appPk: blockletJson?.appPk,
-      },
     };
 
     await vendor.update(Object.fromEntries(Object.entries(updates).filter(([, v]) => v !== undefined)));
@@ -561,6 +558,36 @@ async function redirectToVendor(req: any, res: any) {
   }
 }
 
+async function getCancelledSessions(req: any, res: any) {
+  const { error } = sessionIdsParamSchema.validate(req.body);
+  if (error) {
+    return res.status(400).json({ error: error.message });
+  }
+
+  const { sessionIds = [] } = req.body;
+
+  const allCheckoutSessions = await CheckoutSession.findAll({
+    where: { id: { [Op.in]: sessionIds } },
+    attributes: ['id', 'subscription_id', 'fulfillment_status', 'vendor_info'],
+  });
+
+  const subscriptionIds = allCheckoutSessions.map((item) => item.subscription_id!).filter((item) => !!item);
+
+  const cancelledSubscriptions = await Subscription.findAll({
+    where: {
+      id: { [Op.in]: subscriptionIds },
+      status: 'canceled',
+    },
+    attributes: ['id'],
+  });
+
+  const cancelledSubIds = cancelledSubscriptions.map((item) => item.id);
+  const cancelledSessions = allCheckoutSessions.filter(
+    (item) => item.subscription_id && cancelledSubIds.includes(item.subscription_id)
+  );
+  return res.json({ cancelledSessions });
+}
+
 async function getVendorSubscription(req: any, res: any) {
   const { sessionId } = req.params;
 
@@ -636,6 +663,7 @@ router.get('/order/:sessionId/detail', loginAuth, validateParams(sessionIdParamS
 
 // Those for Vendor Call
 router.get('/connectTest', ensureVendorAuth, getVendorConnectTest);
+router.post('/subscription/cancelled', ensureVendorAuth, getCancelledSessions);
 router.get('/subscription/:sessionId/redirect', handleSubscriptionRedirect);
 router.get('/subscription/:sessionId', ensureVendorAuth, getVendorSubscription);
 

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

@@ -239,6 +239,7 @@ export class CheckoutSession extends Model<InferAttributes<CheckoutSession>, Inf
 
     attempts?: number;
     lastAttemptAt?: string;
+    returnRetry?: number;
     completedAt?: string;
     commissionAmount?: string;
 

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.21.15
+version: 1.21.16
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.21.15",
+  "version": "1.21.16",
   "scripts": {
     "dev": "blocklet dev --open",
     "lint": "tsc --noEmit && eslint src api/src --ext .mjs,.js,.jsx,.ts,.tsx",
@@ -56,9 +56,9 @@
     "@blocklet/error": "^0.2.5",
     "@blocklet/js-sdk": "^1.16.53-beta-20251011-054719-4ed2f6b7",
     "@blocklet/logger": "^1.16.53-beta-20251011-054719-4ed2f6b7",
-    "@blocklet/payment-broker-client": "1.21.15",
-    "@blocklet/payment-react": "1.21.15",
-    "@blocklet/payment-vendor": "1.21.15",
+    "@blocklet/payment-broker-client": "1.21.16",
+    "@blocklet/payment-react": "1.21.16",
+    "@blocklet/payment-vendor": "1.21.16",
     "@blocklet/sdk": "^1.16.53-beta-20251011-054719-4ed2f6b7",
     "@blocklet/ui-react": "^3.1.46",
     "@blocklet/uploader": "^0.2.15",
@@ -128,7 +128,7 @@
   "devDependencies": {
     "@abtnode/types": "^1.16.53-beta-20251011-054719-4ed2f6b7",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.21.15",
+    "@blocklet/payment-types": "1.21.16",
     "@types/cookie-parser": "^1.4.9",
     "@types/cors": "^2.8.19",
     "@types/debug": "^4.1.12",
@@ -175,5 +175,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "fd48f9233f19514b537e30b013e09a7d9f7a9f48"
+  "gitHead": "16509d9abd2da2f52587972c863c79ba9e4cd49d"
 }

package/src/pages/admin/products/vendors/create.tsx

@@ -5,23 +5,21 @@ import { AddOutlined } from '@mui/icons-material';
 import {
   Button,
   CircularProgress,
-  Stack,
-  TextField,
-  FormControlLabel,
-  Switch,
   FormControl,
+  FormControlLabel,
   InputLabel,
-  Select,
   MenuItem,
+  Select,
+  Stack,
+  Switch,
+  TextField,
 } from '@mui/material';
 import { useState } from 'react';
-import { useForm, Controller, FormProvider } from 'react-hook-form';
+import { Controller, FormProvider, useForm } from 'react-hook-form';
 import { dispatch } from 'use-bus';
 
-import { joinURL, withQuery } from 'ufo';
 import DrawerForm from '../../../../components/drawer-form';
 import MetadataForm from '../../../../components/metadata/form';
-import { formatProxyUrl } from '../../../../libs/util';
 
 interface Vendor {
   id: string;
@@ -84,8 +82,6 @@ export default function VendorCreate({
         app_url: '',
         status: 'inactive' as const,
         metadata: [{ key: 'blockletMetaUrl', value: '' }],
-        app_pid: '',
-        app_logo: '',
       };
 
   const methods = useForm<VendorFormData>({
@@ -147,36 +143,6 @@ export default function VendorCreate({
         metadata: metadataObj,
       };
 
-      // 如果状态为启用，则检测应用地址可用性
-      if (submitData.status === 'active') {
-        try {
-          const response = await fetch(
-            formatProxyUrl(withQuery(joinURL(submitData.app_url, '__blocklet__.js'), { type: 'json' })),
-            {
-              method: 'GET',
-              headers: { 'Content-Type': 'application/json' },
-            }
-          );
-
-          if (!response.ok) {
-            Toast.error(t('admin.vendor.addressCheckFailed'));
-            setLoading(false);
-            return;
-          }
-
-          // 从响应中获取appPid和appLogo
-          const blockletInfo = await response.json();
-          if (blockletInfo) {
-            submitData.app_pid = blockletInfo.pid || blockletInfo.appPid;
-            submitData.app_logo = blockletInfo.logo || blockletInfo.appLogo;
-          }
-        } catch (error) {
-          Toast.error(t('admin.vendor.addressCheckFailed'));
-          setLoading(false);
-          return;
-        }
-      }
-
       if (isEditMode && vendorData) {
         // 编辑模式：更新供应商
         await api.put(`/api/vendors/${vendorData.id}`, submitData);

package/src/pages/admin/products/vendors/index.tsx

@@ -6,6 +6,7 @@ import { ContentCopy } from '@mui/icons-material';
 import { Box, Chip, CircularProgress, IconButton, Tooltip, Typography } from '@mui/material';
 import { useEffect, useState } from 'react';
 import useBus from 'use-bus';
+import omit from 'lodash/omit';
 
 import { useLocalStorageState } from 'ahooks';
 import FilterToolbar from '../../../../components/filter-toolbar';
@@ -320,7 +321,10 @@ export default function VendorsList() {
             setSelectedVendor(null);
             refresh();
           }}
-          vendorData={selectedVendor}
+          vendorData={{
+            ...selectedVendor,
+            metadata: omit(selectedVendor?.metadata || {}, 'mountPoint'),
+          }}
         />
       )}
     </>