dolphindb 2.0.504 → 2.0.507

package/index.js

@@ -6,6 +6,7 @@ const ws_1 = require("ws");
 const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
 const customParseFormat_js_1 = tslib_1.__importDefault(require("dayjs/plugin/customParseFormat.js"));
 dayjs_1.default.extend(customParseFormat_js_1.default);
+const net_js_1 = require("xshell/net.js");
 const utils_js_1 = require("xshell/utils.js");
 var DdbForm;
 (function (DdbForm) {
@@ -109,8 +110,7 @@ var DdbFunctionType;
     DdbFunctionType[DdbFunctionType["JitPartialFunc"] = 8] = "JitPartialFunc";
 })(DdbFunctionType = exports.DdbFunctionType || (exports.DdbFunctionType = {}));
 exports.nulls = {
-    bool: 0x80,
-    char: '\x80',
+    int8: -0x80,
     int16: -32768,
     int32: -2147483648,
     int64: -0x8000000000000000n,
@@ -284,12 +284,14 @@ class DdbObj {
             case DdbType.void:
                 return [1, null];
             case DdbType.bool: {
-                const value = buf[0];
-                return [1, value === exports.nulls.bool ? null : Boolean(value)];
+                const dv = new DataView(buf.buffer, buf.byteOffset);
+                const value = dv.getInt8(0);
+                return [1, value === exports.nulls.int8 ? null : Boolean(value)];
             }
             case DdbType.char: {
-                const value = String.fromCharCode(buf[0]);
-                return [1, value === exports.nulls.char ? null : value];
+                const dv = new DataView(buf.buffer, buf.byteOffset);
+                const value = dv.getInt8(0);
+                return [1, value === exports.nulls.int8 ? null : value];
             }
             case DdbType.short: {
                 const dv = new DataView(buf.buffer, buf.byteOffset);
@@ -474,11 +476,10 @@ class DdbObj {
     static parse_vector_items(buf, le, type, length) {
         switch (type) {
             case DdbType.bool:
-                return [length, buf.slice(0, length)];
             case DdbType.char:
                 return [
                     length,
-                    this.dec.decode(buf.subarray(0, length))
+                    new Int8Array(buf.buffer.slice(buf.byteOffset, buf.byteOffset + length))
                 ];
             case DdbType.short:
                 return [
@@ -628,17 +629,17 @@ class DdbObj {
                             return [Uint8Array.of(1)];
                         case DdbType.bool:
                             return [
-                                Uint8Array.of(value === null ?
-                                    exports.nulls.bool
+                                Int8Array.of(value === null ?
+                                    exports.nulls.int8
                                     :
                                         Number(value))
                             ];
                         case DdbType.char:
                             return [
-                                Uint8Array.of((value === null ?
-                                    exports.nulls.char
+                                Int8Array.of((value === null ?
+                                    exports.nulls.int8
                                     :
-                                        value).charCodeAt(0))
+                                        value))
                             ];
                         case DdbType.short:
                             return [
@@ -780,7 +781,7 @@ class DdbObj {
             case DdbType.bool:
                 return [value];
             case DdbType.char:
-                return [this.enc.encode(value)];
+                return [value];
             case DdbType.short:
                 return [value];
             case DdbType.int:
@@ -883,10 +884,16 @@ class DdbObj {
             }
         })();
         const data = (() => {
-            if (this.form === DdbForm.pair)
-                return `${(0, utils_js_1.inspect)(this.value[0], options)}, ${(0, utils_js_1.inspect)(this.value[1], options)}`;
-            if (this.form === DdbForm.scalar && this.type === DdbType.functiondef)
-                return (0, utils_js_1.inspect)(this.value.name, options);
+            switch (this.form) {
+                case DdbForm.pair:
+                    return `${(0, utils_js_1.inspect)(this.value[0], options)}, ${(0, utils_js_1.inspect)(this.value[1], options)}`;
+                case DdbForm.scalar:
+                    switch (this.type) {
+                        case DdbType.functiondef:
+                            return (0, utils_js_1.inspect)(this.value.name, options);
+                    }
+                    break;
+            }
             if (this.value instanceof Uint8Array)
                 return (0, utils_js_1.inspect)((0, utils_js_1.typed_array_to_buffer)(this.value), options);
             return (0, utils_js_1.inspect)(this.value, options);
@@ -900,21 +907,26 @@ class DdbObj {
         for (let i = 0; i < this.rows; i++) {
             let row = {};
             for (let j = 0; j < this.cols; j++) {
-                const { type, name, value } = this.value[j]; // column
+                const { type, name, value: values } = this.value[j]; // column
                 switch (type) {
-                    case DdbType.bool:
-                        row[name] = Boolean(value[i]);
+                    case DdbType.bool: {
+                        const value = values[i];
+                        row[name] = value === exports.nulls.int8 ?
+                            null
+                            :
+                                Boolean(value);
                         break;
+                    }
                     case DdbType.ipaddr:
-                        row[name] = value.subarray(16 * i, 16 * (i + 1));
+                        row[name] = values.subarray(16 * i, 16 * (i + 1));
                         break;
                     case DdbType.symbol_extended: {
-                        const { base, data } = value;
+                        const { base, data } = values;
                         row[name] = base[data[i]];
                         break;
                     }
                     default:
-                        row[name] = value[i];
+                        row[name] = values[i];
                 }
             }
             rows[i] = row;
@@ -968,7 +980,10 @@ class DdbChar extends DdbObj {
             form: DdbForm.scalar,
             type: DdbType.char,
             length: 1,
-            value,
+            value: typeof value === 'string' ?
+                value.charCodeAt(0)
+                :
+                    value
         });
     }
 }
@@ -1363,7 +1378,6 @@ class DDB {
         /** utf-8 text decoder */
         this.dec = new TextDecoder('utf-8');
         this.enc = new TextEncoder();
-        this.print_buffer = false;
         this.websocket = null;
         /** little endian (server) */
         this.le = true;
@@ -1375,8 +1389,13 @@ class DDB {
         this.password = '123456';
         /** python session flag (2048) */
         this.python = false;
-        this.message_hook = null;
-        this.presult = Promise.resolve(null);
+        this.print_message_buffer = false;
+        this.print_object_buffer = false;
+        this.print_message = true;
+        this.parse_object = true;
+        /** DdbMessage listeners */
+        this.listeners = [];
+        this.promise = Promise.resolve(null);
         this.url = url;
         if (options.autologin !== undefined)
             this.autologin = options.autologin;
@@ -1387,16 +1406,10 @@ class DDB {
         if (options.python !== undefined)
             this.python = options.python;
     }
-    /** print message handler */
-    printer(message) {
-        console.log(message);
-    }
-    /** resolver, rejector, promise of last rpc */
-    presolver(buf) { }
-    prejector(error) { }
     get connected() {
         return this.websocket?.readyState === ws_1.WebSocket.OPEN;
     }
+    on_message(event) { }
     /** Establish the actual WebSocket connection to the DolphinDB corresponding to the URL
         - options?:
             - url?: DolphinDB WebSocket URL. By default, the WebSocket URL passed in when the instance is initialized is used
@@ -1417,60 +1430,51 @@ class DDB {
         if (options.python !== undefined)
             this.python = options.python;
         this.disconnect();
-        let websocket = new ws_1.WebSocket(this.url, this.python ? ['python'] : [], {
-            maxPayload: 2 ** 33 // 8 GB
-        });
-        // https://stackoverflow.com/questions/11821096/what-is-the-difference-between-an-arraybuffer-and-a-blob/39951543
-        websocket.binaryType = 'arraybuffer';
-        this.websocket = websocket;
-        await new Promise((resolve, reject) => {
-            websocket.addEventListener('open', async (event) => {
-                console.log(`${websocket.url} opened`);
+        await (0, net_js_1.connect_websocket)(this.url, {
+            protocols: this.python ? ['python'] : [],
+            on_open: async (event, websocket) => {
+                this.websocket = websocket;
                 await this.rpc('connect', {});
-                resolve();
-            });
-            websocket.addEventListener('close', event => {
-                console.log(`${websocket.url} closed with code = ${event.code}, reason = '${event.reason}'`);
-            });
-            websocket.addEventListener('error', event => {
-                const message = `${websocket.url} errored`;
-                console.error(message, event);
-                reject(Object.assign(new Error(message), { event }));
-            });
-            websocket.addEventListener('message', event => {
-                const buf = new Uint8Array(event.data);
-                if (this.message_hook)
-                    this.message_hook(buf);
-                try {
-                    const { type, data } = this.parse_message(buf);
-                    if (type === 'message') {
-                        this.printer(data);
-                        return;
-                    }
-                    this.presolver(data);
-                }
-                catch (error) {
-                    this.prejector(error);
-                }
-            });
+            },
+            on_message: event => {
+                this.on_message(event);
+            }
         });
-        if (!this.python)
-            await this.eval('def pnode_run (nodes, func_name, args, add_node_alias = true) {\n' +
+        await this.eval(this.python ?
+            'def pnode_run (nodes, func_name, args, add_node_alias):\n' +
                 '    nargs = size(args)\n' +
                 '    func = funcByName(func_name)\n' +
                 '    \n' +
-                '    if (!nargs)\n' +
+                '    if not nargs:\n' +
                 '        return pnodeRun(func, nodes, add_node_alias)\n' +
                 '    \n' +
-                '    args_partial = array(any, 1 + nargs, 1 + nargs)\n' +
-                '    args_partial[0] = func\n' +
-                '    args_partial[1:] = args\n' +
+                '    args_partial = [ ]\n' +
+                '    args_partial.append(func)\n' +
+                '    for a in args:\n' +
+                '        args_partial.append(a)\n' +
+                '    \n' +
                 '    return pnodeRun(\n' +
                 '        unifiedCall(partial, args_partial),\n' +
                 '        nodes,\n' +
                 '        add_node_alias\n' +
-                '    )\n' +
-                '}\n', { urgent: true });
+                '    )\n'
+            :
+                'def pnode_run (nodes, func_name, args, add_node_alias = true) {\n' +
+                    '    nargs = size(args)\n' +
+                    '    func = funcByName(func_name)\n' +
+                    '    \n' +
+                    '    if (!nargs)\n' +
+                    '        return pnodeRun(func, nodes, add_node_alias)\n' +
+                    '    \n' +
+                    '    args_partial = array(any, 1 + nargs, 1 + nargs)\n' +
+                    '    args_partial[0] = func\n' +
+                    '    args_partial[1:] = args\n' +
+                    '    return pnodeRun(\n' +
+                    '        unifiedCall(partial, args_partial),\n' +
+                    '        nodes,\n' +
+                    '        add_node_alias\n' +
+                    '    )\n' +
+                    '}\n', { urgent: true });
         if (this.autologin)
             if (this.python)
                 await this.eval(`login(${this.username.quote('double')}, ${this.password.quote('double')})`, { urgent: true });
@@ -1506,47 +1510,69 @@ class DDB {
                 limit,
             ] : [],
         ];
-        return `/ ${options.join('_')}`;
+        return options.join('_');
     }
     disconnect() {
         if (this.connected)
             this.websocket.close(1000);
-        this.presolver = buf => { };
-        this.prejector = error => { };
-        this.presult = Promise.resolve(null);
+        this.on_message = () => { };
+        this.promise = Promise.resolve(null);
     }
     /** rpc through websocket (function/script/variable command)
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
             - vars?: type === 'variable' 时必传，variable 指令中待上传的变量名
+            - handler?: Process messages during this rpc (DdbMessage)
+            - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
+                不做解析，以便后续转发、序列化
     */
-    async rpc(type, { script, func, args = [], vars = [], urgent, }) {
+    async rpc(type, { script, func, args = [], vars = [], urgent, listener, parse_object, }) {
         if (!this.websocket)
             await this.connect();
         if (!this.connected)
             throw new Error(`${this.url} is already disconnected`);
+        // this 上的当前配置需要在 message 到达后使用，先保存起来
+        const _handlers = [...this.listeners].reverse();
         // 临界区：保证多个 rpc 并发时形成 promise 链
         // ddb 世界观：需要等待上一个 rpc 结果从 server 返回之后才能发起下一个调用  
         // 违反世界观可能造成:  
         // 1. 并发多个请求只返回第一个结果（阻塞，需后续请求疏通）
         // 2. windows 下 ddb server 返回多个相同的结果
-        const ptail = this.presult;
-        let presolver;
-        let prejector;
-        const presult = this.presult = new Promise((resolve, reject) => {
-            presolver = resolve;
-            prejector = reject;
+        const ptail = this.promise;
+        let resolve;
+        let reject;
+        const promise = this.promise = new Promise((_resolve, _reject) => {
+            resolve = _resolve;
+            reject = _reject;
         });
         try {
             await ptail;
         }
         catch { }
-        this.presolver = presolver;
-        this.prejector = prejector;
-        // 临界区结束，只有一个 rpc 请求可以写 WebSocket
-        if (urgent && type !== 'script' && type !== 'function')
-            throw new Error('urgent 只适用于 script 和 funciton');
+        // 临界区结束，只有一个 rpc 函数调用运行到这里，可以独占 this.on_message 然后写 WebSocket
+        this.on_message = ({ data: buffer }) => {
+            const buf = new Uint8Array(buffer);
+            if (this.print_message_buffer)
+                console.log((0, utils_js_1.typed_array_to_buffer)(buf));
+            const message = this.parse_message(buf, parse_object);
+            listener?.(message, this);
+            for (const listener of _handlers)
+                listener(message, this);
+            const { type, data } = message;
+            switch (type) {
+                case 'print':
+                    if (this.print_message)
+                        console.log(data);
+                    return;
+                case 'object':
+                    resolve(data);
+                    return;
+                case 'error':
+                    reject(data);
+                    return;
+            }
+        };
         args = this.to_ddbobjs(args);
         const command = this.enc.encode((() => {
             switch (type) {
@@ -1567,40 +1593,40 @@ class DDB {
                     return 'connect\n';
             }
         })());
-        const message = (0, utils_js_1.concat)([
-            this.enc.encode(`API2 ${this.sid} ${command.length}${this.get_rpc_options({ urgent })}\n`),
+        this.websocket.send((0, utils_js_1.concat)([
+            this.enc.encode(`API2 ${this.sid} ${command.length} / ${this.get_rpc_options({ urgent })}\n`),
             command,
             ...args.map((arg) => arg.pack())
-        ]);
-        this.websocket.send(message);
-        const buf_data = await presult;
-        if (this.print_buffer)
-            console.log((0, utils_js_1.typed_array_to_buffer)(buf_data));
-        // LOCAL: 便于 repl
-        // return global.DdbObj.parse(data_buf) as DdbObj
-        return DdbObj.parse(buf_data, this.le);
+        ]));
+        return promise;
     }
-    /** eval script through websocket (script command) */
-    async eval(
-    /** 执行的脚本 */
-    script, 
-    /** 执行选项 */
-    { urgent } = {}) {
-        return this.rpc('script', { script, urgent });
+    /** eval script through websocket (script command)
+        - script?: Script to execute
+        - options?: execution options
+            - urgent?: Urgent flag to ensure that submitted scripts are processed by urgent workers to prevent being blocked by other jobs
+            - listener?: Process messages during this rpc (DdbMessage)
+            - parse_object?: Set parse_object during this rpc, and restore the original after the end.
+                When it is false, the returned DdbObj only contains buffer and le without parsing,
+                so as to facilitate subsequent forwarding and serialization
+    */
+    async eval(script, { urgent, listener, parse_object, } = {}) {
+        return this.rpc('script', { script, urgent, listener, parse_object });
     }
     /** call function through websocket (function command)
-        - func: 函数名
-        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)
-        - options?: 调用选项
-            - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
-            - node?: 设置结点 alias 时发送到集群中对应的结点执行 (使用 DolphinDB 中的 rpc 方法)
-            - nodes?: 设置多个结点 alias 时发送到集群中对应的多个结点执行 (使用 DolphinDB 中的 pnodeRun 方法)
-            - func_type?: 设置 node 参数时必传，需指定函数类型，其它情况下不传
-            - add_node_alias?: 设置 nodes 参数时选传，其它情况不传
+        - func: function name
+        - args?: `[ ]` Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
+        - options?: call options
+            - urgent?: Emergency flag. Use urgent worker execution to prevent being blocked by other jobs
+            - node?: When the node alias is set, it is sent to the corresponding node in the cluster for execution (using the rpc method in DolphinDB)
+            - nodes?: When setting multiple node aliases, send them to the corresponding multiple nodes in the cluster for execution (using the pnodeRun method in DolphinDB)
+            - func_type?: It must be passed when setting the node parameter, the function type needs to be specified, and it is not passed in other cases
+            - add_node_alias?: Select to pass when setting the nodes parameter, otherwise not pass
+            - listener?: Process messages during this rpc (DdbMessage)
+            - parse_object?: Set parse_object during this rpc, and restore the original after the end.
+                When it is false, the returned DdbObj only contains buffer and le without parsing,
+                so as to facilitate subsequent forwarding and serialization
     */
-    async call(func, args = [], { urgent, node, nodes, func_type, add_node_alias } = {}) {
-        if (this.python)
-            throw new Error('call doesn\'t support python session yet');
+    async call(func, args = [], { urgent, node, nodes, func_type, add_node_alias, listener, parse_object, } = {}) {
         if (node) {
             if (typeof func_type === 'undefined')
                 throw new Error('指定 node 时必须设置 func_type');
@@ -1630,6 +1656,8 @@ class DDB {
             func,
             args,
             urgent,
+            listener,
+            parse_object
         });
     }
     /** upload variable through websocket (variable command) */
@@ -1637,19 +1665,19 @@ class DDB {
     /** Uploaded variables' name */
     vars, 
     /** Uploaded variables' value */
-    args) {
+    args, { listener, parse_object, } = {}) {
         if (!args.length || args.length !== vars.length)
-            throw new Error('variable 指令参数为空或参数名为空，或数量不匹配');
-        return this.rpc('variable', { vars, args });
+            throw new Error('variable command parameter is empty or parameter name is empty, or the number does not match');
+        return this.rpc('variable', { vars, args, listener, parse_object });
     }
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
-    parse_message(buf) {
+    parse_message(buf, parse_object = this.parse_object) {
         // MSG\n
         // <message>\0
         // 'M'.codePointAt(0).to_hex_str()
         if (buf[0] === 0x4d && buf[1] === 0x53 && buf[2] === 0x47 && buf[3] === 0x0a)
             return {
-                type: 'message',
+                type: 'print',
                 data: this.dec.decode(buf.subarray(4))
             };
         // '1166953221 1 1\n'
@@ -1673,10 +1701,25 @@ class DDB {
         /** 'OK' 表示成功，其它文本表示失败 */
         const message = this.dec.decode(buf.subarray(i_ls_1, i_lf_1));
         if (message !== 'OK')
-            throw new Error(message);
+            return {
+                type: 'error',
+                data: new Error(message)
+            };
+        const buf_obj = buf.subarray(i_lf_1 + 1);
+        if (this.print_object_buffer)
+            console.log((0, utils_js_1.typed_array_to_buffer)(buf_obj));
         return {
             type: 'object',
-            data: buf.subarray(i_lf_1 + 1)
+            data: parse_object ?
+                DdbObj.parse(buf_obj, this.le)
+                :
+                    new DdbObj({
+                        form: DdbForm.scalar,
+                        type: DdbType.void,
+                        length: 0,
+                        le: this.le,
+                        buffer: buf_obj,
+                    })
         };
     }
     /** 自动转换 js string, boolean 为 DdbObj */