@byted-apaas/server-sdk-node 1.1.16 → 1.1.17-beta.2

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

@@ -411,8 +411,11 @@ class _KQuery {
             });
         }
         else {
-            const criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
-            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), false, this.authType);
+            let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
+            if (queryBuilder.getLogic().logics.length > 0) {
+                criterion = await (0, logic_1.handleCriterion)(criterion);
+            }
+            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, criterion, queryBuilder.fuzzySearch, queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), false, this.authType);
         }
     }
     ;
@@ -437,7 +440,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 +451,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 +477,20 @@ class _KQuery {
             selectFields = queryBuilder.getSelect();
         }
         let maxId = 0, queryCount = 0;
+        let criterionV2;
+        let criterion;
+        if (appCtx) {
+            criterionV2 = (0, logicV2_1.buildCriterionV2)(queryV2.filter);
+        }
+        else {
+            criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
+            if (queryBuilder.getLogic().logics.length > 0) { // 有自定义搜索条件时，需要获取 fields
+                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 +498,24 @@ 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 });
+                criterionV2.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);
+                // 添加 _id>maxId 条件
+                criterion = (0, logic_1.addIDCriterion)(criterion, apiName, maxId);
+                // 发起请求
+                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 +529,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 +558,50 @@ 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);
+        }
+        else {
+            criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
+            if (queryBuilder.getLogic().logics.length > 0) {
+                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 });
+                criterionV2.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);
+                // 添加 _id>maxId 条件
+                criterion = (0, logic_1.addIDCriterion)(criterion, apiName, maxId);
+                // 发起请求
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, criterion, queryBuilder.fuzzySearch, orders, false, selectFields, i, newLimit, false, this.authType);
             }
             queryCount += rs.length;
             try {
@@ -582,7 +612,7 @@ class _KQuery {
             catch (err) {
                 throw err;
             }
-            if (rs.length < queryBuilder_1.defaultLimit) {
+            if (rs.length < pageLimit) {
                 break;
             }
         }
@@ -608,8 +638,12 @@ class _KQuery {
                 });
             }
             else {
-                let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName, maxId);
-                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), null, // FindAll 不再迭代
+                let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
+                if (queryBuilder.getLogic().logics.length > 0) {
+                    criterion = await (0, logic_1.handleCriterion)(criterion);
+                }
+                criterion = (0, logic_1.addIDCriterion)(criterion, apiName, maxId);
+                rs = await Request.GetInstance().getRecordsOrCountByCriterion(apiName, criterion, null, // FindAll 不再迭代
                 [new order_1.Order('_id', 'asc')], false, queryBuilder.getSelect(), 0, queryBuilder_1.defaultLimit, false, this.authType);
             }
             rs.forEach((r) => {
@@ -742,7 +776,10 @@ class _KQuery {
         }
         else {
             let criterion = (0, logic_1.buildCriterion)(queryBuilder.getLogic(), apiName);
-            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, await (0, logic_1.handleCriterion)(criterion), queryBuilder.fuzzySearch, queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), true, this.authType);
+            if (queryBuilder.getLogic().logics.length > 0) {
+                criterion = await (0, logic_1.handleCriterion)(criterion);
+            }
+            return await Request.GetInstance().getRecordsOrCountByCriterion(apiName, criterion, queryBuilder.fuzzySearch, queryBuilder.getOrder(), false, queryBuilder.getSelect(), queryBuilder.getOffset(), queryBuilder.getLimit(), true, this.authType);
         }
     }
     ;

package/kunlun/operator/impl/logic.d.ts

