@byted-apaas/server-sdk-node 1.0.2 → 1.0.4

package/application/application.d.ts

@@ -17,6 +17,7 @@ export interface IApplication {
     cloudfunction(funcName: string): IFunction;
     env(platformEnvType: PlatformEnvType): IApplication;
     localDebugMode(): IApplication;
+    setLaneName(laneName: string): IApplication;
 }
 export declare type AppMode = 'openSDK' | 'faasSDK';
 export interface AppCtx {
@@ -24,4 +25,5 @@ export interface AppCtx {
     env?: PlatformEnvType;
     credential: AppCredential;
     debugType?: "0" | "2";
+    x_tt_env?: string;
 }

package/application/impl/common.js

@@ -39,6 +39,7 @@ async function runCtxForOpenSDK(appCtx, promise) {
             }
             utils.setInvokeFuncName("openSDK");
             utils.setTenant(await appCtx.credential.getTenantInfo());
+            utils.setXTTEnvOnlyDebug(appCtx.x_tt_env);
             if (!utils.getLogID()) {
                 utils.setLogID(crypto.randomBytes(16).toString('hex'));
             }

package/application/impl/impl.d.ts

@@ -13,4 +13,5 @@ export declare class Application implements IApplication {
     cloudfunction(funcName: string): IFunction;
     env(platformEnvType: PlatformEnvType): IApplication;
     localDebugMode(): IApplication;
+    setLaneName(laneName: string): IApplication;
 }

package/application/impl/impl.js

@@ -35,5 +35,9 @@ class Application {
         this.appCtx.debugType = "2";
         return this;
     }
+    setLaneName(laneName) {
+        this.appCtx.x_tt_env = laneName;
+        return this;
+    }
 }
 exports.Application = Application;

package/context/db/impl/object.js

