payment-kit 1.16.1 → 1.16.2

package/api/src/crons/index.ts

@@ -8,6 +8,7 @@ import {
 } from '../integrations/stripe/resource';
 import {
   expiredSessionCleanupCronTime,
+  meteringSubscriptionDetectionCronTime,
   notificationCronTime,
   paymentStatCronTime,
   revokeStakeCronTime,
@@ -23,6 +24,7 @@ import { createPaymentStat } from './payment-stat';
 import { SubscriptionTrialWillEndSchedule } from './subscription-trial-will-end';
 import { SubscriptionWillCanceledSchedule } from './subscription-will-canceled';
 import { SubscriptionWillRenewSchedule } from './subscription-will-renew';
+import { createMeteringSubscriptionDetection } from './metering-subscription-detection';
 
 function init() {
   Cron.init({
@@ -91,6 +93,12 @@ function init() {
         fn: () => createPaymentStat(),
         options: { runOnInit: false },
       },
+      {
+        name: 'metering.subscription.detection',
+        time: meteringSubscriptionDetectionCronTime,
+        fn: () => createMeteringSubscriptionDetection(),
+        options: { runOnInit: false },
+      },
     ],
     onError: (error: Error, name: string) => {
       logger.error('run job failed', { name, error });

package/api/src/crons/metering-subscription-detection.ts

@@ -0,0 +1,207 @@
+import { Notification } from '@blocklet/sdk';
+import { Op } from 'sequelize';
+import { env } from '@blocklet/sdk/lib/config';
+import dayjs from '../libs/dayjs';
+import logger from '../libs/logger';
+import { Event, Invoice, InvoiceItem, Price, Subscription } from '../store/models';
+import { getAdminBillingSubscriptionsUrl, getOwnerDid } from '../libs/util';
+import { translate } from '../locales';
+import type { BaseEmailTemplate, BaseEmailTemplateType } from '../libs/notification/template/base';
+import { getUserLocale } from '../integrations/blocklet/notification';
+import { formatTime } from '../libs/time';
+
+function getAppName() {
+  return env.appName;
+}
+interface SubscriptionSummary {
+  totalCount: number;
+  unreportedCount: number;
+  discrepantCount: number;
+  abnormalSubscriptions: Array<Subscription>;
+  normalCount: number;
+  timeRange: {
+    start: number;
+    end: number;
+  };
+}
+
+interface MeteringSubscriptionDetectionContext {
+  locale: string;
+  userDid: string;
+  summary: SubscriptionSummary;
+  startTimeStr: string;
+  endTimeStr: string;
+  viewAppUrl: string;
+}
+
+export class MeteringSubscriptionDetectionTemplate implements BaseEmailTemplate<MeteringSubscriptionDetectionContext> {
+  private timeRange: { start: number; end: number };
+
+  constructor() {
+    const end = dayjs();
+    const start = end.subtract(24, 'hours');
+    this.timeRange = {
+      start: start.unix(),
+      end: end.unix(),
+    };
+  }
+
+  private async getAbnormalSubscriptions(meteringInvoiceIds: string[], meteringSubscriptionIds: string[]) {
+    const [unreportedEvents, discrepantEvents] = await Promise.all([
+      Event.findAll({
+        where: {
+          type: 'usage.report.empty',
+          created_at: {
+            [Op.between]: [this.timeRange.start * 1000, this.timeRange.end * 1000],
+          },
+          object_id: {
+            [Op.in]: meteringSubscriptionIds,
+          },
+        },
+      }),
+      Event.findAll({
+        where: {
+          type: 'billing.discrepancy',
+          created_at: {
+            [Op.between]: [this.timeRange.start * 1000, this.timeRange.end * 1000],
+          },
+          object_id: {
+            [Op.in]: meteringInvoiceIds,
+          },
+        },
+      }),
+    ]);
+
+    const abnormalSubscriptionIds = new Set([
+      ...unreportedEvents.map((e) => e.object_id),
+      ...discrepantEvents.map((e) => e.data?.object?.subscription_id),
+    ]);
+
+    const unreportedSubscriptionIds = Array.from(new Set(unreportedEvents.map((e) => e.object_id)));
+    const discrepantSubscriptionIds = Array.from(new Set(discrepantEvents.map((e) => e.data?.object?.subscription_id)));
+    const subscriptions = await Subscription.findAll({
+      where: {
+        id: Array.from(abnormalSubscriptionIds),
+      },
+    });
+
+    return {
+      unreported: unreportedSubscriptionIds,
+      discrepant: discrepantSubscriptionIds,
+      subscriptions,
+    };
+  }
+
+  async getContext(): Promise<MeteringSubscriptionDetectionContext> {
+    const { start, end } = this.timeRange;
+    const invoices = await Invoice.findAll({
+      where: {
+        created_at: {
+          [Op.between]: [start * 1000, end * 1000],
+        },
+        billing_reason: {
+          [Op.notIn]: ['stake', 'slash_stake', 'recharge'],
+        },
+      },
+      include: [
+        { model: Subscription, as: 'subscription' },
+        { model: InvoiceItem, as: 'lines' },
+      ],
+    });
+
+    const meteringInvoices: any[] = [];
+    await Promise.all(
+      invoices.map(async (invoice) => {
+        const invoiceJson = invoice.toJSON();
+        const prices = (await Price.findAll()).map((x) => x.toJSON());
+        // @ts-ignore
+        (invoiceJson.lines || []).forEach((item) => {
+          item.price = prices.find((x) => x.id === item.price_id);
+        });
+        // @ts-ignore
+        if ((invoiceJson.lines || []).some((line) => line.price?.recurring?.usage_type === 'metered')) {
+          meteringInvoices.push(invoice);
+        }
+      })
+    );
+    const meteringInvoiceIds = meteringInvoices.map((invoice) => invoice.id);
+    const meteringSubscriptionIds = meteringInvoices
+      .map((invoice) => invoice?.subscription_id)
+      .filter(Boolean) as string[];
+
+    const abnormalSubscriptions = await this.getAbnormalSubscriptions(meteringInvoiceIds, meteringSubscriptionIds);
+    const userDid = await getOwnerDid();
+    if (!userDid) {
+      throw new Error('get owner did failed');
+    }
+    const locale = await getUserLocale(userDid);
+
+    const viewAppUrl = getAdminBillingSubscriptionsUrl({ locale, userDid });
+    return {
+      locale,
+      userDid,
+      summary: {
+        totalCount: meteringInvoices.length,
+        normalCount: Math.max(0, meteringSubscriptionIds.length - abnormalSubscriptions.subscriptions.length),
+        unreportedCount: abnormalSubscriptions.unreported.length,
+        discrepantCount: abnormalSubscriptions.discrepant.length,
+        abnormalSubscriptions: abnormalSubscriptions.subscriptions,
+        timeRange: this.timeRange,
+      },
+      startTimeStr: formatTime(this.timeRange.start * 1000),
+      endTimeStr: formatTime(this.timeRange.end * 1000),
+      viewAppUrl,
+    };
+  }
+
+  async getTemplate(): Promise<BaseEmailTemplateType> {
+    const context = await this.getContext();
+    // @ts-ignore
+    const { locale, summary, startTimeStr, endTimeStr, viewAppUrl } = context;
+    const body =
+      summary.abnormalSubscriptions.length === 0
+        ? translate('notification.meteringSubscriptionDetection.healthyBody', locale, {
+            totalCount: summary.totalCount,
+            startTimeStr,
+            endTimeStr,
+          })
+        : `${translate('notification.meteringSubscriptionDetection.body', locale, {
+            totalCount: summary.totalCount,
+            startTimeStr,
+            endTimeStr,
+            normalCount: summary.normalCount,
+            abnormalCount: summary.abnormalSubscriptions.length,
+            unreportedCount: summary.unreportedCount,
+            discrepantCount: summary.discrepantCount,
+          })}\n${summary.abnormalSubscriptions.map((sub) => `${sub.description}（${sub.id}）`).join('\n')}`;
+    return {
+      title: translate('notification.meteringSubscriptionDetection.title', locale, {
+        appName: getAppName(),
+      }),
+      body,
+      // @ts-ignore
+      actions: [
+        viewAppUrl && {
+          name: translate('notification.meteringSubscriptionDetection.view', locale),
+          title: translate('notification.meteringSubscriptionDetection.view', locale),
+          link: viewAppUrl,
+        },
+      ].filter(Boolean),
+    };
+  }
+}
+
+export async function createMeteringSubscriptionDetection() {
+  logger.info('Start metering subscription detection');
+
+  try {
+    const template = new MeteringSubscriptionDetectionTemplate();
+    const context = await template.getContext();
+    const notification = await template.getTemplate();
+
+    await Notification.sendToUser(context.userDid, notification as any);
+    logger.info('Metering subscription detection created', context);
+  } catch (error) {
+    logger.error('Failed to create metering subscription detection', error);
+  }
+}

package/api/src/libs/env.ts

@@ -10,6 +10,8 @@ export const stripePaymentCronTime: string = process.env.STRIPE_PAYMENT_CRON_TIM
 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 const meteringSubscriptionDetectionCronTime: string =
+  process.env.METERING_SUBSCRIPTION_DETECTION_CRON_TIME || '0 0 10 * * *'; // 默认每天 10:00 执行
 
 export default {
   ...env,

package/api/src/libs/util.ts

@@ -336,3 +336,19 @@ export function getSubscriptionNotificationCustomActions(
     link: x?.link,
   }));
 }
+
+export function getAdminBillingSubscriptionsUrl({ locale, userDid }: { locale: string; userDid: string }) {
+  return getUrl(withQuery('admin/billing/subscriptions', { locale, ...getConnectQueryParam({ userDid }) }));
+}
+
+export function getAdminBillingSubscriptionUrl({
+  locale,
+  userDid,
+  subscriptionId,
+}: {
+  locale: string;
+  userDid: string;
+  subscriptionId: string;
+}) {
+  return getUrl(withQuery(`admin/billing/${subscriptionId}`, { locale, ...getConnectQueryParam({ userDid }) }));
+}

package/api/src/locales/en.ts

@@ -66,6 +66,14 @@ export default flat({
       body: 'No usage report for {productName} detected, please check.',
     },
 
+    meteringSubscriptionDetection: {
+      title: '[{appName}] Metering subscription detection',
+      body: 'During {startTimeStr} - {endTimeStr}, a total of {totalCount} subscriptions with usage-based billing were scanned. \nOut of these, {normalCount} were normal, while {abnormalCount} had anomalies, including {unreportedCount} unreported subscriptions and {discrepantCount} with billing discrepancies. \n\n Abnormal subscriptions:',
+      healthyBody:
+        'During {startTimeStr} - {endTimeStr}, a total of {totalCount} subscriptions with usage-based billing were scanned, and all subscriptions were normal.',
+      view: 'Manage subscriptions',
+    },
+
     subscriptionTrialStart: {
       title: 'Welcome to the start of your {productName} trial',
       body: 'Congratulations on your {productName} trial! The length of the trial is {trialDuration} and will end at {subscriptionTrialEnd}. Have fun with {productName}!',

package/api/src/locales/zh.ts

@@ -66,6 +66,13 @@ export default flat({
       body: '检测到 {productName} 账单金额核算不一致，请留意。',
     },
 
+    meteringSubscriptionDetection: {
+      title: '[{appName}] 按量计费订阅检测',
+      body: '在 {startTimeStr} - {endTimeStr} 期间，共扫描了 {totalCount} 份按量计费的订阅，其中 {normalCount} 份为正常订阅，{abnormalCount} 份存在异常，包括 {unreportedCount} 份未上报的订阅和 {discrepantCount} 份账单核算有问题的订阅。\n\n 异常订阅:',
+      healthyBody: '在 {startTimeStr} - {endTimeStr} 期间，共扫描了 {totalCount} 份按量计费的订阅，且所有订阅均正常。',
+      view: '管理订阅',
+    },
+
     subscriptionTrialStart: {
       title: '欢迎开始您的 {productName} 试用之旅',
       body: '恭喜您获得了 {productName} 的试用资格！试用期时长为 {trialDuration}，将于 {subscriptionTrialEnd} 结束。祝您使用愉快！',

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.16.1",
+  "version": "1.16.2",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -9,7 +9,7 @@
     "format": "prettier -w src",
     "test": "node scripts/jest.js",
     "coverage": "npm run test -- --coverage",
-    "start": "vite-node -c vite-server.config.ts -w api/dev.ts",
+    "start": "tsx watch api/dev.ts",
     "clean": "node scripts/build-clean.js",
     "bundle": "tsc --noEmit && npm run bundle:client && npm run bundle:api",
     "bundle:client": "vite build",
@@ -44,29 +44,29 @@
   },
   "dependencies": {
     "@abtnode/cron": "1.16.33-beta-20241031-073543-49b1ff9b",
-    "@arcblock/did": "^1.18.139",
+    "@arcblock/did": "^1.18.147",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@arcblock/did-connect": "^2.10.65",
-    "@arcblock/did-util": "^1.18.139",
-    "@arcblock/jwt": "^1.18.139",
-    "@arcblock/ux": "^2.10.65",
-    "@arcblock/validator": "^1.18.139",
+    "@arcblock/did-connect": "^2.10.67",
+    "@arcblock/did-util": "^1.18.147",
+    "@arcblock/jwt": "^1.18.147",
+    "@arcblock/ux": "^2.10.67",
+    "@arcblock/validator": "^1.18.147",
     "@blocklet/js-sdk": "1.16.33-beta-20241031-073543-49b1ff9b",
     "@blocklet/logger": "1.16.33-beta-20241031-073543-49b1ff9b",
-    "@blocklet/payment-react": "1.16.1",
+    "@blocklet/payment-react": "1.16.2",
     "@blocklet/sdk": "1.16.33-beta-20241031-073543-49b1ff9b",
-    "@blocklet/ui-react": "^2.10.65",
-    "@blocklet/uploader": "^0.1.51",
+    "@blocklet/ui-react": "^2.10.67",
+    "@blocklet/uploader": "^0.1.52",
     "@blocklet/xss": "^0.1.12",
     "@mui/icons-material": "^5.16.6",
     "@mui/lab": "^5.0.0-alpha.173",
     "@mui/material": "^5.16.6",
     "@mui/system": "^5.16.6",
-    "@ocap/asset": "^1.18.139",
-    "@ocap/client": "^1.18.139",
-    "@ocap/mcrypto": "^1.18.139",
-    "@ocap/util": "^1.18.139",
-    "@ocap/wallet": "^1.18.139",
+    "@ocap/asset": "^1.18.147",
+    "@ocap/client": "^1.18.147",
+    "@ocap/mcrypto": "^1.18.147",
+    "@ocap/util": "^1.18.147",
+    "@ocap/wallet": "^1.18.147",
     "@stripe/react-stripe-js": "^2.7.3",
     "@stripe/stripe-js": "^2.4.0",
     "ahooks": "^3.8.0",
@@ -120,7 +120,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.33-beta-20241031-073543-49b1ff9b",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.16.1",
+    "@blocklet/payment-types": "1.16.2",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -144,12 +144,13 @@
     "rollup-plugin-visualizer": "^5.12.0",
     "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
+    "tsx": "^4.19.2",
     "type-fest": "^4.23.0",
     "typescript": "^4.9.5",
     "vite": "^5.3.5",
     "vite-node": "^2.0.4",
     "vite-plugin-babel-import": "^2.0.5",
-    "vite-plugin-blocklet": "^0.9.12",
+    "vite-plugin-blocklet": "^0.9.13",
     "vite-plugin-node-polyfills": "^0.21.0",
     "vite-plugin-svgr": "^4.2.0",
     "vite-tsconfig-paths": "^4.3.2",
@@ -165,5 +166,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "590597d056e31eafd2b8ebd2a9d0a0c236c33440"
+  "gitHead": "63c0ef382409afb79f595f82ea5e9bb9f264b844"
 }

package/src/components/copyable.tsx

@@ -2,10 +2,18 @@ import { CopyButton } from '@arcblock/ux/lib/ClickToCopy';
 import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
 import { getWordBreakStyle } from '@blocklet/payment-react';
 import { Box, Stack, Typography } from '@mui/material';
+import type { ReactNode } from 'react';
 
-export default function Copyable({ text, children, style }: { text: string; children?: React.ReactNode; style?: any }) {
+interface CopyableProps {
+  text: string;
+  children?: ReactNode;
+  style?: React.CSSProperties;
+}
+export default function Copyable({ text, children, style }: CopyableProps) {
   const { locale } = useLocaleContext();
   return (
+    /* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
+    // @ts-ignore
     <CopyButton
       showTooltip={false}
       content={text}
@@ -20,10 +28,6 @@ export default function Copyable({ text, children, style }: { text: string; chil
               sx={{
                 mr: 0.5,
                 maxWidth: 480,
-                // overflow: 'hidden',
-                // fontSize: 'inherit',
-                // textOverflow: 'ellipsis',
-                // whiteSpace: 'nowrap',
                 wordBreak: getWordBreakStyle(text),
                 whiteSpace: 'break-spaces',
                 minWidth: '60px',