@@ -24,8 +24,16 @@ export type Criterion = {
  * @param objectApiName
  * @param maxId 添加 _id>maxId 条件，为 -1 表示不使用该参数
  */
-export declare function buildCriterion(logic: Logic, objectApiName: string, maxId?: number): Criterion | string;
+export declare function buildCriterion(logic: Logic, objectApiName: string): Criterion;
 export declare function buildExpression(objectApiName: string, left: string, right: Condition | UserDataType, index?: number): Expression;
+/**
+ * 在 criterion 中添加 _id>maxId 的判断条件
+ *
+ * @param criterion
+ * @param apiName
+ * @param maxId 添加 _id>maxId 条件
+ */
+export declare function addIDCriterion(criterion: Criterion, apiName: string, maxId: number): Criterion;
 export declare class Logic {
     value: string;
     expressions: {
@@ -47,4 +55,4 @@ export declare class Logic {
     addLogic(logic: Logic): void;
 }
 export declare function buildLogic(param: (Logic | object)[], logicValue?: string): Logic;
-export declare function handleCriterion(criterion: string | Criterion): Promise<string | Criterion>;
+export declare function handleCriterion(criterion: Criterion): Promise<Criterion>;

package/kunlun/operator/impl/logic.js

@@ -2,7 +2,7 @@
 // Copyright 2022 ByteDance Ltd. and/or its affiliates
 // SPDX-License-Identifier: MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleCriterion = exports.buildLogic = exports.Logic = exports.buildExpression = exports.buildCriterion = exports.Condition = void 0;
+exports.handleCriterion = exports.buildLogic = exports.Logic = exports.addIDCriterion = exports.buildExpression = exports.buildCriterion = exports.Condition = void 0;
 const expression_1 = require("./expression");
 const operator_1 = require("./operator");
 const server_common_node_1 = require("@byted-apaas/server-common-node");
@@ -59,7 +59,7 @@ function isKunlunTypeOrSerializedObject(obj) {
  * @param objectApiName
  * @param maxId 添加 _id>maxId 条件，为 -1 表示不使用该参数
  */
-function buildCriterion(logic, objectApiName, maxId = -1) {
+function buildCriterion(logic, objectApiName) {
     let index = 0;
     let logics = [];
     let expressions = [];
@@ -117,18 +117,9 @@ function buildCriterion(logic, objectApiName, maxId = -1) {
     f(logic);
     // 如果未设置filter，默认添加: _isDeleted = false
     if (expressions.length < 1) {
-        if (maxId >= 0) {
-            return `{"conditions":[{"index":1,"left":{"type":"metadataVariable","settings":{"fieldPath":
-            [{"objectApiName":"${objectApiName}","fieldApiName":"_isDeleted"}]}},"operator":"equals","right":
-            {"type":"constant","settings":{"data":false}}},{"index":2,"left":{"type":"metadataVariable","settings":
-            {"fieldPath":[{"objectApiName":"${objectApiName}","fieldApiName":"_id"}]}},"operator":"greaterThan","right":
-            {"type":"constant","settings":{"data":${maxId}}}}],"logic":"1 and 2"}`;
-        }
-        else {
-            return `{"conditions":[{"index":1,"left":{"type":"metadataVariable","settings":{"fieldPath":
-            [{"objectApiName":"${objectApiName}","fieldApiName":"_isDeleted"}]}},"operator":"equals","right":
-            {"type":"constant","settings":{"data":false}}}],"logic":"1"}`;
-        }
+        expressions.push(buildExpression(objectApiName, '_isDeleted', false, expressions.length + 1));
+        logics.push('1');
+        return { conditions: expressions, logic: logics.join('') };
     }
     let isContainDeleted = false;
     for (let i = 0; i < expressions.length; i++) {
@@ -148,11 +139,6 @@ function buildCriterion(logic, objectApiName, maxId = -1) {
         logics.splice(0, 0, '(');
         logics.push(' and ', `${expressions.length}`, ')');
     }
-    if (maxId >= 0) {
-        expressions.push(buildExpression(objectApiName, '_id', new Condition('_id', maxId, operator_1.operates.GT), expressions.length + 1));
-        logics.splice(0, 0, '(');
-        logics.push(' and ', `${expressions.length}`, ')');
-    }
     return { conditions: expressions, logic: logics.join('') };
 }
 exports.buildCriterion = buildCriterion;
@@ -183,6 +169,22 @@ function buildExpression(objectApiName, left, right, index = 1) {
     return null;
 }
 exports.buildExpression = buildExpression;
+/**
+ * 在 criterion 中添加 _id>maxId 的判断条件
+ *
+ * @param criterion
+ * @param apiName
+ * @param maxId 添加 _id>maxId 条件
+ */
+function addIDCriterion(criterion, apiName, maxId) {
+    criterion.conditions.push(buildExpression(apiName, '_id', new Condition('_id', maxId, operator_1.operates.GT), criterion.conditions.length + 1));
+    let logics = criterion.logic.split('');
+    logics.splice(0, 0, '(');
+    logics.push(' and ', `${criterion.conditions.length}`, ')');
+    criterion.logic = logics.join('');
+    return criterion;
+}
+exports.addIDCriterion = addIDCriterion;
 // 逻辑操作：and 和 or
 class Logic {
     constructor(expressions = null, logicValue = 'and') {
@@ -339,9 +341,6 @@ class Filter {
     }
 }
 async function handleCriterion(criterion) {
-    if (typeof criterion === 'string') {
-        return criterion;
-    }
     if (!criterion || !criterion.conditions || !(criterion.conditions instanceof Array)) {
         return criterion;
     }
@@ -355,7 +354,7 @@ async function handleCriterion(criterion) {
         }
         await handleCondition(condition, fieldRes);
     }
-    return JSON.stringify(criterion);
+    return criterion;
 }
 exports.handleCriterion = handleCriterion;
 async function handleLookupCondition(conditions) {
@@ -376,6 +375,7 @@ async function handleLookupCondition(conditions) {
     let lookupMap = new Map(), dateSet = new Set();
     let firstObjApiName = conditions[0].left.settings.fieldPath[0].objectApiName;
     let fields = [];
+    // 获取对象的字段
     if (queryMap.size === 1) {
         fields.push(await Request.GetInstance().getField(firstObjApiName, fieldName));
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.1.16",
+  "version": "1.1.17-beta.2",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",

package/request/openapi.js

@@ -296,9 +296,12 @@ async function getRecordsOrCountByCriterion(objectApiName, criterion, fuzzySearc
     if (needCount) {
         fieldApiNames = ['_id'];
     }
+    if (typeof criterion === 'string') {
+        criterion = JSON.parse(criterion);
+    }
     // 3.请求
     options.json = {
-        'criterion': JSON.parse(criterion),
+        'criterion': criterion,
         order,
         'ignore_back_lookup_field': ignoreBackLookupField,
         'field_api_names': fieldApiNames,