@@ -348,6 +348,22 @@ class _KQuery {
     }
     async find() {
         const { apiName, appCtx, queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        // 查询非 _id 字段或者关联对象下钻._id, limit 不允许超过 200
+        let checkLimit;
+        let checkFields;
+        if (queryV2) {
+            checkLimit = queryV2._limit;
+            checkFields = queryV2.fields;
+        }
+        else {
+            checkLimit = queryBuilder.getLimit();
+            checkFields = queryBuilder.getSelect();
+        }
+        if (checkFields.length != 1 || !(checkFields[0] == "_id" || checkFields[0].endsWith("._id"))) {
+            if (checkLimit > 200) {
+                throw new Error(`limit(${checkLimit}) > ${queryBuilder_1.maxLimit}. Limit should be 1~${queryBuilder_1.maxLimitV2} when querying the id field, otherwise it should be 1~${queryBuilder_1.maxLimit}`);
+            }
+        }
         if (appCtx) {
             const param = {
                 limit: queryV2._limit,
@@ -478,14 +494,24 @@ class _KQuery {
         return this;
     }
     limit(limit) {
-        const { queryBuilder } = queryPropertiesStore.get(this);
-        queryBuilder.setLimit(limit);
+        const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        if (queryV2) {
+            queryV2.limit(limit);
+        }
+        else {
+            queryBuilder.setLimit(limit);
+        }
         return this;
     }
     ;
     offset(offset) {
-        const { queryBuilder } = queryPropertiesStore.get(this);
-        queryBuilder.setOffset(offset);
+        const { queryBuilder, queryV2 } = queryPropertiesStore.get(this);
+        if (queryV2) {
+            queryV2.offset(offset);
+        }
+        else {
+            queryBuilder.setOffset(offset);
+        }
         return this;
     }
     ;

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

@@ -1,6 +1,7 @@
 import { Order, OrderType } from './order';
 import { Logic } from '../../../kunlun/operator/impl/logic';
 export declare const maxLimit = 200;
+export declare const maxLimitV2 = 10000;
 /**
  * 查询构造器，在 DB 中被初始化，用于构建一次查询
  */

package/context/db/impl/queryBuilder.js

@@ -2,11 +2,13 @@
 // Copyright 2022 ByteDance Ltd. and/or its affiliates
 // SPDX-License-Identifier: MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueryBuilder = exports.maxLimit = void 0;
+exports.QueryBuilder = exports.maxLimitV2 = exports.maxLimit = void 0;
 const order_1 = require("./order");
 const logic_1 = require("../../../kunlun/operator/impl/logic");
 const server_common_node_1 = require("@byted-apaas/server-common-node");
 exports.maxLimit = 200;
+// 限制开放至 1w，当仅查询 _id 时，最大可返回 1w，其他查询字段时仅返回 200，由底层控制。
+exports.maxLimitV2 = 10000;
 /**
  * 查询构造器，在 DB 中被初始化，用于构建一次查询
  */
@@ -62,9 +64,9 @@ class QueryBuilder {
             // need import exceptions
             throw new server_common_node_1.exceptions.InvalidParamError(`limit(${limit}) < 1`);
         }
-        if (limit > exports.maxLimit) {
+        if (limit > exports.maxLimitV2) {
             // need import exceptions
-            throw new server_common_node_1.exceptions.InvalidParamError(`limit(${limit}) > ${exports.maxLimit}`);
+            throw new server_common_node_1.exceptions.InvalidParamError(`limit(${limit}) > ${exports.maxLimitV2}. Limit should be 1~${exports.maxLimitV2} when querying the id field, otherwise it should be 1~${exports.maxLimit}`);
         }
         this.limit = limit;
     }

package/kunlun/operator/impl/logicV2.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildCriterionV2 = exports.logical = exports.QueryV2 = exports.LogicalExpression = exports.ArithmeticExpression = exports.NewConstantExpressionField = exports.NewMetadataExpressionField = void 0;
 const operator_1 = require("./operator");
+const queryBuilder_1 = require("../../../context/db/impl/queryBuilder");
 function NewMetadataExpressionField(objectApiName, fieldApiName) {
     return {
         type: "metadataVariable",
@@ -80,8 +81,8 @@ class QueryV2 {
         this._order = [];
         this.filter = {
             type: "and",
-            arithmeticExpressions: null,
-            logicalExpressions: null,
+            arithmeticExpressions: [],
+            logicalExpressions: [],
         };
     }
     buildCriterion(filter) {
@@ -121,8 +122,8 @@ class QueryV2 {
         return this;
     }
     limit(limit) {
-        if (limit <= 0 || limit > 200) {
-            throw new Error("limit must be greater than 0 and less than or equal to 200");
+        if (limit <= 0 || limit > 10000) {
+            throw new Error(`limit(${limit}) > ${queryBuilder_1.maxLimitV2}. Limit should be 1~${queryBuilder_1.maxLimitV2} when querying the id field, otherwise it should be 1~${queryBuilder_1.maxLimit}`);
         }
         this._limit = limit;
         return this;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byted-apaas/server-sdk-node",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "aPaaS Server SDK",
   "author": "zhouwexin <zhouwexin@bytedance.com>",
   "homepage": "",
@@ -12,14 +12,17 @@
     "pre-build": "rm -rf build && tsc"
   },
   "dependencies": {
-    "@byted-apaas/server-common-node": "1.0.1",
+    "@byted-apaas/server-common-node": "^1.0.4",
     "@jorgeferrero/stream-to-buffer": "^2.0.6",
     "dayjs": "^1.9.6",
     "form-data": "^3.0.0",
+    "typescript": "^4.9.3",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
+    "@types/google-protobuf": "^3.15.6",
     "@types/mocha": "^9.0.0",
+    "@types/node-fetch": "^2.6.2",
     "axios": "^0.21.0",
     "madge": "^3.12.0",
     "mocha": "^9.1.3",

package/request/innerapi.js

@@ -329,8 +329,8 @@ async function deleteRecordsBySync(objectApiName, recordIDs) {
     return { err_map: errMap };
 }
 async function getRecordsOrCountByCriterion(objectApiName, criterion, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount) {
-    if (limit > 1000) {
-        limit = 1000;
+    if (limit > 10000) {
+        limit = 10000;
     }
     // 1.check
     if (!objectApiName) {
@@ -940,8 +940,8 @@ async function openSDKDeleteRecordsBySync(objectApiName, recordIDs) {
 }
 async function openSDKGetRecords(objectApiName, param) {
     // 1. prepare args
-    if (param.limit <= 0 || param.limit > 200) {
-        param.limit = 200;
+    if (param.limit <= 0 || param.limit > 10000) {
+        param.limit = 10000;
     }
     let req;
     req.ObjectAPIAlias = objectApiName;

package/request/openapi.js

@@ -213,8 +213,8 @@ function handleResponse(data, needCount) {
     }
 }
 async function getRecordsOrCountByCriterion(objectApiName, criterion, order, ignoreBackLookupField, fieldApiNames, offset, limit, needCount) {
-    if (limit > 1000) {
-        limit = 1000;
+    if (limit > 10000) {
+        limit = 10000;
     }
     // 1.check
     if (!objectApiName) {
@@ -611,17 +611,17 @@ async function openSDKGetRecords(objectApiName, param) {
     let options = commonHttp.getOptions(null, openapiHttpPath.openSDKGetRecords);
     let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
     urlPath = urlPath.replace(replaceKeys.objectApiName, objectApiName);
-    if (param.limit <= 0 || param.limit > 200) {
-        param.limit = 200;
+    if (param.limit <= 0 || param.limit > 10000) {
+        param.limit = 10000;
     }
     // 2.请求
     options.json = param;
     const data = await openapi.doRequest(null, urlPath, options);
     if (param.count) {
-        return JSON.parse(data.records);
+        return data.total;
     }
     else {
-        return data.total;
+        return data.records;
     }
 }
 async function openSDKUploadFile(fileName, data) {
@@ -661,6 +661,7 @@ async function openSDKDownloadAvatar(imageID) {
     let options = commonHttp.getOptions(null, openapiHttpPath.openSDKDownloadAvatar);
     let urlPath = options._reqPath.replace(replaceKeys.namespace, await (0, common_1.getNamespaceForOpenAndFaaSSDK)());
     urlPath = urlPath.replace(replaceKeys.fileID, imageID);
+    options.responseType = "buffer";
     // 2.请求
     let data = await openapi.doRequest(null, urlPath, options);
     // 3.写入文件