dolphindb 2.0.940 → 2.0.944

package/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { InspectOptions as UtilInspectOptions } from 'util';
-import { inspect } from 'xshell';
+import { inspect, type WebSocketConnectionError } from 'xshell';
 export declare enum DdbForm {
     scalar = 0,
     vector = 1,
@@ -183,8 +183,8 @@ DdbSymbolExtendedValue | DdbArrayVectorValue | DdbDecimal32VectorValue | DdbDeci
 export type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
 export type DdbStringObj = DdbObj<string>;
 export type DdbVectorObj<TValue extends DdbVectorValue = DdbVectorValue> = DdbObj<TValue>;
-export type DdbVectorAnyObj = DdbObj<DdbObj[]>;
-export type DdbVectorStringObj = DdbObj<string[]>;
+export type DdbVectorAnyObj = DdbVectorObj<DdbObj[]>;
+export type DdbVectorStringObj = DdbVectorObj<string[]>;
 export type DdbTableObj<TColumns extends DdbVectorObj[] = DdbVectorObj[]> = DdbObj<TColumns>;
 export type DdbDictObj<TKeys extends DdbVectorObj = DdbVectorObj, TValues extends DdbVectorObj = DdbVectorObj> = DdbObj<[TKeys, TValues]>;
 export type DdbMatrixObj<TValue extends DdbMatrixValue = DdbMatrixValue> = DdbObj<TValue>;
@@ -462,8 +462,9 @@ export interface DdbRpcOptions {
 }
 export declare class DdbConnectionError extends Error {
     name: string;
+    cause?: WebSocketConnectionError;
     ddb: DDB;
-    constructor(ddb: DDB, error_options?: ErrorOptions);
+    constructor(ddb: DDB, error?: WebSocketConnectionError);
 }
 export declare class DdbDatabaseError extends Error {
     name: string;
@@ -497,6 +498,8 @@ export declare class DDB {
     python: boolean;
     /** 是否为流数据连接，非流数据这个字段恒为 null  Whether it is a streaming data connection, this field is always null for non-streaming data */
     streaming: StreamingData;
+    /** 是否打印每个 rpc 的信息用于调试 */
+    verbose: boolean;
     print_message_buffer: boolean;
     print_object_buffer: boolean;
     print_message: boolean;
@@ -518,7 +521,8 @@ export declare class DDB {
             - password?: DolphinDB 登录密码，默认 `'123456'`  DolphinDB password, default `'123456'`
             - python?: 设置 python session flag，默认 `false`  set python session flag, default `false`
             - streaming?: 设置该选项后，该 WebSocket 连接只用于流数据  When this option is set, the WebSocket connection is only used for streaming data
-        
+            - verbose?: 是否打印每个 rpc 的信息用于调试
+            
         @example
         let ddb = new DDB('ws://127.0.0.1:8848')
         
@@ -536,8 +540,10 @@ export declare class DDB {
         password?: string;
         python?: boolean;
         streaming?: StreamingParams;
+        verbose?: boolean;
     });
     private on_message;
+    private on_error;
     /** 建立实际的 WebSocket 连接到 URL 对应的 DolphinDB  Establish a actual websocket connection to the DolphindB corresponding to the URL
         是幂等的，调用后会确保已连接到数据库 (确保 websocket.readyState 为 open)，否则报错  After calling, it will ensure that it has been connected to the database (ensure that websocket.ReadyState is open), otherwise an error will be reported
         this.autologin 为 true 时自动登录  this.autologin automatically log in when it is true */

package/index.js

@@ -4,7 +4,7 @@ import DayjsCustomParseFormat from 'dayjs/plugin/customParseFormat.js';
 dayjs.extend(DayjsCustomParseFormat);
 import ipaddrjs from 'ipaddr.js';
 const { fromByteArray: buf2ipaddr } = ipaddrjs;
-import { concat, assert, inspect, typed_array_to_buffer, connect_websocket, WebSocket, WebSocketConnectionError, defer } from 'xshell';
+import { concat, assert, inspect, typed_array_to_buffer, connect_websocket, WebSocket, defer } from 'xshell';
 import { t } from './i18n/index.js';
 export var DdbForm;
 (function (DdbForm) {
@@ -2134,12 +2134,12 @@ export function int1282str(buffer, le = true) {
 export const winsize = 10_0000;
 export class DdbConnectionError extends Error {
     name = 'DdbConnectionError';
+    cause;
     ddb;
-    constructor(ddb, error_options) {
-        super(error_options?.cause ?
-            error_options.cause.message
-            :
-                `${ddb.url} ${t('连接出错了，可能由于网络原因连接已被关闭，或服务器断开连接')}`, error_options);
+    constructor(ddb, error) {
+        super(error?.message || `${ddb.url} ${t('连接出错了，可能由于网络原因连接已被关闭，或服务器断开连接')}`, { cause: error });
+        if (error)
+            this.cause = error;
         this.ddb = ddb;
     }
 }
@@ -2185,6 +2185,8 @@ export class DDB {
     python = false;
     /** 是否为流数据连接，非流数据这个字段恒为 null  Whether it is a streaming data connection, this field is always null for non-streaming data */
     streaming = null;
+    /** 是否打印每个 rpc 的信息用于调试 */
+    verbose = false;
     // --- 内部选项, 状态
     print_message_buffer = false;
     print_object_buffer = false;
@@ -2209,7 +2211,8 @@ export class DDB {
             - password?: DolphinDB 登录密码，默认 `'123456'`  DolphinDB password, default `'123456'`
             - python?: 设置 python session flag，默认 `false`  set python session flag, default `false`
             - streaming?: 设置该选项后，该 WebSocket 连接只用于流数据  When this option is set, the WebSocket connection is only used for streaming data
-        
+            - verbose?: 是否打印每个 rpc 的信息用于调试
+            
         @example
         let ddb = new DDB('ws://127.0.0.1:8848')
         
@@ -2223,6 +2226,8 @@ export class DDB {
     */
     constructor(url, options = {}) {
         this.url = url;
+        if (options.verbose !== undefined)
+            this.verbose = options.verbose;
         if (options.autologin !== undefined)
             this.autologin = options.autologin;
         if (options.username !== undefined)
@@ -2234,8 +2239,11 @@ export class DDB {
         if (options.streaming !== undefined)
             this.streaming = options.streaming;
     }
-    on_message(buffer) {
-        // 这里的实现一定会被 connect 中的实现覆盖
+    on_message(buffer, websocket) {
+        // 这里的实现一定会被 connect, rpc 中的实现覆盖
+    }
+    on_error(error, websocket) {
+        // 这里的实现一定会被 connect, rpc 中的实现覆盖
     }
     /** 建立实际的 WebSocket 连接到 URL 对应的 DolphinDB  Establish a actual websocket connection to the DolphindB corresponding to the URL
         是幂等的，调用后会确保已连接到数据库 (确保 websocket.readyState 为 open)，否则报错  After calling, it will ensure that it has been connected to the database (ensure that websocket.ReadyState is open), otherwise an error will be reported
@@ -2248,7 +2256,10 @@ export class DDB {
         await ptail;
         try {
             if (!this.connected) {
-                this.on_message = buffer => {
+                this.on_error = (error, websocket) => {
+                    pconnect.reject(new DdbConnectionError(this, error));
+                };
+                this.on_message = (buffer, websocket) => {
                     assert(false, t('这是在调用 this.rpc 之前默认的 on_message, 不应该被调用到，除非建立连接后 server 先推送了 message'));
                 };
                 this.presult = defer(null);
@@ -2261,16 +2272,16 @@ export class DDB {
                             if (this.python)
                                 return 'python';
                         })(),
-                        on_message: (buffer) => {
-                            this.on_message(buffer);
+                        on_message: (buffer, websocket) => {
+                            this.on_message(buffer, websocket);
+                        },
+                        on_error: (error, websocket) => {
+                            this.on_error(error, websocket);
                         }
                     });
                 }
                 catch (error) {
-                    if (error instanceof WebSocketConnectionError)
-                        throw new DdbConnectionError(this, { cause: error });
-                    else
-                        throw error;
+                    throw new DdbConnectionError(this, error);
                 }
                 if (this.streaming)
                     await this.subscribe();
@@ -2399,6 +2410,13 @@ export class DDB {
         }
         catch { }
         // 临界区结束，只有一个 rpc 函数调用运行到这里，可以独占 this.on_message 然后写 WebSocket
+        if (!this.connected) {
+            presult.reject(new DdbConnectionError(this));
+            return presult;
+        }
+        this.on_error = (error, websocket) => {
+            presult.reject(new DdbConnectionError(this, error));
+        };
         this.on_message = buffer => {
             try {
                 const buf = new Uint8Array(buffer);
@@ -2430,19 +2448,28 @@ export class DDB {
         const command = this.enc.encode((() => {
             switch (type) {
                 case 'function':
+                    if (this.verbose)
+                        console.log(func + args.map(arg => inspect(arg, { colors: false })).join(', ').bracket());
                     return 'function\n' +
                         `${func}\n` +
                         `${args.length}\n` +
                         `${Number(DDB.le_client)}\n`;
                 case 'script':
+                    if (this.verbose)
+                        console.log(script);
                     return 'script\n' +
                         script;
                 case 'variable':
+                    if (this.verbose)
+                        for (let i = 0; i < vars.length; i++)
+                            console.log(`${vars[i]} = ${inspect(args[i], { colors: false })}`);
                     return 'variable\n' +
                         `${vars.join(',')}\n` +
                         `${vars.length}\n` +
                         `${Number(DDB.le_client)}\n`;
                 case 'connect':
+                    if (this.verbose)
+                        console.log('connect()');
                     return 'connect\n';
             }
         })());