@cloudbase/database 1.4.3 → 1.5.1

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)
+  })
+})

package/tsconfig.esm.json

@@ -20,10 +20,11 @@
     "pretty": true,
     "removeComments": true,
     "stripInternal": true,
+    "downlevelIteration": true,
     "skipDefaultLibCheck": true,
     "skipLibCheck": true,
     "moduleResolution": "node",
-    "target": "es2017",
+    "target": "es5",
     "lib": [
       "es2015",
       "es6",
@@ -35,6 +36,7 @@
   ],
   "exclude": [
     // "node_modules",
-    "test"
+    "test",
+    "tests"
   ]
 }

package/tsconfig.json

@@ -4,7 +4,6 @@
     "allowJs": false,
     "allowUnreachableCode": false,
     "allowUnusedLabels": false,
-    "charset": "utf8",
     "declaration": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
@@ -21,10 +20,21 @@
     "removeComments": true,
     "stripInternal": true,
     "skipDefaultLibCheck": true,
+    "downlevelIteration": true,
     "skipLibCheck": true,
-    "target": "es2017",
-    "lib": ["es2015", "es6", "dom"]
+    "target": "es5",
+    "lib": [
+      "es2015",
+      "es6",
+      "dom"
+    ]
   },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "test"]
-}
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "test",
+    "tests"
+  ]
+}

