@cloudbase/database 1.4.3 → 1.5.0

package/src/index.ts

@@ -5,8 +5,16 @@ import { Command } from './command'
 import { ServerDateConstructor } from './serverDate/index'
 import { RegExpConstructor } from './regexp/index'
 import { startTransaction, runTransaction } from './transaction/index'
+import { LogicCommand } from './commands/logic'
+import { QueryCommand } from './commands/query'
+import { UpdateCommand } from './commands/update'
 import { ObjectIdConstructor } from './ObjectId/index'
 
+/**
+ * 数据库配置接口（兼容旧名，实际为完整的 CloudBase 配置）
+ */
+export type IDbConfig = ICloudBaseConfig
+
 /**
  * 地理位置类型
  */
@@ -18,7 +26,7 @@ export { Query } from './query'
 export { CollectionReference } from './collection'
 export { DocumentReference } from './document'
 
-interface ICloudBaseConfig {
+export interface ICloudBaseConfig {
   timeout?: number
   isHttp?: boolean
   secretId?: string
@@ -68,12 +76,18 @@ export class Db {
 
   runTransaction: any
 
+  logicCommand: any
+
+  updateCommand: any
+
+  queryCommand: any
+
   /**
    * 初始化
    *
    * 默认是 `default` 数据库，为今后扩展使用
    *
-   * @param config
+   * @param config - 数据库配置
    */
   config: ICloudBaseConfig
 
@@ -83,6 +97,8 @@ export class Db {
 
   static wsClass: any
 
+  static wsClientClass: any
+
   // 创建签名的工具函数，由jssdk传入
   static createSign: Function
 
@@ -94,7 +110,33 @@ export class Db {
   // 应用签名信息，由jssdk传入
   static appSecretInfo: any
 
-  constructor(config?: any) {
+  // 创建请求实例的包装方法，自动添加instance和database参数
+  static createRequest(config: ICloudBaseConfig): any {
+    const request = new Db.reqClass(config)
+    const originalSend = request.send
+
+    // 包装send方法，自动添加instance和database参数；
+    // 剩余参数（如 2.0 引擎的 getReqOpts，含 per-request timeout）原样透传
+    request.send = function(action: string, data: any, ...args: any[]): any {
+      // data 可能为空（如事务 startTransaction 不带参数），注入前需防护
+      if (data) {
+        // 如果配置中包含instance或database参数，添加到请求数据中
+        if (config.instance) {
+          data.instance = config.instance
+        }
+        if (config.database) {
+          data.database = config.database
+        }
+      }
+
+      // 调用原始的send方法
+      return originalSend.call(this, action, data, ...args)
+    }
+
+    return request
+  }
+
+  constructor(config?: ICloudBaseConfig) {
     this.config = config
     this.Geo = Geo
     this.serverDate = ServerDateConstructor
@@ -103,6 +145,11 @@ export class Db {
     this.ObjectId = ObjectIdConstructor
     this.startTransaction = startTransaction
     this.runTransaction = runTransaction
+
+    // 暴露command类 给新sdk灰度兼容用
+    this.logicCommand = LogicCommand
+    this.updateCommand = UpdateCommand
+    this.queryCommand = QueryCommand
   }
 
   /**
@@ -121,7 +168,7 @@ export class Db {
    * 创建集合
    */
   createCollection(collName: string) {
-    let request = new Db.reqClass(this.config)
+    let request = Db.createRequest(this.config)
 
     const params = {
       collectionName: collName

package/src/query.ts

@@ -9,9 +9,8 @@ import { QuerySerializer } from './serializer/query'
 import { UpdateSerializer } from './serializer/update'
 // import { WSClient } from "./websocket/wsclient"
 import { IWatchOptions, DBRealtimeListener } from './typings/index'
-import { RealtimeWebSocketClient } from './realtime/websocket-client'
 import { ErrorCode } from './constant'
-import { getReqOpts, stringifyByEJSON, processReturn } from './utils/utils'
+import { getWsInstance, getReqOpts, stringifyByEJSON, processReturn, withCallback } from './utils/utils'
 import { ERRORS } from './const/code'
 import { EJSON } from 'bson'
 
@@ -156,7 +155,7 @@ export class Query {
     this._fieldFilters = fieldFilters
     this._apiOptions = apiOptions || {}
     /* eslint-disable new-cap */
-    this._request = new Db.reqClass(this._db.config)
+    this._request = Db.createRequest(this._db.config)
     this._transactionId = transactionId
   }
 
@@ -166,7 +165,11 @@ export class Query {
    * - 默认获取集合下全部文档数据
    * - 可以把通过 `orderBy`、`where`、`skip`、`limit`设置的数据添加请求参数上
    */
-  public async get(): Promise<GetRes> {
+  public get(callback?: any): Promise<GetRes> {
+    return withCallback(this._get(), callback) as Promise<GetRes>
+  }
+
+  private async _get(): Promise<GetRes> {
     /* eslint-disable no-param-reassign */
 
     const order = (this._apiOptions as QueryOption).order
@@ -176,7 +179,7 @@ export class Query {
       transactionId?: string
       query?: Object
       queryType: QueryType
-      order?: string[]
+      order?: string
       offset?: number
       limit?: number
       projection?: Object
@@ -200,14 +203,8 @@ export class Query {
     if (offset) {
       param.offset = offset
     }
-
     const limit = (this._apiOptions as QueryOption).limit
 
-    // if (this._queryOptions.limit) {
-    //   param.limit = this._queryOptions.limit < 1000 ? this._queryOptions.limit : 1000
-    // } else {
-    //   param.limit = 100
-    // }
     if (limit) {
       param.limit = limit < 1000 ? limit : 1000
     } else {
@@ -252,7 +249,11 @@ export class Query {
   /**
    * 获取总数
    */
-  public async count() {
+  public count(callback?: any) {
+    return withCallback(this._count(), callback)
+  }
+
+  private async _count() {
     interface Param {
       collectionName: string
       query?: Object
@@ -348,7 +349,6 @@ export class Query {
     const order = (this._apiOptions as QueryOption).order || {}
 
     const newApiOption = Object.assign({}, this._apiOptions, {
-      // order: order.concat(newOrder)
       order: Object.assign({}, order, newOrder)
     })
 
@@ -390,7 +390,11 @@ export class Query {
    *
    * @param data 数据
    */
-  public async update(data: Object): Promise<any> {
+  public update(data: Object, callback?: any): Promise<any> {
+    return withCallback(this._update(data), callback)
+  }
+
+  private async _update(data: Object): Promise<any> {
     if (!data || typeof data !== 'object') {
       return processReturn(this._db.config.throwOnCode, {
         ...ERRORS.INVALID_PARAM,
@@ -419,6 +423,10 @@ export class Query {
       data: UpdateSerializer.encodeEJSON(data, this._apiOptions.raw || false)
     }
 
+    if (this._transactionId) {
+      param.transactionId = this._transactionId
+    }
+
     if (this._fieldFilters) {
       param.query = this._fieldFilters
     }
@@ -481,7 +489,11 @@ export class Query {
   /**
    * 条件删除文档
    */
-  public async remove() {
+  public remove(callback?: any) {
+    return withCallback(this._remove(), callback)
+  }
+
+  private async _remove() {
     // if (Object.keys(this._queryOptions).length > 0) {
     //   console.warn('`offset`, `limit` and `projection` are not supported in remove() operation')
     // }
@@ -504,12 +516,15 @@ export class Query {
     let { multiple } = this._apiOptions as UpdateOption
     const multi = multiple === undefined ? true : multiple // where remove 不传multi默认为true
 
-    const param = {
+    const param: any = {
       collectionName: this._coll,
       query: this._fieldFilters,
       queryType: QueryType.WHERE,
       multi
     }
+    if (this._transactionId) {
+      param.transactionId = this._transactionId
+    }
     const res = await this._request.send(
       'database.removeDocument',
       param,
@@ -579,22 +594,11 @@ export class Query {
    * 监听query对应的doc变化
    */
   watch = (options: IWatchOptions): DBRealtimeListener => {
-    if (!Db.ws) {
-      Db.ws = new RealtimeWebSocketClient({
-        context: {
-          appConfig: {
-            docSizeLimit: 1000,
-            realtimePingInterval: 10000,
-            realtimePongWaitTimeout: 5000,
-            request: this._request
-          }
-        }
-      })
-    }
+    const ws = getWsInstance(this._db)
 
     const { limit, order } = this._apiOptions as QueryOption
 
-    return (Db.ws as RealtimeWebSocketClient).watch({
+    return ws.watch({
       ...options,
       envId: this._db.config.env,
       collectionName: this._coll,

package/src/serializer/query.ts

@@ -4,15 +4,27 @@ import {
   QUERY_COMMANDS_LITERAL,
   QueryCommand
 } from '../commands/query'
-import { isLogicCommand, LOGIC_COMMANDS_LITERAL, LogicCommand } from '../commands/logic'
+import {
+  isLogicCommand,
+  LOGIC_COMMANDS_LITERAL,
+  LogicCommand
+} from '../commands/logic'
 import { SYMBOL_UNSET_FIELD_NAME, SYMBOL_GEO_POINT } from '../helper/symbol'
 import { getType, isObject, isArray, isRegExp, isDate } from '../utils/type'
 import { operatorToString } from '../operator-map'
-import { flattenQueryObject, isConversionRequired, encodeInternalDataType } from './common'
-import { IGeoNearOptions, IGeoWithinOptions, IGeoIntersectsOptions } from '../commands/query'
+import {
+  flattenQueryObject,
+  isConversionRequired,
+  encodeInternalDataType
+} from './common'
+import {
+  IGeoNearOptions,
+  IGeoWithinOptions,
+  IGeoIntersectsOptions
+} from '../commands/query'
 import { stringifyByEJSON } from '../utils/utils'
 import { Validate } from '../validate'
-import { Point } from '../geo'
+import { Point } from '../geo/index'
 
 export type IQueryCondition = Record<string, any> | LogicCommand
 
@@ -39,10 +51,10 @@ class QueryEncoder {
       } else if (isQueryCommand(query)) {
         return this.encodeQueryCommand(query)
       } else if (isRegExp(query)) {
-        //  /xxx/ 形式
+        // /xxx/ 形式
         return { [key]: this.encodeRegExp(query) }
       } else if (isDate(query)) {
-        return { [key]: query }
+        return { [key]: encodeInternalDataType(query) }
       } else {
         return { [key]: this.encodeQueryObject(query) }
       }

package/src/transaction/index.ts

@@ -27,7 +27,7 @@ export class Transaction {
 
   public constructor(db: Db) {
     this._db = db
-    this._request = new Db.reqClass(this._db.config)
+    this._request = Db.createRequest(this._db.config)
     this.aborted = false
     this.commited = false
     this.inited = false

package/src/typings/index.ts

@@ -1,10 +1,6 @@
 /**
  * Common interfaces and types
  */
-
-/**
- * Database Watch
- */
 import { Point } from '../geo/index'
 
 export type DataType = 'init' | 'update' | 'add' | 'remove' | 'replace' | 'limit'

package/src/utils/utils.ts

@@ -1,9 +1,29 @@
+import { Db } from '../'
 import { QueryOption, UpdateOption } from '../query'
 import { EJSON } from 'bson'
 import { isObject } from './type'
 
 export const sleep = (ms: number = 0) => new Promise(r => setTimeout(r, ms))
 
+/**
+ * 兼容旧版 callback 调用风格（对齐 0.12.x 行为）：
+ * - 传入 callback：成功时 callback(0, result)、失败时 callback(err)，方法返回 undefined
+ * - 不传 callback：原样返回 promise
+ *
+ * 注意用 then(f, g) 而非 then(f).catch(g)，保证派生 promise 为 resolved，
+ * 避免 callback 模式下产生 unhandled rejection。
+ */
+export function withCallback<T>(promise: Promise<T>, callback?: any): Promise<T> | undefined {
+  if (typeof callback === 'function') {
+    promise.then(
+      (res: any) => callback(0, res),
+      (err: any) => callback(err)
+    )
+    return undefined
+  }
+  return promise
+}
+
 const counters: Record<string, number> = {}
 
 export const autoCount = (domain: string = 'any'): number => {
@@ -13,6 +33,32 @@ export const autoCount = (domain: string = 'any'): number => {
   return counters[domain]++
 }
 
+/**
+ * 工厂模式创建 ws 实例
+ */
+const wsList = {}
+export function getWsInstance(db: Db) {
+  if(!Db.wsClientClass){
+    throw new Error('to use realtime you must import realtime module first')
+  }
+  const { env } = db.config
+
+  if (!wsList[env]) {
+    wsList[env] = new Db.wsClientClass({
+      context: {
+        appConfig: {
+          docSizeLimit: 1000,
+          realtimePingInterval: 10000,
+          realtimePongWaitTimeout: 5000,
+          request: Db.createRequest(db.config)
+        }
+      }
+    })
+  }
+
+  return wsList[env]
+}
+
 export const getReqOpts = (apiOptions: QueryOption | UpdateOption): any => {
   // 影响底层request的暂时只有timeout
   if (apiOptions.timeout !== undefined) {

package/src/validate.ts

@@ -11,9 +11,8 @@ import { QueryOption, UpdateOption } from './query'
 import { ERRORS } from './const/code'
 import { E } from './utils/utils'
 import { getType } from './utils/type'
-import { Point } from './geo'
+import { Point } from './geo/index'
 import { CenterSphere } from './typings'
-
 import { SYMBOL_GEO_POINT } from './helper/symbol'
 
 const validOptionsKeys = ['limit', 'offset', 'projection', 'order', 'multiple', 'timeout', 'raw']
@@ -243,11 +242,9 @@ export class Validate {
   }
 
   /**
+   * 校验 centerSphere 结构
    *
-   * @static
-   * @param {[Point, number]} param
-   * @returns {Boolean}
-   * @memberof Validate
+   * @param param - [Point, number] 或 [[number, number], number]
    */
   static isCentersPhere(param: CenterSphere): Boolean {
     if (Array.isArray(param) && param.length === 2) {

package/tests/gateway-contract.test.ts

@@ -0,0 +1,180 @@
+import { EJSON } from 'bson'
+import { Db } from '../src/index'
+import { Transaction } from '../src/transaction/index'
+
+/**
+ * GATEWAY 模式接口名契约测试
+ *
+ * js-sdk（packages/cloudbase/database/src/index.ts 的 gateWayFunc）在
+ * endPointMode === 'GATEWAY' 时按 action 名查表路由到 RESTful 网关，
+ * 表外的 action 会 fallback 到 super.send() 走老通道，导致网关被绕过。
+ *
+ * 本测试用与 js-sdk gateWayFunc 相同的接口名集合模拟 GATEWAY 分发，
+ * 验证 2.0 引擎发出的所有 action 都能命中映射表，
+ * 任何一侧改名/新增接口而另一侧未同步时，此测试会失败。
+ */
+describe('GATEWAY 模式接口名契约（与 js-sdk gateWayFunc 对齐）', () => {
+  // 与 js-sdk gateWayFunc 的 key 保持一致
+  const GATEWAY_ACTIONS = [
+    // 旧接口名（0.12.x 引擎）
+    'database.queryDocument',
+    'database.addDocument',
+    'database.updateDocument',
+    'database.deleteDocument',
+    'database.countDocument',
+    'database.addCollection',
+    'database.aggregate',
+    // 事务（新旧引擎同名）
+    'database.startTransaction',
+    'database.commitTransaction',
+    'database.abortTransaction',
+    'database.getInTransaction',
+    'database.updateDocInTransaction',
+    'database.deleteDocInTransaction',
+    'database.insertDocInTransaction',
+    'database.runCommands',
+    // 新接口名（2.0 引擎，js-sdk gateWayFunc 已添加映射）
+    'database.getDocument',
+    'database.insertDocument',
+    'database.modifyDocument',
+    'database.removeDocument',
+    'database.calculateDocument',
+    'database.aggregateDocuments'
+  ]
+
+  let hitActions: string[]
+
+  class MockGatewayReq {
+    async send(action: string) {
+      if (GATEWAY_ACTIONS.indexOf(action) < 0) {
+        throw new Error(`GATEWAY 模式下无此接口映射: ${action}`)
+      }
+      hitActions.push(action)
+
+      // 按接口返回 2.0 引擎期望的最小响应结构
+      switch (action) {
+        case 'database.getDocument':
+          return {
+            data: { list: [EJSON.stringify({ _id: 'doc1', name: 'Alice' })] },
+            requestId: 'gw-req-get'
+          }
+        case 'database.insertDocument':
+          return {
+            data: { insertedIds: ['new-id'] },
+            requestId: 'gw-req-insert'
+          }
+        case 'database.modifyDocument':
+          return {
+            data: { updated: 1, upsert_id: 'doc1' },
+            requestId: 'gw-req-modify'
+          }
+        case 'database.removeDocument':
+          return {
+            data: { deleted: 1 },
+            requestId: 'gw-req-remove'
+          }
+        case 'database.calculateDocument':
+          return {
+            data: { total: 5 },
+            requestId: 'gw-req-count'
+          }
+        case 'database.aggregateDocuments':
+          return {
+            data: { list: [EJSON.stringify({ total: 1 })] },
+            requestId: 'gw-req-agg'
+          }
+        case 'database.startTransaction':
+          return { transactionId: 'gw-tx-001' }
+        case 'database.commitTransaction':
+        case 'database.abortTransaction':
+          return { requestId: 'gw-req-tx' }
+        default:
+          return { data: { ok: 1 }, requestId: 'gw-req-default' }
+      }
+    }
+  }
+
+  beforeEach(() => {
+    hitActions = []
+    Db.reqClass = MockGatewayReq as any
+  })
+
+  function createDb() {
+    return new Db({ env: 'test-env' })
+  }
+
+  async function createInitedTransaction(db: Db) {
+    const tx = new Transaction(db)
+    await tx.init()
+    return tx
+  }
+
+  it('collection CRUD 应全部命中网关映射表', async () => {
+    const db = createDb()
+    const coll = db.collection('users')
+
+    await coll.where({ age: 18 }).get()
+    await coll.where({ age: 18 }).count()
+    await coll.where({ age: 18 }).update({ age: 19 })
+    await coll.where({ age: 18 }).remove()
+    await coll.add({ name: 'New' })
+    await coll
+      .aggregate()
+      .match({ age: { $gt: 10 } })
+      .end()
+
+    expect(hitActions).toEqual([
+      'database.getDocument',
+      'database.calculateDocument',
+      'database.modifyDocument',
+      'database.removeDocument',
+      'database.insertDocument',
+      'database.aggregateDocuments'
+    ])
+  })
+
+  it('document CRUD 应全部命中网关映射表', async () => {
+    const db = createDb()
+    const doc = db.collection('users').doc('doc1')
+
+    await doc.get()
+    await doc.create({ name: 'Alice' })
+    await doc.set({ name: 'Alice2' })
+    await doc.update({ name: 'Alice3' })
+    await doc.remove()
+
+    expect(hitActions).toEqual([
+      'database.getDocument',
+      'database.insertDocument',
+      'database.modifyDocument',
+      'database.modifyDocument',
+      'database.removeDocument'
+    ])
+  })
+
+  it('事务操作应全部命中网关映射表', async () => {
+    const db = createDb()
+    const tx = await createInitedTransaction(db)
+
+    await tx.collection('users').where({ age: 18 }).get()
+    await tx.collection('users').where({ age: 18 }).update({ age: 19 })
+    await tx.collection('users').add({ name: 'TxNew' })
+    await tx.collection('users').doc('doc1').set({ name: 'TxSet' })
+    await tx.commit()
+
+    expect(hitActions).toEqual([
+      'database.startTransaction',
+      'database.getDocument',
+      'database.modifyDocument',
+      'database.insertDocument',
+      'database.modifyDocument',
+      'database.commitTransaction'
+    ])
+  })
+
+  it('createCollection 应命中网关映射表', async () => {
+    const db = createDb()
+    await db.createCollection('new-coll')
+    expect(hitActions).toEqual(['database.addCollection'])
+  })
+})