@byted-apaas/server-sdk-node 1.1.15 → 1.1.17-beta.1

package/context/db/impl/IObject.d.ts

@@ -163,6 +163,21 @@ export interface _IKQuery<T> {
      * ```
      */
     findStream(handler: (records: object[]) => Promise<void>): Promise<void>;
+    /**
+     * 遍历全部符合条件的记录
+     * 注：
+     *   如果未设置排序字段，默认以 _id 增序查询；
+     *   如果有设置排序字段，必须设置具有唯一属性的字段，否则会有数据重复的风险；
+     * @param handler 业务处理函数
+     * @param pageLimit 分页查询的数量
+     * @example
+     * ```
+     * await application.data.object('_user').findStream(async (records) => {
+     *     // doSomething ...
+     * }, 300);
+     * ```
+     */
+    findStream(handler: (records: object[]) => Promise<void>, pageLimit: number): Promise<void>;
     /**
      * 无需入参，返回符合条件的记录，单次返回 200 条
      * @example

package/context/db/impl/object.js

@@ -437,7 +437,7 @@ class _KQuery {
         return await this.getRecordsByPage();
     }
     ;
-    async findStream(handler) {
+    async findStream(handler, pageLimit) {
         const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
         let offset = 0, orders = [];
         if (queryV2) {
@@ -448,14 +448,17 @@ class _KQuery {
             offset = queryBuilder.getOffset();
             orders = queryBuilder.getOrder();
         }
+        if (pageLimit == 0) {
+            pageLimit = queryBuilder_1.defaultLimit;
+        }
         if (orders.length === 0 && offset === 0) {
             // 走主键翻页
-            return await this.walkRecordsByID(handler);
+            return await this.walkRecordsByID(handler, pageLimit);
         }
         // 走 limit offset 翻页
-        return await this.walkRecordsByLimitOffset(handler);
+        return await this.walkRecordsByLimitOffset(handler, pageLimit);
     }
-    async walkRecordsByID(handler) {
+    async walkRecordsByID(handler, pageLimit) {
         const { apiName, appCtx, queryBuilder, queryV2 } = queryPropertiesStore.get(this);
         let limit = 0, selectFields = [];
         if (queryV2) {
@@ -471,9 +474,19 @@ class _KQuery {
             selectFields = queryBuilder.getSelect();
         }
         let maxId = 0, queryCount = 0;
+        let criterionV2;
+        let criterion;
+        if (appCtx) {
+            criterionV2 = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
+            criterionV2.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
+        }
+        else {
+            criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
+            criterion = await (0, logic_1.handleCriterion)(criterion);
+        }
         while (true) {
-            let newLimit = queryBuilder_1.defaultLimit;
-            if (limit > 0 && limit - queryCount < queryBuilder_1.defaultLimit) {
+            let newLimit = pageLimit;
+            if (limit > 0 && limit - queryCount < pageLimit) {
                 newLimit = limit - queryCount;
             }
             if (newLimit <= 0) {
@@ -481,23 +494,20 @@ class _KQuery {
             }
             let rs;
             if (appCtx) {
-                let criterion = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
-                criterion.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
                 const param = {
                     limit: newLimit,
                     offset: 0,
                     sort: [{ field: '_id', direction: 'asc', type: '' }],
                     fields: selectFields,
                     count: false,
-                    filter: criterion,
+                    filter: criterionV2,
                 };
                 rs = await (0, common_1.runCtxForOpenSDK)(appCtx, async () => {
                     return await Request.GetInstance().openSDKGetRecords(apiName, param);
                 });
             }
             else {
-                let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
-                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, [new order_1.Order('_id', 'asc')], false, queryBuilder.getSelect(), 0, newLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, criterion, queryBuilder.fuzzySearch, [new order_1.Order('_id', 'asc')], false, queryBuilder.getSelect(), 0, newLimit, false, this.authType);
             }
             queryCount += rs.length;
             rs.forEach((r) => {
@@ -511,12 +521,12 @@ class _KQuery {
             catch (err) {
                 throw err;
             }
-            if (rs.length < queryBuilder_1.defaultLimit) {
+            if (rs.length < pageLimit) {
                 break;
             }
         }
     }
-    async walkRecordsByLimitOffset(handler) {
+    async walkRecordsByLimitOffset(handler, pageLimit) {
         const { apiName, appCtx, queryBuilder, queryV2 } = queryPropertiesStore.get(this);
         let limit = 0, offset = 0, selectFields = [], orders = [];
         if (queryV2) {
@@ -540,38 +550,45 @@ class _KQuery {
             orders = [{ field: '_id', direction: 'asc', type: '' }];
         }
         let maxId = 0, queryCount = 0;
-        for (let i = offset; !limit || i < offset + limit; i += queryBuilder_1.defaultLimit) {
+        let criterionV2;
+        let criterion;
+        if (appCtx) {
+            criterionV2 = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
+            criterionV2.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
+        }
+        else {
+            criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
+            criterion = await (0, logic_1.handleCriterion)(criterion);
+        }
+        for (let i = offset; !limit || i < offset + limit; i += pageLimit) {
             let newLimit = function () {
                 if (limit == 0) {
-                    return queryBuilder_1.defaultLimit;
+                    return pageLimit;
                 }
-                if (offset + limit - i < queryBuilder_1.defaultLimit) {
+                if (offset + limit - i < pageLimit) {
                     return offset + limit - i;
                 }
-                return queryBuilder_1.defaultLimit;
+                return pageLimit;
             }();
             if (newLimit <= 0) {
                 break;
             }
             let rs;
             if (appCtx) {
-                let criterion = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
-                criterion.push({ leftValue: '_id', operator: operator_1.operates.GT, rightValue: maxId });
                 const param = {
                     limit: newLimit,
                     offset: i,
                     sort: orders,
                     fields: selectFields,
                     count: false,
-                    filter: criterion,
+                    filter: criterionV2,
                 };
                 rs = await (0, common_1.runCtxForOpenSDK)(appCtx, async () => {
                     return await Request.GetInstance().openSDKGetRecords(apiName, param);
                 });
             }
             else {
-                let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
-                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, orders, false, selectFields, i, newLimit, false, this.authType);
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, criterion, queryBuilder.fuzzySearch, orders, false, selectFields, i, newLimit, false, this.authType);
             }
             queryCount += rs.length;
             try {
@@ -582,7 +599,7 @@ class _KQuery {
             catch (err) {
                 throw err;
             }
-            if (rs.length < queryBuilder_1.defaultLimit) {
+            if (rs.length < pageLimit) {
                 break;
             }
         }

package/global/application/flow/flow.d.ts

@@ -1,5 +1,5 @@
 import { IApprovalInstance, IApprovalInstanceListOptions, IApprovalInstanceList, IGetApprovalInstanceOptions } from '../../../request/structs';
-export declare function NewFlow(): Flow;
+export declare function newFlow(context: any): Flow;
 export interface Flow {
     /**
      * 获取流程实例人工任务详情列表

package/global/application/flow/flow.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NewFlow = void 0;
+exports.newFlow = void 0;
 const flow_1 = require("./impl/flow");
-function NewFlow() {
-    return new flow_1.Flow();
+function newFlow(context) {
+    return new flow_1.Flow(context?.flow);
 }
-exports.NewFlow = NewFlow;
+exports.newFlow = newFlow;

package/global/application/flow/impl/flow.d.ts

@@ -1,6 +1,16 @@
-import { Flow as IFlow, ExecuteOptions, ExecutionResult, ExecutionInfo, FlowTaskInfo, RevokeExecutionOptions } from '../flow';
+import { Flow as IFlow, ExecuteOptions, ExecutionResult, ExecutionInfo, FlowTaskInfo, RevokeExecutionOptions, Execution } from '../flow';
 import { IApprovalInstance, IApprovalInstanceList, IApprovalInstanceListOptions, IGetApprovalInstanceOptions } from "../../../../request/structs";
 export declare class Flow implements IFlow {
+    execution: Execution;
+    /**
+    * 工作流的 API name
+    */
+    apiName: string;
+    /**
+     * 工作流实例的 ID
+     */
+    instanceId: number;
+    constructor(flowParams: any);
     execute(APIName: string, options: ExecuteOptions | undefined): Promise<ExecutionResult>;
     getExecutionInfo(executionId: number): Promise<ExecutionInfo>;
     getExecutionUserTaskInfo(executionId: number): Promise<FlowTaskInfo[]>;

package/global/application/flow/impl/flow.js

@@ -5,6 +5,11 @@ const exceptions_1 = require("@byted-apaas/server-common-node/utils/exceptions")
 const Request = require("../../../../request/interface");
 const server_common_node_1 = require("@byted-apaas/server-common-node");
 class Flow {
+    constructor(flowParams) {
+        this.execution = flowParams?.execution;
+        this.apiName = flowParams?.apiName;
+        this.instanceId = flowParams?.instanceId;
+    }
     async execute(APIName, options) {
         if (!APIName || typeof APIName !== 'string') {
             throw new exceptions_1.InvalidParamError(`param's type (${APIName}) need string, but is ${typeof APIName}`);

package/hooks/hooks.js

@@ -95,7 +95,7 @@ function mountApplication(context) {
     }
     global.application.constants.metaType = metadataApi.metaType();
     // flow
-    global.application.flow = (0, flow_1.NewFlow)();
+    global.application.flow = (0, flow_1.newFlow)(context);
     // operator
     global.application.operator = new operator_1.Operator();
     global.application.integration = new integration_1._Integration();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.15",
+  "version": "1.1.17-beta.1",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -13,7 +13,7 @@
     "clean": "tsc --build --clean && rm -rf **/*.js.map"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "^2.0.4",
+    "@byted-apaas/server-common-node": "^2.0.5",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",