@cloudbase/database 1.5.0 → 1.5.1

package/dist/commonjs/query.d.ts

@@ -15,7 +15,7 @@ export interface QueryOption extends BaseOption {
     limit?: number;
     offset?: number;
     projection?: Object;
-    order?: Record<string, any>[];
+    order?: Record<string, any>;
 }
 export interface UpdateOption extends BaseOption {
     multiple?: boolean;

package/dist/commonjs/query.js

@@ -46,6 +46,22 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Query = void 0;
 var constant_1 = require("./constant");
@@ -64,12 +80,14 @@ var Query = (function () {
         this.watch = function (options) {
             var ws = (0, utils_1.getWsInstance)(_this._db);
             var _a = _this._apiOptions, limit = _a.limit, order = _a.order;
-            return ws.watch(__assign(__assign({}, options), { envId: _this._db.config.env, collectionName: _this._coll, query: JSON.stringify(_this._fieldFilters), limit: limit, orderBy: order
-                    ? order.reduce(function (acc, cur) {
-                        acc[cur.field] = cur.direction;
-                        return acc;
-                    }, {})
-                    : undefined }));
+            var orderBy = order
+                ? Object.entries(order).reduce(function (acc, _a) {
+                    var _b = __read(_a, 2), field = _b[0], direction = _b[1];
+                    acc[field] = direction === -1 ? 'desc' : 'asc';
+                    return acc;
+                }, {})
+                : undefined;
+            return ws.watch(__assign(__assign({}, options), { envId: _this._db.config.env, collectionName: _this._coll, query: (0, utils_1.toWatchQuery)(_this._fieldFilters), limit: limit, orderBy: orderBy }));
         };
         this._db = db;
         this._coll = coll;

package/dist/commonjs/utils/utils.d.ts

@@ -8,6 +8,7 @@ export declare const getReqOpts: (apiOptions: QueryOption | UpdateOption) => any
 export declare const filterUndefined: (o: any) => any;
 export declare const stringifyByEJSON: (params: any) => string;
 export declare const parseByEJSON: (params: any) => any;
+export declare const toWatchQuery: (ejsonStr: string) => string;
 export declare class TcbError extends Error {
     readonly code: string;
     readonly message: string;

package/dist/commonjs/utils/utils.js

@@ -25,8 +25,19 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processReturn = exports.E = exports.TcbError = exports.parseByEJSON = exports.stringifyByEJSON = exports.filterUndefined = exports.getReqOpts = exports.getWsInstance = exports.autoCount = exports.withCallback = exports.sleep = void 0;
+exports.processReturn = exports.E = exports.TcbError = exports.toWatchQuery = exports.parseByEJSON = exports.stringifyByEJSON = exports.filterUndefined = exports.getReqOpts = exports.getWsInstance = exports.autoCount = exports.withCallback = exports.sleep = void 0;
 var __1 = require("../");
 var bson_1 = require("bson");
 var type_1 = require("./type");
@@ -106,6 +117,55 @@ var parseByEJSON = function (params) {
     return bson_1.EJSON.parse(params);
 };
 exports.parseByEJSON = parseByEJSON;
+var toWatchLegacyValue = function (val) {
+    var e_1, _a;
+    if (val instanceof Date) {
+        return { $date: +val };
+    }
+    if (val instanceof RegExp) {
+        return { $regex: val.source, $options: val.flags };
+    }
+    if (val && typeof val === 'object') {
+        if (val._bsontype === 'ObjectId') {
+            return { $oid: val.toHexString() };
+        }
+        if (val._bsontype === 'BSONRegExp') {
+            return { $regex: val.pattern, $options: val.options };
+        }
+        if (Array.isArray(val)) {
+            return val.map(toWatchLegacyValue);
+        }
+        var ret = {};
+        try {
+            for (var _b = __values(Object.keys(val)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var key = _c.value;
+                ret[key] = toWatchLegacyValue(val[key]);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return ret;
+    }
+    return val;
+};
+var toWatchQuery = function (ejsonStr) {
+    if (!ejsonStr) {
+        return '{}';
+    }
+    try {
+        var parsed = bson_1.EJSON.parse(ejsonStr);
+        return JSON.stringify(toWatchLegacyValue(parsed));
+    }
+    catch (e) {
+        return ejsonStr;
+    }
+};
+exports.toWatchQuery = toWatchQuery;
 var TcbError = (function (_super) {
     __extends(TcbError, _super);
     function TcbError(error) {

package/dist/esm/query.d.ts

@@ -15,7 +15,7 @@ export interface QueryOption extends BaseOption {
     limit?: number;
     offset?: number;
     projection?: Object;
-    order?: Record<string, any>[];
+    order?: Record<string, any>;
 }
 export interface UpdateOption extends BaseOption {
     multiple?: boolean;

package/dist/esm/query.js

@@ -45,6 +45,22 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 import { QueryType } from './constant';
 import { Db } from './index';
 import { Validate } from './validate';
@@ -52,7 +68,7 @@ import { Util } from './util';
 import { QuerySerializer } from './serializer/query';
 import { UpdateSerializer } from './serializer/update';
 import { ErrorCode } from './constant';
-import { getWsInstance, getReqOpts, stringifyByEJSON, processReturn, withCallback } from './utils/utils';
+import { getWsInstance, getReqOpts, stringifyByEJSON, toWatchQuery, processReturn, withCallback } from './utils/utils';
 import { ERRORS } from './const/code';
 import { EJSON } from 'bson';
 var Query = (function () {
@@ -61,12 +77,14 @@ var Query = (function () {
         this.watch = function (options) {
             var ws = getWsInstance(_this._db);
             var _a = _this._apiOptions, limit = _a.limit, order = _a.order;
-            return ws.watch(__assign(__assign({}, options), { envId: _this._db.config.env, collectionName: _this._coll, query: JSON.stringify(_this._fieldFilters), limit: limit, orderBy: order
-                    ? order.reduce(function (acc, cur) {
-                        acc[cur.field] = cur.direction;
-                        return acc;
-                    }, {})
-                    : undefined }));
+            var orderBy = order
+                ? Object.entries(order).reduce(function (acc, _a) {
+                    var _b = __read(_a, 2), field = _b[0], direction = _b[1];
+                    acc[field] = direction === -1 ? 'desc' : 'asc';
+                    return acc;
+                }, {})
+                : undefined;
+            return ws.watch(__assign(__assign({}, options), { envId: _this._db.config.env, collectionName: _this._coll, query: toWatchQuery(_this._fieldFilters), limit: limit, orderBy: orderBy }));
         };
         this._db = db;
         this._coll = coll;

package/dist/esm/utils/utils.d.ts

@@ -8,6 +8,7 @@ export declare const getReqOpts: (apiOptions: QueryOption | UpdateOption) => any
 export declare const filterUndefined: (o: any) => any;
 export declare const stringifyByEJSON: (params: any) => string;
 export declare const parseByEJSON: (params: any) => any;
+export declare const toWatchQuery: (ejsonStr: string) => string;
 export declare class TcbError extends Error {
     readonly code: string;
     readonly message: string;

package/dist/esm/utils/utils.js

@@ -24,6 +24,17 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
 import { Db } from '../';
 import { EJSON } from 'bson';
 import { isObject } from './type';
@@ -95,6 +106,54 @@ export var stringifyByEJSON = function (params) {
 export var parseByEJSON = function (params) {
     return EJSON.parse(params);
 };
+var toWatchLegacyValue = function (val) {
+    var e_1, _a;
+    if (val instanceof Date) {
+        return { $date: +val };
+    }
+    if (val instanceof RegExp) {
+        return { $regex: val.source, $options: val.flags };
+    }
+    if (val && typeof val === 'object') {
+        if (val._bsontype === 'ObjectId') {
+            return { $oid: val.toHexString() };
+        }
+        if (val._bsontype === 'BSONRegExp') {
+            return { $regex: val.pattern, $options: val.options };
+        }
+        if (Array.isArray(val)) {
+            return val.map(toWatchLegacyValue);
+        }
+        var ret = {};
+        try {
+            for (var _b = __values(Object.keys(val)), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var key = _c.value;
+                ret[key] = toWatchLegacyValue(val[key]);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return ret;
+    }
+    return val;
+};
+export var toWatchQuery = function (ejsonStr) {
+    if (!ejsonStr) {
+        return '{}';
+    }
+    try {
+        var parsed = EJSON.parse(ejsonStr);
+        return JSON.stringify(toWatchLegacyValue(parsed));
+    }
+    catch (e) {
+        return ejsonStr;
+    }
+};
 var TcbError = (function (_super) {
     __extends(TcbError, _super);
     function TcbError(error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbase/database",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "database for (node.)js sdk ",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.js",

package/src/query.ts

@@ -10,7 +10,7 @@ import { UpdateSerializer } from './serializer/update'
 // import { WSClient } from "./websocket/wsclient"
 import { IWatchOptions, DBRealtimeListener } from './typings/index'
 import { ErrorCode } from './constant'
-import { getWsInstance, getReqOpts, stringifyByEJSON, processReturn, withCallback } from './utils/utils'
+import { getWsInstance, getReqOpts, stringifyByEJSON, toWatchQuery, processReturn, withCallback } from './utils/utils'
 import { ERRORS } from './const/code'
 import { EJSON } from 'bson'
 
@@ -34,8 +34,8 @@ export interface QueryOption extends BaseOption {
   offset?: number
   // 指定显示或者不显示哪些字段
   projection?: Object
-  // 结果排序
-  order?: Record<string, any>[]
+  // 结果排序（orderBy() 存为 { field: 1 | -1 }）
+  order?: Record<string, any>
 }
 
 export interface UpdateOption extends BaseOption {
@@ -598,18 +598,24 @@ export class Query {
 
     const { limit, order } = this._apiOptions as QueryOption
 
+    // order 由 orderBy() 存为 { field: 1 | -1 }，实时推送协议要求 'asc' | 'desc'
+    const orderBy = order
+      ? Object.entries(order).reduce<Record<string, string>>((acc, [field, direction]) => {
+          acc[field] = direction === -1 ? 'desc' : 'asc'
+          return acc
+        }, {})
+      : undefined
+
     return ws.watch({
       ...options,
       envId: this._db.config.env,
       collectionName: this._coll,
-      query: JSON.stringify(this._fieldFilters), // 实时推送这里需要换成ejson协议，todo
+      // where() 产出 canonical EJSON 字符串，但 watch 协议要求 legacy 内部编码
+      // （数字裸值、$date 为 epoch 毫秒数字）——canonical 形态服务端虽接受但会静默匹配不到文档，
+      // 且不可再 JSON.stringify（否则双重编码，线上 100003 事故根因）
+      query: toWatchQuery(this._fieldFilters),
       limit,
-      orderBy: order
-        ? order.reduce<Record<string, string>>((acc, cur) => {
-            acc[cur.field] = cur.direction
-            return acc
-          }, {})
-        : undefined
+      orderBy
     })
   }
 }

package/src/utils/utils.ts

@@ -99,6 +99,65 @@ export const parseByEJSON = params => {
   return EJSON.parse(params)
 }
 
+/**
+ * 将 EJSON 值递归转为实时推送 watch 协议要求的 legacy 内部编码（0.12.x 形态）
+ * - Date → { $date: <epoch 毫秒数字> }
+ * - ObjectId → { $oid }、BSONRegExp/原生 RegExp → { $regex, $options }
+ * - 数字/字符串/布尔等基本值保持裸值
+ *
+ * bson 类型用 _bsontype 字符串判断而非 instanceof：EJSON.parse 产出的实例
+ * 来自运行时实际加载的 bson（可能与编译时版本/副本不同），instanceOf 跨副本
+ * 会失效，_bsontype 是 bson 各版本稳定的类型标记。
+ */
+const toWatchLegacyValue = (val: any): any => {
+  if (val instanceof Date) {
+    return { $date: +val }
+  }
+  if (val instanceof RegExp) {
+    // 原生 RegExp 兜底（正常链路编码器已转 $regularExpression，raw 模式等可能漏过）
+    return { $regex: val.source, $options: val.flags }
+  }
+  if (val && typeof val === 'object') {
+    if (val._bsontype === 'ObjectId') {
+      return { $oid: val.toHexString() }
+    }
+    if (val._bsontype === 'BSONRegExp') {
+      return { $regex: val.pattern, $options: val.options }
+    }
+    if (Array.isArray(val)) {
+      return val.map(toWatchLegacyValue)
+    }
+    const ret: Record<string, any> = {}
+    for (const key of Object.keys(val)) {
+      ret[key] = toWatchLegacyValue(val[key])
+    }
+    return ret
+  }
+  return val
+}
+
+/**
+ * 实时推送 watch 协议的 query 编码
+ *
+ * where() 产出的 _fieldFilters 是 canonical EJSON 字符串（relaxed:false），
+ * 但服务端 watch 查询引擎只认 0.12.x 的 legacy 内部编码：
+ * - 数字必须裸值（{$numberInt}/{$numberLong} 会被静默匹配不到文档，实测 0 命中）
+ * - 日期必须是 { $date: <epoch 毫秒数字> }（ISO 串与 {$date:{$numberLong}} 均不命中）
+ * 此处 parse 后转成 legacy 形态再序列化。
+ */
+export const toWatchQuery = (ejsonStr: string): string => {
+  if (!ejsonStr) {
+    return '{}'
+  }
+  try {
+    const parsed = EJSON.parse(ejsonStr)
+    return JSON.stringify(toWatchLegacyValue(parsed))
+  } catch (e) {
+    // 非 EJSON 文本（EJSON.parse 兼容普通 JSON，走到这说明确实解析不了），原样透传由调用方保证格式
+    return ejsonStr
+  }
+}
+
 export class TcbError extends Error {
   readonly code: string
   readonly message: string

package/tests/watch-query.test.ts

@@ -0,0 +1,144 @@
+/**
+ * Query.watch() 回归测试
+ *
+ * 1.5.0 引入的回归：where() 改用 QuerySerializer.encodeEJSON() 后
+ * _fieldFilters 已是 EJSON 字符串，watch() 若再 JSON.stringify 会产生
+ * 双重编码（线上 INIT_WATCH 失败、errorCode=100003 的根因）。
+ * 伴生问题：orderBy() 改存对象 {field: 1|-1} 后，watch() 仍按 0.12.x
+ * 数组形态调用 order.reduce()，带 orderBy 的 watch 会直接抛 TypeError。
+ *
+ * 第二轮真实环境实测（2026-09-03）追加约束：服务端 watch 查询引擎只认
+ * 0.12.x legacy 内部编码——数字裸值、日期 { $date: epoch 毫秒数字 }。
+ * canonical EJSON（$numberInt/$numberLong/$date ISO）虽不报错但静默匹配
+ * 不到文档，因此 watch query 须由 canonical EJSON 转换为 legacy 形态。
+ */
+import { Db } from '../src/index'
+
+describe('Query.watch() 参数序列化', () => {
+  let watchArgs: any[]
+
+  class MockRequest {
+    constructor(_config: any) {}
+    async send(_action: string, _data: any) {
+      return { data: { ok: 1 }, requestId: 'mock' }
+    }
+  }
+
+  class MockWsClient {
+    constructor(_opts: any) {}
+    watch(args: any) {
+      watchArgs.push(args)
+      return { close: () => {} }
+    }
+  }
+
+  beforeEach(() => {
+    Db.reqClass = MockRequest as any
+    Db.wsClientClass = MockWsClient as any
+    watchArgs = []
+  })
+
+  function makeDb() {
+    // getWsInstance 按 env 缓存实例，每个用例用独立 env
+    return new Db({ env: `env-${Math.random()}` } as any)
+  }
+
+  it('数字条件应为裸值（legacy 编码），无 $numberInt/$numberLong 标记', () => {
+    const db = makeDb()
+    db.collection('test-collection')
+      .where({ ts: { $gt: 1788421619261 } } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs).toHaveLength(1)
+    const query = watchArgs[0].query
+    // legacy 形态：数字裸值
+    expect(query).toBe('{"ts":{"$gt":1788421619261}}')
+    // 双重编码的标志形态：外层以引号开头 —— 必须不存在
+    expect(query.startsWith('"')).toBe(false)
+    // canonical 标记 —— 必须不存在
+    expect(query).not.toContain('$numberInt')
+    expect(query).not.toContain('$numberLong')
+  })
+
+  it('where() + command 查询条件同样转为裸数字', () => {
+    const db = makeDb()
+    db.collection('test-collection')
+      .where({ count: db.command.gt(10) } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs[0].query).toBe('{"count":{"$gt":10}}')
+  })
+
+  it('日期条件应转为 { $date: epoch 毫秒数字 }（0.12.x legacy 形态）', () => {
+    const db = makeDb()
+    const date = new Date('2020-01-01T00:00:00.000Z')
+    db.collection('test-collection')
+      .where({ createdAt: db.command.gt(date) } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs[0].query).toBe(`{"createdAt":{"$gt":{"$date":${+date}}}}`)
+  })
+
+  it('db.RegExp / 原生 RegExp 应转为 { $regex, $options }（$regularExpression 不被服务端识别）', () => {
+    const db = makeDb()
+    db.collection('test-collection')
+      .where({ text: db.RegExp({ regexp: 'probe-\\d+', options: 'i' }) } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+    // canonical 编码为 $regularExpression，watch 须转为 0.12.x 的 $regex/$options
+    expect(watchArgs[0].query).toBe('{"text":{"$regex":"probe-\\\\d+","$options":"i"}}')
+    expect(watchArgs[0].query).not.toContain('$regularExpression')
+
+    db.collection('test-collection')
+      .where({ text: /probe-\d+/i } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+    expect(watchArgs[1].query).toBe('{"text":{"$regex":"probe-\\\\d+","$options":"i"}}')
+  })
+
+  it('ObjectId 条件应保持 { $oid } 形态', () => {
+    const db = makeDb()
+    // 该仓库 ObjectId 构造签名为 { id } 对象形式（bson 风格位置参数会静默得到空 id）
+    db.collection('test-collection')
+      .where({ _id: db.ObjectId({ id: '507f1f77bcf86cd799439011' }) } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs[0].query).toBe('{"_id":{"$oid":"507f1f77bcf86cd799439011"}}')
+  })
+
+  it('无 where() 时 query 回退为 "{}"', () => {
+    const db = makeDb()
+    db.collection('test-collection').watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs[0].query).toBe('{}')
+  })
+
+  it('字符串等基本类型条件保持原样', () => {
+    const db = makeDb()
+    db.collection('test-collection')
+      .where({ _id: 'xxx', name: 'foo' } as any)
+      .watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs[0].query).toBe('{"_id":"xxx","name":"foo"}')
+  })
+
+  it('orderBy() 后 watch() 不抛错且方向映射为 asc/desc', () => {
+    const db = makeDb()
+    expect(() => {
+      db.collection('test-collection')
+        .where({ ts: { $gt: 1 } } as any)
+        .orderBy('ts', 'desc')
+        .watch({ onChange: () => {}, onError: () => {} })
+    }).not.toThrow()
+
+    expect(watchArgs[0].orderBy).toEqual({ ts: 'desc' })
+  })
+
+  it('limit 应透传到 watch 参数', () => {
+    const db = makeDb()
+    db.collection('test-collection')
+      .where({ a: 1 } as any)
+      .limit(10)
+      .watch({ onChange: () => {}, onError: () => {} })
+
+    expect(watchArgs[0].limit).toBe(10)
+  })
+})