package/tsconfig.test.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "isolatedModules": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "allowJs": true
+  },
+  "include": ["tests/**/*.ts", "src/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/dist/commonjs/realtime/error.d.ts

@@ -1,7 +0,0 @@
-import { IResponseMessageErrorMsg } from '../typings/realtime';
-export declare class RealtimeErrorMessageError extends Error {
-    isRealtimeErrorMessageError: boolean;
-    payload: IResponseMessageErrorMsg;
-    constructor(serverErrorMsg: IResponseMessageErrorMsg);
-}
-export declare const isRealtimeErrorMessageError: (e: any) => e is RealtimeErrorMessageError;

package/dist/commonjs/realtime/error.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class RealtimeErrorMessageError extends Error {
-    constructor(serverErrorMsg) {
-        super(`Watch Error ${JSON.stringify(serverErrorMsg.msgData)} (requestid: ${serverErrorMsg.requestId})`);
-        this.isRealtimeErrorMessageError = true;
-        this.payload = serverErrorMsg;
-    }
-}
-exports.RealtimeErrorMessageError = RealtimeErrorMessageError;
-exports.isRealtimeErrorMessageError = (e) => e && e.isRealtimeErrorMessageError;

package/dist/commonjs/realtime/listener.d.ts

@@ -1,14 +0,0 @@
-import { VirtualWebSocketClient } from './virtual-websocket-client';
-import { IRealtimeListenerConstructorOptions, DBRealtimeListener } from '../typings/index';
-interface IRealtimeListenerOptions extends IRealtimeListenerConstructorOptions {
-    close: () => void;
-    debug?: boolean;
-    virtualClient?: VirtualWebSocketClient;
-}
-export declare class RealtimeListener implements DBRealtimeListener {
-    close: () => void;
-    onChange: (res: any) => void;
-    onError: (error: any) => void;
-    constructor(options: IRealtimeListenerOptions);
-}
-export {};

package/dist/commonjs/realtime/listener.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class RealtimeListener {
-    constructor(options) {
-        this.close = options.close;
-        this.onChange = options.onChange;
-        this.onError = options.onError;
-        if (options.debug) {
-            Object.defineProperty(this, 'virtualClient', {
-                get: () => {
-                    return options.virtualClient;
-                }
-            });
-        }
-    }
-}
-exports.RealtimeListener = RealtimeListener;

package/dist/commonjs/realtime/message.d.ts

@@ -1,3 +0,0 @@
-import { IResponseMessage, IResponseMessageInitEventMsg } from '../typings/realtime';
-export declare function genRequestId(prefix?: string): string;
-export declare function isInitEventMessage(msg: IResponseMessage): msg is IResponseMessageInitEventMsg;

package/dist/commonjs/realtime/message.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function genRequestId(prefix = '') {
-    return `${prefix ? `${prefix}_` : ''}${+new Date()}_${Math.random()}`;
-}
-exports.genRequestId = genRequestId;
-function isInitEventMessage(msg) {
-    return msg.msgType === 'INIT_EVENT';
-}
-exports.isInitEventMessage = isInitEventMessage;

package/dist/commonjs/realtime/snapshot.d.ts

@@ -1,16 +0,0 @@
-import { ISingleDBEvent, SnapshotType, ISnapshot } from '../typings/index';
-interface ISnapshotConstructorOptions {
-    id: number;
-    docChanges: ISingleDBEvent[];
-    docs: Record<string, any>[];
-    type?: SnapshotType;
-    msgType?: String;
-}
-export declare class Snapshot implements ISnapshot {
-    id: number;
-    docChanges: ISingleDBEvent[];
-    docs: Record<string, any>[];
-    type?: 'init';
-    constructor(options: ISnapshotConstructorOptions);
-}
-export {};

package/dist/commonjs/realtime/snapshot.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Snapshot {
-    constructor(options) {
-        const { id, docChanges, docs, msgType, type } = options;
-        let cachedDocChanges;
-        let cachedDocs;
-        Object.defineProperties(this, {
-            id: {
-                get: () => id,
-                enumerable: true
-            },
-            docChanges: {
-                get: () => {
-                    if (!cachedDocChanges) {
-                        cachedDocChanges = JSON.parse(JSON.stringify(docChanges));
-                    }
-                    return cachedDocChanges;
-                },
-                enumerable: true
-            },
-            docs: {
-                get: () => {
-                    if (!cachedDocs) {
-                        cachedDocs = JSON.parse(JSON.stringify(docs));
-                    }
-                    return cachedDocs;
-                },
-                enumerable: true
-            },
-            msgType: {
-                get: () => msgType,
-                enumerable: true
-            },
-            type: {
-                get: () => type,
-                enumerable: true
-            }
-        });
-    }
-}
-exports.Snapshot = Snapshot;

package/dist/commonjs/realtime/virtual-websocket-client.d.ts

@@ -1,63 +0,0 @@
-import { IResponseMessage } from '../typings/realtime';
-import { RealtimeListener } from './listener';
-import { IWSSendOptions } from './websocket-client';
-import { IWatchOptions } from '../typings/index';
-interface IVirtualWebSocketClientConstructorOptions extends IWatchOptions {
-    envId?: string;
-    collectionName: string;
-    query: string;
-    limit?: number;
-    orderBy?: Record<string, string>;
-    send: <T = any>(opts: IWSSendOptions) => Promise<T>;
-    login: (envId?: string, refresh?: boolean) => Promise<any>;
-    isWSConnected: () => boolean;
-    onceWSConnected: () => Promise<void>;
-    getWaitExpectedTimeoutLength: () => number;
-    onWatchStart: (client: VirtualWebSocketClient, queryID: string) => void;
-    onWatchClose: (client: VirtualWebSocketClient, queryID: string) => void;
-    debug?: boolean;
-}
-export declare class VirtualWebSocketClient {
-    watchId: string;
-    private envId?;
-    private collectionName;
-    private query;
-    private limit;
-    private orderBy;
-    private send;
-    private login;
-    private isWSConnected;
-    private onceWSConnected;
-    private getWaitExpectedTimeoutLength;
-    private onWatchStart;
-    private onWatchClose;
-    private debug?;
-    listener: RealtimeListener;
-    private watchStatus;
-    private _availableRetries;
-    private _ackTimeoutId?;
-    private _initWatchPromise?;
-    private _rebuildWatchPromise?;
-    private sessionInfo?;
-    private _waitExpectedTimeoutId?;
-    constructor(options: IVirtualWebSocketClientConstructorOptions);
-    private _login;
-    private initWatch;
-    private rebuildWatch;
-    private handleWatchEstablishmentError;
-    private closeWatch;
-    private scheduleSendACK;
-    private clearACKSchedule;
-    private sendACK;
-    private handleCommonError;
-    private useRetryTicket;
-    private handleServerEvents;
-    private _handleServerEvents;
-    private _postHandleServerEventsValidityCheck;
-    private clearWaitExpectedEvent;
-    onMessage(msg: IResponseMessage): void;
-    closeWithError(error: any): void;
-    pause(): void;
-    resume(): Promise<void>;
-}
-export {};